blob: 5e15381ebd65361a62e3a816a405c070567524f8 [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
Ivan Lozano0a468a42024-05-13 21:03:34 -0400103 Rlibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700104
Colin Cross3e5e7782022-06-17 22:17:05 +0000105 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
106 // prevent automatically exporting symbols.
107 UnexportedStaticLibs []string
108
Chris Parsons79d66a52020-06-05 17:26:16 -0400109 // Used for data dependencies adjacent to tests
110 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700111 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400112
Yo Chiang219968c2020-09-22 18:45:04 +0800113 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
114 SystemSharedLibs []string
115
Vinh Tran367d89d2023-04-28 11:21:25 -0400116 // Used by DepMutator to pass aidl_library modules to aidl compiler
117 AidlLibs []string
118
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500119 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800120 StaticUnwinderIfLegacy bool
121
Colin Cross5950f382016-12-13 12:50:57 -0800122 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700123
Colin Cross81413472016-04-11 14:37:39 -0700124 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700125
Dan Willemsenb40aab62016-04-20 14:21:14 -0700126 GeneratedSources []string
127 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900128 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700129
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700130 ReexportGeneratedHeaders []string
131
Colin Crossc465efd2021-06-11 18:00:04 -0700132 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700133
134 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700135 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900136
137 // List of libs that need to be excluded for APEX variant
138 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900139 // List of libs that need to be excluded for non-APEX variant
140 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800141
142 // LLNDK headers for the ABI checker to check LLNDK implementation library.
143 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
144 // The core variant cannot depend on the vendor variant because of the order of CreateVariations.
145 // Instead, the LLNDK implementation depends on the LLNDK header libs.
146 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700147}
148
Ivan Lozano0a468a42024-05-13 21:03:34 -0400149// A struct which to collect flags for rlib dependencies
150type RustRlibDep struct {
151 LibPath android.Path // path to the rlib
152 LinkDirs []string // flags required for dependency (e.g. -L flags)
153 CrateName string // crateNames associated with rlibDeps
154}
155
156func EqRustRlibDeps(a RustRlibDep, b RustRlibDep) bool {
157 return a.LibPath == b.LibPath
158}
159
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500160// PathDeps is a struct containing file paths to dependencies of a module.
161// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
162// It's used to construct flags for various build statements (such as for compiling and linking).
163// It is then passed to module decorator functions responsible for registering build statements
164// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800165type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700166 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900167 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700168 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900169 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700170 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700171 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400172 // Paths and crateNames for RustStaticLib dependencies
173 RustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700174
Colin Cross0de8a1e2020-09-18 14:15:30 -0700175 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700176 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700177
Colin Cross26c34ed2016-09-30 17:10:16 -0700178 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100179 Objs Objects
180 // Paths to .o files in dependencies that provide them. Note that these lists
181 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800182 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700183 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700184
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100185 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
186 // the libs from all whole_static_lib dependencies.
187 WholeStaticLibsFromPrebuilts android.Paths
188
Colin Cross26c34ed2016-09-30 17:10:16 -0700189 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700190 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900191 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700192
Inseob Kimd110f872019-12-06 13:15:38 +0900193 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000194 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900195 IncludeDirs android.Paths
196 SystemIncludeDirs android.Paths
197 ReexportedDirs android.Paths
198 ReexportedSystemDirs android.Paths
199 ReexportedFlags []string
200 ReexportedGeneratedHeaders android.Paths
201 ReexportedDeps android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400202 ReexportedRustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700203
Colin Cross26c34ed2016-09-30 17:10:16 -0700204 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700205 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700206
Dan Willemsena0790e32018-10-12 00:24:23 -0700207 // Path to the dynamic linker binary
208 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700209
210 // For Darwin builds, the path to the second architecture's output that should
211 // be combined with this architectures's output into a FAT MachO file.
212 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400213
214 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
215 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800216
217 // LLNDK headers for the ABI checker to check LLNDK implementation library.
218 LlndkIncludeDirs android.Paths
219 LlndkSystemIncludeDirs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700220}
221
Colin Cross4af21ed2019-11-04 09:37:55 -0800222// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
223// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
224// command line so they can be overridden by the local module flags).
225type LocalOrGlobalFlags struct {
226 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700227 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800228 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700229 CFlags []string // Flags that apply to C and C++ source files
230 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
231 ConlyFlags []string // Flags that apply to C source files
232 CppFlags []string // Flags that apply to C++ source files
233 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700234 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800235}
236
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500237// Flags contains various types of command line flags (and settings) for use in building build
238// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800239type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500240 // Local flags (which individual modules are responsible for). These may override global flags.
241 Local LocalOrGlobalFlags
242 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700243 Global LocalOrGlobalFlags
244 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800245
246 aidlFlags []string // Flags that apply to aidl source files
247 rsFlags []string // Flags that apply to renderscript source files
248 libFlags []string // Flags to add libraries early to the link order
249 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
250 TidyFlags []string // Flags that apply to clang-tidy
251 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700252
Colin Crossc3199482017-03-30 15:03:04 -0700253 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800254 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700255 SystemIncludeFlags []string
256
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800257 Toolchain config.Toolchain
258 Tidy bool // True if ninja .tidy rules should be generated.
259 NeedTidyFiles bool // True if module link should depend on .tidy files
260 GcovCoverage bool // True if coverage files should be generated.
261 SAbiDump bool // True if header abi dumps should be generated.
262 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
kellyhungd62ea302024-05-19 21:16:07 +0800263 ClangVerify bool // If true, append cflags "-Xclang -verify" and append "&& touch $out" to the clang command line.
Colin Crossca860ac2016-01-04 14:34:37 -0800264
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500265 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800266 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500267 // The target-device system path to the dynamic linker.
268 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800269
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700270 CFlagsDeps android.Paths // Files depended on by compiler flags
271 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800272
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500273 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700274 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800275
Colin Cross19878da2019-03-28 14:45:07 -0700276 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700277 protoC bool // Whether to use C instead of C++
278 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700279
280 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200281 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700282}
283
Colin Crossca860ac2016-01-04 14:34:37 -0800284// Properties used to compile all C or C++ modules
285type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700286 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800287 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700288
Jiyong Parkb35a8192020-08-10 15:59:36 +0900289 // The API level that this module is built against. The APIs of this API level will be
290 // visible at build time, but use of any APIs newer than min_sdk_version will render the
291 // module unloadable on older devices. In the future it will be possible to weakly-link new
292 // APIs, making the behavior match Java: such modules will load on older devices, but
293 // calling new APIs on devices that do not support them will result in a crash.
294 //
295 // This property has the same behavior as sdk_version does for Java modules. For those
296 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
297 // does for Java code.
298 //
299 // In addition, setting this property causes two variants to be built, one for the platform
300 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800301 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700302
Jiyong Parkb35a8192020-08-10 15:59:36 +0900303 // Minimum OS API level supported by this C or C++ module. This property becomes the value
304 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
305 // this property is also used to ensure that the min_sdk_version of the containing module is
306 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
307 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
308 // min_sdk_version of the containing APEX. When the module
309 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900310 Min_sdk_version *string
311
Colin Crossc511bc52020-04-07 16:50:32 +0000312 // If true, always create an sdk variant and don't create a platform variant.
313 Sdk_variant_only *bool
314
Jiyong Parkde866cb2018-12-07 23:08:36 +0900315 AndroidMkSharedLibs []string `blueprint:"mutated"`
316 AndroidMkStaticLibs []string `blueprint:"mutated"`
Ivan Lozano0a468a42024-05-13 21:03:34 -0400317 AndroidMkRlibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900318 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
319 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700320 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900321 HideFromMake bool `blueprint:"mutated"`
322 PreventInstall bool `blueprint:"mutated"`
323 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700324
Yo Chiang219968c2020-09-22 18:45:04 +0800325 // Set by DepsMutator.
326 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
327
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900328 // The name of the image this module is built for
329 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200330
331 // The VNDK version this module is built against. If empty, the module is not
332 // build against the VNDK.
333 VndkVersion string `blueprint:"mutated"`
334
335 // Suffix for the name of Android.mk entries generated by this module
336 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800337
338 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
339 // file
Inseob Kim37e0bb02024-04-29 15:54:44 +0900340 Logtags []string `android:"path"`
Jiyong Parkf9332f12018-02-01 00:54:12 +0900341
Yifan Hong39143a92020-10-26 12:43:12 -0700342 // Make this module available when building for ramdisk.
343 // On device without a dedicated recovery partition, the module is only
344 // available after switching root into
345 // /first_stage_ramdisk. To expose the module before switching root, install
346 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800347 Ramdisk_available *bool
348
Yifan Hong39143a92020-10-26 12:43:12 -0700349 // Make this module available when building for vendor ramdisk.
350 // On device without a dedicated recovery partition, the module is only
351 // available after switching root into
352 // /first_stage_ramdisk. To expose the module before switching root, install
353 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700354 Vendor_ramdisk_available *bool
355
Jiyong Parkf9332f12018-02-01 00:54:12 +0900356 // Make this module available when building for recovery
357 Recovery_available *bool
358
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200359 // Used by imageMutator, set by ImageMutatorBegin()
360 CoreVariantNeeded bool `blueprint:"mutated"`
361 RamdiskVariantNeeded bool `blueprint:"mutated"`
362 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
363 RecoveryVariantNeeded bool `blueprint:"mutated"`
364
365 // A list of variations for the "image" mutator of the form
366 //<image name> '.' <version char>, for example, 'vendor.S'
367 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900368
369 // Allows this module to use non-APEX version of libraries. Useful
370 // for building binaries that are started before APEXes are activated.
371 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900372
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000373 // Allows this module to be included in CMake release snapshots to be built outside of Android
374 // build system and source tree.
375 Cmake_snapshot_supported *bool
376
Colin Cross1bc94122021-10-28 13:25:54 -0700377 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000378
379 // Set by factories of module types that can only be referenced from variants compiled against
380 // the SDK.
381 AlwaysSdk bool `blueprint:"mutated"`
382
383 // Variant is an SDK variant created by sdkMutator
384 IsSdkVariant bool `blueprint:"mutated"`
385 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
386 // variant to have a ".sdk" suffix.
387 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700388
Jiyong Park46a512f2020-12-04 18:02:13 +0900389 // List of APEXes that this module has private access to for testing purpose. The module
390 // can depend on libraries that are not exported by the APEXes and use private symbols
391 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000392 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800393
394 Target struct {
395 Platform struct {
396 // List of modules required by the core variant.
397 Required []string `android:"arch_variant"`
398
399 // List of modules not required by the core variant.
400 Exclude_required []string `android:"arch_variant"`
401 } `android:"arch_variant"`
402
403 Recovery struct {
404 // List of modules required by the recovery variant.
405 Required []string `android:"arch_variant"`
406
407 // List of modules not required by the recovery variant.
408 Exclude_required []string `android:"arch_variant"`
409 } `android:"arch_variant"`
410 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700411}
412
413type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900414 // whether this module should be allowed to be directly depended by other
415 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900416 // If set to true, two variants will be built separately, one like
417 // normal, and the other limited to the set of libraries and headers
418 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700419 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900420 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700421 // so it shouldn't have any unversioned runtime dependencies, or
422 // make assumptions about the system that may not be true in the
423 // future.
424 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900425 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900426 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900427 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900428 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900429 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700430 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
431 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900432
Justin Yunebcf0c52021-01-08 18:00:19 +0900433 // This is the same as the "vendor_available" except that the install path
434 // of the vendor variant is /odm or /vendor/odm.
435 // By replacing "vendor_available: true" with "odm_available: true", the
436 // module will install its vendor variant to the /odm partition or /vendor/odm.
437 // As the modules with "odm_available: true" still create the vendor variants,
438 // they can link to the other vendor modules as the vendor_available modules do.
439 // Also, the vendor modules can link to odm_available modules.
440 //
441 // It may not be used for VNDK modules.
442 Odm_available *bool
443
Justin Yun63e9ec72020-10-29 16:49:43 +0900444 // whether this module should be allowed to be directly depended by other
445 // modules with `product_specific: true` or `product_available: true`.
446 // If set to true, an additional product variant will be built separately
447 // that is limited to the set of libraries and headers that are exposed to
448 // /product modules.
449 //
450 // The product variant may be used with a different (newer) /system,
451 // so it shouldn't have any unversioned runtime dependencies, or
452 // make assumptions about the system that may not be true in the
453 // future.
454 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900455 // If set to false, this module becomes inaccessible from /product modules.
456 //
457 // Different from the 'vendor_available' property, the modules with
458 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
459 // library without 'product_available' may not be depended on by any other
460 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900461 //
462 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
463 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
464 Product_available *bool
465
Jiyong Park5fb8c102018-04-09 12:03:06 +0900466 // whether this module is capable of being loaded with other instance
467 // (possibly an older version) of the same module in the same process.
468 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
469 // can be double loaded in a vendor process if the library is also a
470 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
471 // explicitly marked as `double_loadable: true` by the owner, or the dependency
472 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
473 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800474
475 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
476 IsLLNDK bool `blueprint:"mutated"`
477
Colin Cross78212242021-01-06 14:51:30 -0800478 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
479 IsVNDKCore bool `blueprint:"mutated"`
480
481 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
482 IsVNDKSP bool `blueprint:"mutated"`
483
484 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
485 // module sets the llndk.private property.
486 IsVNDKPrivate bool `blueprint:"mutated"`
487
488 // IsVNDKProduct is set if a VNDK module sets the product_available property.
489 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700490
491 // IsVendorPublicLibrary is set for the core and product variants of a library that has
492 // vendor_public_library stubs.
493 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800494}
495
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500496// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
497// to understanding details about the type of the current module.
498// For example, one might call these functions to determine whether the current module is a static
499// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800500type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800501 static() bool
502 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700503 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800504 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900505 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900506 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900507 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700508 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900509 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700510 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800511 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900512 minSdkVersion() string
513 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700514 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700515 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800516 IsLlndk() bool
517 IsLlndkPublic() bool
518 isImplementationForLLNDKPublic() bool
519 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900520 isVndk() bool
521 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500522 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700523 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900524 inProduct() bool
525 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800526 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700527 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900528 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900529 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700530 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700531 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800532 getVndkExtendsModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800533 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000534 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800535 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900536 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800537 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800538 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800539 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700540 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700541 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900542 bootstrap() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700543 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700544 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800545 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800546 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800547 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800548 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800549}
550
551type SharedFlags struct {
552 numSharedFlags int
553 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800554}
555
556type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700557 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800558 ModuleContextIntf
559}
560
561type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700562 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800563 ModuleContextIntf
564}
565
Colin Cross37047f12016-12-13 17:06:13 -0800566type DepsContext interface {
567 android.BottomUpMutatorContext
568 ModuleContextIntf
569}
570
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500571// feature represents additional (optional) steps to building cc-related modules, such as invocation
572// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800573type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800574 flags(ctx ModuleContext, flags Flags) Flags
575 props() []interface{}
576}
577
Joe Onorato37f900c2023-07-18 16:58:16 -0700578// Information returned from Generator about the source code it's generating
579type GeneratedSource struct {
580 IncludeDirs android.Paths
581 Sources android.Paths
582 Headers android.Paths
583 ReexportedDirs android.Paths
584}
585
586// generator allows injection of generated code
587type Generator interface {
588 GeneratorProps() []interface{}
589 GeneratorInit(ctx BaseModuleContext)
590 GeneratorDeps(ctx DepsContext, deps Deps) Deps
591 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
592 GeneratorSources(ctx ModuleContext) GeneratedSource
593 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
594}
595
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500596// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500597// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800598type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700599 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800600 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800601 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700602 compilerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000603 baseCompilerProps() BaseCompilerProperties
Colin Cross42742b82016-08-01 13:20:05 -0700604
Colin Cross76fada02016-07-27 10:31:13 -0700605 appendCflags([]string)
606 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700607 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800608}
609
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500610// linker is the interface for a linker decorator object. Individual module types can provide
611// their own implementation for this decorator, and thus specify custom logic regarding build
612// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800613type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700614 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800615 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700616 linkerFlags(ctx ModuleContext, flags Flags) Flags
617 linkerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000618 baseLinkerProps() BaseLinkerProperties
Ivan Lozanobd721262018-11-27 14:33:03 -0800619 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700620
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700621 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700622 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900623 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800624 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700625
626 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900627 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000628
629 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000630 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800631
632 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000633}
634
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500635// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000636type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500637 sharedLibs []string
638 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
639 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700640 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800641}
642
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500643// installer is the interface for an installer helper object. This helper is responsible for
644// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800645type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700646 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700647 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000648 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800649 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700650 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700651 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900652 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000653 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900654 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800655}
656
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800657type xref interface {
658 XrefCcFiles() android.Paths
659}
660
Inseob Kima1888ce2022-10-04 14:42:02 +0900661type overridable interface {
662 overriddenModules() []string
663}
664
Colin Cross6e511a92020-07-27 21:26:48 -0700665type libraryDependencyKind int
666
667const (
668 headerLibraryDependency = iota
669 sharedLibraryDependency
670 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400671 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700672)
673
674func (k libraryDependencyKind) String() string {
675 switch k {
676 case headerLibraryDependency:
677 return "headerLibraryDependency"
678 case sharedLibraryDependency:
679 return "sharedLibraryDependency"
680 case staticLibraryDependency:
681 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400682 case rlibLibraryDependency:
683 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700684 default:
685 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
686 }
687}
688
689type libraryDependencyOrder int
690
691const (
692 earlyLibraryDependency = -1
693 normalLibraryDependency = 0
694 lateLibraryDependency = 1
695)
696
697func (o libraryDependencyOrder) String() string {
698 switch o {
699 case earlyLibraryDependency:
700 return "earlyLibraryDependency"
701 case normalLibraryDependency:
702 return "normalLibraryDependency"
703 case lateLibraryDependency:
704 return "lateLibraryDependency"
705 default:
706 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
707 }
708}
709
710// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
711// tags that have a set of predefined tag objects that are reused for each dependency, a
712// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
713// That means that comparing a libraryDependencyTag for equality will only be equal if all
714// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
715// then check individual metadata fields instead.
716type libraryDependencyTag struct {
717 blueprint.BaseDependencyTag
718
719 // These are exported so that fmt.Printf("%#v") can call their String methods.
720 Kind libraryDependencyKind
721 Order libraryDependencyOrder
722
723 wholeStatic bool
724
725 reexportFlags bool
726 explicitlyVersioned bool
727 dataLib bool
728 ndk bool
729
730 staticUnwinder bool
731
732 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900733
Cindy Zhou18417cb2020-12-10 07:12:38 -0800734 // Whether or not this dependency should skip the apex dependency check
735 skipApexAllowedDependenciesCheck bool
736
Jiyong Parke3867542020-12-03 17:28:25 +0900737 // Whether or not this dependency has to be followed for the apex variants
738 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900739 // Whether or not this dependency has to be followed for the non-apex variants
740 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000741
742 // If true, don't automatically export symbols from the static library into a shared library.
743 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700744}
745
746// header returns true if the libraryDependencyTag is tagging a header lib dependency.
747func (d libraryDependencyTag) header() bool {
748 return d.Kind == headerLibraryDependency
749}
750
751// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
752func (d libraryDependencyTag) shared() bool {
753 return d.Kind == sharedLibraryDependency
754}
755
756// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
757func (d libraryDependencyTag) static() bool {
758 return d.Kind == staticLibraryDependency
759}
760
Ivan Lozano0a468a42024-05-13 21:03:34 -0400761// rlib returns true if the libraryDependencyTag is tagging an rlib dependency.
762func (d libraryDependencyTag) rlib() bool {
763 return d.Kind == rlibLibraryDependency
764}
765
Colin Cross65cb3142021-12-10 23:05:02 +0000766func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
767 if d.shared() {
768 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
769 }
770 return nil
771}
772
773var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
774
Colin Crosse9fe2942020-11-10 18:12:15 -0800775// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
776// binaries or other shared libraries are installed as dependencies.
777func (d libraryDependencyTag) InstallDepNeeded() bool {
778 return d.shared()
779}
780
781var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
782
Yu Liu67a28422024-03-05 00:36:31 +0000783func (d libraryDependencyTag) PropagateAconfigValidation() bool {
784 return d.static()
785}
786
787var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
788
Colin Crosse9fe2942020-11-10 18:12:15 -0800789// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700790// libraryDependencyTag. Each tag object is created globally and reused for multiple
791// dependencies (although since the object contains no references, assigning a tag to a
792// variable and modifying it will not modify the original). Users can compare the tag
793// returned by ctx.OtherModuleDependencyTag against the global original
794type dependencyTag struct {
795 blueprint.BaseDependencyTag
796 name string
797}
798
Colin Crosse9fe2942020-11-10 18:12:15 -0800799// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
800// libraryDependencyTag, but where the dependency needs to be installed when the parent is
801// installed.
802type installDependencyTag struct {
803 blueprint.BaseDependencyTag
804 android.InstallAlwaysNeededDependencyTag
805 name string
806}
807
Colin Crossc99deeb2016-04-11 15:06:20 -0700808var (
Colin Cross6e511a92020-07-27 21:26:48 -0700809 genSourceDepTag = dependencyTag{name: "gen source"}
810 genHeaderDepTag = dependencyTag{name: "gen header"}
811 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
812 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900813 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700814 reuseObjTag = dependencyTag{name: "reuse objects"}
815 staticVariantTag = dependencyTag{name: "static variant"}
816 vndkExtDepTag = dependencyTag{name: "vndk extends"}
817 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700818 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800819 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700820 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700821 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000822 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500823 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400824 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800825 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700826)
827
Roland Levillainf89cd092019-07-29 16:22:59 +0100828func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700829 ccLibDepTag, ok := depTag.(libraryDependencyTag)
830 return ok && ccLibDepTag.shared()
831}
832
833func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
834 ccLibDepTag, ok := depTag.(libraryDependencyTag)
835 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100836}
837
Zach Johnson3df4e632020-11-06 11:56:27 -0800838func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
839 ccLibDepTag, ok := depTag.(libraryDependencyTag)
840 return ok && ccLibDepTag.header()
841}
842
Roland Levillainf89cd092019-07-29 16:22:59 +0100843func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800844 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100845}
846
847func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700848 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100849 return ok && ccDepTag == testPerSrcDepTag
850}
851
Colin Crossca860ac2016-01-04 14:34:37 -0800852// Module contains the properties and members used by all C/C++ module types, and implements
853// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500854// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
855// interface.
856//
857// To define a C/C++ related module, construct a new Module object and point its delegates to
858// type-specific structs. These delegates will be invoked to register module-specific build
859// statements which may be unique to the module type. For example, module.compiler.compile() should
860// be defined so as to register build statements which are responsible for compiling the module.
861//
862// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
863// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
864// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
865// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800866type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700867 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700868
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700869 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700870 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700871 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700872
Colin Crossca860ac2016-01-04 14:34:37 -0800873 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000874 hod android.HostOrDeviceSupported
875 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000876 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700877
Paul Duffina0843f62019-12-13 19:50:38 +0000878 // Allowable SdkMemberTypes of this module type.
879 sdkMemberTypes []android.SdkMemberType
880
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500881 // decorator delegates, initialize before calling Init
882 // these may contain module-specific implementations, and effectively allow for custom
883 // type-specific logic. These members may reference different objects or the same object.
884 // Functions of these decorators will be invoked to initialize and register type-specific
885 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800886 generators []Generator
887 compiler compiler
888 linker linker
889 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500890
Spandan Dase12d2522023-09-12 21:42:31 +0000891 features []feature
892 stl *stl
893 sanitize *sanitize
894 coverage *coverage
895 fuzzer *fuzzer
896 sabi *sabi
897 vndkdep *vndkdep
898 lto *lto
899 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000900 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800901
Colin Cross31076b32020-10-23 17:22:06 -0700902 library libraryInterface
903
Colin Cross635c3b02016-05-18 15:37:25 -0700904 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800905
Colin Crossb98c8b02016-07-29 13:44:28 -0700906 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700907
908 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800909
910 // Flags used to compile this module
911 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700912
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800913 // Shared flags among build rules of this module
914 sharedFlags SharedFlags
915
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800916 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700917 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900918
919 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800920 // Kythe (source file indexer) paths for this compilation module
921 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700922 // Object .o file output paths for this compilation module
923 objFiles android.Paths
924 // Tidy .tidy file output paths for this compilation module
925 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900926
927 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700928 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700929
930 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800931
Inseob Kim37e0bb02024-04-29 15:54:44 +0900932 logtagsPaths android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700933}
934
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200935func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400936 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
937 if b, ok := c.compiler.(*baseCompiler); ok {
938 hasAidl = b.hasSrcExt(".aidl")
939 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
940 hasProto = b.hasSrcExt(".proto")
941 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
942 hasSysprop = b.hasSrcExt(".sysprop")
943 hasWinMsg = b.hasSrcExt(".mc")
944 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
945 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200946 c.AndroidModuleBase().AddJSONData(d)
947 (*d)["Cc"] = map[string]interface{}{
948 "SdkVersion": c.SdkVersion(),
949 "MinSdkVersion": c.MinSdkVersion(),
950 "VndkVersion": c.VndkVersion(),
951 "ProductSpecific": c.ProductSpecific(),
952 "SocSpecific": c.SocSpecific(),
953 "DeviceSpecific": c.DeviceSpecific(),
954 "InProduct": c.InProduct(),
955 "InVendor": c.InVendor(),
956 "InRamdisk": c.InRamdisk(),
957 "InVendorRamdisk": c.InVendorRamdisk(),
958 "InRecovery": c.InRecovery(),
959 "VendorAvailable": c.VendorAvailable(),
960 "ProductAvailable": c.ProductAvailable(),
961 "RamdiskAvailable": c.RamdiskAvailable(),
962 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
963 "RecoveryAvailable": c.RecoveryAvailable(),
964 "OdmAvailable": c.OdmAvailable(),
965 "InstallInData": c.InstallInData(),
966 "InstallInRamdisk": c.InstallInRamdisk(),
967 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
968 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
969 "InstallInRecovery": c.InstallInRecovery(),
970 "InstallInRoot": c.InstallInRoot(),
971 "IsVndk": c.IsVndk(),
972 "IsVndkExt": c.IsVndkExt(),
973 "IsVndkPrivate": c.IsVndkPrivate(),
974 "IsVndkSp": c.IsVndkSp(),
975 "IsLlndk": c.IsLlndk(),
976 "IsLlndkPublic": c.IsLlndkPublic(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200977 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
978 "ApexSdkVersion": c.apexSdkVersion,
979 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400980 "AidlSrcs": hasAidl,
981 "LexSrcs": hasLex,
982 "ProtoSrcs": hasProto,
983 "RenderscriptSrcs": hasRenderscript,
984 "SyspropSrcs": hasSysprop,
985 "WinMsgSrcs": hasWinMsg,
986 "YaccSrsc": hasYacc,
987 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200988 }
989}
990
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500991func (c *Module) SetPreventInstall() {
992 c.Properties.PreventInstall = true
993}
994
995func (c *Module) SetHideFromMake() {
996 c.Properties.HideFromMake = true
997}
998
Ivan Lozanod7586b62021-04-01 09:49:36 -0400999func (c *Module) HiddenFromMake() bool {
1000 return c.Properties.HideFromMake
1001}
1002
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001003func (c *Module) RequiredModuleNames() []string {
1004 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
1005 if c.ImageVariation().Variation == android.CoreVariation {
1006 required = append(required, c.Properties.Target.Platform.Required...)
1007 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1008 } else if c.InRecovery() {
1009 required = append(required, c.Properties.Target.Recovery.Required...)
1010 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1011 }
1012 return android.FirstUniqueStrings(required)
1013}
1014
Ivan Lozano52767be2019-10-18 14:49:46 -07001015func (c *Module) Toc() android.OptionalPath {
1016 if c.linker != nil {
1017 if library, ok := c.linker.(libraryInterface); ok {
1018 return library.toc()
1019 }
1020 }
1021 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1022}
1023
1024func (c *Module) ApiLevel() string {
1025 if c.linker != nil {
1026 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001027 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001028 }
1029 }
1030 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1031}
1032
1033func (c *Module) Static() bool {
1034 if c.linker != nil {
1035 if library, ok := c.linker.(libraryInterface); ok {
1036 return library.static()
1037 }
1038 }
1039 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1040}
1041
1042func (c *Module) Shared() bool {
1043 if c.linker != nil {
1044 if library, ok := c.linker.(libraryInterface); ok {
1045 return library.shared()
1046 }
1047 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001048
Ivan Lozano52767be2019-10-18 14:49:46 -07001049 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1050}
1051
1052func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001053 if c.stl != nil {
1054 return c.stl.Properties.SelectedStl
1055 }
1056 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001057}
1058
Ivan Lozano52767be2019-10-18 14:49:46 -07001059func (c *Module) NdkPrebuiltStl() bool {
1060 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1061 return true
1062 }
1063 return false
1064}
1065
1066func (c *Module) StubDecorator() bool {
1067 if _, ok := c.linker.(*stubDecorator); ok {
1068 return true
1069 }
1070 return false
1071}
1072
1073func (c *Module) SdkVersion() string {
1074 return String(c.Properties.Sdk_version)
1075}
1076
Artur Satayev480e25b2020-04-27 18:53:18 +01001077func (c *Module) MinSdkVersion() string {
1078 return String(c.Properties.Min_sdk_version)
1079}
1080
Jiyong Park5df7bd32021-08-25 16:18:46 +09001081func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001082 if linker, ok := c.linker.(*objectLinker); ok {
1083 return linker.isCrt()
1084 }
1085 return false
1086}
1087
Jiyong Park5df7bd32021-08-25 16:18:46 +09001088func (c *Module) SplitPerApiLevel() bool {
1089 return c.canUseSdk() && c.isCrt()
1090}
1091
Colin Crossc511bc52020-04-07 16:50:32 +00001092func (c *Module) AlwaysSdk() bool {
1093 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1094}
1095
Ivan Lozano183a3212019-10-18 14:18:45 -07001096func (c *Module) CcLibrary() bool {
1097 if c.linker != nil {
1098 if _, ok := c.linker.(*libraryDecorator); ok {
1099 return true
1100 }
Colin Crossd48fe732020-09-23 20:37:24 -07001101 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1102 return true
1103 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001104 }
1105 return false
1106}
1107
1108func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001109 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001110 return true
1111 }
1112 return false
1113}
1114
Spandan Dase12d2522023-09-12 21:42:31 +00001115func (c *Module) IsNdkPrebuiltStl() bool {
1116 if c.linker == nil {
1117 return false
1118 }
1119 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1120 return true
1121 }
1122 return false
1123}
1124
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001125func (c *Module) RlibStd() bool {
1126 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1127}
1128
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001129func (c *Module) RustLibraryInterface() bool {
1130 return false
1131}
1132
Ivan Lozano0a468a42024-05-13 21:03:34 -04001133func (c *Module) CrateName() string {
1134 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1135}
1136
1137func (c *Module) ExportedCrateLinkDirs() []string {
1138 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1139}
1140
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001141func (c *Module) IsFuzzModule() bool {
1142 if _, ok := c.compiler.(*fuzzBinary); ok {
1143 return true
1144 }
1145 return false
1146}
1147
1148func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1149 return c.FuzzModule
1150}
1151
1152func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1153 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1154 return fuzzer.fuzzPackagedModule
1155 }
1156 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1157}
1158
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001159func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001160 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1161 return fuzzer.sharedLibraries
1162 }
1163 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1164}
1165
Ivan Lozano2b262972019-11-21 12:30:50 -08001166func (c *Module) NonCcVariants() bool {
1167 return false
1168}
1169
Ivan Lozano183a3212019-10-18 14:18:45 -07001170func (c *Module) SetStatic() {
1171 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001172 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001173 library.setStatic()
1174 return
1175 }
1176 }
1177 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1178}
1179
1180func (c *Module) SetShared() {
1181 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001182 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001183 library.setShared()
1184 return
1185 }
1186 }
1187 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1188}
1189
1190func (c *Module) BuildStaticVariant() bool {
1191 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001192 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001193 return library.buildStatic()
1194 }
1195 }
1196 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1197}
1198
1199func (c *Module) BuildSharedVariant() bool {
1200 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001201 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001202 return library.buildShared()
1203 }
1204 }
1205 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1206}
1207
1208func (c *Module) Module() android.Module {
1209 return c
1210}
1211
Jiyong Parkc20eee32018-09-05 22:36:17 +09001212func (c *Module) OutputFile() android.OptionalPath {
1213 return c.outputFile
1214}
1215
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001216func (c *Module) CoverageFiles() android.Paths {
1217 if c.linker != nil {
1218 if library, ok := c.linker.(libraryInterface); ok {
1219 return library.objs().coverageFiles
1220 }
1221 }
1222 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1223}
1224
Ivan Lozano183a3212019-10-18 14:18:45 -07001225var _ LinkableInterface = (*Module)(nil)
1226
Jiyong Park719b4462019-01-13 00:39:51 +09001227func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001228 if c.linker != nil {
1229 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001230 }
1231 return nil
1232}
1233
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001234func (c *Module) CoverageOutputFile() android.OptionalPath {
1235 if c.linker != nil {
1236 return c.linker.coverageOutputFilePath()
1237 }
1238 return android.OptionalPath{}
1239}
1240
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001241func (c *Module) RelativeInstallPath() string {
1242 if c.installer != nil {
1243 return c.installer.relativeInstallPath()
1244 }
1245 return ""
1246}
1247
Jooyung Han344d5432019-08-23 11:17:39 +09001248func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001249 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001250}
1251
Colin Cross36242852017-06-23 15:06:31 -07001252func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001253 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001254 for _, generator := range c.generators {
1255 c.AddProperties(generator.GeneratorProps()...)
1256 }
Colin Crossca860ac2016-01-04 14:34:37 -08001257 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001258 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001259 }
1260 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001261 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001262 }
1263 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001264 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001265 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001266 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001267 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001268 }
Colin Cross16b23492016-01-06 14:41:07 -08001269 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001270 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001271 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001272 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001273 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001274 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001275 if c.fuzzer != nil {
1276 c.AddProperties(c.fuzzer.props()...)
1277 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001278 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001279 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001280 }
Justin Yun8effde42017-06-23 19:24:43 +09001281 if c.vndkdep != nil {
1282 c.AddProperties(c.vndkdep.props()...)
1283 }
Stephen Craneba090d12017-05-09 15:44:35 -07001284 if c.lto != nil {
1285 c.AddProperties(c.lto.props()...)
1286 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001287 if c.afdo != nil {
1288 c.AddProperties(c.afdo.props()...)
1289 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001290 if c.orderfile != nil {
1291 c.AddProperties(c.orderfile.props()...)
1292 }
Colin Crossca860ac2016-01-04 14:34:37 -08001293 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001294 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001295 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001296 // Allow test-only on libraries that are not cc_test_library
1297 if c.library != nil && !c.testLibrary() {
1298 c.AddProperties(&c.sourceProperties)
1299 }
Colin Crossc472d572015-03-17 15:06:21 -07001300
Colin Cross36242852017-06-23 15:06:31 -07001301 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001302 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001303 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001304
Colin Cross36242852017-06-23 15:06:31 -07001305 return c
Colin Crossc472d572015-03-17 15:06:21 -07001306}
1307
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001308// UseVndk() returns true if this module is built against VNDK.
1309// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001310func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001311 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001312}
1313
Colin Crossc511bc52020-04-07 16:50:32 +00001314func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001315 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001316 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001317}
1318
1319func (c *Module) UseSdk() bool {
1320 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001321 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001322 }
1323 return false
1324}
1325
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001326func (c *Module) isCoverageVariant() bool {
1327 return c.coverage.Properties.IsCoverageVariant
1328}
1329
Colin Cross95f1ca02020-10-29 20:47:22 -07001330func (c *Module) IsNdk(config android.Config) bool {
1331 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001332}
1333
Colin Cross127bb8b2020-12-16 16:46:01 -08001334func (c *Module) IsLlndk() bool {
1335 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001336}
1337
Colin Cross127bb8b2020-12-16 16:46:01 -08001338func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001339 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001340}
1341
Colin Cross1f3f1302021-04-26 18:37:44 -07001342func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001343 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001344 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001345}
1346
Colin Cross5271fea2021-04-27 13:06:04 -07001347func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1348 lib := moduleLibraryInterface(m)
1349 return lib != nil && (lib.hasVendorPublicLibrary())
1350}
1351
1352// IsVendorPublicLibrary returns true for vendor public libraries.
1353func (c *Module) IsVendorPublicLibrary() bool {
1354 return c.VendorProperties.IsVendorPublicLibrary
1355}
1356
Ivan Lozanof1868af2022-04-12 13:08:36 -04001357func (c *Module) IsVndkPrebuiltLibrary() bool {
1358 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1359 return true
1360 }
1361 return false
1362}
1363
1364func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1365 return c.Properties.SdkAndPlatformVariantVisibleToMake
1366}
1367
Ivan Lozanod7586b62021-04-01 09:49:36 -04001368func (c *Module) HasLlndkStubs() bool {
1369 lib := moduleLibraryInterface(c)
1370 return lib != nil && lib.hasLLNDKStubs()
1371}
1372
1373func (c *Module) StubsVersion() string {
1374 if lib, ok := c.linker.(versionedInterface); ok {
1375 return lib.stubsVersion()
1376 }
1377 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1378}
1379
Colin Cross127bb8b2020-12-16 16:46:01 -08001380// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1381// and does not set llndk.vendor_available: false.
1382func (c *Module) isImplementationForLLNDKPublic() bool {
1383 library, _ := c.library.(*libraryDecorator)
1384 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001385 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001386}
1387
Justin Yunfd9e8042020-12-23 18:23:14 +09001388// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001389func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001390 // Check if VNDK-core-private or VNDK-SP-private
1391 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001392 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001393 }
1394
1395 // Check if LLNDK-private
1396 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001397 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001398 }
1399
1400 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001401}
1402
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001403// IsVndk() returns true if this module has a vndk variant.
1404// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1405// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001406func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001407 if vndkdep := c.vndkdep; vndkdep != nil {
1408 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001409 }
1410 return false
1411}
1412
Colin Cross3513fb12024-01-24 14:44:47 -08001413func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001414 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001415 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001416 }
1417 return false
1418}
1419
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001420func (c *Module) isOrderfileCompile() bool {
1421 if orderfile := c.orderfile; orderfile != nil {
1422 return orderfile.Properties.OrderfileLoad
1423 }
1424 return false
1425}
1426
Yi Kongc702ebd2022-08-19 16:02:45 +08001427func (c *Module) isCfi() bool {
1428 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001429 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001430 }
1431 return false
1432}
1433
Yi Konged79fa32023-06-04 17:15:42 +09001434func (c *Module) isFuzzer() bool {
1435 if sanitize := c.sanitize; sanitize != nil {
1436 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1437 }
1438 return false
1439}
1440
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001441func (c *Module) isNDKStubLibrary() bool {
1442 if _, ok := c.compiler.(*stubDecorator); ok {
1443 return true
1444 }
1445 return false
1446}
1447
Ivan Lozanod7586b62021-04-01 09:49:36 -04001448func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001449 if vndkdep := c.vndkdep; vndkdep != nil {
1450 return vndkdep.isVndkSp()
1451 }
1452 return false
1453}
1454
Ivan Lozanof9e21722020-12-02 09:00:51 -05001455func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001456 if vndkdep := c.vndkdep; vndkdep != nil {
1457 return vndkdep.isVndkExt()
1458 }
1459 return false
1460}
1461
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001462func (c *Module) SubName() string {
1463 return c.Properties.SubName
1464}
1465
Logan Chienf3511742017-10-31 18:04:35 +08001466func (c *Module) getVndkExtendsModuleName() string {
1467 if vndkdep := c.vndkdep; vndkdep != nil {
1468 return vndkdep.getVndkExtendsModuleName()
1469 }
1470 return ""
1471}
1472
Jiyong Park25fc6a92018-11-18 18:02:45 +09001473func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001474 if lib := c.library; lib != nil {
1475 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001476 }
1477 return false
1478}
1479
1480func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001481 if lib := c.library; lib != nil {
1482 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001483 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001484 return false
1485}
1486
Alan Stokes73feba32022-11-14 12:21:24 +00001487func (c *Module) IsStubsImplementationRequired() bool {
1488 if lib := c.library; lib != nil {
1489 return lib.isStubsImplementationRequired()
1490 }
1491 return false
1492}
1493
Colin Cross0477b422020-10-13 18:43:54 -07001494// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1495// the implementation. If it is an implementation library it returns its own name.
1496func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1497 name := ctx.OtherModuleName(c)
1498 if versioned, ok := c.linker.(versionedInterface); ok {
1499 name = versioned.implementationModuleName(name)
1500 }
1501 return name
1502}
1503
Martin Stjernholm2856c662020-12-02 15:03:42 +00001504// Similar to ImplementationModuleName, but uses the Make variant of the module
1505// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1506// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1507// under the premise that the prebuilt module overrides its source counterpart
1508// if it is exposed to Make).
1509func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1510 name := c.BaseModuleName()
1511 if versioned, ok := c.linker.(versionedInterface); ok {
1512 name = versioned.implementationModuleName(name)
1513 }
1514 return name
1515}
1516
Jiyong Park7d55b612021-06-11 17:22:09 +09001517func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001518 return Bool(c.Properties.Bootstrap)
1519}
1520
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001521func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001522 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1523 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1524 return false
1525 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001526 return c.linker != nil && c.linker.nativeCoverage()
1527}
1528
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001529func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001530 if p, ok := c.linker.(SnapshotInterface); ok {
1531 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001532 }
1533 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001534}
1535
Jiyong Parkf1194352019-02-25 11:05:47 +09001536func isBionic(name string) bool {
1537 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001538 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001539 return true
1540 }
1541 return false
1542}
1543
Martin Stjernholm279de572019-09-10 23:18:20 +01001544func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001545 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001546 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001547 }
1548 return isBionic(name)
1549}
1550
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001551func (c *Module) XrefCcFiles() android.Paths {
1552 return c.kytheFiles
1553}
1554
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001555func (c *Module) isCfiAssemblySupportEnabled() bool {
1556 return c.sanitize != nil &&
1557 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1558}
1559
Inseob Kim800d1142021-06-14 12:03:51 +09001560func (c *Module) InstallInRoot() bool {
1561 return c.installer != nil && c.installer.installInRoot()
1562}
1563
Colin Crossca860ac2016-01-04 14:34:37 -08001564type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001565 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001566 moduleContextImpl
1567}
1568
Colin Cross37047f12016-12-13 17:06:13 -08001569type depsContext struct {
1570 android.BottomUpMutatorContext
1571 moduleContextImpl
1572}
1573
Colin Crossca860ac2016-01-04 14:34:37 -08001574type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001575 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001576 moduleContextImpl
1577}
1578
1579type moduleContextImpl struct {
1580 mod *Module
1581 ctx BaseModuleContext
1582}
1583
Colin Crossb98c8b02016-07-29 13:44:28 -07001584func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001585 return ctx.mod.toolchain(ctx.ctx)
1586}
1587
1588func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001589 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001590}
1591
1592func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001593 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001594}
1595
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001596func (ctx *moduleContextImpl) testBinary() bool {
1597 return ctx.mod.testBinary()
1598}
1599
Yi Kong56fc1b62022-09-06 16:24:00 +08001600func (ctx *moduleContextImpl) testLibrary() bool {
1601 return ctx.mod.testLibrary()
1602}
1603
Jiyong Park1d1119f2019-07-29 21:27:18 +09001604func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001605 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001606}
1607
Inseob Kim7f283f42020-06-01 21:53:49 +09001608func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001609 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001610}
1611
Inseob Kim1042d292020-06-01 23:23:05 +09001612func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001613 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001614}
1615
Jooyung Hanccce2f22020-03-07 03:45:53 +09001616func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001617 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001618}
1619
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001620func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001621 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001622}
1623
1624func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001625 if ctx.ctx.Device() {
Justin Yun732aa6a2018-03-23 17:43:47 +09001626 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001627 }
1628 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001629}
1630
Jiyong Parkb35a8192020-08-10 15:59:36 +09001631func (ctx *moduleContextImpl) minSdkVersion() string {
1632 ver := ctx.mod.MinSdkVersion()
1633 if ver == "apex_inherit" && !ctx.isForPlatform() {
1634 ver = ctx.apexSdkVersion().String()
1635 }
1636 if ver == "apex_inherit" || ver == "" {
1637 ver = ctx.sdkVersion()
1638 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001639
1640 if ctx.ctx.Device() {
1641 config := ctx.ctx.Config()
Kiyoung Kim8f05c542024-05-22 16:50:34 +09001642 if ctx.inVendor() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001643 // If building for vendor with final API, then use the latest _stable_ API as "current".
1644 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1645 ver = config.PlatformSdkVersion().String()
1646 }
1647 }
1648 }
1649
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001650 // For crt objects, the meaning of min_sdk_version is very different from other types of
1651 // module. For them, min_sdk_version defines the oldest version that the build system will
1652 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1653 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1654 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001655 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1656 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1657 // support such an old version. The version is set to the later version in case when the
1658 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1659 // it's for an APEX.
1660 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1661 if ctx.isForPlatform() {
1662 ver = strconv.Itoa(android.FutureApiLevelInt)
1663 } else { // for apex
1664 ver = ctx.apexSdkVersion().String()
1665 if ver == "" { // in case when min_sdk_version was not set by the APEX
1666 ver = ctx.sdkVersion()
1667 }
1668 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001669 }
1670
Jiyong Parkb35a8192020-08-10 15:59:36 +09001671 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1672 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1673 minSdkVersionInt, err2 := strconv.Atoi(ver)
1674 if err == nil && err2 == nil {
1675 if sdkVersionInt < minSdkVersionInt {
1676 return strconv.Itoa(sdkVersionInt)
1677 }
1678 }
1679 return ver
1680}
1681
1682func (ctx *moduleContextImpl) isSdkVariant() bool {
1683 return ctx.mod.IsSdkVariant()
1684}
1685
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001686func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001687 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001688}
Justin Yun8effde42017-06-23 19:24:43 +09001689
Kiyoung Kimaa394802024-01-08 12:55:45 +09001690func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1691 return ctx.mod.InVendorOrProduct()
1692}
1693
Colin Cross95f1ca02020-10-29 20:47:22 -07001694func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1695 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001696}
1697
Colin Cross127bb8b2020-12-16 16:46:01 -08001698func (ctx *moduleContextImpl) IsLlndk() bool {
1699 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001700}
1701
Colin Cross127bb8b2020-12-16 16:46:01 -08001702func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1703 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001704}
1705
Colin Cross127bb8b2020-12-16 16:46:01 -08001706func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1707 return ctx.mod.isImplementationForLLNDKPublic()
1708}
1709
1710func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1711 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001712}
1713
Logan Chienf3511742017-10-31 18:04:35 +08001714func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001715 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001716}
1717
Colin Cross3513fb12024-01-24 14:44:47 -08001718func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1719 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001720}
1721
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001722func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1723 return ctx.mod.isOrderfileCompile()
1724}
1725
Yi Kongc702ebd2022-08-19 16:02:45 +08001726func (ctx *moduleContextImpl) isCfi() bool {
1727 return ctx.mod.isCfi()
1728}
1729
Yi Konged79fa32023-06-04 17:15:42 +09001730func (ctx *moduleContextImpl) isFuzzer() bool {
1731 return ctx.mod.isFuzzer()
1732}
1733
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001734func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1735 return ctx.mod.isNDKStubLibrary()
1736}
1737
Justin Yun8effde42017-06-23 19:24:43 +09001738func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001739 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001740}
1741
Ivan Lozanof9e21722020-12-02 09:00:51 -05001742func (ctx *moduleContextImpl) IsVndkExt() bool {
1743 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001744}
1745
Colin Cross5271fea2021-04-27 13:06:04 -07001746func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1747 return ctx.mod.IsVendorPublicLibrary()
1748}
1749
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001750func (ctx *moduleContextImpl) selectedStl() string {
1751 if stl := ctx.mod.stl; stl != nil {
1752 return stl.Properties.SelectedStl
1753 }
1754 return ""
1755}
1756
Ivan Lozanobd721262018-11-27 14:33:03 -08001757func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1758 return ctx.mod.linker.useClangLld(actx)
1759}
1760
Colin Crossce75d2c2016-10-06 16:12:58 -07001761func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001762 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001763}
1764
Logan Chienf3511742017-10-31 18:04:35 +08001765func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1766 return ctx.mod.getVndkExtendsModuleName()
1767}
1768
Logan Chiene274fc92019-12-03 11:18:32 -08001769func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001770 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1771 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001772}
1773
Colin Crosse07f2312020-08-13 11:24:56 -07001774func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001775 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1776 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001777}
1778
Dan Albertc8060532020-07-22 22:32:17 -07001779func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001780 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001781}
1782
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001783func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001784 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001785}
1786
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001787func (ctx *moduleContextImpl) nativeCoverage() bool {
1788 return ctx.mod.nativeCoverage()
1789}
1790
Colin Cross56a83212020-09-15 18:30:11 -07001791func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1792 return ctx.mod.DirectlyInAnyApex()
1793}
1794
Colin Cross95b07f22020-12-16 11:06:50 -08001795func (ctx *moduleContextImpl) isPreventInstall() bool {
1796 return ctx.mod.Properties.PreventInstall
1797}
1798
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001799func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1800 shared := &ctx.mod.sharedFlags
1801 if shared.flagsMap == nil {
1802 shared.numSharedFlags = 0
1803 shared.flagsMap = make(map[string]string)
1804 }
1805 return shared
1806}
1807
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001808func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1809 return ctx.mod.isCfiAssemblySupportEnabled()
1810}
1811
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001812func (ctx *moduleContextImpl) notInPlatform() bool {
1813 return ctx.mod.NotInPlatform()
1814}
1815
Colin Cross635c3b02016-05-18 15:37:25 -07001816func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001817 return &Module{
1818 hod: hod,
1819 multilib: multilib,
1820 }
1821}
1822
Colin Cross635c3b02016-05-18 15:37:25 -07001823func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001824 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001825 module.features = []feature{
1826 &tidyFeature{},
1827 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001828 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001829 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001830 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001831 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001832 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001833 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001834 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001835 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001836 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001837 return module
1838}
1839
Colin Crossce75d2c2016-10-06 16:12:58 -07001840func (c *Module) Prebuilt() *android.Prebuilt {
1841 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1842 return p.prebuilt()
1843 }
1844 return nil
1845}
1846
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001847func (c *Module) IsPrebuilt() bool {
1848 return c.Prebuilt() != nil
1849}
1850
Colin Crossce75d2c2016-10-06 16:12:58 -07001851func (c *Module) Name() string {
1852 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001853 if p, ok := c.linker.(interface {
1854 Name(string) string
1855 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001856 name = p.Name(name)
1857 }
1858 return name
1859}
1860
Alex Light3d673592019-01-18 14:37:31 -08001861func (c *Module) Symlinks() []string {
1862 if p, ok := c.installer.(interface {
1863 symlinkList() []string
1864 }); ok {
1865 return p.symlinkList()
1866 }
1867 return nil
1868}
1869
Roland Levillainf89cd092019-07-29 16:22:59 +01001870func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1871 test, ok := c.linker.(testPerSrc)
1872 return ok && test.isAllTestsVariation()
1873}
1874
Chris Parsons216e10a2020-07-09 17:12:52 -04001875func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001876 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001877 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001878 }); ok {
1879 return p.dataPaths()
1880 }
1881 return nil
1882}
1883
Ivan Lozanof1868af2022-04-12 13:08:36 -04001884func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001885 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1886 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001887 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001888 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001889 if c.ProductSpecific() {
1890 // If the module is product specific with 'product_specific: true',
1891 // do not add a name suffix because it is a base module.
1892 return ""
1893 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001894 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001895 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001896 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001897 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001898 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001899 // add version suffix only if the module is using different vndk version than the
1900 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001901 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001902 }
1903 return nameSuffix
1904}
1905
Ivan Lozanof1868af2022-04-12 13:08:36 -04001906func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1907 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001908
1909 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001910 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001911 }
1912
Colin Cross127bb8b2020-12-16 16:46:01 -08001913 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001914 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001915 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1916 // added for product variant only when we have vendor and product variants with core
1917 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001918 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001919 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001920 subName += vendorPublicLibrarySuffix
1921 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001922 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1923 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001924 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001925 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001926 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001927 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001928 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001929 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001930 subName += RecoverySuffix
1931 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1932 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001933 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001934 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001935 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001936 } else if c.IsStubs() && c.IsSdkVariant() {
1937 // Public API surface (NDK)
1938 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1939 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001940 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001941
1942 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001943}
1944
Sam Delmerico75dbca22023-04-20 13:13:25 +00001945func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1946 ctx := &moduleContext{
1947 ModuleContext: actx,
1948 moduleContextImpl: moduleContextImpl{
1949 mod: c,
1950 },
1951 }
1952 ctx.ctx = ctx
1953 return ctx
1954}
1955
Spandan Das20fce2d2023-04-12 17:21:39 +00001956// TODO (b/277651159): Remove this allowlist
1957var (
1958 skipStubLibraryMultipleApexViolation = map[string]bool{
1959 "libclang_rt.asan": true,
1960 "libclang_rt.hwasan": true,
1961 // runtime apex
1962 "libc": true,
1963 "libc_hwasan": true,
1964 "libdl_android": true,
1965 "libm": true,
1966 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001967 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001968 // art apex
1969 "libandroidio": true,
1970 "libdexfile": true,
1971 "libnativebridge": true,
1972 "libnativehelper": true,
1973 "libnativeloader": true,
1974 "libsigchain": true,
1975 }
1976)
1977
1978// Returns true if a stub library could be installed in multiple apexes
1979func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1980 // If this is not an apex variant, no check necessary
1981 if !c.InAnyApex() {
1982 return false
1983 }
1984 // If this is not a stub library, no check necessary
1985 if !c.HasStubsVariants() {
1986 return false
1987 }
1988 // Skip the allowlist
1989 // Use BaseModuleName so that this matches prebuilts.
1990 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1991 return false
1992 }
1993
1994 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1995 // Stub libraries should not have more than one apex_available
1996 if len(aaWithoutTestApexes) > 1 {
1997 return true
1998 }
1999 // Stub libraries should not use the wildcard
2000 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2001 return true
2002 }
2003 // Default: no violation
2004 return false
2005}
2006
Chris Parsons8d6e4332021-02-22 16:13:50 -05002007func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002008 ctx := moduleContextFromAndroidModuleContext(actx, c)
2009
Inseob Kim37e0bb02024-04-29 15:54:44 +09002010 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
2011 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
2012 Logtags: c.logtagsPaths,
2013 })
2014
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002015 // If Test_only is set on a module in bp file, respect the setting, otherwise
2016 // see if is a known test module type.
2017 testOnly := c.testModule || c.testLibrary()
2018 if c.sourceProperties.Test_only != nil {
2019 testOnly = Bool(c.sourceProperties.Test_only)
2020 }
2021 // Keep before any early returns.
2022 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2023 TestOnly: testOnly,
2024 TopLevelTarget: c.testModule,
2025 })
2026
Chris Parsons8d6e4332021-02-22 16:13:50 -05002027 // Handle the case of a test module split by `test_per_src` mutator.
2028 //
2029 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2030 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2031 // module and return early, as this module does not produce an output file per se.
2032 if c.IsTestPerSrcAllTestsVariation() {
2033 c.outputFile = android.OptionalPath{}
2034 return
2035 }
2036
Ivan Lozanof1868af2022-04-12 13:08:36 -04002037 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002038 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002039 if !apexInfo.IsForPlatform() {
2040 c.hideApexVariantFromMake = true
2041 }
2042
Chris Parsonseefc9e62021-04-02 17:36:47 -04002043 c.makeLinkType = GetMakeLinkType(actx, c)
2044
Colin Crossf18e1102017-11-16 14:33:08 -08002045 deps := c.depsToPaths(ctx)
2046 if ctx.Failed() {
2047 return
2048 }
2049
Joe Onorato37f900c2023-07-18 16:58:16 -07002050 for _, generator := range c.generators {
2051 gen := generator.GeneratorSources(ctx)
2052 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2053 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2054 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2055 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2056 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2057 if len(deps.Objs.objFiles) == 0 {
2058 // If we are reusuing object files (which happens when we're a shared library and we're
2059 // reusing our static variant's object files), then skip adding the actual source files,
2060 // because we already have the object for it.
2061 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2062 }
2063 }
2064
2065 if ctx.Failed() {
2066 return
2067 }
2068
Spandan Das20fce2d2023-04-12 17:21:39 +00002069 if c.stubLibraryMultipleApexViolation(actx) {
2070 actx.PropertyErrorf("apex_available",
2071 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2072 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002073 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2074 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002075 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2076 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002077 }
2078
Colin Crossca860ac2016-01-04 14:34:37 -08002079 flags := Flags{
2080 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002081 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002082 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002083 for _, generator := range c.generators {
2084 flags = generator.GeneratorFlags(ctx, flags, deps)
2085 }
Colin Crossca860ac2016-01-04 14:34:37 -08002086 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002087 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002088 }
2089 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002090 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002091 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002092 if c.stl != nil {
2093 flags = c.stl.flags(ctx, flags)
2094 }
Colin Cross16b23492016-01-06 14:41:07 -08002095 if c.sanitize != nil {
2096 flags = c.sanitize.flags(ctx, flags)
2097 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002098 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002099 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002100 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002101 if c.fuzzer != nil {
2102 flags = c.fuzzer.flags(ctx, flags)
2103 }
Stephen Craneba090d12017-05-09 15:44:35 -07002104 if c.lto != nil {
2105 flags = c.lto.flags(ctx, flags)
2106 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002107 if c.afdo != nil {
2108 flags = c.afdo.flags(ctx, flags)
2109 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002110 if c.orderfile != nil {
2111 flags = c.orderfile.flags(ctx, flags)
2112 }
Colin Crossca860ac2016-01-04 14:34:37 -08002113 for _, feature := range c.features {
2114 flags = feature.flags(ctx, flags)
2115 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002116 if ctx.Failed() {
2117 return
2118 }
2119
Colin Cross4af21ed2019-11-04 09:37:55 -08002120 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2121 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2122 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002123
Colin Cross4af21ed2019-11-04 09:37:55 -08002124 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002125
2126 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002127 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002128 }
2129 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002130 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002131 }
2132
Colin Cross3e5e7782022-06-17 22:17:05 +00002133 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2134
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002135 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002136 // We need access to all the flags seen by a source file.
2137 if c.sabi != nil {
2138 flags = c.sabi.flags(ctx, flags)
2139 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002140
Colin Cross4af21ed2019-11-04 09:37:55 -08002141 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002142
Joe Onorato37f900c2023-07-18 16:58:16 -07002143 for _, generator := range c.generators {
2144 generator.GeneratorBuildActions(ctx, flags, deps)
2145 }
2146
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002147 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002148 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002149 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002150 if ctx.Failed() {
2151 return
2152 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002153 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002154 c.objFiles = objs.objFiles
2155 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002156 }
2157
Colin Crossca860ac2016-01-04 14:34:37 -08002158 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002159 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002160 if ctx.Failed() {
2161 return
2162 }
Colin Cross635c3b02016-05-18 15:37:25 -07002163 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002164
Chris Parsons94a0bba2021-06-04 15:03:47 -04002165 c.maybeUnhideFromMake()
Colin Crossce75d2c2016-10-06 16:12:58 -07002166 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002167 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002168 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002169 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002170
Colin Cross40213022023-12-13 15:19:49 -08002171 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002172
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002173 if Bool(c.Properties.Cmake_snapshot_supported) {
2174 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2175 }
2176
Chris Parsons94a0bba2021-06-04 15:03:47 -04002177 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002178
2179 if c.linker != nil {
2180 moduleInfoJSON := ctx.ModuleInfoJSON()
2181 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2182 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2183 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2184 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2185 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2186
2187 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2188 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2189 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2190 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2191
2192 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2193 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2194 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2195 moduleInfoJSON.SubName += ".cfi"
2196 }
2197 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2198 moduleInfoJSON.SubName += ".hwasan"
2199 }
2200 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2201 moduleInfoJSON.SubName += ".scs"
2202 }
2203 }
2204 moduleInfoJSON.SubName += c.Properties.SubName
2205
2206 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2207 moduleInfoJSON.Uninstallable = true
2208 }
2209
2210 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002211}
2212
2213func (c *Module) maybeUnhideFromMake() {
2214 // If a lib is directly included in any of the APEXes or is not available to the
2215 // platform (which is often the case when the stub is provided as a prebuilt),
2216 // unhide the stubs variant having the latest version gets visible to make. In
2217 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2218 // force anything in the make world to link against the stubs library. (unless it
2219 // is explicitly referenced via .bootstrap suffix or the module is marked with
2220 // 'bootstrap: true').
2221 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002222 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002223 c.IsStubs() && !c.InVendorRamdisk() {
2224 c.Properties.HideFromMake = false // unhide
2225 // Note: this is still non-installable
2226 }
2227}
2228
Colin Cross8ff10582023-12-07 13:10:56 -08002229// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2230// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002231func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002232 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002233 // If the module has been specifically configure to not be installed then
2234 // hide from make as otherwise it will break when running inside make
2235 // as the output path to install will not be specified. Not all uninstallable
2236 // modules can be hidden from make as some are needed for resolving make side
2237 // dependencies.
2238 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002239 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002240 c.SkipInstall()
2241 }
2242
2243 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2244 // to allow using the outputs in a genrule.
2245 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002246 c.installer.install(ctx, c.outputFile.Path())
2247 if ctx.Failed() {
2248 return
Colin Crossca860ac2016-01-04 14:34:37 -08002249 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002250 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002251}
2252
Colin Cross0ea8ba82019-06-06 14:33:29 -07002253func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002254 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002255 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002256 }
Colin Crossca860ac2016-01-04 14:34:37 -08002257 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002258}
2259
Colin Crossca860ac2016-01-04 14:34:37 -08002260func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002261 for _, generator := range c.generators {
2262 generator.GeneratorInit(ctx)
2263 }
Colin Crossca860ac2016-01-04 14:34:37 -08002264 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002265 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002266 }
Colin Crossca860ac2016-01-04 14:34:37 -08002267 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002268 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002269 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002270 if c.stl != nil {
2271 c.stl.begin(ctx)
2272 }
Colin Cross16b23492016-01-06 14:41:07 -08002273 if c.sanitize != nil {
2274 c.sanitize.begin(ctx)
2275 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002276 if c.coverage != nil {
2277 c.coverage.begin(ctx)
2278 }
Yi Kong9723e332023-12-04 14:52:53 +09002279 if c.afdo != nil {
2280 c.afdo.begin(ctx)
2281 }
Stephen Craneba090d12017-05-09 15:44:35 -07002282 if c.lto != nil {
2283 c.lto.begin(ctx)
2284 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002285 if c.orderfile != nil {
2286 c.orderfile.begin(ctx)
2287 }
Dan Albert92fe7402020-07-15 13:33:30 -07002288 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002289 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002290 if err != nil {
2291 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002292 c.Properties.Sdk_version = nil
2293 } else {
2294 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002295 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002296 }
Colin Crossca860ac2016-01-04 14:34:37 -08002297}
2298
Colin Cross37047f12016-12-13 17:06:13 -08002299func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002300 deps := Deps{}
2301
Joe Onorato37f900c2023-07-18 16:58:16 -07002302 for _, generator := range c.generators {
2303 deps = generator.GeneratorDeps(ctx, deps)
2304 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002305 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002306 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002307 }
2308 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002309 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002310 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002311 if c.stl != nil {
2312 deps = c.stl.deps(ctx, deps)
2313 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002314 if c.coverage != nil {
2315 deps = c.coverage.deps(ctx, deps)
2316 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002317
Colin Crossb6715442017-10-24 11:13:31 -07002318 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2319 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
Ivan Lozano0a468a42024-05-13 21:03:34 -04002320 deps.Rlibs = android.LastUniqueStrings(deps.Rlibs)
Colin Crossb6715442017-10-24 11:13:31 -07002321 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2322 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2323 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2324 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002325 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002326 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002327
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002328 for _, lib := range deps.ReexportSharedLibHeaders {
2329 if !inList(lib, deps.SharedLibs) {
2330 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2331 }
2332 }
2333
2334 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002335 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2336 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 -07002337 }
2338 }
2339
Colin Cross5950f382016-12-13 12:50:57 -08002340 for _, lib := range deps.ReexportHeaderLibHeaders {
2341 if !inList(lib, deps.HeaderLibs) {
2342 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2343 }
2344 }
2345
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002346 for _, gen := range deps.ReexportGeneratedHeaders {
2347 if !inList(gen, deps.GeneratedHeaders) {
2348 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2349 }
2350 }
2351
Colin Crossc99deeb2016-04-11 15:06:20 -07002352 return deps
2353}
2354
Dan Albert7e9d2952016-08-04 13:02:36 -07002355func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002356 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002357 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002358 moduleContextImpl: moduleContextImpl{
2359 mod: c,
2360 },
2361 }
2362 ctx.ctx = ctx
2363
Colin Crossca860ac2016-01-04 14:34:37 -08002364 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002365}
2366
Jiyong Park7ed9de32018-10-15 22:25:07 +09002367// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002368func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002369 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2370 version := name[sharp+1:]
2371 libname := name[:sharp]
2372 return libname, version
2373 }
2374 return name, ""
2375}
2376
Dan Albert92fe7402020-07-15 13:33:30 -07002377func GetCrtVariations(ctx android.BottomUpMutatorContext,
2378 m LinkableInterface) []blueprint.Variation {
2379 if ctx.Os() != android.Android {
2380 return nil
2381 }
2382 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002383 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2384 minSdkVersion := m.MinSdkVersion()
2385 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2386 minSdkVersion = m.SdkVersion()
2387 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002388 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2389 if err != nil {
2390 ctx.PropertyErrorf("min_sdk_version", err.Error())
2391 }
Colin Cross363ec762023-01-13 13:45:14 -08002392
2393 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002394 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002395 if apiLevel.LessThan(minApiForArch) {
2396 apiLevel = minApiForArch
2397 }
2398
Dan Albert92fe7402020-07-15 13:33:30 -07002399 return []blueprint.Variation{
2400 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002401 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002402 }
2403 }
2404 return []blueprint.Variation{
2405 {Mutator: "sdk", Variation: ""},
2406 }
2407}
2408
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002409func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2410 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002411
2412 variations = append([]blueprint.Variation(nil), variations...)
2413
Liz Kammer23942242022-04-08 15:41:00 -04002414 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002415 // Version is explicitly specified. i.e. libFoo#30
2416 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002417 if tag, ok := depTag.(libraryDependencyTag); ok {
2418 tag.explicitlyVersioned = true
2419 } else {
2420 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2421 }
Colin Crosse7257d22020-09-24 09:56:18 -07002422 }
Colin Crosse7257d22020-09-24 09:56:18 -07002423
Colin Cross0de8a1e2020-09-18 14:15:30 -07002424 if far {
2425 ctx.AddFarVariationDependencies(variations, depTag, name)
2426 } else {
2427 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002428 }
2429}
2430
Kiyoung Kim487689e2022-07-26 09:48:22 +09002431func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2432 apiImportInfo := multitree.ApiImportInfo{}
2433
2434 if c.Device() {
2435 var apiImportModule []blueprint.Module
2436 if actx.OtherModuleExists("api_imports") {
2437 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2438 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002439 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002440 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002441 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002442 }
2443 }
2444 }
2445
2446 return apiImportInfo
2447}
2448
Kiyoung Kim487689e2022-07-26 09:48:22 +09002449func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2450 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002451 return snapshot
2452 }
2453
2454 return lib
2455}
2456
Kiyoung Kim37693d02024-04-04 09:56:15 +09002457// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002458// of names:
2459//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002460// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002461//
2462// For each of these, it adds the name of the ndk_library module to the list of
2463// variant libs.
2464//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002465// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002466//
2467// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002468//
2469// The caller can then know to add the variantLibs dependencies differently from the
2470// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002471func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002472 variantLibs = []string{}
2473
2474 nonvariantLibs = []string{}
2475 for _, entry := range list {
2476 // strip #version suffix out
2477 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002478 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002479 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002480 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002481 nonvariantLibs = append(nonvariantLibs, entry)
2482 }
2483 }
2484 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002485
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002486}
2487
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002488func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2489 nonVariantLibs := []string{}
2490 variantLibs := []string{}
2491
2492 for _, lib := range libs {
2493 replaceLibName := GetReplaceModuleName(lib, replaceList)
2494 if replaceLibName == lib {
2495 // Do not handle any libs which are not in API imports
2496 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2497 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2498 variantLibs = append(variantLibs, replaceLibName)
2499 } else {
2500 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2501 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002502 }
2503
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002504 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002505}
2506
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002507func (c *Module) shouldUseApiSurface() bool {
2508 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2509 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2510 // LLNDK Variant
2511 return true
2512 }
2513
2514 if c.Properties.IsSdkVariant {
2515 // NDK Variant
2516 return true
2517 }
2518
2519 if c.isImportedApiLibrary() {
2520 // API Library should depend on API headers
2521 return true
2522 }
2523 }
2524
2525 return false
2526}
2527
Colin Cross1e676be2016-10-12 14:38:15 -07002528func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002529 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002530 return
2531 }
2532
Colin Cross37047f12016-12-13 17:06:13 -08002533 ctx := &depsContext{
2534 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002535 moduleContextImpl: moduleContextImpl{
2536 mod: c,
2537 },
2538 }
2539 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002540
Colin Crossc99deeb2016-04-11 15:06:20 -07002541 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002542 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002543
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002544 apiNdkLibs := []string{}
2545 apiLateNdkLibs := []string{}
2546
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002547 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002548 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2549 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2550 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2551 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2552 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002553 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002554
Yo Chiang219968c2020-09-22 18:45:04 +08002555 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2556
Dan Albert914449f2016-06-17 16:45:24 -07002557 variantNdkLibs := []string{}
2558 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002559 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002560 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2561 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2562 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002563 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002564
Colin Cross32ec36c2016-12-15 07:39:51 -08002565 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002566 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002567 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002568 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002569 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002570
Kiyoung Kim51279d32022-08-24 14:10:46 +09002571 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002572 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002573 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2574 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002575
Spandan Das73bcafc2022-08-18 23:26:00 +00002576 if c.isNDKStubLibrary() {
2577 // ndk_headers do not have any variations
2578 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002579 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002580 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002581 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002582 } else {
2583 actx.AddVariationDependencies(nil, depTag, lib)
2584 }
2585 }
2586
Dan Albertf1d14c72020-07-30 14:32:55 -07002587 if c.isNDKStubLibrary() {
2588 // NDK stubs depend on their implementation because the ABI dumps are
2589 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002590
Spandan Das8b08aea2023-03-14 19:29:34 +00002591 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2592 c.ImageVariation(),
2593 blueprint.Variation{Mutator: "link", Variation: "shared"},
2594 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002595 }
2596
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002597 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2598 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2599 c.Target().NativeBridge == android.NativeBridgeDisabled {
2600 actx.AddVariationDependencies(
2601 []blueprint.Variation{{Mutator: "image", Variation: VendorVariation}},
2602 llndkHeaderLibTag,
2603 deps.LlndkHeaderLibs...)
2604 }
2605
Jiyong Park5d1598f2019-02-25 22:14:17 +09002606 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002607 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002608
Jiyong Park5d1598f2019-02-25 22:14:17 +09002609 actx.AddVariationDependencies([]blueprint.Variation{
2610 {Mutator: "link", Variation: "static"},
2611 }, depTag, lib)
2612 }
2613
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002614 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002615 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002616 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002617 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002618 }
Jiyong Parke3867542020-12-03 17:28:25 +09002619 if inList(lib, deps.ExcludeLibsForApex) {
2620 depTag.excludeInApex = true
2621 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002622
Dan Willemsen59339a22018-07-22 21:18:45 -07002623 actx.AddVariationDependencies([]blueprint.Variation{
2624 {Mutator: "link", Variation: "static"},
2625 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002626 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002627
Ivan Lozano0a468a42024-05-13 21:03:34 -04002628 for _, lib := range deps.Rlibs {
2629 depTag := libraryDependencyTag{Kind: rlibLibraryDependency}
2630 actx.AddVariationDependencies([]blueprint.Variation{
2631 {Mutator: "link", Variation: ""},
2632 {Mutator: "rust_libraries", Variation: "rlib"},
2633 {Mutator: "rust_stdlinkage", Variation: "rlib-std"},
2634 }, depTag, lib)
2635 }
2636
Jooyung Han75568392020-03-20 04:29:24 +09002637 // staticUnwinderDep is treated as staticDep for Q apexes
2638 // so that native libraries/binaries are linked with static unwinder
2639 // because Q libc doesn't have unwinder APIs
2640 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002641 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002642 actx.AddVariationDependencies([]blueprint.Variation{
2643 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002644 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002645 }
2646
Jiyong Park7ed9de32018-10-15 22:25:07 +09002647 // shared lib names without the #version suffix
2648 var sharedLibNames []string
2649
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002650 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002651 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002652 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002653 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002654 }
Jiyong Parke3867542020-12-03 17:28:25 +09002655 if inList(lib, deps.ExcludeLibsForApex) {
2656 depTag.excludeInApex = true
2657 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002658 if inList(lib, deps.ExcludeLibsForNonApex) {
2659 depTag.excludeInNonApex = true
2660 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002661
Jiyong Park73c54ee2019-10-22 20:31:18 +09002662 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002663 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2664 name = apiLibraryName
2665 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002666 sharedLibNames = append(sharedLibNames, name)
2667
Colin Crosse7257d22020-09-24 09:56:18 -07002668 variations := []blueprint.Variation{
2669 {Mutator: "link", Variation: "shared"},
2670 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002671
2672 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2673 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2674 }
2675
2676 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2677 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2678 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002679 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002680
Colin Crossfe9acfe2021-06-14 16:13:03 -07002681 for _, lib := range deps.LateStaticLibs {
2682 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2683 actx.AddVariationDependencies([]blueprint.Variation{
2684 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002685 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002686 }
2687
Colin Cross3e5e7782022-06-17 22:17:05 +00002688 for _, lib := range deps.UnexportedStaticLibs {
2689 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2690 actx.AddVariationDependencies([]blueprint.Variation{
2691 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002692 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002693 }
2694
Jiyong Park7ed9de32018-10-15 22:25:07 +09002695 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002696 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002697 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2698 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2699 // linking against both the stubs lib and the non-stubs lib at the same time.
2700 continue
2701 }
Colin Cross6e511a92020-07-27 21:26:48 -07002702 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002703 variations := []blueprint.Variation{
2704 {Mutator: "link", Variation: "shared"},
2705 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002706 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002707 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002708
Dan Willemsen59339a22018-07-22 21:18:45 -07002709 actx.AddVariationDependencies([]blueprint.Variation{
2710 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002711 }, dataLibDepTag, deps.DataLibs...)
2712
Colin Crossc8caa062021-09-24 16:50:14 -07002713 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2714
Chris Parsons79d66a52020-06-05 17:26:16 -04002715 actx.AddVariationDependencies([]blueprint.Variation{
2716 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002717 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002718
Colin Cross68861832016-07-08 10:41:41 -07002719 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002720
2721 for _, gen := range deps.GeneratedHeaders {
2722 depTag := genHeaderDepTag
2723 if inList(gen, deps.ReexportGeneratedHeaders) {
2724 depTag = genHeaderExportDepTag
2725 }
2726 actx.AddDependency(c, depTag, gen)
2727 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002728
Dan Albert92fe7402020-07-15 13:33:30 -07002729 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002730 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002731 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002732 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002733 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08002734 }
Colin Crossc465efd2021-06-11 18:00:04 -07002735 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002736 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002737 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07002738 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002739 if deps.DynamicLinker != "" {
2740 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002741 }
Dan Albert914449f2016-06-17 16:45:24 -07002742
2743 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002744
2745 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002746 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002747 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002748 {Mutator: "link", Variation: "shared"},
2749 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002750 actx.AddVariationDependencies([]blueprint.Variation{
2751 {Mutator: "version", Variation: version},
2752 {Mutator: "link", Variation: "shared"},
2753 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002754
2755 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002756 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002757 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002758 {Mutator: "link", Variation: "shared"},
2759 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002760 actx.AddVariationDependencies([]blueprint.Variation{
2761 {Mutator: "version", Variation: version},
2762 {Mutator: "link", Variation: "shared"},
2763 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002764
2765 if vndkdep := c.vndkdep; vndkdep != nil {
2766 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002767 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002768 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002769 {Mutator: "link", Variation: "shared"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002770 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002771 }
2772 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002773
Vinh Tran367d89d2023-04-28 11:21:25 -04002774 if len(deps.AidlLibs) > 0 {
2775 actx.AddDependency(
2776 c,
2777 aidlLibraryTag,
2778 deps.AidlLibs...,
2779 )
2780 }
2781
Kiyoung Kimee58c932022-10-25 22:59:41 +09002782 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002783}
Colin Cross21b9a242015-03-24 14:15:58 -07002784
Colin Crosse40b4ea2018-10-02 22:25:58 -07002785func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002786 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002787 c.beginMutator(ctx)
2788 }
2789}
2790
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002791// Whether a module can link to another module, taking into
2792// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002793func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002794 tag blueprint.DependencyTag) {
2795
2796 switch t := tag.(type) {
2797 case dependencyTag:
2798 if t != vndkExtDepTag {
2799 return
2800 }
2801 case libraryDependencyTag:
2802 default:
2803 return
2804 }
2805
Ivan Lozanof9e21722020-12-02 09:00:51 -05002806 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002807 // Host code is not restricted
2808 return
2809 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002810
2811 // VNDK is cc.Module supported only for now.
2812 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002813 // Though allowed dependency is limited by the image mutator,
2814 // each vendor and product module needs to check link-type
2815 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002816 if ccTo, ok := to.(*Module); ok {
2817 if ccFrom.vndkdep != nil {
2818 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2819 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002820 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002821 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002822 }
2823 return
2824 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002825 // TODO(b/244244438) : Remove this once all variants are implemented
2826 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2827 return
2828 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002829 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002830 // Platform code can link to anything
2831 return
2832 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002833 if from.InRamdisk() {
2834 // Ramdisk code is not NDK
2835 return
2836 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002837 if from.InVendorRamdisk() {
2838 // Vendor ramdisk code is not NDK
2839 return
2840 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002841 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002842 // Recovery code is not NDK
2843 return
2844 }
Colin Cross31076b32020-10-23 17:22:06 -07002845 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002846 if c.NdkPrebuiltStl() {
2847 // These are allowed, but they don't set sdk_version
2848 return
2849 }
2850 if c.StubDecorator() {
2851 // These aren't real libraries, but are the stub shared libraries that are included in
2852 // the NDK.
2853 return
2854 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002855 if c.isImportedApiLibrary() {
2856 // Imported library from the API surface is a stub library built against interface definition.
2857 return
2858 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002859 }
Logan Chien834b9a62019-01-14 15:39:03 +08002860
Ivan Lozano52767be2019-10-18 14:49:46 -07002861 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002862 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2863 // to link to libc++ (non-NDK and without sdk_version).
2864 return
2865 }
2866
Ivan Lozano52767be2019-10-18 14:49:46 -07002867 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002868 // NDK code linking to platform code is never okay.
2869 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002870 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002871 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002872 }
2873
2874 // At this point we know we have two NDK libraries, but we need to
2875 // check that we're not linking against anything built against a higher
2876 // API level, as it is only valid to link against older or equivalent
2877 // APIs.
2878
Inseob Kim01a28722018-04-11 09:48:45 +09002879 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002880 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002881 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002882 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002883 // Current can't be linked against by anything else.
2884 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002885 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002886 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002887 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002888 if err != nil {
2889 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002890 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002891 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002892 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002893 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002894 if err != nil {
2895 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002896 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002897 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002898 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002899
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002900 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002901 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002902 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002903 }
2904 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002905 }
Dan Albert202fe492017-12-15 13:56:59 -08002906
2907 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002908 fromStl := from.SelectedStl()
2909 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002910 if fromStl == "" || toStl == "" {
2911 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002912 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002913 // We can be permissive with the system "STL" since it is only the C++
2914 // ABI layer, but in the future we should make sure that everyone is
2915 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002916 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002917 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002918 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2919 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002920 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002921}
2922
Jooyung Han479ca172020-10-19 18:51:07 +09002923func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2924 if c, ok := ctx.Module().(*Module); ok {
2925 ctx.VisitDirectDeps(func(dep android.Module) {
2926 depTag := ctx.OtherModuleDependencyTag(dep)
2927 ccDep, ok := dep.(LinkableInterface)
2928 if ok {
2929 checkLinkType(ctx, c, ccDep, depTag)
2930 }
2931 })
2932 }
2933}
2934
Jiyong Park5fb8c102018-04-09 12:03:06 +09002935// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002936// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2937// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002938// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002939func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2940 check := func(child, parent android.Module) bool {
2941 to, ok := child.(*Module)
2942 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002943 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002944 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002945
Jooyung Hana70f0672019-01-18 15:20:43 +09002946 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2947 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002948 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002949
Jiyong Park0474e1f2021-01-14 14:26:06 +09002950 // These dependencies are not excercised at runtime. Tracking these will give us
2951 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002952 depTag := ctx.OtherModuleDependencyTag(child)
2953 if IsHeaderDepTag(depTag) {
2954 return false
2955 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002956 if depTag == staticVariantTag {
2957 return false
2958 }
2959 if depTag == stubImplDepTag {
2960 return false
2961 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002962 if depTag == android.RequiredDepTag {
2963 return false
2964 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002965
Justin Yun63e9ec72020-10-29 16:49:43 +09002966 // Even if target lib has no vendor variant, keep checking dependency
2967 // graph in case it depends on vendor_available or product_available
2968 // but not double_loadable transtively.
2969 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002970 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002971 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002972
Jiyong Park0474e1f2021-01-14 14:26:06 +09002973 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2974 // one.
2975 if Bool(to.VendorProperties.Double_loadable) {
2976 return true
2977 }
2978
Ivan Lozanod7586b62021-04-01 09:49:36 -04002979 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002980 return false
2981 }
2982
Jooyung Hana70f0672019-01-18 15:20:43 +09002983 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2984 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002985 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002986 return false
2987 }
2988 if module, ok := ctx.Module().(*Module); ok {
2989 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002990 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002991 ctx.WalkDeps(check)
2992 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002993 }
2994 }
2995}
2996
Yu Liue4312402023-01-18 09:15:31 -08002997func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
2998 // For the dependency from platform to apex, use the latest stubs
2999 apexSdkVersion := android.FutureApiLevel
3000 if !apexInfo.IsForPlatform() {
3001 apexSdkVersion = apexInfo.MinSdkVersion
3002 }
3003
3004 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3005 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3006 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3007 // (b/144430859)
3008 apexSdkVersion = android.FutureApiLevel
3009 }
3010
3011 return apexSdkVersion
3012}
3013
Colin Crossc99deeb2016-04-11 15:06:20 -07003014// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003015func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003016 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003017
Colin Cross0de8a1e2020-09-18 14:15:30 -07003018 var directStaticDeps []StaticLibraryInfo
3019 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003020
Colin Cross0de8a1e2020-09-18 14:15:30 -07003021 reexportExporter := func(exporter FlagExporterInfo) {
3022 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3023 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3024 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3025 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3026 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003027 }
3028
Colin Crossff694a82023-12-13 15:54:49 -08003029 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003030 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003031
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003032 skipModuleList := map[string]bool{}
3033
3034 var apiImportInfo multitree.ApiImportInfo
3035 hasApiImportInfo := false
3036
3037 ctx.VisitDirectDeps(func(dep android.Module) {
3038 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003039 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003040 hasApiImportInfo = true
3041 }
3042 })
3043
3044 if hasApiImportInfo {
3045 targetStubModuleList := map[string]string{}
3046 targetOrigModuleList := map[string]string{}
3047
3048 // Search for dependency which both original module and API imported library with APEX stub exists
3049 ctx.VisitDirectDeps(func(dep android.Module) {
3050 depName := ctx.OtherModuleName(dep)
3051 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3052 targetStubModuleList[apiLibrary] = depName
3053 }
3054 })
3055 ctx.VisitDirectDeps(func(dep android.Module) {
3056 depName := ctx.OtherModuleName(dep)
3057 if origLibrary, ok := targetStubModuleList[depName]; ok {
3058 targetOrigModuleList[origLibrary] = depName
3059 }
3060 })
3061
3062 // Decide which library should be used between original and API imported library
3063 ctx.VisitDirectDeps(func(dep android.Module) {
3064 depName := ctx.OtherModuleName(dep)
3065 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003066 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003067 skipModuleList[depName] = true
3068 } else {
3069 skipModuleList[apiLibrary] = true
3070 }
3071 }
3072 })
3073 }
3074
Colin Crossd11fcda2017-10-23 17:59:01 -07003075 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003076 depName := ctx.OtherModuleName(dep)
3077 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003078
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003079 if _, ok := skipModuleList[depName]; ok {
3080 // skip this module because original module or API imported module matching with this should be used instead.
3081 return
3082 }
3083
Dan Willemsen47450072021-10-19 20:24:49 -07003084 if depTag == android.DarwinUniversalVariantTag {
3085 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3086 return
3087 }
3088
Vinh Tran367d89d2023-04-28 11:21:25 -04003089 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003090 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003091 depPaths.AidlLibraryInfos = append(
3092 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003093 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003094 )
3095 }
3096 }
3097
Ivan Lozano52767be2019-10-18 14:49:46 -07003098 ccDep, ok := dep.(LinkableInterface)
3099 if !ok {
3100
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003101 // handling for a few module types that aren't cc Module but that are also supported
3102 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003103 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003104 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003105 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3106 genRule.GeneratedSourceFiles()...)
3107 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003108 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003109 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003110 // Support exported headers from a generated_sources dependency
3111 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003112 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003113 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003114 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003115 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003116 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003117 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003118 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003119 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003120 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3121 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003122 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003123 // 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 +09003124 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003125
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003126 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003127 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003128 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003129 }
Colin Crosscef792e2021-06-11 18:01:26 -07003130 case CrtBeginDepTag:
3131 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3132 case CrtEndDepTag:
3133 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003134 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003135 return
3136 }
3137
Colin Crossfe17f6f2019-03-28 19:30:56 -07003138 if depTag == android.ProtoPluginDepTag {
3139 return
3140 }
3141
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003142 if depTag == android.RequiredDepTag {
3143 return
3144 }
3145
Colin Crossd11fcda2017-10-23 17:59:01 -07003146 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003147 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3148 return
3149 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003150 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003151 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3152 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003153 return
3154 }
3155
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003156 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003157 // Skip reused objects for stub libraries, they use their own stub object file instead.
3158 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3159 // version mutator, so the stubs variant is created from the shared variant that
3160 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003161 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003162 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003163 objs := staticAnalogue.ReuseObjects
3164 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003165 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003166 reexportExporter(depExporterInfo)
3167 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003168 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003169 }
3170
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003171 if depTag == llndkHeaderLibTag {
3172 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3173 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3174 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3175 }
3176
Colin Cross6e511a92020-07-27 21:26:48 -07003177 linkFile := ccDep.OutputFile()
3178
3179 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3180 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003181 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003182 return
3183 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003184
Jiyong Parke3867542020-12-03 17:28:25 +09003185 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3186 return
3187 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003188 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3189 return
3190 }
Jiyong Parke3867542020-12-03 17:28:25 +09003191
Colin Cross313aa542023-12-13 13:47:44 -08003192 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003193
Colin Cross6e511a92020-07-27 21:26:48 -07003194 var ptr *android.Paths
3195 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003196
Colin Cross6e511a92020-07-27 21:26:48 -07003197 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003198
Colin Cross6e511a92020-07-27 21:26:48 -07003199 switch {
3200 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003201 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003202 if !ctx.Config().AllowMissingDependencies() {
3203 ctx.ModuleErrorf("module %q is not a header library", depName)
3204 } else {
3205 ctx.AddMissingDependencies([]string{depName})
3206 }
3207 return
3208 }
Colin Cross6e511a92020-07-27 21:26:48 -07003209 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003210 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003211 if !ctx.Config().AllowMissingDependencies() {
3212 ctx.ModuleErrorf("module %q is not a shared library", depName)
3213 } else {
3214 ctx.AddMissingDependencies([]string{depName})
3215 }
3216 return
3217 }
Jiyong Parke3867542020-12-03 17:28:25 +09003218
Jiyong Park7d55b612021-06-11 17:22:09 +09003219 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3220 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003221
Jiyong Park1ad8e162020-12-01 23:40:09 +09003222 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3223 // linkFile, depFile, and ptr.
3224 if c.IsStubs() {
3225 break
3226 }
3227
Colin Cross0de8a1e2020-09-18 14:15:30 -07003228 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3229 depFile = sharedLibraryInfo.TableOfContents
3230
Colin Cross6e511a92020-07-27 21:26:48 -07003231 ptr = &depPaths.SharedLibs
3232 switch libDepTag.Order {
3233 case earlyLibraryDependency:
3234 ptr = &depPaths.EarlySharedLibs
3235 depPtr = &depPaths.EarlySharedLibsDeps
3236 case normalLibraryDependency:
3237 ptr = &depPaths.SharedLibs
3238 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003239 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003240 case lateLibraryDependency:
3241 ptr = &depPaths.LateSharedLibs
3242 depPtr = &depPaths.LateSharedLibsDeps
3243 default:
3244 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003245 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003246
3247 case libDepTag.rlib():
3248 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: ccDep.CrateName(), LinkDirs: ccDep.ExportedCrateLinkDirs()}
3249 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
3250 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3251 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3252 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3253
Colin Cross6e511a92020-07-27 21:26:48 -07003254 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003255 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3256 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003257 if !ctx.Config().AllowMissingDependencies() {
3258 ctx.ModuleErrorf("module %q is not a static library", depName)
3259 } else {
3260 ctx.AddMissingDependencies([]string{depName})
3261 }
3262 return
3263 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003264
3265 // Stubs lib doesn't link to the static lib dependencies. Don't set
3266 // linkFile, depFile, and ptr.
3267 if c.IsStubs() {
3268 break
3269 }
3270
Colin Cross0de8a1e2020-09-18 14:15:30 -07003271 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003272 if libDepTag.wholeStatic {
3273 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003274 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3275 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003276 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003277 // This case normally catches prebuilt static
3278 // libraries, but it can also occur when
3279 // AllowMissingDependencies is on and the
3280 // dependencies has no sources of its own
3281 // but has a whole_static_libs dependency
3282 // on a missing library. We want to depend
3283 // on the .a file so that there is something
3284 // in the dependency tree that contains the
3285 // error rule for the missing transitive
3286 // dependency.
3287 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003288 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003289 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3290 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003291 } else {
3292 switch libDepTag.Order {
3293 case earlyLibraryDependency:
3294 panic(fmt.Errorf("early static libs not suppported"))
3295 case normalLibraryDependency:
3296 // static dependencies will be handled separately so they can be ordered
3297 // using transitive dependencies.
3298 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003299 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003300 case lateLibraryDependency:
3301 ptr = &depPaths.LateStaticLibs
3302 default:
3303 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003304 }
3305 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003306
3307 // We re-export the Rust static_rlibs so rlib dependencies don't need to be redeclared by cc_library_static dependents.
3308 // E.g. libfoo (cc_library_static) depends on libfoo.ffi (a rust_ffi rlib), libbar depending on libfoo shouldn't have to also add libfoo.ffi to static_rlibs.
3309 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3310 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3311
Colin Cross3e5e7782022-06-17 22:17:05 +00003312 if libDepTag.unexportedSymbols {
3313 depPaths.LdFlags = append(depPaths.LdFlags,
3314 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3315 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003316 }
3317
Colin Cross6e511a92020-07-27 21:26:48 -07003318 if libDepTag.static() && !libDepTag.wholeStatic {
3319 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3320 ctx.ModuleErrorf("module %q not a static library", depName)
3321 return
3322 }
Logan Chien43d34c32017-12-20 01:17:32 +08003323
Colin Cross6e511a92020-07-27 21:26:48 -07003324 // When combining coverage files for shared libraries and executables, coverage files
3325 // in static libraries act as if they were whole static libraries. The same goes for
3326 // source based Abi dump files.
3327 if c, ok := ccDep.(*Module); ok {
3328 staticLib := c.linker.(libraryInterface)
3329 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3330 staticLib.objs().coverageFiles...)
3331 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3332 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003333 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003334 // Handle non-CC modules here
3335 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003336 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003337 }
3338 }
3339
Colin Cross6e511a92020-07-27 21:26:48 -07003340 if ptr != nil {
3341 if !linkFile.Valid() {
3342 if !ctx.Config().AllowMissingDependencies() {
3343 ctx.ModuleErrorf("module %q missing output file", depName)
3344 } else {
3345 ctx.AddMissingDependencies([]string{depName})
3346 }
3347 return
3348 }
3349 *ptr = append(*ptr, linkFile.Path())
3350 }
3351
3352 if depPtr != nil {
3353 dep := depFile
3354 if !dep.Valid() {
3355 dep = linkFile
3356 }
3357 *depPtr = append(*depPtr, dep.Path())
3358 }
3359
Colin Cross0de8a1e2020-09-18 14:15:30 -07003360 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3361 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3362 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3363 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003364 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3365
3366 // Only re-export RustRlibDeps for cc static libs
3367 if c.static() {
3368 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3369 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003370
3371 if libDepTag.reexportFlags {
3372 reexportExporter(depExporterInfo)
3373 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3374 // Re-exported shared library headers must be included as well since they can help us with type information
3375 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003376 c.sabi.Properties.ReexportedIncludes = append(
3377 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003378 c.sabi.Properties.ReexportedSystemIncludes = append(
3379 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003380 }
3381
Spandan Das3faa7922024-02-26 19:42:32 +00003382 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003383 switch {
3384 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003385 c.Properties.AndroidMkHeaderLibs = append(
3386 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003387 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003388 if lib := moduleLibraryInterface(dep); lib != nil {
3389 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003390 // Add the dependency to the APEX(es) providing the library so that
3391 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003392 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003393 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003394 c.Properties.ApexesProvidingSharedLibs = append(
3395 c.Properties.ApexesProvidingSharedLibs, an)
3396 }
3397 }
3398 }
3399
3400 // Note: the order of libs in this list is not important because
3401 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003402 c.Properties.AndroidMkSharedLibs = append(
3403 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003404 case libDepTag.static():
3405 if libDepTag.wholeStatic {
3406 c.Properties.AndroidMkWholeStaticLibs = append(
3407 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3408 } else {
3409 c.Properties.AndroidMkStaticLibs = append(
3410 c.Properties.AndroidMkStaticLibs, makeLibName)
3411 }
3412 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003413 } else if !c.IsStubs() {
3414 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3415
Colin Cross6e511a92020-07-27 21:26:48 -07003416 switch depTag {
3417 case runtimeDepTag:
3418 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003419 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003420 case objDepTag:
3421 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3422 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003423 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003424 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003425 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003426 case dynamicLinkerDepTag:
3427 depPaths.DynamicLinker = linkFile
3428 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003429 }
Colin Crossca860ac2016-01-04 14:34:37 -08003430 })
3431
Jeff Gaston294356f2017-09-27 17:05:30 -07003432 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003433 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3434 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3435 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003436
Colin Crossdd84e052017-05-17 13:44:16 -07003437 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003438 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003439 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3440 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003441 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003442 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3443
Jiyong Park74955042019-10-22 20:19:51 +09003444 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3445 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003446 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003447 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003448 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003449 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003450
3451 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003452 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003453 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003454 }
Colin Crossdd84e052017-05-17 13:44:16 -07003455
Colin Crossca860ac2016-01-04 14:34:37 -08003456 return depPaths
3457}
3458
Spandan Das604f3762023-03-16 22:51:40 +00003459func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003460 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003461 thisModule, ok := ctx.Module().(android.ApexModule)
3462 if !ok {
3463 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3464 }
3465
Kiyoung Kimaa394802024-01-08 12:55:45 +09003466 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003467 bootstrap := false
3468 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3469 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3470 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003471 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003472 bootstrap = linkable.Bootstrap()
3473 }
3474
Colin Crossff694a82023-12-13 15:54:49 -08003475 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003476
3477 useStubs := false
3478
Kiyoung Kimaa394802024-01-08 12:55:45 +09003479 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003480 if !apexInfo.IsForPlatform() {
3481 // For platform libraries, use current version of LLNDK
3482 // If this is for use_vendor apex we will apply the same rules
3483 // of apex sdk enforcement below to choose right version.
3484 useStubs = true
3485 }
3486 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3487 // If not building for APEX or the containing APEX allows the use of
3488 // platform APIs, use stubs only when it is from an APEX (and not from
3489 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3490 // bootstrap modules, always link to non-stub variant
3491 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3492
3493 isApexImportedApiLibrary := false
3494
3495 if cc, ok := dep.(*Module); ok {
3496 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3497 if apiLibrary.hasApexStubs() {
3498 isApexImportedApiLibrary = true
3499 }
3500 }
3501 }
3502
3503 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3504
3505 if useStubs {
3506 // Another exception: if this module is a test for an APEX, then
3507 // it is linked with the non-stub variant of a module in the APEX
3508 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003509 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003510 for _, apexContents := range testFor.ApexContents {
3511 if apexContents.DirectlyInApex(depName) {
3512 useStubs = false
3513 break
3514 }
3515 }
3516 }
3517 if useStubs {
3518 // Yet another exception: If this module and the dependency are
3519 // available to the same APEXes then skip stubs between their
3520 // platform variants. This complements the test_for case above,
3521 // which avoids the stubs on a direct APEX library dependency, by
3522 // avoiding stubs for indirect test dependencies as well.
3523 //
3524 // TODO(b/183882457): This doesn't work if the two libraries have
3525 // only partially overlapping apex_available. For that test_for
3526 // modules would need to be split into APEX variants and resolved
3527 // separately for each APEX they have access to.
3528 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3529 useStubs = false
3530 }
3531 }
3532 } else {
3533 // If building for APEX, use stubs when the parent is in any APEX that
3534 // the child is not in.
3535 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3536 }
3537
3538 return useStubs
3539}
3540
3541// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3542// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3543// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3544// has different level of updatability. For example, if a library foo in an APEX depends on a
3545// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3546// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3547// same APEX as foo, the non-stub variant of bar is used.
3548func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3549 depTag := ctx.OtherModuleDependencyTag(dep)
3550 libDepTag, ok := depTag.(libraryDependencyTag)
3551 if !ok || !libDepTag.shared() {
3552 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3553 }
3554
Colin Cross313aa542023-12-13 13:47:44 -08003555 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3556 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3557 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003558
3559 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003560 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003561 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003562 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3563 toUse := stubs[len(stubs)-1]
3564 sharedLibraryInfo = toUse.SharedLibraryInfo
3565 depExporterInfo = toUse.FlagExporterInfo
3566 }
3567 }
3568 return sharedLibraryInfo, depExporterInfo
3569}
3570
Colin Cross0de8a1e2020-09-18 14:15:30 -07003571// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3572// to match the topological order of the dependency tree, including any static analogues of
3573// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3574// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003575func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3576 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003577 var staticPaths android.Paths
3578 for _, staticDep := range staticDeps {
3579 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3580 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3581 }
3582 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003583 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3584 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003585 }
3586 }
3587 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3588
3589 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3590
3591 // reorder the dependencies based on transitive dependencies
3592 staticPaths = android.FirstUniquePaths(staticPaths)
3593 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3594
3595 if len(orderedStaticPaths) != len(staticPaths) {
3596 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3597 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3598 }
3599
3600 return orderedStaticPaths, transitiveStaticLibs
3601}
3602
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003603// BaseLibName trims known prefixes and suffixes
3604func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003605 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3606 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003607 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003608 return libName
3609}
3610
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003611func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003612 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003613 ccDepModule, _ := ccDep.(*Module)
3614 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003615 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003616
Justin Yuncbca3732021-02-03 19:24:13 +09003617 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003618 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003619 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003620 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003621
Ivan Lozanod1dec542021-05-26 15:33:11 -04003622 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003623 }
3624 }
3625
Kiyoung Kim22152f62024-05-24 10:45:28 +09003626 if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003627 // The vendor and product modules in Make will have been renamed to not conflict with the
3628 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003629 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003630 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003631 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003632 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003633 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003634 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003635 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003636 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003637 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003638 } else {
3639 return libName
3640 }
3641}
3642
Colin Crossca860ac2016-01-04 14:34:37 -08003643func (c *Module) InstallInData() bool {
3644 if c.installer == nil {
3645 return false
3646 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003647 return c.installer.inData()
3648}
3649
3650func (c *Module) InstallInSanitizerDir() bool {
3651 if c.installer == nil {
3652 return false
3653 }
3654 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003655 return true
3656 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003657 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003658}
3659
Yifan Hong1b3348d2020-01-21 15:53:22 -08003660func (c *Module) InstallInRamdisk() bool {
3661 return c.InRamdisk()
3662}
3663
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003664func (c *Module) InstallInVendorRamdisk() bool {
3665 return c.InVendorRamdisk()
3666}
3667
Jiyong Parkf9332f12018-02-01 00:54:12 +09003668func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003669 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003670}
3671
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003672func (c *Module) MakeUninstallable() {
3673 if c.installer == nil {
3674 c.ModuleBase.MakeUninstallable()
3675 return
3676 }
3677 c.installer.makeUninstallable(c)
3678}
3679
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003680func (c *Module) HostToolPath() android.OptionalPath {
3681 if c.installer == nil {
3682 return android.OptionalPath{}
3683 }
3684 return c.installer.hostToolPath()
3685}
3686
Nan Zhangd4e641b2017-07-12 12:55:28 -07003687func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3688 return c.outputFile
3689}
3690
Colin Cross41955e82019-05-29 14:40:35 -07003691func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3692 switch tag {
3693 case "":
3694 if c.outputFile.Valid() {
3695 return android.Paths{c.outputFile.Path()}, nil
3696 }
3697 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003698 case "unstripped":
3699 if c.linker != nil {
3700 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3701 }
3702 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003703 case "stripped_all":
3704 if c.linker != nil {
3705 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3706 }
3707 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003708 default:
3709 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003710 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003711}
3712
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003713func (c *Module) static() bool {
3714 if static, ok := c.linker.(interface {
3715 static() bool
3716 }); ok {
3717 return static.static()
3718 }
3719 return false
3720}
3721
Jiyong Park379de2f2018-12-19 02:47:14 +09003722func (c *Module) staticBinary() bool {
3723 if static, ok := c.linker.(interface {
3724 staticBinary() bool
3725 }); ok {
3726 return static.staticBinary()
3727 }
3728 return false
3729}
3730
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003731func (c *Module) testBinary() bool {
3732 if test, ok := c.linker.(interface {
3733 testBinary() bool
3734 }); ok {
3735 return test.testBinary()
3736 }
3737 return false
3738}
3739
Jingwen Chen537242c2022-08-24 11:53:27 +00003740func (c *Module) testLibrary() bool {
3741 if test, ok := c.linker.(interface {
3742 testLibrary() bool
3743 }); ok {
3744 return test.testLibrary()
3745 }
3746 return false
3747}
3748
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003749func (c *Module) benchmarkBinary() bool {
3750 if b, ok := c.linker.(interface {
3751 benchmarkBinary() bool
3752 }); ok {
3753 return b.benchmarkBinary()
3754 }
3755 return false
3756}
3757
3758func (c *Module) fuzzBinary() bool {
3759 if f, ok := c.linker.(interface {
3760 fuzzBinary() bool
3761 }); ok {
3762 return f.fuzzBinary()
3763 }
3764 return false
3765}
3766
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003767// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3768func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003769 if h, ok := c.linker.(interface {
3770 header() bool
3771 }); ok {
3772 return h.header()
3773 }
3774 return false
3775}
3776
Ivan Lozanod7586b62021-04-01 09:49:36 -04003777func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003778 if b, ok := c.linker.(interface {
3779 binary() bool
3780 }); ok {
3781 return b.binary()
3782 }
3783 return false
3784}
3785
Justin Yun5e035862021-06-29 20:50:37 +09003786func (c *Module) StaticExecutable() bool {
3787 if b, ok := c.linker.(*binaryDecorator); ok {
3788 return b.static()
3789 }
3790 return false
3791}
3792
Ivan Lozanod7586b62021-04-01 09:49:36 -04003793func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003794 if o, ok := c.linker.(interface {
3795 object() bool
3796 }); ok {
3797 return o.object()
3798 }
3799 return false
3800}
3801
Kiyoung Kim37693d02024-04-04 09:56:15 +09003802func (m *Module) Dylib() bool {
3803 return false
3804}
3805
3806func (m *Module) Rlib() bool {
3807 return false
3808}
3809
Ivan Lozanof9e21722020-12-02 09:00:51 -05003810func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003811 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003812 if c.IsLlndk() {
3813 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003814 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003815 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003816 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003817 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003818 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003819 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003820 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003821 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003822 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003823 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003824 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003825 return "native:product"
3826 }
Jooyung Han38002912019-05-16 04:01:54 +09003827 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003828 } else if c.InRamdisk() {
3829 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003830 } else if c.InVendorRamdisk() {
3831 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003832 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003833 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003834 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003835 return "native:ndk:none:none"
3836 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3837 //family, link := getNdkStlFamilyAndLinkType(c)
3838 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
3839 } else {
3840 return "native:platform"
3841 }
3842}
3843
Jiyong Park9d452992018-10-03 00:38:19 +09003844// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003845// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003846func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003847 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003848 // Stub libs and prebuilt libs in a versioned SDK are not
3849 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003850 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003851 } else if _, ok := c.linker.(testPerSrc); ok {
3852 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003853 }
3854 return false
3855}
3856
Jiyong Parka90ca002019-10-07 15:47:24 +09003857func (c *Module) AvailableFor(what string) bool {
3858 if linker, ok := c.linker.(interface {
3859 availableFor(string) bool
3860 }); ok {
3861 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3862 } else {
3863 return c.ApexModuleBase.AvailableFor(what)
3864 }
3865}
3866
Jiyong Park62304bb2020-04-13 16:19:48 +09003867func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003868 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003869}
3870
Paul Duffin0cb37b92020-03-04 14:52:46 +00003871func (c *Module) EverInstallable() bool {
3872 return c.installer != nil &&
3873 // Check to see whether the module is actually ever installable.
3874 c.installer.everInstallable()
3875}
3876
Ivan Lozanod7586b62021-04-01 09:49:36 -04003877func (c *Module) PreventInstall() bool {
3878 return c.Properties.PreventInstall
3879}
3880
3881func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003882 if c.library != nil {
3883 if i := c.library.installable(); i != nil {
3884 return i
3885 }
3886 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003887 return c.Properties.Installable
3888}
3889
3890func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003891 ret := c.EverInstallable() &&
3892 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003893 proptools.BoolDefault(c.Installable(), true) &&
3894 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003895
3896 // The platform variant doesn't need further condition. Apex variants however might not
3897 // be installable because it will likely to be included in the APEX and won't appear
3898 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003899 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003900 return ret
3901 }
3902
3903 // Special case for modules that are configured to be installed to /data, which includes
3904 // test modules. For these modules, both APEX and non-APEX variants are considered as
3905 // installable. This is because even the APEX variants won't be included in the APEX, but
3906 // will anyway be installed to /data/*.
3907 // See b/146995717
3908 if c.InstallInData() {
3909 return ret
3910 }
3911
3912 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003913}
3914
Logan Chien41eabe62019-04-10 13:33:58 +08003915func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3916 if c.linker != nil {
3917 if library, ok := c.linker.(*libraryDecorator); ok {
3918 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3919 }
3920 }
3921}
3922
Jiyong Park45bf82e2020-12-15 22:29:02 +09003923var _ android.ApexModule = (*Module)(nil)
3924
3925// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003926func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003927 depTag := ctx.OtherModuleDependencyTag(dep)
3928 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3929
3930 if cc, ok := dep.(*Module); ok {
3931 if cc.HasStubsVariants() {
3932 if isLibDepTag && libDepTag.shared() {
3933 // dynamic dep to a stubs lib crosses APEX boundary
3934 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003935 }
Colin Cross6e511a92020-07-27 21:26:48 -07003936 if IsRuntimeDepTag(depTag) {
3937 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003938 return false
3939 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003940 }
Zhijun Heec285872021-04-24 10:47:08 -07003941 if cc.IsLlndk() {
3942 return false
3943 }
Colin Crossaac32222020-07-29 12:51:56 -07003944 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003945 // shared_lib dependency from a static lib is considered as crossing
3946 // the APEX boundary because the dependency doesn't actually is
3947 // linked; the dependency is used only during the compilation phase.
3948 return false
3949 }
Jiyong Parke3867542020-12-03 17:28:25 +09003950
3951 if isLibDepTag && libDepTag.excludeInApex {
3952 return false
3953 }
Colin Cross6e511a92020-07-27 21:26:48 -07003954 }
Colin Crossc1b36442021-05-06 13:42:48 -07003955 if depTag == stubImplDepTag {
3956 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003957 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003958 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003959 if depTag == staticVariantTag {
3960 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3961 // actually mean that the static lib (and its dependencies) are copied into the
3962 // APEX.
3963 return false
3964 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003965 return true
3966}
3967
Jiyong Park45bf82e2020-12-15 22:29:02 +09003968// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003969func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3970 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003971 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3972 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3973 return nil
3974 }
Jooyung Han749dc692020-04-15 11:03:39 +09003975 // We don't check for prebuilt modules
3976 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3977 return nil
3978 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003979
Jooyung Han749dc692020-04-15 11:03:39 +09003980 minSdkVersion := c.MinSdkVersion()
3981 if minSdkVersion == "apex_inherit" {
3982 return nil
3983 }
3984 if minSdkVersion == "" {
3985 // JNI libs within APK-in-APEX fall into here
3986 // Those are okay to set sdk_version instead
3987 // We don't have to check if this is a SDK variant because
3988 // non-SDK variant resets sdk_version, which works too.
3989 minSdkVersion = c.SdkVersion()
3990 }
Dan Albertc8060532020-07-22 22:32:17 -07003991 if minSdkVersion == "" {
3992 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3993 }
3994 // Not using nativeApiLevelFromUser because the context here is not
3995 // necessarily a native context.
3996 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003997 if err != nil {
3998 return err
3999 }
Dan Albertc8060532020-07-22 22:32:17 -07004000
Colin Cross8ca61c12022-10-06 21:00:14 -07004001 // A dependency only needs to support a min_sdk_version at least
4002 // as high as the api level that the architecture was introduced in.
4003 // This allows introducing new architectures in the platform that
4004 // need to be included in apexes that normally require an older
4005 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08004006 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07004007 if sdkVersion.LessThan(minApiForArch) {
4008 sdkVersion = minApiForArch
4009 }
4010
Dan Albertc8060532020-07-22 22:32:17 -07004011 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004012 return fmt.Errorf("newer SDK(%v)", ver)
4013 }
4014 return nil
4015}
4016
Paul Duffinb5769c12021-05-12 16:16:51 +01004017// Implements android.ApexModule
4018func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4019 // stub libraries and native bridge libraries are always available to platform
4020 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4021}
4022
Jooyung Han91f92032022-02-04 12:36:33 +09004023// Overrides android.ApexModuleBase.UniqueApexVariations
4024func (c *Module) UniqueApexVariations() bool {
4025 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4026 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4027 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004028 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004029 return c.UseVndk() && c.IsVndk()
4030}
4031
Inseob Kima1888ce2022-10-04 14:42:02 +09004032func (c *Module) overriddenModules() []string {
4033 if o, ok := c.linker.(overridable); ok {
4034 return o.overriddenModules()
4035 }
4036 return nil
4037}
4038
Liz Kammer35ca77e2021-12-22 15:31:40 -05004039type moduleType int
4040
4041const (
4042 unknownType moduleType = iota
4043 binary
4044 object
4045 fullLibrary
4046 staticLibrary
4047 sharedLibrary
4048 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004049 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004050 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004051 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004052)
4053
4054func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004055 if c.testBinary() {
4056 // testBinary is also a binary, so this comes before the c.Binary()
4057 // conditional. A testBinary has additional implicit dependencies and
4058 // other test-only semantics.
4059 return testBin
4060 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004061 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004062 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004063 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004064 } else if c.testLibrary() {
4065 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4066 // will let them add implicit compile deps on gtest, for example.
4067 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004068 // For now, treat them as regular libraries.
4069 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004070 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004071 static := false
4072 shared := false
4073 if library, ok := c.linker.(*libraryDecorator); ok {
4074 static = library.MutatedProperties.BuildStatic
4075 shared = library.MutatedProperties.BuildShared
4076 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4077 static = library.MutatedProperties.BuildStatic
4078 shared = library.MutatedProperties.BuildShared
4079 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004080 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004081 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004082 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004083 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004084 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004085 return staticLibrary
4086 }
4087 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004088 } else if c.isNDKStubLibrary() {
4089 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004090 } else if c.IsNdkPrebuiltStl() {
4091 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004092 }
4093 return unknownType
4094}
4095
Colin Crosscfad1192015-11-02 16:43:11 -08004096// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004097type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004098 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004099 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004100 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004101}
4102
Patrice Arrudac249c712019-03-19 17:00:29 -07004103// cc_defaults provides a set of properties that can be inherited by other cc
4104// modules. A module can use the properties from a cc_defaults using
4105// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4106// merged (when possible) by prepending the default module's values to the
4107// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004108func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004109 return DefaultsFactory()
4110}
4111
Colin Cross36242852017-06-23 15:06:31 -07004112func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004113 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004114
Colin Cross36242852017-06-23 15:06:31 -07004115 module.AddProperties(props...)
4116 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004117 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004118 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004119 &BaseCompilerProperties{},
4120 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004121 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004122 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004123 &StaticProperties{},
4124 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004125 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004126 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004127 &TestLinkerProperties{},
4128 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004129 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004130 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004131 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004132 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004133 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004134 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004135 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004136 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004137 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004138 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004139 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004140 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004141 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004142 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004143 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004144 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4145 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004146 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004147 )
Colin Crosscfad1192015-11-02 16:43:11 -08004148
Jooyung Hancc372c52019-09-25 15:18:44 +09004149 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004150
4151 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004152}
4153
Jiyong Park2286afd2020-06-16 21:58:53 +09004154func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004155 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004156}
4157
Kiyoung Kim51279d32022-08-24 14:10:46 +09004158func (c *Module) isImportedApiLibrary() bool {
4159 _, ok := c.linker.(*apiLibraryDecorator)
4160 return ok
4161}
4162
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004163func kytheExtractAllFactory() android.Singleton {
4164 return &kytheExtractAllSingleton{}
4165}
4166
4167type kytheExtractAllSingleton struct {
4168}
4169
4170func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4171 var xrefTargets android.Paths
4172 ctx.VisitAllModules(func(module android.Module) {
4173 if ccModule, ok := module.(xref); ok {
4174 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4175 }
4176 })
4177 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4178 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004179 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004180 }
4181}
4182
Jihoon Kangf78a8902022-09-01 22:47:07 +00004183func (c *Module) Partition() string {
4184 if p, ok := c.installer.(interface {
4185 getPartition() string
4186 }); ok {
4187 return p.getPartition()
4188 }
4189 return ""
4190}
4191
Spandan Das2b6dfb52024-01-19 00:22:22 +00004192type sourceModuleName interface {
4193 sourceModuleName() string
4194}
4195
4196func (c *Module) BaseModuleName() string {
4197 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4198 // if the prebuilt module sets a source_module_name in Android.bp, use that
4199 return smn.sourceModuleName()
4200 }
4201 return c.ModuleBase.BaseModuleName()
4202}
4203
Colin Cross06a931b2015-10-28 17:23:31 -07004204var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004205var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004206var BoolPtr = proptools.BoolPtr
4207var String = proptools.String
4208var StringPtr = proptools.StringPtr