blob: e3954d7a8d0876bcab2afa348af28a9f7aee2fb3 [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()
Colin Crosse40b4ea2018-10-02 22:25:58 -070053 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010054 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070055 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070056 ctx.BottomUp("begin", BeginMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070057 })
Colin Cross16b23492016-01-06 14:41:07 -080058
Paul Duffin036e7002019-12-19 19:16:28 +000059 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040060 for _, san := range Sanitizers {
61 san.registerMutators(ctx)
62 }
Dan Willemsen581341d2017-02-09 16:16:31 -080063
Colin Cross0b908332019-06-19 23:00:20 -070064 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090065 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080066
Cory Barkera1da26f2022-06-07 20:12:06 +000067 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000068
Colin Crossf5f4ad32024-01-19 15:41:48 -080069 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070070
Colin Crossd38feb02024-01-23 16:38:06 -080071 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +080072
Colin Cross33e0c812024-01-23 16:36:07 -080073 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000074
Colin Cross6ac83a82024-01-23 11:23:10 -080075 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090076
Jooyung Han479ca172020-10-19 18:51:07 +090077 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090078 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070079 })
Colin Crossb98c8b02016-07-29 13:44:28 -070080
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080081 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
82 // sabi mutator needs to be run after apex mutator finishes.
83 ctx.TopDown("sabi_deps", sabiDepsMutator)
84 })
85
LaMont Jones0c10e4d2023-05-16 00:58:37 +000086 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070087}
88
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050089// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
90// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
91// edges to these modules.
92// This object is constructed in DepsMutator, by calling to various module delegates to set
93// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
94// dependencies.
95// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
96// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080097type Deps struct {
98 SharedLibs, LateSharedLibs []string
99 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800100 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800101 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700102
Colin Cross3e5e7782022-06-17 22:17:05 +0000103 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
104 // prevent automatically exporting symbols.
105 UnexportedStaticLibs []string
106
Chris Parsons79d66a52020-06-05 17:26:16 -0400107 // Used for data dependencies adjacent to tests
108 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700109 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400110
Yo Chiang219968c2020-09-22 18:45:04 +0800111 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
112 SystemSharedLibs []string
113
Vinh Tran367d89d2023-04-28 11:21:25 -0400114 // Used by DepMutator to pass aidl_library modules to aidl compiler
115 AidlLibs []string
116
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500117 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800118 StaticUnwinderIfLegacy bool
119
Colin Cross5950f382016-12-13 12:50:57 -0800120 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700121
Colin Cross81413472016-04-11 14:37:39 -0700122 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700123
Dan Willemsenb40aab62016-04-20 14:21:14 -0700124 GeneratedSources []string
125 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900126 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700127
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700128 ReexportGeneratedHeaders []string
129
Colin Crossc465efd2021-06-11 18:00:04 -0700130 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700131
132 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700133 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900134
135 // List of libs that need to be excluded for APEX variant
136 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900137 // List of libs that need to be excluded for non-APEX variant
138 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800139
140 // LLNDK headers for the ABI checker to check LLNDK implementation library.
141 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
142 // The core variant cannot depend on the vendor variant because of the order of CreateVariations.
143 // Instead, the LLNDK implementation depends on the LLNDK header libs.
144 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700145}
146
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500147// PathDeps is a struct containing file paths to dependencies of a module.
148// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
149// It's used to construct flags for various build statements (such as for compiling and linking).
150// It is then passed to module decorator functions responsible for registering build statements
151// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800152type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700153 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900154 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700155 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900156 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700157 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700158 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700159
Colin Cross0de8a1e2020-09-18 14:15:30 -0700160 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700161 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700162
Colin Cross26c34ed2016-09-30 17:10:16 -0700163 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100164 Objs Objects
165 // Paths to .o files in dependencies that provide them. Note that these lists
166 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800167 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700168 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700169
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100170 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
171 // the libs from all whole_static_lib dependencies.
172 WholeStaticLibsFromPrebuilts android.Paths
173
Colin Cross26c34ed2016-09-30 17:10:16 -0700174 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700175 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900176 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700177
Inseob Kimd110f872019-12-06 13:15:38 +0900178 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000179 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900180 IncludeDirs android.Paths
181 SystemIncludeDirs android.Paths
182 ReexportedDirs android.Paths
183 ReexportedSystemDirs android.Paths
184 ReexportedFlags []string
185 ReexportedGeneratedHeaders android.Paths
186 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700187
Colin Cross26c34ed2016-09-30 17:10:16 -0700188 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700189 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700190
Dan Willemsena0790e32018-10-12 00:24:23 -0700191 // Path to the dynamic linker binary
192 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700193
194 // For Darwin builds, the path to the second architecture's output that should
195 // be combined with this architectures's output into a FAT MachO file.
196 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400197
198 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
199 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800200
201 // LLNDK headers for the ABI checker to check LLNDK implementation library.
202 LlndkIncludeDirs android.Paths
203 LlndkSystemIncludeDirs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700204}
205
Colin Cross4af21ed2019-11-04 09:37:55 -0800206// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
207// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
208// command line so they can be overridden by the local module flags).
209type LocalOrGlobalFlags struct {
210 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700211 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800212 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700213 CFlags []string // Flags that apply to C and C++ source files
214 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
215 ConlyFlags []string // Flags that apply to C source files
216 CppFlags []string // Flags that apply to C++ source files
217 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700218 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800219}
220
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500221// Flags contains various types of command line flags (and settings) for use in building build
222// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800223type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500224 // Local flags (which individual modules are responsible for). These may override global flags.
225 Local LocalOrGlobalFlags
226 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700227 Global LocalOrGlobalFlags
228 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800229
230 aidlFlags []string // Flags that apply to aidl source files
231 rsFlags []string // Flags that apply to renderscript source files
232 libFlags []string // Flags to add libraries early to the link order
233 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
234 TidyFlags []string // Flags that apply to clang-tidy
235 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700236
Colin Crossc3199482017-03-30 15:03:04 -0700237 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800238 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700239 SystemIncludeFlags []string
240
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800241 Toolchain config.Toolchain
242 Tidy bool // True if ninja .tidy rules should be generated.
243 NeedTidyFiles bool // True if module link should depend on .tidy files
244 GcovCoverage bool // True if coverage files should be generated.
245 SAbiDump bool // True if header abi dumps should be generated.
246 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800247
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500248 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800249 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500250 // The target-device system path to the dynamic linker.
251 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800252
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700253 CFlagsDeps android.Paths // Files depended on by compiler flags
254 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800255
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500256 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700257 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800258
Colin Cross19878da2019-03-28 14:45:07 -0700259 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700260 protoC bool // Whether to use C instead of C++
261 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700262
263 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200264 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700265}
266
Colin Crossca860ac2016-01-04 14:34:37 -0800267// Properties used to compile all C or C++ modules
268type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700269 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800270 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700271
Jiyong Parkb35a8192020-08-10 15:59:36 +0900272 // The API level that this module is built against. The APIs of this API level will be
273 // visible at build time, but use of any APIs newer than min_sdk_version will render the
274 // module unloadable on older devices. In the future it will be possible to weakly-link new
275 // APIs, making the behavior match Java: such modules will load on older devices, but
276 // calling new APIs on devices that do not support them will result in a crash.
277 //
278 // This property has the same behavior as sdk_version does for Java modules. For those
279 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
280 // does for Java code.
281 //
282 // In addition, setting this property causes two variants to be built, one for the platform
283 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800284 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700285
Jiyong Parkb35a8192020-08-10 15:59:36 +0900286 // Minimum OS API level supported by this C or C++ module. This property becomes the value
287 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
288 // this property is also used to ensure that the min_sdk_version of the containing module is
289 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
290 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
291 // min_sdk_version of the containing APEX. When the module
292 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900293 Min_sdk_version *string
294
Colin Crossc511bc52020-04-07 16:50:32 +0000295 // If true, always create an sdk variant and don't create a platform variant.
296 Sdk_variant_only *bool
297
Jiyong Parkde866cb2018-12-07 23:08:36 +0900298 AndroidMkSharedLibs []string `blueprint:"mutated"`
299 AndroidMkStaticLibs []string `blueprint:"mutated"`
300 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
301 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700302 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900303 HideFromMake bool `blueprint:"mutated"`
304 PreventInstall bool `blueprint:"mutated"`
305 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700306
Yo Chiang219968c2020-09-22 18:45:04 +0800307 // Set by DepsMutator.
308 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
309
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900310 // The name of the image this module is built for
311 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200312
313 // The VNDK version this module is built against. If empty, the module is not
314 // build against the VNDK.
315 VndkVersion string `blueprint:"mutated"`
316
317 // Suffix for the name of Android.mk entries generated by this module
318 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800319
320 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
321 // file
322 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900323
Yifan Hong39143a92020-10-26 12:43:12 -0700324 // Make this module available when building for ramdisk.
325 // On device without a dedicated recovery partition, the module is only
326 // available after switching root into
327 // /first_stage_ramdisk. To expose the module before switching root, install
328 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800329 Ramdisk_available *bool
330
Yifan Hong39143a92020-10-26 12:43:12 -0700331 // Make this module available when building for vendor ramdisk.
332 // On device without a dedicated recovery partition, the module is only
333 // available after switching root into
334 // /first_stage_ramdisk. To expose the module before switching root, install
335 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700336 Vendor_ramdisk_available *bool
337
Jiyong Parkf9332f12018-02-01 00:54:12 +0900338 // Make this module available when building for recovery
339 Recovery_available *bool
340
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200341 // Used by imageMutator, set by ImageMutatorBegin()
342 CoreVariantNeeded bool `blueprint:"mutated"`
343 RamdiskVariantNeeded bool `blueprint:"mutated"`
344 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
345 RecoveryVariantNeeded bool `blueprint:"mutated"`
346
347 // A list of variations for the "image" mutator of the form
348 //<image name> '.' <version char>, for example, 'vendor.S'
349 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900350
351 // Allows this module to use non-APEX version of libraries. Useful
352 // for building binaries that are started before APEXes are activated.
353 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900354
355 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
356 // see soong/cc/config/vndk.go
357 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900358
Colin Cross1bc94122021-10-28 13:25:54 -0700359 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000360
361 // Set by factories of module types that can only be referenced from variants compiled against
362 // the SDK.
363 AlwaysSdk bool `blueprint:"mutated"`
364
365 // Variant is an SDK variant created by sdkMutator
366 IsSdkVariant bool `blueprint:"mutated"`
367 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
368 // variant to have a ".sdk" suffix.
369 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700370
Jiyong Park46a512f2020-12-04 18:02:13 +0900371 // List of APEXes that this module has private access to for testing purpose. The module
372 // can depend on libraries that are not exported by the APEXes and use private symbols
373 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000374 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800375
376 Target struct {
377 Platform struct {
378 // List of modules required by the core variant.
379 Required []string `android:"arch_variant"`
380
381 // List of modules not required by the core variant.
382 Exclude_required []string `android:"arch_variant"`
383 } `android:"arch_variant"`
384
385 Recovery struct {
386 // List of modules required by the recovery variant.
387 Required []string `android:"arch_variant"`
388
389 // List of modules not required by the recovery variant.
390 Exclude_required []string `android:"arch_variant"`
391 } `android:"arch_variant"`
392 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700393}
394
395type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900396 // whether this module should be allowed to be directly depended by other
397 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900398 // If set to true, two variants will be built separately, one like
399 // normal, and the other limited to the set of libraries and headers
400 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700401 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900402 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700403 // so it shouldn't have any unversioned runtime dependencies, or
404 // make assumptions about the system that may not be true in the
405 // future.
406 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900407 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900408 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900409 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900410 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900411 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700412 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
413 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900414
Justin Yunebcf0c52021-01-08 18:00:19 +0900415 // This is the same as the "vendor_available" except that the install path
416 // of the vendor variant is /odm or /vendor/odm.
417 // By replacing "vendor_available: true" with "odm_available: true", the
418 // module will install its vendor variant to the /odm partition or /vendor/odm.
419 // As the modules with "odm_available: true" still create the vendor variants,
420 // they can link to the other vendor modules as the vendor_available modules do.
421 // Also, the vendor modules can link to odm_available modules.
422 //
423 // It may not be used for VNDK modules.
424 Odm_available *bool
425
Justin Yun63e9ec72020-10-29 16:49:43 +0900426 // whether this module should be allowed to be directly depended by other
427 // modules with `product_specific: true` or `product_available: true`.
428 // If set to true, an additional product variant will be built separately
429 // that is limited to the set of libraries and headers that are exposed to
430 // /product modules.
431 //
432 // The product variant may be used with a different (newer) /system,
433 // so it shouldn't have any unversioned runtime dependencies, or
434 // make assumptions about the system that may not be true in the
435 // future.
436 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900437 // If set to false, this module becomes inaccessible from /product modules.
438 //
439 // Different from the 'vendor_available' property, the modules with
440 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
441 // library without 'product_available' may not be depended on by any other
442 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900443 //
444 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
445 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
446 Product_available *bool
447
Jiyong Park5fb8c102018-04-09 12:03:06 +0900448 // whether this module is capable of being loaded with other instance
449 // (possibly an older version) of the same module in the same process.
450 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
451 // can be double loaded in a vendor process if the library is also a
452 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
453 // explicitly marked as `double_loadable: true` by the owner, or the dependency
454 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
455 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800456
457 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
458 IsLLNDK bool `blueprint:"mutated"`
459
Colin Cross78212242021-01-06 14:51:30 -0800460 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
461 // set and the module is not listed in VndkMustUseVendorVariantList.
462 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
463
464 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
465 IsVNDKCore bool `blueprint:"mutated"`
466
467 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
468 IsVNDKSP bool `blueprint:"mutated"`
469
470 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
471 // module sets the llndk.private property.
472 IsVNDKPrivate bool `blueprint:"mutated"`
473
474 // IsVNDKProduct is set if a VNDK module sets the product_available property.
475 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700476
477 // IsVendorPublicLibrary is set for the core and product variants of a library that has
478 // vendor_public_library stubs.
479 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800480}
481
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500482// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
483// to understanding details about the type of the current module.
484// For example, one might call these functions to determine whether the current module is a static
485// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800486type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800487 static() bool
488 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700489 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800490 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900491 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900492 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900493 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700494 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900495 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700496 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800497 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900498 minSdkVersion() string
499 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700500 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700501 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800502 IsLlndk() bool
503 IsLlndkPublic() bool
504 isImplementationForLLNDKPublic() bool
505 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900506 isVndk() bool
507 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500508 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700509 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900510 inProduct() bool
511 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800512 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700513 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900514 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900515 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700516 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700517 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800518 getVndkExtendsModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800519 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000520 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800521 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900522 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800523 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800524 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800525 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700526 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700527 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900528 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800529 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700530 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700531 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800532 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800533 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800534 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800535 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800536}
537
538type SharedFlags struct {
539 numSharedFlags int
540 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800541}
542
543type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700544 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800545 ModuleContextIntf
546}
547
548type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700549 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800550 ModuleContextIntf
551}
552
Colin Cross37047f12016-12-13 17:06:13 -0800553type DepsContext interface {
554 android.BottomUpMutatorContext
555 ModuleContextIntf
556}
557
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500558// feature represents additional (optional) steps to building cc-related modules, such as invocation
559// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800560type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800561 flags(ctx ModuleContext, flags Flags) Flags
562 props() []interface{}
563}
564
Joe Onorato37f900c2023-07-18 16:58:16 -0700565// Information returned from Generator about the source code it's generating
566type GeneratedSource struct {
567 IncludeDirs android.Paths
568 Sources android.Paths
569 Headers android.Paths
570 ReexportedDirs android.Paths
571}
572
573// generator allows injection of generated code
574type Generator interface {
575 GeneratorProps() []interface{}
576 GeneratorInit(ctx BaseModuleContext)
577 GeneratorDeps(ctx DepsContext, deps Deps) Deps
578 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
579 GeneratorSources(ctx ModuleContext) GeneratedSource
580 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
581}
582
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500583// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500584// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800585type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700586 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800587 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800588 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700589 compilerProps() []interface{}
590
Colin Cross76fada02016-07-27 10:31:13 -0700591 appendCflags([]string)
592 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700593 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800594}
595
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500596// linker is the interface for a linker decorator object. Individual module types can provide
597// their own implementation for this decorator, and thus specify custom logic regarding build
598// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800599type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700600 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800601 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700602 linkerFlags(ctx ModuleContext, flags Flags) Flags
603 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800604 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700605
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700606 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700607 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900608 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800609 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700610
611 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900612 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000613
614 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000615 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800616
617 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000618}
619
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500620// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000621type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500622 sharedLibs []string
623 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
624 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700625 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800626}
627
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500628// installer is the interface for an installer helper object. This helper is responsible for
629// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800630type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700631 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700632 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000633 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800634 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700635 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700636 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900637 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000638 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900639 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800640}
641
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800642type xref interface {
643 XrefCcFiles() android.Paths
644}
645
Inseob Kima1888ce2022-10-04 14:42:02 +0900646type overridable interface {
647 overriddenModules() []string
648}
649
Colin Cross6e511a92020-07-27 21:26:48 -0700650type libraryDependencyKind int
651
652const (
653 headerLibraryDependency = iota
654 sharedLibraryDependency
655 staticLibraryDependency
656)
657
658func (k libraryDependencyKind) String() string {
659 switch k {
660 case headerLibraryDependency:
661 return "headerLibraryDependency"
662 case sharedLibraryDependency:
663 return "sharedLibraryDependency"
664 case staticLibraryDependency:
665 return "staticLibraryDependency"
666 default:
667 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
668 }
669}
670
671type libraryDependencyOrder int
672
673const (
674 earlyLibraryDependency = -1
675 normalLibraryDependency = 0
676 lateLibraryDependency = 1
677)
678
679func (o libraryDependencyOrder) String() string {
680 switch o {
681 case earlyLibraryDependency:
682 return "earlyLibraryDependency"
683 case normalLibraryDependency:
684 return "normalLibraryDependency"
685 case lateLibraryDependency:
686 return "lateLibraryDependency"
687 default:
688 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
689 }
690}
691
692// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
693// tags that have a set of predefined tag objects that are reused for each dependency, a
694// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
695// That means that comparing a libraryDependencyTag for equality will only be equal if all
696// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
697// then check individual metadata fields instead.
698type libraryDependencyTag struct {
699 blueprint.BaseDependencyTag
700
701 // These are exported so that fmt.Printf("%#v") can call their String methods.
702 Kind libraryDependencyKind
703 Order libraryDependencyOrder
704
705 wholeStatic bool
706
707 reexportFlags bool
708 explicitlyVersioned bool
709 dataLib bool
710 ndk bool
711
712 staticUnwinder bool
713
714 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900715
Cindy Zhou18417cb2020-12-10 07:12:38 -0800716 // Whether or not this dependency should skip the apex dependency check
717 skipApexAllowedDependenciesCheck bool
718
Jiyong Parke3867542020-12-03 17:28:25 +0900719 // Whether or not this dependency has to be followed for the apex variants
720 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900721 // Whether or not this dependency has to be followed for the non-apex variants
722 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000723
724 // If true, don't automatically export symbols from the static library into a shared library.
725 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700726}
727
728// header returns true if the libraryDependencyTag is tagging a header lib dependency.
729func (d libraryDependencyTag) header() bool {
730 return d.Kind == headerLibraryDependency
731}
732
733// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
734func (d libraryDependencyTag) shared() bool {
735 return d.Kind == sharedLibraryDependency
736}
737
738// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
739func (d libraryDependencyTag) static() bool {
740 return d.Kind == staticLibraryDependency
741}
742
Colin Cross65cb3142021-12-10 23:05:02 +0000743func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
744 if d.shared() {
745 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
746 }
747 return nil
748}
749
750var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
751
Colin Crosse9fe2942020-11-10 18:12:15 -0800752// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
753// binaries or other shared libraries are installed as dependencies.
754func (d libraryDependencyTag) InstallDepNeeded() bool {
755 return d.shared()
756}
757
758var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
759
Yu Liu67a28422024-03-05 00:36:31 +0000760func (d libraryDependencyTag) PropagateAconfigValidation() bool {
761 return d.static()
762}
763
764var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
765
Colin Crosse9fe2942020-11-10 18:12:15 -0800766// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700767// libraryDependencyTag. Each tag object is created globally and reused for multiple
768// dependencies (although since the object contains no references, assigning a tag to a
769// variable and modifying it will not modify the original). Users can compare the tag
770// returned by ctx.OtherModuleDependencyTag against the global original
771type dependencyTag struct {
772 blueprint.BaseDependencyTag
773 name string
774}
775
Colin Crosse9fe2942020-11-10 18:12:15 -0800776// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
777// libraryDependencyTag, but where the dependency needs to be installed when the parent is
778// installed.
779type installDependencyTag struct {
780 blueprint.BaseDependencyTag
781 android.InstallAlwaysNeededDependencyTag
782 name string
783}
784
Colin Crossc99deeb2016-04-11 15:06:20 -0700785var (
Colin Cross6e511a92020-07-27 21:26:48 -0700786 genSourceDepTag = dependencyTag{name: "gen source"}
787 genHeaderDepTag = dependencyTag{name: "gen header"}
788 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
789 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900790 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700791 reuseObjTag = dependencyTag{name: "reuse objects"}
792 staticVariantTag = dependencyTag{name: "static variant"}
793 vndkExtDepTag = dependencyTag{name: "vndk extends"}
794 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700795 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800796 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700797 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700798 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000799 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500800 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400801 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800802 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700803)
804
Roland Levillainf89cd092019-07-29 16:22:59 +0100805func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700806 ccLibDepTag, ok := depTag.(libraryDependencyTag)
807 return ok && ccLibDepTag.shared()
808}
809
810func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
811 ccLibDepTag, ok := depTag.(libraryDependencyTag)
812 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100813}
814
Zach Johnson3df4e632020-11-06 11:56:27 -0800815func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
816 ccLibDepTag, ok := depTag.(libraryDependencyTag)
817 return ok && ccLibDepTag.header()
818}
819
Roland Levillainf89cd092019-07-29 16:22:59 +0100820func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800821 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100822}
823
824func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700825 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100826 return ok && ccDepTag == testPerSrcDepTag
827}
828
Colin Crossca860ac2016-01-04 14:34:37 -0800829// Module contains the properties and members used by all C/C++ module types, and implements
830// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500831// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
832// interface.
833//
834// To define a C/C++ related module, construct a new Module object and point its delegates to
835// type-specific structs. These delegates will be invoked to register module-specific build
836// statements which may be unique to the module type. For example, module.compiler.compile() should
837// be defined so as to register build statements which are responsible for compiling the module.
838//
839// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
840// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
841// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
842// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800843type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700844 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700845
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700846 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700847 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700848 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700849
Colin Crossca860ac2016-01-04 14:34:37 -0800850 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000851 hod android.HostOrDeviceSupported
852 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000853 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700854
Paul Duffina0843f62019-12-13 19:50:38 +0000855 // Allowable SdkMemberTypes of this module type.
856 sdkMemberTypes []android.SdkMemberType
857
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500858 // decorator delegates, initialize before calling Init
859 // these may contain module-specific implementations, and effectively allow for custom
860 // type-specific logic. These members may reference different objects or the same object.
861 // Functions of these decorators will be invoked to initialize and register type-specific
862 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800863 generators []Generator
864 compiler compiler
865 linker linker
866 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500867
Spandan Dase12d2522023-09-12 21:42:31 +0000868 features []feature
869 stl *stl
870 sanitize *sanitize
871 coverage *coverage
872 fuzzer *fuzzer
873 sabi *sabi
874 vndkdep *vndkdep
875 lto *lto
876 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000877 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800878
Colin Cross31076b32020-10-23 17:22:06 -0700879 library libraryInterface
880
Colin Cross635c3b02016-05-18 15:37:25 -0700881 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800882
Colin Crossb98c8b02016-07-29 13:44:28 -0700883 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700884
885 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800886
887 // Flags used to compile this module
888 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700889
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800890 // Shared flags among build rules of this module
891 sharedFlags SharedFlags
892
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800893 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700894 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900895
896 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800897 // Kythe (source file indexer) paths for this compilation module
898 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700899 // Object .o file output paths for this compilation module
900 objFiles android.Paths
901 // Tidy .tidy file output paths for this compilation module
902 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900903
904 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700905 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700906
907 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800908
909 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800910 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700911}
912
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200913func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400914 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
915 if b, ok := c.compiler.(*baseCompiler); ok {
916 hasAidl = b.hasSrcExt(".aidl")
917 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
918 hasProto = b.hasSrcExt(".proto")
919 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
920 hasSysprop = b.hasSrcExt(".sysprop")
921 hasWinMsg = b.hasSrcExt(".mc")
922 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
923 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200924 c.AndroidModuleBase().AddJSONData(d)
925 (*d)["Cc"] = map[string]interface{}{
926 "SdkVersion": c.SdkVersion(),
927 "MinSdkVersion": c.MinSdkVersion(),
928 "VndkVersion": c.VndkVersion(),
929 "ProductSpecific": c.ProductSpecific(),
930 "SocSpecific": c.SocSpecific(),
931 "DeviceSpecific": c.DeviceSpecific(),
932 "InProduct": c.InProduct(),
933 "InVendor": c.InVendor(),
934 "InRamdisk": c.InRamdisk(),
935 "InVendorRamdisk": c.InVendorRamdisk(),
936 "InRecovery": c.InRecovery(),
937 "VendorAvailable": c.VendorAvailable(),
938 "ProductAvailable": c.ProductAvailable(),
939 "RamdiskAvailable": c.RamdiskAvailable(),
940 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
941 "RecoveryAvailable": c.RecoveryAvailable(),
942 "OdmAvailable": c.OdmAvailable(),
943 "InstallInData": c.InstallInData(),
944 "InstallInRamdisk": c.InstallInRamdisk(),
945 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
946 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
947 "InstallInRecovery": c.InstallInRecovery(),
948 "InstallInRoot": c.InstallInRoot(),
949 "IsVndk": c.IsVndk(),
950 "IsVndkExt": c.IsVndkExt(),
951 "IsVndkPrivate": c.IsVndkPrivate(),
952 "IsVndkSp": c.IsVndkSp(),
953 "IsLlndk": c.IsLlndk(),
954 "IsLlndkPublic": c.IsLlndkPublic(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200955 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
956 "ApexSdkVersion": c.apexSdkVersion,
957 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400958 "AidlSrcs": hasAidl,
959 "LexSrcs": hasLex,
960 "ProtoSrcs": hasProto,
961 "RenderscriptSrcs": hasRenderscript,
962 "SyspropSrcs": hasSysprop,
963 "WinMsgSrcs": hasWinMsg,
964 "YaccSrsc": hasYacc,
965 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200966 }
967}
968
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500969func (c *Module) SetPreventInstall() {
970 c.Properties.PreventInstall = true
971}
972
973func (c *Module) SetHideFromMake() {
974 c.Properties.HideFromMake = true
975}
976
Ivan Lozanod7586b62021-04-01 09:49:36 -0400977func (c *Module) HiddenFromMake() bool {
978 return c.Properties.HideFromMake
979}
980
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800981func (c *Module) RequiredModuleNames() []string {
982 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
983 if c.ImageVariation().Variation == android.CoreVariation {
984 required = append(required, c.Properties.Target.Platform.Required...)
985 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
986 } else if c.InRecovery() {
987 required = append(required, c.Properties.Target.Recovery.Required...)
988 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
989 }
990 return android.FirstUniqueStrings(required)
991}
992
Ivan Lozano52767be2019-10-18 14:49:46 -0700993func (c *Module) Toc() android.OptionalPath {
994 if c.linker != nil {
995 if library, ok := c.linker.(libraryInterface); ok {
996 return library.toc()
997 }
998 }
999 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1000}
1001
1002func (c *Module) ApiLevel() string {
1003 if c.linker != nil {
1004 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001005 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001006 }
1007 }
1008 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1009}
1010
1011func (c *Module) Static() bool {
1012 if c.linker != nil {
1013 if library, ok := c.linker.(libraryInterface); ok {
1014 return library.static()
1015 }
1016 }
1017 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1018}
1019
1020func (c *Module) Shared() bool {
1021 if c.linker != nil {
1022 if library, ok := c.linker.(libraryInterface); ok {
1023 return library.shared()
1024 }
1025 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001026
Ivan Lozano52767be2019-10-18 14:49:46 -07001027 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1028}
1029
1030func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001031 if c.stl != nil {
1032 return c.stl.Properties.SelectedStl
1033 }
1034 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001035}
1036
Ivan Lozano52767be2019-10-18 14:49:46 -07001037func (c *Module) NdkPrebuiltStl() bool {
1038 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1039 return true
1040 }
1041 return false
1042}
1043
1044func (c *Module) StubDecorator() bool {
1045 if _, ok := c.linker.(*stubDecorator); ok {
1046 return true
1047 }
1048 return false
1049}
1050
1051func (c *Module) SdkVersion() string {
1052 return String(c.Properties.Sdk_version)
1053}
1054
Artur Satayev480e25b2020-04-27 18:53:18 +01001055func (c *Module) MinSdkVersion() string {
1056 return String(c.Properties.Min_sdk_version)
1057}
1058
Jiyong Park5df7bd32021-08-25 16:18:46 +09001059func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001060 if linker, ok := c.linker.(*objectLinker); ok {
1061 return linker.isCrt()
1062 }
1063 return false
1064}
1065
Jiyong Park5df7bd32021-08-25 16:18:46 +09001066func (c *Module) SplitPerApiLevel() bool {
1067 return c.canUseSdk() && c.isCrt()
1068}
1069
Colin Crossc511bc52020-04-07 16:50:32 +00001070func (c *Module) AlwaysSdk() bool {
1071 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1072}
1073
Ivan Lozano183a3212019-10-18 14:18:45 -07001074func (c *Module) CcLibrary() bool {
1075 if c.linker != nil {
1076 if _, ok := c.linker.(*libraryDecorator); ok {
1077 return true
1078 }
Colin Crossd48fe732020-09-23 20:37:24 -07001079 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1080 return true
1081 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001082 }
1083 return false
1084}
1085
1086func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001087 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001088 return true
1089 }
1090 return false
1091}
1092
Spandan Dase12d2522023-09-12 21:42:31 +00001093func (c *Module) IsNdkPrebuiltStl() bool {
1094 if c.linker == nil {
1095 return false
1096 }
1097 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1098 return true
1099 }
1100 return false
1101}
1102
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001103func (c *Module) RlibStd() bool {
1104 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1105}
1106
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001107func (c *Module) RustLibraryInterface() bool {
1108 return false
1109}
1110
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001111func (c *Module) IsFuzzModule() bool {
1112 if _, ok := c.compiler.(*fuzzBinary); ok {
1113 return true
1114 }
1115 return false
1116}
1117
1118func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1119 return c.FuzzModule
1120}
1121
1122func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1123 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1124 return fuzzer.fuzzPackagedModule
1125 }
1126 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1127}
1128
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001129func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001130 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1131 return fuzzer.sharedLibraries
1132 }
1133 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1134}
1135
Ivan Lozano2b262972019-11-21 12:30:50 -08001136func (c *Module) NonCcVariants() bool {
1137 return false
1138}
1139
Ivan Lozano183a3212019-10-18 14:18:45 -07001140func (c *Module) SetStatic() {
1141 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001142 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001143 library.setStatic()
1144 return
1145 }
1146 }
1147 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1148}
1149
1150func (c *Module) SetShared() {
1151 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001152 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001153 library.setShared()
1154 return
1155 }
1156 }
1157 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1158}
1159
1160func (c *Module) BuildStaticVariant() bool {
1161 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001162 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001163 return library.buildStatic()
1164 }
1165 }
1166 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1167}
1168
1169func (c *Module) BuildSharedVariant() bool {
1170 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001171 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001172 return library.buildShared()
1173 }
1174 }
1175 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1176}
1177
1178func (c *Module) Module() android.Module {
1179 return c
1180}
1181
Jiyong Parkc20eee32018-09-05 22:36:17 +09001182func (c *Module) OutputFile() android.OptionalPath {
1183 return c.outputFile
1184}
1185
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001186func (c *Module) CoverageFiles() android.Paths {
1187 if c.linker != nil {
1188 if library, ok := c.linker.(libraryInterface); ok {
1189 return library.objs().coverageFiles
1190 }
1191 }
1192 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1193}
1194
Ivan Lozano183a3212019-10-18 14:18:45 -07001195var _ LinkableInterface = (*Module)(nil)
1196
Jiyong Park719b4462019-01-13 00:39:51 +09001197func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001198 if c.linker != nil {
1199 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001200 }
1201 return nil
1202}
1203
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001204func (c *Module) CoverageOutputFile() android.OptionalPath {
1205 if c.linker != nil {
1206 return c.linker.coverageOutputFilePath()
1207 }
1208 return android.OptionalPath{}
1209}
1210
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001211func (c *Module) RelativeInstallPath() string {
1212 if c.installer != nil {
1213 return c.installer.relativeInstallPath()
1214 }
1215 return ""
1216}
1217
Jooyung Han344d5432019-08-23 11:17:39 +09001218func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001219 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001220}
1221
Colin Cross36242852017-06-23 15:06:31 -07001222func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001223 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001224 for _, generator := range c.generators {
1225 c.AddProperties(generator.GeneratorProps()...)
1226 }
Colin Crossca860ac2016-01-04 14:34:37 -08001227 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001228 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001229 }
1230 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001231 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001232 }
1233 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001234 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001235 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001236 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001237 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001238 }
Colin Cross16b23492016-01-06 14:41:07 -08001239 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001240 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001241 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001242 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001243 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001244 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001245 if c.fuzzer != nil {
1246 c.AddProperties(c.fuzzer.props()...)
1247 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001248 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001249 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001250 }
Justin Yun8effde42017-06-23 19:24:43 +09001251 if c.vndkdep != nil {
1252 c.AddProperties(c.vndkdep.props()...)
1253 }
Stephen Craneba090d12017-05-09 15:44:35 -07001254 if c.lto != nil {
1255 c.AddProperties(c.lto.props()...)
1256 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001257 if c.afdo != nil {
1258 c.AddProperties(c.afdo.props()...)
1259 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001260 if c.orderfile != nil {
1261 c.AddProperties(c.orderfile.props()...)
1262 }
Colin Crossca860ac2016-01-04 14:34:37 -08001263 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001264 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001265 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001266 // Allow test-only on libraries that are not cc_test_library
1267 if c.library != nil && !c.testLibrary() {
1268 c.AddProperties(&c.sourceProperties)
1269 }
Colin Crossc472d572015-03-17 15:06:21 -07001270
Colin Cross36242852017-06-23 15:06:31 -07001271 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001272 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001273 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001274
Colin Cross36242852017-06-23 15:06:31 -07001275 return c
Colin Crossc472d572015-03-17 15:06:21 -07001276}
1277
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001278// UseVndk() returns true if this module is built against VNDK.
1279// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001280func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001281 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001282}
1283
Colin Crossc511bc52020-04-07 16:50:32 +00001284func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001285 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001286 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001287}
1288
1289func (c *Module) UseSdk() bool {
1290 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001291 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001292 }
1293 return false
1294}
1295
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001296func (c *Module) isCoverageVariant() bool {
1297 return c.coverage.Properties.IsCoverageVariant
1298}
1299
Colin Cross95f1ca02020-10-29 20:47:22 -07001300func (c *Module) IsNdk(config android.Config) bool {
1301 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001302}
1303
Colin Cross127bb8b2020-12-16 16:46:01 -08001304func (c *Module) IsLlndk() bool {
1305 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001306}
1307
Colin Cross127bb8b2020-12-16 16:46:01 -08001308func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001309 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001310}
1311
Colin Cross1f3f1302021-04-26 18:37:44 -07001312func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001313 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001314 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001315}
1316
Colin Cross5271fea2021-04-27 13:06:04 -07001317func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1318 lib := moduleLibraryInterface(m)
1319 return lib != nil && (lib.hasVendorPublicLibrary())
1320}
1321
1322// IsVendorPublicLibrary returns true for vendor public libraries.
1323func (c *Module) IsVendorPublicLibrary() bool {
1324 return c.VendorProperties.IsVendorPublicLibrary
1325}
1326
Ivan Lozanof1868af2022-04-12 13:08:36 -04001327func (c *Module) IsVndkPrebuiltLibrary() bool {
1328 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1329 return true
1330 }
1331 return false
1332}
1333
1334func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1335 return c.Properties.SdkAndPlatformVariantVisibleToMake
1336}
1337
Ivan Lozanod7586b62021-04-01 09:49:36 -04001338func (c *Module) HasLlndkStubs() bool {
1339 lib := moduleLibraryInterface(c)
1340 return lib != nil && lib.hasLLNDKStubs()
1341}
1342
1343func (c *Module) StubsVersion() string {
1344 if lib, ok := c.linker.(versionedInterface); ok {
1345 return lib.stubsVersion()
1346 }
1347 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1348}
1349
Colin Cross127bb8b2020-12-16 16:46:01 -08001350// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1351// and does not set llndk.vendor_available: false.
1352func (c *Module) isImplementationForLLNDKPublic() bool {
1353 library, _ := c.library.(*libraryDecorator)
1354 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001355 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001356}
1357
Justin Yunfd9e8042020-12-23 18:23:14 +09001358// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001359func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001360 // Check if VNDK-core-private or VNDK-SP-private
1361 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001362 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001363 }
1364
1365 // Check if LLNDK-private
1366 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001367 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001368 }
1369
1370 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001371}
1372
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001373// IsVndk() returns true if this module has a vndk variant.
1374// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1375// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001376func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001377 if vndkdep := c.vndkdep; vndkdep != nil {
1378 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001379 }
1380 return false
1381}
1382
Colin Cross3513fb12024-01-24 14:44:47 -08001383func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001384 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001385 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001386 }
1387 return false
1388}
1389
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001390func (c *Module) isOrderfileCompile() bool {
1391 if orderfile := c.orderfile; orderfile != nil {
1392 return orderfile.Properties.OrderfileLoad
1393 }
1394 return false
1395}
1396
Yi Kongc702ebd2022-08-19 16:02:45 +08001397func (c *Module) isCfi() bool {
1398 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001399 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001400 }
1401 return false
1402}
1403
Yi Konged79fa32023-06-04 17:15:42 +09001404func (c *Module) isFuzzer() bool {
1405 if sanitize := c.sanitize; sanitize != nil {
1406 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1407 }
1408 return false
1409}
1410
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001411func (c *Module) isNDKStubLibrary() bool {
1412 if _, ok := c.compiler.(*stubDecorator); ok {
1413 return true
1414 }
1415 return false
1416}
1417
Ivan Lozanod7586b62021-04-01 09:49:36 -04001418func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001419 if vndkdep := c.vndkdep; vndkdep != nil {
1420 return vndkdep.isVndkSp()
1421 }
1422 return false
1423}
1424
Ivan Lozanof9e21722020-12-02 09:00:51 -05001425func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001426 if vndkdep := c.vndkdep; vndkdep != nil {
1427 return vndkdep.isVndkExt()
1428 }
1429 return false
1430}
1431
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001432func (c *Module) SubName() string {
1433 return c.Properties.SubName
1434}
1435
Ivan Lozano52767be2019-10-18 14:49:46 -07001436func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001437 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001438}
1439
Logan Chienf3511742017-10-31 18:04:35 +08001440func (c *Module) getVndkExtendsModuleName() string {
1441 if vndkdep := c.vndkdep; vndkdep != nil {
1442 return vndkdep.getVndkExtendsModuleName()
1443 }
1444 return ""
1445}
1446
Jiyong Park25fc6a92018-11-18 18:02:45 +09001447func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001448 if lib := c.library; lib != nil {
1449 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001450 }
1451 return false
1452}
1453
1454func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001455 if lib := c.library; lib != nil {
1456 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001457 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001458 return false
1459}
1460
Alan Stokes73feba32022-11-14 12:21:24 +00001461func (c *Module) IsStubsImplementationRequired() bool {
1462 if lib := c.library; lib != nil {
1463 return lib.isStubsImplementationRequired()
1464 }
1465 return false
1466}
1467
Colin Cross0477b422020-10-13 18:43:54 -07001468// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1469// the implementation. If it is an implementation library it returns its own name.
1470func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1471 name := ctx.OtherModuleName(c)
1472 if versioned, ok := c.linker.(versionedInterface); ok {
1473 name = versioned.implementationModuleName(name)
1474 }
1475 return name
1476}
1477
Martin Stjernholm2856c662020-12-02 15:03:42 +00001478// Similar to ImplementationModuleName, but uses the Make variant of the module
1479// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1480// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1481// under the premise that the prebuilt module overrides its source counterpart
1482// if it is exposed to Make).
1483func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1484 name := c.BaseModuleName()
1485 if versioned, ok := c.linker.(versionedInterface); ok {
1486 name = versioned.implementationModuleName(name)
1487 }
1488 return name
1489}
1490
Jiyong Park7d55b612021-06-11 17:22:09 +09001491func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001492 return Bool(c.Properties.Bootstrap)
1493}
1494
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001495func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001496 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1497 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1498 return false
1499 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001500 return c.linker != nil && c.linker.nativeCoverage()
1501}
1502
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001503func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001504 if p, ok := c.linker.(SnapshotInterface); ok {
1505 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001506 }
1507 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001508}
1509
Jiyong Parkf1194352019-02-25 11:05:47 +09001510func isBionic(name string) bool {
1511 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001512 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001513 return true
1514 }
1515 return false
1516}
1517
Martin Stjernholm279de572019-09-10 23:18:20 +01001518func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001519 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001520 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001521 }
1522 return isBionic(name)
1523}
1524
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001525func (c *Module) XrefCcFiles() android.Paths {
1526 return c.kytheFiles
1527}
1528
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001529func (c *Module) isCfiAssemblySupportEnabled() bool {
1530 return c.sanitize != nil &&
1531 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1532}
1533
Inseob Kim800d1142021-06-14 12:03:51 +09001534func (c *Module) InstallInRoot() bool {
1535 return c.installer != nil && c.installer.installInRoot()
1536}
1537
Colin Crossca860ac2016-01-04 14:34:37 -08001538type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001539 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001540 moduleContextImpl
1541}
1542
Colin Cross37047f12016-12-13 17:06:13 -08001543type depsContext struct {
1544 android.BottomUpMutatorContext
1545 moduleContextImpl
1546}
1547
Colin Crossca860ac2016-01-04 14:34:37 -08001548type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001549 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001550 moduleContextImpl
1551}
1552
1553type moduleContextImpl struct {
1554 mod *Module
1555 ctx BaseModuleContext
1556}
1557
Colin Crossb98c8b02016-07-29 13:44:28 -07001558func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001559 return ctx.mod.toolchain(ctx.ctx)
1560}
1561
1562func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001563 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001564}
1565
1566func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001567 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001568}
1569
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001570func (ctx *moduleContextImpl) testBinary() bool {
1571 return ctx.mod.testBinary()
1572}
1573
Yi Kong56fc1b62022-09-06 16:24:00 +08001574func (ctx *moduleContextImpl) testLibrary() bool {
1575 return ctx.mod.testLibrary()
1576}
1577
Jiyong Park1d1119f2019-07-29 21:27:18 +09001578func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001579 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001580}
1581
Inseob Kim7f283f42020-06-01 21:53:49 +09001582func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001583 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001584}
1585
Inseob Kim1042d292020-06-01 23:23:05 +09001586func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001587 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001588}
1589
Jooyung Hanccce2f22020-03-07 03:45:53 +09001590func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001591 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001592}
1593
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001594func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001595 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001596}
1597
1598func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001599 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001600 config := ctx.ctx.Config()
1601 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001602 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001603 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001604 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001605 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001606 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001607 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001608 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001609 }
1610 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001611}
1612
Jiyong Parkb35a8192020-08-10 15:59:36 +09001613func (ctx *moduleContextImpl) minSdkVersion() string {
1614 ver := ctx.mod.MinSdkVersion()
1615 if ver == "apex_inherit" && !ctx.isForPlatform() {
1616 ver = ctx.apexSdkVersion().String()
1617 }
1618 if ver == "apex_inherit" || ver == "" {
1619 ver = ctx.sdkVersion()
1620 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001621
1622 if ctx.ctx.Device() {
1623 config := ctx.ctx.Config()
1624 if config.IsVndkDeprecated() && ctx.inVendor() {
1625 // If building for vendor with final API, then use the latest _stable_ API as "current".
1626 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1627 ver = config.PlatformSdkVersion().String()
1628 }
1629 }
1630 }
1631
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001632 // For crt objects, the meaning of min_sdk_version is very different from other types of
1633 // module. For them, min_sdk_version defines the oldest version that the build system will
1634 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1635 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1636 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001637 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1638 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1639 // support such an old version. The version is set to the later version in case when the
1640 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1641 // it's for an APEX.
1642 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1643 if ctx.isForPlatform() {
1644 ver = strconv.Itoa(android.FutureApiLevelInt)
1645 } else { // for apex
1646 ver = ctx.apexSdkVersion().String()
1647 if ver == "" { // in case when min_sdk_version was not set by the APEX
1648 ver = ctx.sdkVersion()
1649 }
1650 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001651 }
1652
Jiyong Parkb35a8192020-08-10 15:59:36 +09001653 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1654 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1655 minSdkVersionInt, err2 := strconv.Atoi(ver)
1656 if err == nil && err2 == nil {
1657 if sdkVersionInt < minSdkVersionInt {
1658 return strconv.Itoa(sdkVersionInt)
1659 }
1660 }
1661 return ver
1662}
1663
1664func (ctx *moduleContextImpl) isSdkVariant() bool {
1665 return ctx.mod.IsSdkVariant()
1666}
1667
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001668func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001669 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001670}
Justin Yun8effde42017-06-23 19:24:43 +09001671
Kiyoung Kimaa394802024-01-08 12:55:45 +09001672func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1673 return ctx.mod.InVendorOrProduct()
1674}
1675
Colin Cross95f1ca02020-10-29 20:47:22 -07001676func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1677 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001678}
1679
Colin Cross127bb8b2020-12-16 16:46:01 -08001680func (ctx *moduleContextImpl) IsLlndk() bool {
1681 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001682}
1683
Colin Cross127bb8b2020-12-16 16:46:01 -08001684func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1685 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001686}
1687
Colin Cross127bb8b2020-12-16 16:46:01 -08001688func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1689 return ctx.mod.isImplementationForLLNDKPublic()
1690}
1691
1692func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1693 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001694}
1695
Logan Chienf3511742017-10-31 18:04:35 +08001696func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001697 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001698}
1699
Colin Cross3513fb12024-01-24 14:44:47 -08001700func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1701 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001702}
1703
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001704func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1705 return ctx.mod.isOrderfileCompile()
1706}
1707
Yi Kongc702ebd2022-08-19 16:02:45 +08001708func (ctx *moduleContextImpl) isCfi() bool {
1709 return ctx.mod.isCfi()
1710}
1711
Yi Konged79fa32023-06-04 17:15:42 +09001712func (ctx *moduleContextImpl) isFuzzer() bool {
1713 return ctx.mod.isFuzzer()
1714}
1715
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001716func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1717 return ctx.mod.isNDKStubLibrary()
1718}
1719
Justin Yun8effde42017-06-23 19:24:43 +09001720func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001721 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001722}
1723
Ivan Lozanof9e21722020-12-02 09:00:51 -05001724func (ctx *moduleContextImpl) IsVndkExt() bool {
1725 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001726}
1727
Colin Cross5271fea2021-04-27 13:06:04 -07001728func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1729 return ctx.mod.IsVendorPublicLibrary()
1730}
1731
Vic Yangefd249e2018-11-12 20:19:56 -08001732func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001733 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001734}
1735
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001736func (ctx *moduleContextImpl) selectedStl() string {
1737 if stl := ctx.mod.stl; stl != nil {
1738 return stl.Properties.SelectedStl
1739 }
1740 return ""
1741}
1742
Ivan Lozanobd721262018-11-27 14:33:03 -08001743func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1744 return ctx.mod.linker.useClangLld(actx)
1745}
1746
Colin Crossce75d2c2016-10-06 16:12:58 -07001747func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001748 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001749}
1750
Logan Chienf3511742017-10-31 18:04:35 +08001751func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1752 return ctx.mod.getVndkExtendsModuleName()
1753}
1754
Logan Chiene274fc92019-12-03 11:18:32 -08001755func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001756 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1757 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001758}
1759
Colin Crosse07f2312020-08-13 11:24:56 -07001760func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001761 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1762 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001763}
1764
Dan Albertc8060532020-07-22 22:32:17 -07001765func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001766 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001767}
1768
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001769func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001770 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001771}
1772
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001773func (ctx *moduleContextImpl) nativeCoverage() bool {
1774 return ctx.mod.nativeCoverage()
1775}
1776
Colin Cross56a83212020-09-15 18:30:11 -07001777func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1778 return ctx.mod.DirectlyInAnyApex()
1779}
1780
Colin Cross95b07f22020-12-16 11:06:50 -08001781func (ctx *moduleContextImpl) isPreventInstall() bool {
1782 return ctx.mod.Properties.PreventInstall
1783}
1784
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001785func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1786 shared := &ctx.mod.sharedFlags
1787 if shared.flagsMap == nil {
1788 shared.numSharedFlags = 0
1789 shared.flagsMap = make(map[string]string)
1790 }
1791 return shared
1792}
1793
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001794func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1795 return ctx.mod.isCfiAssemblySupportEnabled()
1796}
1797
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001798func (ctx *moduleContextImpl) notInPlatform() bool {
1799 return ctx.mod.NotInPlatform()
1800}
1801
Colin Cross635c3b02016-05-18 15:37:25 -07001802func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001803 return &Module{
1804 hod: hod,
1805 multilib: multilib,
1806 }
1807}
1808
Colin Cross635c3b02016-05-18 15:37:25 -07001809func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001810 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001811 module.features = []feature{
1812 &tidyFeature{},
1813 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001814 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001815 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001816 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001817 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001818 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001819 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001820 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001821 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001822 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001823 return module
1824}
1825
Colin Crossce75d2c2016-10-06 16:12:58 -07001826func (c *Module) Prebuilt() *android.Prebuilt {
1827 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1828 return p.prebuilt()
1829 }
1830 return nil
1831}
1832
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001833func (c *Module) IsPrebuilt() bool {
1834 return c.Prebuilt() != nil
1835}
1836
Colin Crossce75d2c2016-10-06 16:12:58 -07001837func (c *Module) Name() string {
1838 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001839 if p, ok := c.linker.(interface {
1840 Name(string) string
1841 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001842 name = p.Name(name)
1843 }
1844 return name
1845}
1846
Alex Light3d673592019-01-18 14:37:31 -08001847func (c *Module) Symlinks() []string {
1848 if p, ok := c.installer.(interface {
1849 symlinkList() []string
1850 }); ok {
1851 return p.symlinkList()
1852 }
1853 return nil
1854}
1855
Roland Levillainf89cd092019-07-29 16:22:59 +01001856func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1857 test, ok := c.linker.(testPerSrc)
1858 return ok && test.isAllTestsVariation()
1859}
1860
Chris Parsons216e10a2020-07-09 17:12:52 -04001861func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001862 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001863 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001864 }); ok {
1865 return p.dataPaths()
1866 }
1867 return nil
1868}
1869
Ivan Lozanof1868af2022-04-12 13:08:36 -04001870func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001871 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1872 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001873 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001874 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001875 if c.ProductSpecific() {
1876 // If the module is product specific with 'product_specific: true',
1877 // do not add a name suffix because it is a base module.
1878 return ""
1879 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001880 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001881 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001882 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001883 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001884 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001885 // add version suffix only if the module is using different vndk version than the
1886 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001887 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001888 }
1889 return nameSuffix
1890}
1891
Ivan Lozanof1868af2022-04-12 13:08:36 -04001892func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1893 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001894
1895 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001896 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001897 }
1898
Colin Cross127bb8b2020-12-16 16:46:01 -08001899 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001900 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001901 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1902 // added for product variant only when we have vendor and product variants with core
1903 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001904 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001905 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001906 subName += vendorPublicLibrarySuffix
1907 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001908 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1909 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001910 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001911 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001912 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001913 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001914 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001915 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001916 subName += RecoverySuffix
1917 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1918 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001919 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001920 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001921 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001922 } else if c.IsStubs() && c.IsSdkVariant() {
1923 // Public API surface (NDK)
1924 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1925 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001926 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001927
1928 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001929}
1930
Sam Delmerico75dbca22023-04-20 13:13:25 +00001931func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1932 ctx := &moduleContext{
1933 ModuleContext: actx,
1934 moduleContextImpl: moduleContextImpl{
1935 mod: c,
1936 },
1937 }
1938 ctx.ctx = ctx
1939 return ctx
1940}
1941
Spandan Das20fce2d2023-04-12 17:21:39 +00001942// TODO (b/277651159): Remove this allowlist
1943var (
1944 skipStubLibraryMultipleApexViolation = map[string]bool{
1945 "libclang_rt.asan": true,
1946 "libclang_rt.hwasan": true,
1947 // runtime apex
1948 "libc": true,
1949 "libc_hwasan": true,
1950 "libdl_android": true,
1951 "libm": true,
1952 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001953 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001954 // art apex
1955 "libandroidio": true,
1956 "libdexfile": true,
1957 "libnativebridge": true,
1958 "libnativehelper": true,
1959 "libnativeloader": true,
1960 "libsigchain": true,
1961 }
1962)
1963
1964// Returns true if a stub library could be installed in multiple apexes
1965func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1966 // If this is not an apex variant, no check necessary
1967 if !c.InAnyApex() {
1968 return false
1969 }
1970 // If this is not a stub library, no check necessary
1971 if !c.HasStubsVariants() {
1972 return false
1973 }
1974 // Skip the allowlist
1975 // Use BaseModuleName so that this matches prebuilts.
1976 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1977 return false
1978 }
1979
1980 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1981 // Stub libraries should not have more than one apex_available
1982 if len(aaWithoutTestApexes) > 1 {
1983 return true
1984 }
1985 // Stub libraries should not use the wildcard
1986 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
1987 return true
1988 }
1989 // Default: no violation
1990 return false
1991}
1992
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001993func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1994 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
1995}
1996
Chris Parsons8d6e4332021-02-22 16:13:50 -05001997func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07001998 ctx := moduleContextFromAndroidModuleContext(actx, c)
1999
2000 // If Test_only is set on a module in bp file, respect the setting, otherwise
2001 // see if is a known test module type.
2002 testOnly := c.testModule || c.testLibrary()
2003 if c.sourceProperties.Test_only != nil {
2004 testOnly = Bool(c.sourceProperties.Test_only)
2005 }
2006 // Keep before any early returns.
2007 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2008 TestOnly: testOnly,
2009 TopLevelTarget: c.testModule,
2010 })
2011
Chris Parsons8d6e4332021-02-22 16:13:50 -05002012 // Handle the case of a test module split by `test_per_src` mutator.
2013 //
2014 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2015 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2016 // module and return early, as this module does not produce an output file per se.
2017 if c.IsTestPerSrcAllTestsVariation() {
2018 c.outputFile = android.OptionalPath{}
2019 return
2020 }
2021
Ivan Lozanof1868af2022-04-12 13:08:36 -04002022 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002023 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002024 if !apexInfo.IsForPlatform() {
2025 c.hideApexVariantFromMake = true
2026 }
2027
Chris Parsonseefc9e62021-04-02 17:36:47 -04002028 c.makeLinkType = GetMakeLinkType(actx, c)
2029
Colin Crossf18e1102017-11-16 14:33:08 -08002030 deps := c.depsToPaths(ctx)
2031 if ctx.Failed() {
2032 return
2033 }
2034
Joe Onorato37f900c2023-07-18 16:58:16 -07002035 for _, generator := range c.generators {
2036 gen := generator.GeneratorSources(ctx)
2037 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2038 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2039 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2040 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2041 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2042 if len(deps.Objs.objFiles) == 0 {
2043 // If we are reusuing object files (which happens when we're a shared library and we're
2044 // reusing our static variant's object files), then skip adding the actual source files,
2045 // because we already have the object for it.
2046 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2047 }
2048 }
2049
2050 if ctx.Failed() {
2051 return
2052 }
2053
Spandan Das20fce2d2023-04-12 17:21:39 +00002054 if c.stubLibraryMultipleApexViolation(actx) {
2055 actx.PropertyErrorf("apex_available",
2056 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2057 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002058 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2059 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002060 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2061 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002062 }
2063
Colin Crossca860ac2016-01-04 14:34:37 -08002064 flags := Flags{
2065 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002066 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002067 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002068 for _, generator := range c.generators {
2069 flags = generator.GeneratorFlags(ctx, flags, deps)
2070 }
Colin Crossca860ac2016-01-04 14:34:37 -08002071 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002072 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002073 }
2074 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002075 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002076 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002077 if c.stl != nil {
2078 flags = c.stl.flags(ctx, flags)
2079 }
Colin Cross16b23492016-01-06 14:41:07 -08002080 if c.sanitize != nil {
2081 flags = c.sanitize.flags(ctx, flags)
2082 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002083 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002084 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002085 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002086 if c.fuzzer != nil {
2087 flags = c.fuzzer.flags(ctx, flags)
2088 }
Stephen Craneba090d12017-05-09 15:44:35 -07002089 if c.lto != nil {
2090 flags = c.lto.flags(ctx, flags)
2091 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002092 if c.afdo != nil {
2093 flags = c.afdo.flags(ctx, flags)
2094 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002095 if c.orderfile != nil {
2096 flags = c.orderfile.flags(ctx, flags)
2097 }
Colin Crossca860ac2016-01-04 14:34:37 -08002098 for _, feature := range c.features {
2099 flags = feature.flags(ctx, flags)
2100 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002101 if ctx.Failed() {
2102 return
2103 }
2104
Colin Cross4af21ed2019-11-04 09:37:55 -08002105 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2106 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2107 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002108
Colin Cross4af21ed2019-11-04 09:37:55 -08002109 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002110
2111 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002112 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002113 }
2114 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002115 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002116 }
2117
Colin Cross3e5e7782022-06-17 22:17:05 +00002118 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2119
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002120 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002121 // We need access to all the flags seen by a source file.
2122 if c.sabi != nil {
2123 flags = c.sabi.flags(ctx, flags)
2124 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002125
Colin Cross4af21ed2019-11-04 09:37:55 -08002126 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002127
Joe Onorato37f900c2023-07-18 16:58:16 -07002128 for _, generator := range c.generators {
2129 generator.GeneratorBuildActions(ctx, flags, deps)
2130 }
2131
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002132 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002133 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002134 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002135 if ctx.Failed() {
2136 return
2137 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002138 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002139 c.objFiles = objs.objFiles
2140 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002141 }
2142
Colin Crossca860ac2016-01-04 14:34:37 -08002143 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002144 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002145 if ctx.Failed() {
2146 return
2147 }
Colin Cross635c3b02016-05-18 15:37:25 -07002148 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002149
Chris Parsons94a0bba2021-06-04 15:03:47 -04002150 c.maybeUnhideFromMake()
Colin Crossce75d2c2016-10-06 16:12:58 -07002151 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002152 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002153 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002154 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002155
Colin Cross40213022023-12-13 15:19:49 -08002156 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002157
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002158 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002159
Chris Parsons94a0bba2021-06-04 15:03:47 -04002160 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002161
2162 if c.linker != nil {
2163 moduleInfoJSON := ctx.ModuleInfoJSON()
2164 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2165 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2166 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2167 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2168 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2169
2170 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2171 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2172 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2173 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2174
2175 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2176 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2177 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2178 moduleInfoJSON.SubName += ".cfi"
2179 }
2180 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2181 moduleInfoJSON.SubName += ".hwasan"
2182 }
2183 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2184 moduleInfoJSON.SubName += ".scs"
2185 }
2186 }
2187 moduleInfoJSON.SubName += c.Properties.SubName
2188
2189 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2190 moduleInfoJSON.Uninstallable = true
2191 }
2192
2193 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002194}
2195
2196func (c *Module) maybeUnhideFromMake() {
2197 // If a lib is directly included in any of the APEXes or is not available to the
2198 // platform (which is often the case when the stub is provided as a prebuilt),
2199 // unhide the stubs variant having the latest version gets visible to make. In
2200 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2201 // force anything in the make world to link against the stubs library. (unless it
2202 // is explicitly referenced via .bootstrap suffix or the module is marked with
2203 // 'bootstrap: true').
2204 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002205 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002206 c.IsStubs() && !c.InVendorRamdisk() {
2207 c.Properties.HideFromMake = false // unhide
2208 // Note: this is still non-installable
2209 }
2210}
2211
Colin Cross8ff10582023-12-07 13:10:56 -08002212// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2213// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002214func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002215 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002216 // If the module has been specifically configure to not be installed then
2217 // hide from make as otherwise it will break when running inside make
2218 // as the output path to install will not be specified. Not all uninstallable
2219 // modules can be hidden from make as some are needed for resolving make side
2220 // dependencies.
2221 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002222 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002223 c.SkipInstall()
2224 }
2225
2226 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2227 // to allow using the outputs in a genrule.
2228 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002229 c.installer.install(ctx, c.outputFile.Path())
2230 if ctx.Failed() {
2231 return
Colin Crossca860ac2016-01-04 14:34:37 -08002232 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002233 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002234}
2235
Colin Cross0ea8ba82019-06-06 14:33:29 -07002236func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002237 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002238 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002239 }
Colin Crossca860ac2016-01-04 14:34:37 -08002240 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002241}
2242
Colin Crossca860ac2016-01-04 14:34:37 -08002243func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002244 for _, generator := range c.generators {
2245 generator.GeneratorInit(ctx)
2246 }
Colin Crossca860ac2016-01-04 14:34:37 -08002247 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002248 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002249 }
Colin Crossca860ac2016-01-04 14:34:37 -08002250 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002251 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002252 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002253 if c.stl != nil {
2254 c.stl.begin(ctx)
2255 }
Colin Cross16b23492016-01-06 14:41:07 -08002256 if c.sanitize != nil {
2257 c.sanitize.begin(ctx)
2258 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002259 if c.coverage != nil {
2260 c.coverage.begin(ctx)
2261 }
Yi Kong9723e332023-12-04 14:52:53 +09002262 if c.afdo != nil {
2263 c.afdo.begin(ctx)
2264 }
Stephen Craneba090d12017-05-09 15:44:35 -07002265 if c.lto != nil {
2266 c.lto.begin(ctx)
2267 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002268 if c.orderfile != nil {
2269 c.orderfile.begin(ctx)
2270 }
Dan Albert92fe7402020-07-15 13:33:30 -07002271 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002272 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002273 if err != nil {
2274 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002275 c.Properties.Sdk_version = nil
2276 } else {
2277 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002278 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002279 }
Colin Crossca860ac2016-01-04 14:34:37 -08002280}
2281
Colin Cross37047f12016-12-13 17:06:13 -08002282func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002283 deps := Deps{}
2284
Joe Onorato37f900c2023-07-18 16:58:16 -07002285 for _, generator := range c.generators {
2286 deps = generator.GeneratorDeps(ctx, deps)
2287 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002288 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002289 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002290 }
2291 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002292 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002293 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002294 if c.stl != nil {
2295 deps = c.stl.deps(ctx, deps)
2296 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002297 if c.coverage != nil {
2298 deps = c.coverage.deps(ctx, deps)
2299 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002300
Colin Crossb6715442017-10-24 11:13:31 -07002301 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2302 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2303 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2304 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2305 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2306 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002307 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002308 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002309
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002310 for _, lib := range deps.ReexportSharedLibHeaders {
2311 if !inList(lib, deps.SharedLibs) {
2312 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2313 }
2314 }
2315
2316 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002317 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2318 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 -07002319 }
2320 }
2321
Colin Cross5950f382016-12-13 12:50:57 -08002322 for _, lib := range deps.ReexportHeaderLibHeaders {
2323 if !inList(lib, deps.HeaderLibs) {
2324 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2325 }
2326 }
2327
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002328 for _, gen := range deps.ReexportGeneratedHeaders {
2329 if !inList(gen, deps.GeneratedHeaders) {
2330 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2331 }
2332 }
2333
Colin Crossc99deeb2016-04-11 15:06:20 -07002334 return deps
2335}
2336
Dan Albert7e9d2952016-08-04 13:02:36 -07002337func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002338 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002339 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002340 moduleContextImpl: moduleContextImpl{
2341 mod: c,
2342 },
2343 }
2344 ctx.ctx = ctx
2345
Colin Crossca860ac2016-01-04 14:34:37 -08002346 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002347}
2348
Jiyong Park7ed9de32018-10-15 22:25:07 +09002349// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002350func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002351 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2352 version := name[sharp+1:]
2353 libname := name[:sharp]
2354 return libname, version
2355 }
2356 return name, ""
2357}
2358
Dan Albert92fe7402020-07-15 13:33:30 -07002359func GetCrtVariations(ctx android.BottomUpMutatorContext,
2360 m LinkableInterface) []blueprint.Variation {
2361 if ctx.Os() != android.Android {
2362 return nil
2363 }
2364 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002365 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2366 minSdkVersion := m.MinSdkVersion()
2367 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2368 minSdkVersion = m.SdkVersion()
2369 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002370 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2371 if err != nil {
2372 ctx.PropertyErrorf("min_sdk_version", err.Error())
2373 }
Colin Cross363ec762023-01-13 13:45:14 -08002374
2375 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002376 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002377 if apiLevel.LessThan(minApiForArch) {
2378 apiLevel = minApiForArch
2379 }
2380
Dan Albert92fe7402020-07-15 13:33:30 -07002381 return []blueprint.Variation{
2382 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002383 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002384 }
2385 }
2386 return []blueprint.Variation{
2387 {Mutator: "sdk", Variation: ""},
2388 }
2389}
2390
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002391func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2392 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002393
2394 variations = append([]blueprint.Variation(nil), variations...)
2395
Liz Kammer23942242022-04-08 15:41:00 -04002396 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002397 // Version is explicitly specified. i.e. libFoo#30
2398 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002399 if tag, ok := depTag.(libraryDependencyTag); ok {
2400 tag.explicitlyVersioned = true
2401 } else {
2402 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2403 }
Colin Crosse7257d22020-09-24 09:56:18 -07002404 }
Colin Crosse7257d22020-09-24 09:56:18 -07002405
Colin Cross0de8a1e2020-09-18 14:15:30 -07002406 if far {
2407 ctx.AddFarVariationDependencies(variations, depTag, name)
2408 } else {
2409 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002410 }
2411}
2412
Kiyoung Kim487689e2022-07-26 09:48:22 +09002413func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2414 apiImportInfo := multitree.ApiImportInfo{}
2415
2416 if c.Device() {
2417 var apiImportModule []blueprint.Module
2418 if actx.OtherModuleExists("api_imports") {
2419 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2420 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002421 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002422 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002423 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002424 }
2425 }
2426 }
2427
2428 return apiImportInfo
2429}
2430
Kiyoung Kim487689e2022-07-26 09:48:22 +09002431func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2432 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002433 return snapshot
2434 }
2435
2436 return lib
2437}
2438
Kiyoung Kim37693d02024-04-04 09:56:15 +09002439// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002440// of names:
2441//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002442// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002443//
2444// For each of these, it adds the name of the ndk_library module to the list of
2445// variant libs.
2446//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002447// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002448//
2449// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002450//
2451// The caller can then know to add the variantLibs dependencies differently from the
2452// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002453func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002454 variantLibs = []string{}
2455
2456 nonvariantLibs = []string{}
2457 for _, entry := range list {
2458 // strip #version suffix out
2459 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002460 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002461 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002462 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002463 nonvariantLibs = append(nonvariantLibs, entry)
2464 }
2465 }
2466 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002467
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002468}
2469
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002470func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2471 nonVariantLibs := []string{}
2472 variantLibs := []string{}
2473
2474 for _, lib := range libs {
2475 replaceLibName := GetReplaceModuleName(lib, replaceList)
2476 if replaceLibName == lib {
2477 // Do not handle any libs which are not in API imports
2478 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2479 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2480 variantLibs = append(variantLibs, replaceLibName)
2481 } else {
2482 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2483 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002484 }
2485
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002486 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002487}
2488
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002489func (c *Module) shouldUseApiSurface() bool {
2490 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2491 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2492 // LLNDK Variant
2493 return true
2494 }
2495
2496 if c.Properties.IsSdkVariant {
2497 // NDK Variant
2498 return true
2499 }
2500
2501 if c.isImportedApiLibrary() {
2502 // API Library should depend on API headers
2503 return true
2504 }
2505 }
2506
2507 return false
2508}
2509
Colin Cross1e676be2016-10-12 14:38:15 -07002510func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002511 if !c.Enabled() {
2512 return
2513 }
2514
Colin Cross37047f12016-12-13 17:06:13 -08002515 ctx := &depsContext{
2516 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002517 moduleContextImpl: moduleContextImpl{
2518 mod: c,
2519 },
2520 }
2521 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002522
Colin Crossc99deeb2016-04-11 15:06:20 -07002523 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002524 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002525
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002526 apiNdkLibs := []string{}
2527 apiLateNdkLibs := []string{}
2528
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002529 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002530 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2531 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2532 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2533 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2534 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002535 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002536
Yo Chiang219968c2020-09-22 18:45:04 +08002537 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2538
Dan Albert914449f2016-06-17 16:45:24 -07002539 variantNdkLibs := []string{}
2540 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002541 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002542 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2543 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2544 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002545 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002546
Colin Cross32ec36c2016-12-15 07:39:51 -08002547 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002548 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002549 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002550 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002551 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002552
Kiyoung Kim51279d32022-08-24 14:10:46 +09002553 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002554 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002555 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2556 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002557
Spandan Das73bcafc2022-08-18 23:26:00 +00002558 if c.isNDKStubLibrary() {
2559 // ndk_headers do not have any variations
2560 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002561 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002562 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002563 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002564 } else {
2565 actx.AddVariationDependencies(nil, depTag, lib)
2566 }
2567 }
2568
Dan Albertf1d14c72020-07-30 14:32:55 -07002569 if c.isNDKStubLibrary() {
2570 // NDK stubs depend on their implementation because the ABI dumps are
2571 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002572
Spandan Das8b08aea2023-03-14 19:29:34 +00002573 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2574 c.ImageVariation(),
2575 blueprint.Variation{Mutator: "link", Variation: "shared"},
2576 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002577 }
2578
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002579 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2580 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2581 c.Target().NativeBridge == android.NativeBridgeDisabled {
2582 actx.AddVariationDependencies(
2583 []blueprint.Variation{{Mutator: "image", Variation: VendorVariation}},
2584 llndkHeaderLibTag,
2585 deps.LlndkHeaderLibs...)
2586 }
2587
Jiyong Park5d1598f2019-02-25 22:14:17 +09002588 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002589 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002590
Jiyong Park5d1598f2019-02-25 22:14:17 +09002591 actx.AddVariationDependencies([]blueprint.Variation{
2592 {Mutator: "link", Variation: "static"},
2593 }, depTag, lib)
2594 }
2595
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002596 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002597 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002598 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002599 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002600 }
Jiyong Parke3867542020-12-03 17:28:25 +09002601 if inList(lib, deps.ExcludeLibsForApex) {
2602 depTag.excludeInApex = true
2603 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002604
Dan Willemsen59339a22018-07-22 21:18:45 -07002605 actx.AddVariationDependencies([]blueprint.Variation{
2606 {Mutator: "link", Variation: "static"},
2607 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002608 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002609
Jooyung Han75568392020-03-20 04:29:24 +09002610 // staticUnwinderDep is treated as staticDep for Q apexes
2611 // so that native libraries/binaries are linked with static unwinder
2612 // because Q libc doesn't have unwinder APIs
2613 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002614 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002615 actx.AddVariationDependencies([]blueprint.Variation{
2616 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002617 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002618 }
2619
Jiyong Park7ed9de32018-10-15 22:25:07 +09002620 // shared lib names without the #version suffix
2621 var sharedLibNames []string
2622
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002623 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002624 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002625 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002626 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002627 }
Jiyong Parke3867542020-12-03 17:28:25 +09002628 if inList(lib, deps.ExcludeLibsForApex) {
2629 depTag.excludeInApex = true
2630 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002631 if inList(lib, deps.ExcludeLibsForNonApex) {
2632 depTag.excludeInNonApex = true
2633 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002634
Jiyong Park73c54ee2019-10-22 20:31:18 +09002635 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002636 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2637 name = apiLibraryName
2638 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002639 sharedLibNames = append(sharedLibNames, name)
2640
Colin Crosse7257d22020-09-24 09:56:18 -07002641 variations := []blueprint.Variation{
2642 {Mutator: "link", Variation: "shared"},
2643 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002644
2645 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2646 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2647 }
2648
2649 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2650 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2651 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002652 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002653
Colin Crossfe9acfe2021-06-14 16:13:03 -07002654 for _, lib := range deps.LateStaticLibs {
2655 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2656 actx.AddVariationDependencies([]blueprint.Variation{
2657 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002658 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002659 }
2660
Colin Cross3e5e7782022-06-17 22:17:05 +00002661 for _, lib := range deps.UnexportedStaticLibs {
2662 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2663 actx.AddVariationDependencies([]blueprint.Variation{
2664 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002665 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002666 }
2667
Jiyong Park7ed9de32018-10-15 22:25:07 +09002668 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002669 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002670 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2671 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2672 // linking against both the stubs lib and the non-stubs lib at the same time.
2673 continue
2674 }
Colin Cross6e511a92020-07-27 21:26:48 -07002675 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002676 variations := []blueprint.Variation{
2677 {Mutator: "link", Variation: "shared"},
2678 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002679 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002680 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002681
Dan Willemsen59339a22018-07-22 21:18:45 -07002682 actx.AddVariationDependencies([]blueprint.Variation{
2683 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002684 }, dataLibDepTag, deps.DataLibs...)
2685
Colin Crossc8caa062021-09-24 16:50:14 -07002686 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2687
Chris Parsons79d66a52020-06-05 17:26:16 -04002688 actx.AddVariationDependencies([]blueprint.Variation{
2689 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002690 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002691
Colin Cross68861832016-07-08 10:41:41 -07002692 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002693
2694 for _, gen := range deps.GeneratedHeaders {
2695 depTag := genHeaderDepTag
2696 if inList(gen, deps.ReexportGeneratedHeaders) {
2697 depTag = genHeaderExportDepTag
2698 }
2699 actx.AddDependency(c, depTag, gen)
2700 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002701
Dan Albert92fe7402020-07-15 13:33:30 -07002702 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002703 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002704 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002705 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002706 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08002707 }
Colin Crossc465efd2021-06-11 18:00:04 -07002708 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002709 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002710 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07002711 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002712 if deps.DynamicLinker != "" {
2713 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002714 }
Dan Albert914449f2016-06-17 16:45:24 -07002715
2716 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002717
2718 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002719 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002720 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002721 {Mutator: "link", Variation: "shared"},
2722 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002723 actx.AddVariationDependencies([]blueprint.Variation{
2724 {Mutator: "version", Variation: version},
2725 {Mutator: "link", Variation: "shared"},
2726 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002727
2728 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002729 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002730 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002731 {Mutator: "link", Variation: "shared"},
2732 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002733 actx.AddVariationDependencies([]blueprint.Variation{
2734 {Mutator: "version", Variation: version},
2735 {Mutator: "link", Variation: "shared"},
2736 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002737
2738 if vndkdep := c.vndkdep; vndkdep != nil {
2739 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002740 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002741 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002742 {Mutator: "link", Variation: "shared"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002743 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002744 }
2745 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002746
Vinh Tran367d89d2023-04-28 11:21:25 -04002747 if len(deps.AidlLibs) > 0 {
2748 actx.AddDependency(
2749 c,
2750 aidlLibraryTag,
2751 deps.AidlLibs...,
2752 )
2753 }
2754
Kiyoung Kimee58c932022-10-25 22:59:41 +09002755 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002756}
Colin Cross21b9a242015-03-24 14:15:58 -07002757
Colin Crosse40b4ea2018-10-02 22:25:58 -07002758func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002759 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2760 c.beginMutator(ctx)
2761 }
2762}
2763
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002764// Whether a module can link to another module, taking into
2765// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002766func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002767 tag blueprint.DependencyTag) {
2768
2769 switch t := tag.(type) {
2770 case dependencyTag:
2771 if t != vndkExtDepTag {
2772 return
2773 }
2774 case libraryDependencyTag:
2775 default:
2776 return
2777 }
2778
Ivan Lozanof9e21722020-12-02 09:00:51 -05002779 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002780 // Host code is not restricted
2781 return
2782 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002783
2784 // VNDK is cc.Module supported only for now.
2785 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002786 // Though allowed dependency is limited by the image mutator,
2787 // each vendor and product module needs to check link-type
2788 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002789 if ccTo, ok := to.(*Module); ok {
2790 if ccFrom.vndkdep != nil {
2791 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2792 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002793 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002794 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002795 }
2796 return
2797 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002798 // TODO(b/244244438) : Remove this once all variants are implemented
2799 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2800 return
2801 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002802 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002803 // Platform code can link to anything
2804 return
2805 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002806 if from.InRamdisk() {
2807 // Ramdisk code is not NDK
2808 return
2809 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002810 if from.InVendorRamdisk() {
2811 // Vendor ramdisk code is not NDK
2812 return
2813 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002814 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002815 // Recovery code is not NDK
2816 return
2817 }
Colin Cross31076b32020-10-23 17:22:06 -07002818 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002819 if c.NdkPrebuiltStl() {
2820 // These are allowed, but they don't set sdk_version
2821 return
2822 }
2823 if c.StubDecorator() {
2824 // These aren't real libraries, but are the stub shared libraries that are included in
2825 // the NDK.
2826 return
2827 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002828 if c.isImportedApiLibrary() {
2829 // Imported library from the API surface is a stub library built against interface definition.
2830 return
2831 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002832 }
Logan Chien834b9a62019-01-14 15:39:03 +08002833
Ivan Lozano52767be2019-10-18 14:49:46 -07002834 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002835 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2836 // to link to libc++ (non-NDK and without sdk_version).
2837 return
2838 }
2839
Ivan Lozano52767be2019-10-18 14:49:46 -07002840 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002841 // NDK code linking to platform code is never okay.
2842 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002843 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002844 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002845 }
2846
2847 // At this point we know we have two NDK libraries, but we need to
2848 // check that we're not linking against anything built against a higher
2849 // API level, as it is only valid to link against older or equivalent
2850 // APIs.
2851
Inseob Kim01a28722018-04-11 09:48:45 +09002852 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002853 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002854 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002855 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002856 // Current can't be linked against by anything else.
2857 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002858 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002859 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002860 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002861 if err != nil {
2862 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002863 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002864 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002865 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002866 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002867 if err != nil {
2868 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002869 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002870 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002871 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002872
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002873 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002874 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002875 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002876 }
2877 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002878 }
Dan Albert202fe492017-12-15 13:56:59 -08002879
2880 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002881 fromStl := from.SelectedStl()
2882 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002883 if fromStl == "" || toStl == "" {
2884 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002885 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002886 // We can be permissive with the system "STL" since it is only the C++
2887 // ABI layer, but in the future we should make sure that everyone is
2888 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002889 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002890 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002891 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2892 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002893 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002894}
2895
Jooyung Han479ca172020-10-19 18:51:07 +09002896func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2897 if c, ok := ctx.Module().(*Module); ok {
2898 ctx.VisitDirectDeps(func(dep android.Module) {
2899 depTag := ctx.OtherModuleDependencyTag(dep)
2900 ccDep, ok := dep.(LinkableInterface)
2901 if ok {
2902 checkLinkType(ctx, c, ccDep, depTag)
2903 }
2904 })
2905 }
2906}
2907
Jiyong Park5fb8c102018-04-09 12:03:06 +09002908// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002909// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2910// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002911// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002912func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2913 check := func(child, parent android.Module) bool {
2914 to, ok := child.(*Module)
2915 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002916 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002917 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002918
Jooyung Hana70f0672019-01-18 15:20:43 +09002919 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2920 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002921 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002922
Jiyong Park0474e1f2021-01-14 14:26:06 +09002923 // These dependencies are not excercised at runtime. Tracking these will give us
2924 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002925 depTag := ctx.OtherModuleDependencyTag(child)
2926 if IsHeaderDepTag(depTag) {
2927 return false
2928 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002929 if depTag == staticVariantTag {
2930 return false
2931 }
2932 if depTag == stubImplDepTag {
2933 return false
2934 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002935 if depTag == android.RequiredDepTag {
2936 return false
2937 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002938
Justin Yun63e9ec72020-10-29 16:49:43 +09002939 // Even if target lib has no vendor variant, keep checking dependency
2940 // graph in case it depends on vendor_available or product_available
2941 // but not double_loadable transtively.
2942 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002943 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002944 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002945
Jiyong Park0474e1f2021-01-14 14:26:06 +09002946 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2947 // one.
2948 if Bool(to.VendorProperties.Double_loadable) {
2949 return true
2950 }
2951
Ivan Lozanod7586b62021-04-01 09:49:36 -04002952 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002953 return false
2954 }
2955
Jooyung Hana70f0672019-01-18 15:20:43 +09002956 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2957 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002958 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002959 return false
2960 }
2961 if module, ok := ctx.Module().(*Module); ok {
2962 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002963 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002964 ctx.WalkDeps(check)
2965 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002966 }
2967 }
2968}
2969
Yu Liue4312402023-01-18 09:15:31 -08002970func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
2971 // For the dependency from platform to apex, use the latest stubs
2972 apexSdkVersion := android.FutureApiLevel
2973 if !apexInfo.IsForPlatform() {
2974 apexSdkVersion = apexInfo.MinSdkVersion
2975 }
2976
2977 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2978 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2979 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2980 // (b/144430859)
2981 apexSdkVersion = android.FutureApiLevel
2982 }
2983
2984 return apexSdkVersion
2985}
2986
Colin Crossc99deeb2016-04-11 15:06:20 -07002987// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002988func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002989 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002990
Colin Cross0de8a1e2020-09-18 14:15:30 -07002991 var directStaticDeps []StaticLibraryInfo
2992 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002993
Colin Cross0de8a1e2020-09-18 14:15:30 -07002994 reexportExporter := func(exporter FlagExporterInfo) {
2995 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2996 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2997 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2998 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2999 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003000 }
3001
Colin Crossff694a82023-12-13 15:54:49 -08003002 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003003 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003004
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003005 skipModuleList := map[string]bool{}
3006
3007 var apiImportInfo multitree.ApiImportInfo
3008 hasApiImportInfo := false
3009
3010 ctx.VisitDirectDeps(func(dep android.Module) {
3011 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003012 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003013 hasApiImportInfo = true
3014 }
3015 })
3016
3017 if hasApiImportInfo {
3018 targetStubModuleList := map[string]string{}
3019 targetOrigModuleList := map[string]string{}
3020
3021 // Search for dependency which both original module and API imported library with APEX stub exists
3022 ctx.VisitDirectDeps(func(dep android.Module) {
3023 depName := ctx.OtherModuleName(dep)
3024 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3025 targetStubModuleList[apiLibrary] = depName
3026 }
3027 })
3028 ctx.VisitDirectDeps(func(dep android.Module) {
3029 depName := ctx.OtherModuleName(dep)
3030 if origLibrary, ok := targetStubModuleList[depName]; ok {
3031 targetOrigModuleList[origLibrary] = depName
3032 }
3033 })
3034
3035 // Decide which library should be used between original and API imported library
3036 ctx.VisitDirectDeps(func(dep android.Module) {
3037 depName := ctx.OtherModuleName(dep)
3038 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003039 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003040 skipModuleList[depName] = true
3041 } else {
3042 skipModuleList[apiLibrary] = true
3043 }
3044 }
3045 })
3046 }
3047
Colin Crossd11fcda2017-10-23 17:59:01 -07003048 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003049 depName := ctx.OtherModuleName(dep)
3050 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003051
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003052 if _, ok := skipModuleList[depName]; ok {
3053 // skip this module because original module or API imported module matching with this should be used instead.
3054 return
3055 }
3056
Dan Willemsen47450072021-10-19 20:24:49 -07003057 if depTag == android.DarwinUniversalVariantTag {
3058 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3059 return
3060 }
3061
Vinh Tran367d89d2023-04-28 11:21:25 -04003062 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003063 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003064 depPaths.AidlLibraryInfos = append(
3065 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003066 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003067 )
3068 }
3069 }
3070
Ivan Lozano52767be2019-10-18 14:49:46 -07003071 ccDep, ok := dep.(LinkableInterface)
3072 if !ok {
3073
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003074 // handling for a few module types that aren't cc Module but that are also supported
3075 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003076 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003077 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003078 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3079 genRule.GeneratedSourceFiles()...)
3080 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003081 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003082 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003083 // Support exported headers from a generated_sources dependency
3084 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003085 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003086 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003087 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003088 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003089 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003090 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003091 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003092 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003093 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3094 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003095 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003096 // 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 +09003097 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003098
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003099 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003100 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003101 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003102 }
Colin Crosscef792e2021-06-11 18:01:26 -07003103 case CrtBeginDepTag:
3104 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3105 case CrtEndDepTag:
3106 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003107 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003108 return
3109 }
3110
Colin Crossfe17f6f2019-03-28 19:30:56 -07003111 if depTag == android.ProtoPluginDepTag {
3112 return
3113 }
3114
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003115 if depTag == android.RequiredDepTag {
3116 return
3117 }
3118
Colin Crossd11fcda2017-10-23 17:59:01 -07003119 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003120 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3121 return
3122 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003123 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003124 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3125 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003126 return
3127 }
3128
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003129 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003130 // Skip reused objects for stub libraries, they use their own stub object file instead.
3131 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3132 // version mutator, so the stubs variant is created from the shared variant that
3133 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003134 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003135 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003136 objs := staticAnalogue.ReuseObjects
3137 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003138 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003139 reexportExporter(depExporterInfo)
3140 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003141 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003142 }
3143
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003144 if depTag == llndkHeaderLibTag {
3145 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3146 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3147 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3148 }
3149
Colin Cross6e511a92020-07-27 21:26:48 -07003150 linkFile := ccDep.OutputFile()
3151
3152 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3153 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003154 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003155 return
3156 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003157
Jiyong Parke3867542020-12-03 17:28:25 +09003158 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3159 return
3160 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003161 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3162 return
3163 }
Jiyong Parke3867542020-12-03 17:28:25 +09003164
Colin Cross313aa542023-12-13 13:47:44 -08003165 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003166
Colin Cross6e511a92020-07-27 21:26:48 -07003167 var ptr *android.Paths
3168 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003169
Colin Cross6e511a92020-07-27 21:26:48 -07003170 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003171
Colin Cross6e511a92020-07-27 21:26:48 -07003172 switch {
3173 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003174 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003175 if !ctx.Config().AllowMissingDependencies() {
3176 ctx.ModuleErrorf("module %q is not a header library", depName)
3177 } else {
3178 ctx.AddMissingDependencies([]string{depName})
3179 }
3180 return
3181 }
Colin Cross6e511a92020-07-27 21:26:48 -07003182 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003183 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003184 if !ctx.Config().AllowMissingDependencies() {
3185 ctx.ModuleErrorf("module %q is not a shared library", depName)
3186 } else {
3187 ctx.AddMissingDependencies([]string{depName})
3188 }
3189 return
3190 }
Jiyong Parke3867542020-12-03 17:28:25 +09003191
Jiyong Park7d55b612021-06-11 17:22:09 +09003192 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3193 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003194
Jiyong Park1ad8e162020-12-01 23:40:09 +09003195 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3196 // linkFile, depFile, and ptr.
3197 if c.IsStubs() {
3198 break
3199 }
3200
Colin Cross0de8a1e2020-09-18 14:15:30 -07003201 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3202 depFile = sharedLibraryInfo.TableOfContents
3203
Colin Cross6e511a92020-07-27 21:26:48 -07003204 ptr = &depPaths.SharedLibs
3205 switch libDepTag.Order {
3206 case earlyLibraryDependency:
3207 ptr = &depPaths.EarlySharedLibs
3208 depPtr = &depPaths.EarlySharedLibsDeps
3209 case normalLibraryDependency:
3210 ptr = &depPaths.SharedLibs
3211 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003212 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003213 case lateLibraryDependency:
3214 ptr = &depPaths.LateSharedLibs
3215 depPtr = &depPaths.LateSharedLibsDeps
3216 default:
3217 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003218 }
Colin Cross6e511a92020-07-27 21:26:48 -07003219 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003220 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3221 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003222 if !ctx.Config().AllowMissingDependencies() {
3223 ctx.ModuleErrorf("module %q is not a static library", depName)
3224 } else {
3225 ctx.AddMissingDependencies([]string{depName})
3226 }
3227 return
3228 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003229
3230 // Stubs lib doesn't link to the static lib dependencies. Don't set
3231 // linkFile, depFile, and ptr.
3232 if c.IsStubs() {
3233 break
3234 }
3235
Colin Cross0de8a1e2020-09-18 14:15:30 -07003236 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003237 if libDepTag.wholeStatic {
3238 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003239 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3240 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003241 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003242 // This case normally catches prebuilt static
3243 // libraries, but it can also occur when
3244 // AllowMissingDependencies is on and the
3245 // dependencies has no sources of its own
3246 // but has a whole_static_libs dependency
3247 // on a missing library. We want to depend
3248 // on the .a file so that there is something
3249 // in the dependency tree that contains the
3250 // error rule for the missing transitive
3251 // dependency.
3252 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003253 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003254 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3255 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003256 } else {
3257 switch libDepTag.Order {
3258 case earlyLibraryDependency:
3259 panic(fmt.Errorf("early static libs not suppported"))
3260 case normalLibraryDependency:
3261 // static dependencies will be handled separately so they can be ordered
3262 // using transitive dependencies.
3263 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003264 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003265 case lateLibraryDependency:
3266 ptr = &depPaths.LateStaticLibs
3267 default:
3268 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003269 }
3270 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003271 if libDepTag.unexportedSymbols {
3272 depPaths.LdFlags = append(depPaths.LdFlags,
3273 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3274 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003275 }
3276
Colin Cross6e511a92020-07-27 21:26:48 -07003277 if libDepTag.static() && !libDepTag.wholeStatic {
3278 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3279 ctx.ModuleErrorf("module %q not a static library", depName)
3280 return
3281 }
Logan Chien43d34c32017-12-20 01:17:32 +08003282
Colin Cross6e511a92020-07-27 21:26:48 -07003283 // When combining coverage files for shared libraries and executables, coverage files
3284 // in static libraries act as if they were whole static libraries. The same goes for
3285 // source based Abi dump files.
3286 if c, ok := ccDep.(*Module); ok {
3287 staticLib := c.linker.(libraryInterface)
3288 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3289 staticLib.objs().coverageFiles...)
3290 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3291 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003292 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003293 // Handle non-CC modules here
3294 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003295 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003296 }
3297 }
3298
Colin Cross6e511a92020-07-27 21:26:48 -07003299 if ptr != nil {
3300 if !linkFile.Valid() {
3301 if !ctx.Config().AllowMissingDependencies() {
3302 ctx.ModuleErrorf("module %q missing output file", depName)
3303 } else {
3304 ctx.AddMissingDependencies([]string{depName})
3305 }
3306 return
3307 }
3308 *ptr = append(*ptr, linkFile.Path())
3309 }
3310
3311 if depPtr != nil {
3312 dep := depFile
3313 if !dep.Valid() {
3314 dep = linkFile
3315 }
3316 *depPtr = append(*depPtr, dep.Path())
3317 }
3318
Colin Cross0de8a1e2020-09-18 14:15:30 -07003319 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3320 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3321 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3322 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3323
3324 if libDepTag.reexportFlags {
3325 reexportExporter(depExporterInfo)
3326 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3327 // Re-exported shared library headers must be included as well since they can help us with type information
3328 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003329 c.sabi.Properties.ReexportedIncludes = append(
3330 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003331 c.sabi.Properties.ReexportedSystemIncludes = append(
3332 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003333 }
3334
Spandan Das3faa7922024-02-26 19:42:32 +00003335 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003336 switch {
3337 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003338 c.Properties.AndroidMkHeaderLibs = append(
3339 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003340 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003341 if lib := moduleLibraryInterface(dep); lib != nil {
3342 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003343 // Add the dependency to the APEX(es) providing the library so that
3344 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003345 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003346 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003347 c.Properties.ApexesProvidingSharedLibs = append(
3348 c.Properties.ApexesProvidingSharedLibs, an)
3349 }
3350 }
3351 }
3352
3353 // Note: the order of libs in this list is not important because
3354 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003355 c.Properties.AndroidMkSharedLibs = append(
3356 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003357 case libDepTag.static():
3358 if libDepTag.wholeStatic {
3359 c.Properties.AndroidMkWholeStaticLibs = append(
3360 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3361 } else {
3362 c.Properties.AndroidMkStaticLibs = append(
3363 c.Properties.AndroidMkStaticLibs, makeLibName)
3364 }
3365 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003366 } else if !c.IsStubs() {
3367 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3368
Colin Cross6e511a92020-07-27 21:26:48 -07003369 switch depTag {
3370 case runtimeDepTag:
3371 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003372 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003373 case objDepTag:
3374 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3375 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003376 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003377 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003378 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003379 case dynamicLinkerDepTag:
3380 depPaths.DynamicLinker = linkFile
3381 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003382 }
Colin Crossca860ac2016-01-04 14:34:37 -08003383 })
3384
Jeff Gaston294356f2017-09-27 17:05:30 -07003385 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003386 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3387 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3388 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003389
Colin Crossdd84e052017-05-17 13:44:16 -07003390 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003391 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003392 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3393 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003394 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003395 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3396 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003397 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003398 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003399 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003400
3401 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003402 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003403 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003404 }
Colin Crossdd84e052017-05-17 13:44:16 -07003405
Colin Crossca860ac2016-01-04 14:34:37 -08003406 return depPaths
3407}
3408
Spandan Das604f3762023-03-16 22:51:40 +00003409func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003410 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003411 thisModule, ok := ctx.Module().(android.ApexModule)
3412 if !ok {
3413 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3414 }
3415
Kiyoung Kimaa394802024-01-08 12:55:45 +09003416 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003417 bootstrap := false
3418 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3419 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3420 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003421 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003422 bootstrap = linkable.Bootstrap()
3423 }
3424
Colin Crossff694a82023-12-13 15:54:49 -08003425 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003426
3427 useStubs := false
3428
Kiyoung Kimaa394802024-01-08 12:55:45 +09003429 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003430 if !apexInfo.IsForPlatform() {
3431 // For platform libraries, use current version of LLNDK
3432 // If this is for use_vendor apex we will apply the same rules
3433 // of apex sdk enforcement below to choose right version.
3434 useStubs = true
3435 }
3436 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3437 // If not building for APEX or the containing APEX allows the use of
3438 // platform APIs, use stubs only when it is from an APEX (and not from
3439 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3440 // bootstrap modules, always link to non-stub variant
3441 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3442
3443 isApexImportedApiLibrary := false
3444
3445 if cc, ok := dep.(*Module); ok {
3446 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3447 if apiLibrary.hasApexStubs() {
3448 isApexImportedApiLibrary = true
3449 }
3450 }
3451 }
3452
3453 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3454
3455 if useStubs {
3456 // Another exception: if this module is a test for an APEX, then
3457 // it is linked with the non-stub variant of a module in the APEX
3458 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003459 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003460 for _, apexContents := range testFor.ApexContents {
3461 if apexContents.DirectlyInApex(depName) {
3462 useStubs = false
3463 break
3464 }
3465 }
3466 }
3467 if useStubs {
3468 // Yet another exception: If this module and the dependency are
3469 // available to the same APEXes then skip stubs between their
3470 // platform variants. This complements the test_for case above,
3471 // which avoids the stubs on a direct APEX library dependency, by
3472 // avoiding stubs for indirect test dependencies as well.
3473 //
3474 // TODO(b/183882457): This doesn't work if the two libraries have
3475 // only partially overlapping apex_available. For that test_for
3476 // modules would need to be split into APEX variants and resolved
3477 // separately for each APEX they have access to.
3478 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3479 useStubs = false
3480 }
3481 }
3482 } else {
3483 // If building for APEX, use stubs when the parent is in any APEX that
3484 // the child is not in.
3485 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3486 }
3487
3488 return useStubs
3489}
3490
3491// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3492// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3493// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3494// has different level of updatability. For example, if a library foo in an APEX depends on a
3495// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3496// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3497// same APEX as foo, the non-stub variant of bar is used.
3498func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3499 depTag := ctx.OtherModuleDependencyTag(dep)
3500 libDepTag, ok := depTag.(libraryDependencyTag)
3501 if !ok || !libDepTag.shared() {
3502 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3503 }
3504
Colin Cross313aa542023-12-13 13:47:44 -08003505 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3506 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3507 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003508
3509 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003510 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003511 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003512 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3513 toUse := stubs[len(stubs)-1]
3514 sharedLibraryInfo = toUse.SharedLibraryInfo
3515 depExporterInfo = toUse.FlagExporterInfo
3516 }
3517 }
3518 return sharedLibraryInfo, depExporterInfo
3519}
3520
Colin Cross0de8a1e2020-09-18 14:15:30 -07003521// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3522// to match the topological order of the dependency tree, including any static analogues of
3523// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3524// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003525func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3526 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003527 var staticPaths android.Paths
3528 for _, staticDep := range staticDeps {
3529 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3530 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3531 }
3532 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003533 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3534 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003535 }
3536 }
3537 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3538
3539 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3540
3541 // reorder the dependencies based on transitive dependencies
3542 staticPaths = android.FirstUniquePaths(staticPaths)
3543 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3544
3545 if len(orderedStaticPaths) != len(staticPaths) {
3546 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3547 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3548 }
3549
3550 return orderedStaticPaths, transitiveStaticLibs
3551}
3552
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003553// BaseLibName trims known prefixes and suffixes
3554func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003555 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3556 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003557 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003558 return libName
3559}
3560
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003561func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003562 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003563 ccDepModule, _ := ccDep.(*Module)
3564 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003565 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003566
Justin Yuncbca3732021-02-03 19:24:13 +09003567 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003568 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003569 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003570 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003571
Ivan Lozanod1dec542021-05-26 15:33:11 -04003572 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003573 }
3574 }
3575
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003576 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3577 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003578 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3579 // core module instead.
3580 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003581 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003582 // The vendor and product modules in Make will have been renamed to not conflict with the
3583 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003584 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003585 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003586 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003587 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003588 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003589 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003590 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003591 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003592 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003593 } else {
3594 return libName
3595 }
3596}
3597
Colin Crossca860ac2016-01-04 14:34:37 -08003598func (c *Module) InstallInData() bool {
3599 if c.installer == nil {
3600 return false
3601 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003602 return c.installer.inData()
3603}
3604
3605func (c *Module) InstallInSanitizerDir() bool {
3606 if c.installer == nil {
3607 return false
3608 }
3609 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003610 return true
3611 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003612 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003613}
3614
Yifan Hong1b3348d2020-01-21 15:53:22 -08003615func (c *Module) InstallInRamdisk() bool {
3616 return c.InRamdisk()
3617}
3618
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003619func (c *Module) InstallInVendorRamdisk() bool {
3620 return c.InVendorRamdisk()
3621}
3622
Jiyong Parkf9332f12018-02-01 00:54:12 +09003623func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003624 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003625}
3626
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003627func (c *Module) MakeUninstallable() {
3628 if c.installer == nil {
3629 c.ModuleBase.MakeUninstallable()
3630 return
3631 }
3632 c.installer.makeUninstallable(c)
3633}
3634
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003635func (c *Module) HostToolPath() android.OptionalPath {
3636 if c.installer == nil {
3637 return android.OptionalPath{}
3638 }
3639 return c.installer.hostToolPath()
3640}
3641
Nan Zhangd4e641b2017-07-12 12:55:28 -07003642func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3643 return c.outputFile
3644}
3645
Colin Cross41955e82019-05-29 14:40:35 -07003646func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3647 switch tag {
3648 case "":
3649 if c.outputFile.Valid() {
3650 return android.Paths{c.outputFile.Path()}, nil
3651 }
3652 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003653 case "unstripped":
3654 if c.linker != nil {
3655 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3656 }
3657 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003658 case "stripped_all":
3659 if c.linker != nil {
3660 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3661 }
3662 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003663 default:
3664 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003665 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003666}
3667
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003668func (c *Module) static() bool {
3669 if static, ok := c.linker.(interface {
3670 static() bool
3671 }); ok {
3672 return static.static()
3673 }
3674 return false
3675}
3676
Jiyong Park379de2f2018-12-19 02:47:14 +09003677func (c *Module) staticBinary() bool {
3678 if static, ok := c.linker.(interface {
3679 staticBinary() bool
3680 }); ok {
3681 return static.staticBinary()
3682 }
3683 return false
3684}
3685
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003686func (c *Module) testBinary() bool {
3687 if test, ok := c.linker.(interface {
3688 testBinary() bool
3689 }); ok {
3690 return test.testBinary()
3691 }
3692 return false
3693}
3694
Jingwen Chen537242c2022-08-24 11:53:27 +00003695func (c *Module) testLibrary() bool {
3696 if test, ok := c.linker.(interface {
3697 testLibrary() bool
3698 }); ok {
3699 return test.testLibrary()
3700 }
3701 return false
3702}
3703
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003704func (c *Module) benchmarkBinary() bool {
3705 if b, ok := c.linker.(interface {
3706 benchmarkBinary() bool
3707 }); ok {
3708 return b.benchmarkBinary()
3709 }
3710 return false
3711}
3712
3713func (c *Module) fuzzBinary() bool {
3714 if f, ok := c.linker.(interface {
3715 fuzzBinary() bool
3716 }); ok {
3717 return f.fuzzBinary()
3718 }
3719 return false
3720}
3721
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003722// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3723func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003724 if h, ok := c.linker.(interface {
3725 header() bool
3726 }); ok {
3727 return h.header()
3728 }
3729 return false
3730}
3731
Ivan Lozanod7586b62021-04-01 09:49:36 -04003732func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003733 if b, ok := c.linker.(interface {
3734 binary() bool
3735 }); ok {
3736 return b.binary()
3737 }
3738 return false
3739}
3740
Justin Yun5e035862021-06-29 20:50:37 +09003741func (c *Module) StaticExecutable() bool {
3742 if b, ok := c.linker.(*binaryDecorator); ok {
3743 return b.static()
3744 }
3745 return false
3746}
3747
Ivan Lozanod7586b62021-04-01 09:49:36 -04003748func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003749 if o, ok := c.linker.(interface {
3750 object() bool
3751 }); ok {
3752 return o.object()
3753 }
3754 return false
3755}
3756
Kiyoung Kim37693d02024-04-04 09:56:15 +09003757func (m *Module) Dylib() bool {
3758 return false
3759}
3760
3761func (m *Module) Rlib() bool {
3762 return false
3763}
3764
Ivan Lozanof9e21722020-12-02 09:00:51 -05003765func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003766 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003767 if c.IsLlndk() {
3768 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003769 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003770 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003771 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003772 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003773 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003774 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003775 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003776 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003777 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003778 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003779 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003780 return "native:product"
3781 }
Jooyung Han38002912019-05-16 04:01:54 +09003782 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003783 } else if c.InRamdisk() {
3784 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003785 } else if c.InVendorRamdisk() {
3786 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003787 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003788 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003789 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003790 return "native:ndk:none:none"
3791 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3792 //family, link := getNdkStlFamilyAndLinkType(c)
3793 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003794 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003795 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003796 } else {
3797 return "native:platform"
3798 }
3799}
3800
Jiyong Park9d452992018-10-03 00:38:19 +09003801// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003802// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003803func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003804 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003805 // Stub libs and prebuilt libs in a versioned SDK are not
3806 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003807 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003808 } else if _, ok := c.linker.(testPerSrc); ok {
3809 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003810 }
3811 return false
3812}
3813
Jiyong Parka90ca002019-10-07 15:47:24 +09003814func (c *Module) AvailableFor(what string) bool {
3815 if linker, ok := c.linker.(interface {
3816 availableFor(string) bool
3817 }); ok {
3818 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3819 } else {
3820 return c.ApexModuleBase.AvailableFor(what)
3821 }
3822}
3823
Jiyong Park62304bb2020-04-13 16:19:48 +09003824func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003825 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003826}
3827
Paul Duffin0cb37b92020-03-04 14:52:46 +00003828func (c *Module) EverInstallable() bool {
3829 return c.installer != nil &&
3830 // Check to see whether the module is actually ever installable.
3831 c.installer.everInstallable()
3832}
3833
Ivan Lozanod7586b62021-04-01 09:49:36 -04003834func (c *Module) PreventInstall() bool {
3835 return c.Properties.PreventInstall
3836}
3837
3838func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003839 if c.library != nil {
3840 if i := c.library.installable(); i != nil {
3841 return i
3842 }
3843 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003844 return c.Properties.Installable
3845}
3846
3847func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003848 ret := c.EverInstallable() &&
3849 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003850 proptools.BoolDefault(c.Installable(), true) &&
3851 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003852
3853 // The platform variant doesn't need further condition. Apex variants however might not
3854 // be installable because it will likely to be included in the APEX and won't appear
3855 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003856 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003857 return ret
3858 }
3859
3860 // Special case for modules that are configured to be installed to /data, which includes
3861 // test modules. For these modules, both APEX and non-APEX variants are considered as
3862 // installable. This is because even the APEX variants won't be included in the APEX, but
3863 // will anyway be installed to /data/*.
3864 // See b/146995717
3865 if c.InstallInData() {
3866 return ret
3867 }
3868
3869 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003870}
3871
Logan Chien41eabe62019-04-10 13:33:58 +08003872func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3873 if c.linker != nil {
3874 if library, ok := c.linker.(*libraryDecorator); ok {
3875 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3876 }
3877 }
3878}
3879
Jiyong Park45bf82e2020-12-15 22:29:02 +09003880var _ android.ApexModule = (*Module)(nil)
3881
3882// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003883func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003884 depTag := ctx.OtherModuleDependencyTag(dep)
3885 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3886
3887 if cc, ok := dep.(*Module); ok {
3888 if cc.HasStubsVariants() {
3889 if isLibDepTag && libDepTag.shared() {
3890 // dynamic dep to a stubs lib crosses APEX boundary
3891 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003892 }
Colin Cross6e511a92020-07-27 21:26:48 -07003893 if IsRuntimeDepTag(depTag) {
3894 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003895 return false
3896 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003897 }
Zhijun Heec285872021-04-24 10:47:08 -07003898 if cc.IsLlndk() {
3899 return false
3900 }
Colin Crossaac32222020-07-29 12:51:56 -07003901 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003902 // shared_lib dependency from a static lib is considered as crossing
3903 // the APEX boundary because the dependency doesn't actually is
3904 // linked; the dependency is used only during the compilation phase.
3905 return false
3906 }
Jiyong Parke3867542020-12-03 17:28:25 +09003907
3908 if isLibDepTag && libDepTag.excludeInApex {
3909 return false
3910 }
Colin Cross6e511a92020-07-27 21:26:48 -07003911 }
Colin Crossc1b36442021-05-06 13:42:48 -07003912 if depTag == stubImplDepTag {
3913 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003914 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003915 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003916 if depTag == staticVariantTag {
3917 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3918 // actually mean that the static lib (and its dependencies) are copied into the
3919 // APEX.
3920 return false
3921 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003922 return true
3923}
3924
Jiyong Park45bf82e2020-12-15 22:29:02 +09003925// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003926func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3927 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003928 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3929 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3930 return nil
3931 }
Jooyung Han749dc692020-04-15 11:03:39 +09003932 // We don't check for prebuilt modules
3933 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3934 return nil
3935 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003936
Jooyung Han749dc692020-04-15 11:03:39 +09003937 minSdkVersion := c.MinSdkVersion()
3938 if minSdkVersion == "apex_inherit" {
3939 return nil
3940 }
3941 if minSdkVersion == "" {
3942 // JNI libs within APK-in-APEX fall into here
3943 // Those are okay to set sdk_version instead
3944 // We don't have to check if this is a SDK variant because
3945 // non-SDK variant resets sdk_version, which works too.
3946 minSdkVersion = c.SdkVersion()
3947 }
Dan Albertc8060532020-07-22 22:32:17 -07003948 if minSdkVersion == "" {
3949 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3950 }
3951 // Not using nativeApiLevelFromUser because the context here is not
3952 // necessarily a native context.
3953 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003954 if err != nil {
3955 return err
3956 }
Dan Albertc8060532020-07-22 22:32:17 -07003957
Colin Cross8ca61c12022-10-06 21:00:14 -07003958 // A dependency only needs to support a min_sdk_version at least
3959 // as high as the api level that the architecture was introduced in.
3960 // This allows introducing new architectures in the platform that
3961 // need to be included in apexes that normally require an older
3962 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003963 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003964 if sdkVersion.LessThan(minApiForArch) {
3965 sdkVersion = minApiForArch
3966 }
3967
Dan Albertc8060532020-07-22 22:32:17 -07003968 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003969 return fmt.Errorf("newer SDK(%v)", ver)
3970 }
3971 return nil
3972}
3973
Paul Duffinb5769c12021-05-12 16:16:51 +01003974// Implements android.ApexModule
3975func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3976 // stub libraries and native bridge libraries are always available to platform
3977 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3978}
3979
Jooyung Han91f92032022-02-04 12:36:33 +09003980// Overrides android.ApexModuleBase.UniqueApexVariations
3981func (c *Module) UniqueApexVariations() bool {
3982 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
3983 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
3984 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09003985 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09003986 return c.UseVndk() && c.IsVndk()
3987}
3988
Inseob Kima1888ce2022-10-04 14:42:02 +09003989func (c *Module) overriddenModules() []string {
3990 if o, ok := c.linker.(overridable); ok {
3991 return o.overriddenModules()
3992 }
3993 return nil
3994}
3995
Liz Kammer35ca77e2021-12-22 15:31:40 -05003996type moduleType int
3997
3998const (
3999 unknownType moduleType = iota
4000 binary
4001 object
4002 fullLibrary
4003 staticLibrary
4004 sharedLibrary
4005 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004006 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004007 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004008 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004009)
4010
4011func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004012 if c.testBinary() {
4013 // testBinary is also a binary, so this comes before the c.Binary()
4014 // conditional. A testBinary has additional implicit dependencies and
4015 // other test-only semantics.
4016 return testBin
4017 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004018 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004019 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004020 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004021 } else if c.testLibrary() {
4022 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4023 // will let them add implicit compile deps on gtest, for example.
4024 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004025 // For now, treat them as regular libraries.
4026 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004027 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004028 static := false
4029 shared := false
4030 if library, ok := c.linker.(*libraryDecorator); ok {
4031 static = library.MutatedProperties.BuildStatic
4032 shared = library.MutatedProperties.BuildShared
4033 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4034 static = library.MutatedProperties.BuildStatic
4035 shared = library.MutatedProperties.BuildShared
4036 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004037 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004038 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004039 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004040 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004041 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004042 return staticLibrary
4043 }
4044 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004045 } else if c.isNDKStubLibrary() {
4046 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004047 } else if c.IsNdkPrebuiltStl() {
4048 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004049 }
4050 return unknownType
4051}
4052
Colin Crosscfad1192015-11-02 16:43:11 -08004053// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004054type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004055 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004056 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004057 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004058
4059 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4060 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004061}
4062
Patrice Arrudac249c712019-03-19 17:00:29 -07004063// cc_defaults provides a set of properties that can be inherited by other cc
4064// modules. A module can use the properties from a cc_defaults using
4065// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4066// merged (when possible) by prepending the default module's values to the
4067// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004068func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004069 return DefaultsFactory()
4070}
4071
Colin Cross36242852017-06-23 15:06:31 -07004072func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004073 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004074
Colin Cross36242852017-06-23 15:06:31 -07004075 module.AddProperties(props...)
4076 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004077 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004078 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004079 &BaseCompilerProperties{},
4080 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004081 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004082 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004083 &StaticProperties{},
4084 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004085 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004086 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004087 &TestLinkerProperties{},
4088 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004089 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004090 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004091 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004092 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004093 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004094 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004095 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004096 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004097 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004098 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004099 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004100 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004101 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004102 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004103 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004104 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4105 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004106 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004107 )
Colin Crosscfad1192015-11-02 16:43:11 -08004108
Jooyung Hancc372c52019-09-25 15:18:44 +09004109 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004110
4111 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004112}
4113
Jiyong Park2286afd2020-06-16 21:58:53 +09004114func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004115 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004116}
4117
Kiyoung Kim51279d32022-08-24 14:10:46 +09004118func (c *Module) isImportedApiLibrary() bool {
4119 _, ok := c.linker.(*apiLibraryDecorator)
4120 return ok
4121}
4122
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004123func kytheExtractAllFactory() android.Singleton {
4124 return &kytheExtractAllSingleton{}
4125}
4126
4127type kytheExtractAllSingleton struct {
4128}
4129
4130func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4131 var xrefTargets android.Paths
4132 ctx.VisitAllModules(func(module android.Module) {
4133 if ccModule, ok := module.(xref); ok {
4134 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4135 }
4136 })
4137 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4138 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004139 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004140 }
4141}
4142
Jihoon Kangf78a8902022-09-01 22:47:07 +00004143func (c *Module) Partition() string {
4144 if p, ok := c.installer.(interface {
4145 getPartition() string
4146 }); ok {
4147 return p.getPartition()
4148 }
4149 return ""
4150}
4151
Spandan Das2b6dfb52024-01-19 00:22:22 +00004152type sourceModuleName interface {
4153 sourceModuleName() string
4154}
4155
4156func (c *Module) BaseModuleName() string {
4157 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4158 // if the prebuilt module sets a source_module_name in Android.bp, use that
4159 return smn.sourceModuleName()
4160 }
4161 return c.ModuleBase.BaseModuleName()
4162}
4163
Colin Cross06a931b2015-10-28 17:23:31 -07004164var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004165var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004166var BoolPtr = proptools.BoolPtr
4167var String = proptools.String
4168var StringPtr = proptools.StringPtr