blob: 449d38f3315246ba9812c3b5c54dab5b70cb345c [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Aditya Choudhary87b2ab22023-11-17 15:27:06 +000027 "android/soong/testing"
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090028
Colin Cross97ba0732015-03-23 17:50:24 -070029 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070030 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070031
Vinh Tran367d89d2023-04-28 11:21:25 -040032 "android/soong/aidl_library"
Colin Cross635c3b02016-05-18 15:37:25 -070033 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070034 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070035 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070036 "android/soong/genrule"
Kiyoung Kim487689e2022-07-26 09:48:22 +090037 "android/soong/multitree"
Rob Seymour925aa092021-08-10 20:42:03 +000038 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080039)
40
Colin Cross463a90e2015-06-17 14:20:06 -070041func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000042 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070043
Inseob Kim3b244062023-07-11 13:31:36 +090044 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000045 pctx.Import("android/soong/cc/config")
46}
47
48func RegisterCCBuildComponents(ctx android.RegistrationContext) {
49 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
50
51 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000052 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090053 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070054 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010055 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070056 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070057 ctx.BottomUp("begin", BeginMutator).Parallel()
Ke-Yu Lu0be9d602024-02-06 02:15:03 +000058 ctx.BottomUp("fdo_profile", fdoProfileMutator)
Colin Cross1e676be2016-10-12 14:38:15 -070059 })
Colin Cross16b23492016-01-06 14:41:07 -080060
Paul Duffin036e7002019-12-19 19:16:28 +000061 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040062 for _, san := range Sanitizers {
63 san.registerMutators(ctx)
64 }
Dan Willemsen581341d2017-02-09 16:16:31 -080065
Colin Cross0b908332019-06-19 23:00:20 -070066 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090067 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080068
Cory Barkera1da26f2022-06-07 20:12:06 +000069 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000070
Colin Crossf5f4ad32024-01-19 15:41:48 -080071 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070072
Ke-Yu Lu0be9d602024-02-06 02:15:03 +000073 ctx.TopDown("afdo_deps", afdoDepsMutator)
74 ctx.BottomUp("afdo", afdoMutator).Parallel()
Yi Kongeb8efc92021-12-09 18:06:29 +080075
Colin Cross33e0c812024-01-23 16:36:07 -080076 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000077
Colin Cross6ac83a82024-01-23 11:23:10 -080078 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090079
Jooyung Han479ca172020-10-19 18:51:07 +090080 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090081 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070082 })
Colin Crossb98c8b02016-07-29 13:44:28 -070083
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080084 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
85 // sabi mutator needs to be run after apex mutator finishes.
86 ctx.TopDown("sabi_deps", sabiDepsMutator)
87 })
88
LaMont Jones0c10e4d2023-05-16 00:58:37 +000089 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070090}
91
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050092// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
93// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
94// edges to these modules.
95// This object is constructed in DepsMutator, by calling to various module delegates to set
96// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
97// dependencies.
98// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
99// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800100type Deps struct {
101 SharedLibs, LateSharedLibs []string
102 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800103 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800104 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700105
Colin Cross3e5e7782022-06-17 22:17:05 +0000106 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
107 // prevent automatically exporting symbols.
108 UnexportedStaticLibs []string
109
Chris Parsons79d66a52020-06-05 17:26:16 -0400110 // Used for data dependencies adjacent to tests
111 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700112 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400113
Yo Chiang219968c2020-09-22 18:45:04 +0800114 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
115 SystemSharedLibs []string
116
Vinh Tran367d89d2023-04-28 11:21:25 -0400117 // Used by DepMutator to pass aidl_library modules to aidl compiler
118 AidlLibs []string
119
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500120 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800121 StaticUnwinderIfLegacy bool
122
Colin Cross5950f382016-12-13 12:50:57 -0800123 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700124
Colin Cross81413472016-04-11 14:37:39 -0700125 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700126
Dan Willemsenb40aab62016-04-20 14:21:14 -0700127 GeneratedSources []string
128 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900129 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700130
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700131 ReexportGeneratedHeaders []string
132
Colin Crossc465efd2021-06-11 18:00:04 -0700133 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700134
135 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700136 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900137
138 // List of libs that need to be excluded for APEX variant
139 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900140 // List of libs that need to be excluded for non-APEX variant
141 ExcludeLibsForNonApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700142}
143
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500144// PathDeps is a struct containing file paths to dependencies of a module.
145// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
146// It's used to construct flags for various build statements (such as for compiling and linking).
147// It is then passed to module decorator functions responsible for registering build statements
148// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800149type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700150 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900151 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700152 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900153 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700154 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700155 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700156
Colin Cross0de8a1e2020-09-18 14:15:30 -0700157 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700158 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700159
Colin Cross26c34ed2016-09-30 17:10:16 -0700160 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100161 Objs Objects
162 // Paths to .o files in dependencies that provide them. Note that these lists
163 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800164 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700165 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700166
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100167 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
168 // the libs from all whole_static_lib dependencies.
169 WholeStaticLibsFromPrebuilts android.Paths
170
Colin Cross26c34ed2016-09-30 17:10:16 -0700171 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700172 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900173 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700174
Inseob Kimd110f872019-12-06 13:15:38 +0900175 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000176 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900177 IncludeDirs android.Paths
178 SystemIncludeDirs android.Paths
179 ReexportedDirs android.Paths
180 ReexportedSystemDirs android.Paths
181 ReexportedFlags []string
182 ReexportedGeneratedHeaders android.Paths
183 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700184
Colin Cross26c34ed2016-09-30 17:10:16 -0700185 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700186 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700187
Dan Willemsena0790e32018-10-12 00:24:23 -0700188 // Path to the dynamic linker binary
189 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700190
191 // For Darwin builds, the path to the second architecture's output that should
192 // be combined with this architectures's output into a FAT MachO file.
193 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400194
195 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
196 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700197}
198
Colin Cross4af21ed2019-11-04 09:37:55 -0800199// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
200// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
201// command line so they can be overridden by the local module flags).
202type LocalOrGlobalFlags struct {
203 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700204 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800205 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700206 CFlags []string // Flags that apply to C and C++ source files
207 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
208 ConlyFlags []string // Flags that apply to C source files
209 CppFlags []string // Flags that apply to C++ source files
210 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700211 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800212}
213
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500214// Flags contains various types of command line flags (and settings) for use in building build
215// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800216type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500217 // Local flags (which individual modules are responsible for). These may override global flags.
218 Local LocalOrGlobalFlags
219 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800220 Global LocalOrGlobalFlags
221
222 aidlFlags []string // Flags that apply to aidl source files
223 rsFlags []string // Flags that apply to renderscript source files
224 libFlags []string // Flags to add libraries early to the link order
225 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
226 TidyFlags []string // Flags that apply to clang-tidy
227 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700228
Colin Crossc3199482017-03-30 15:03:04 -0700229 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800230 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700231 SystemIncludeFlags []string
232
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800233 Toolchain config.Toolchain
234 Tidy bool // True if ninja .tidy rules should be generated.
235 NeedTidyFiles bool // True if module link should depend on .tidy files
236 GcovCoverage bool // True if coverage files should be generated.
237 SAbiDump bool // True if header abi dumps should be generated.
238 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800239
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500240 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800241 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500242 // The target-device system path to the dynamic linker.
243 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800244
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700245 CFlagsDeps android.Paths // Files depended on by compiler flags
246 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800247
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500248 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700249 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800250
Colin Cross19878da2019-03-28 14:45:07 -0700251 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700252 protoC bool // Whether to use C instead of C++
253 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700254
255 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200256 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700257}
258
Colin Crossca860ac2016-01-04 14:34:37 -0800259// Properties used to compile all C or C++ modules
260type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700261 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800262 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700263
Jiyong Parkb35a8192020-08-10 15:59:36 +0900264 // The API level that this module is built against. The APIs of this API level will be
265 // visible at build time, but use of any APIs newer than min_sdk_version will render the
266 // module unloadable on older devices. In the future it will be possible to weakly-link new
267 // APIs, making the behavior match Java: such modules will load on older devices, but
268 // calling new APIs on devices that do not support them will result in a crash.
269 //
270 // This property has the same behavior as sdk_version does for Java modules. For those
271 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
272 // does for Java code.
273 //
274 // In addition, setting this property causes two variants to be built, one for the platform
275 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800276 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700277
Jiyong Parkb35a8192020-08-10 15:59:36 +0900278 // Minimum OS API level supported by this C or C++ module. This property becomes the value
279 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
280 // this property is also used to ensure that the min_sdk_version of the containing module is
281 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
282 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
283 // min_sdk_version of the containing APEX. When the module
284 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900285 Min_sdk_version *string
286
Colin Crossc511bc52020-04-07 16:50:32 +0000287 // If true, always create an sdk variant and don't create a platform variant.
288 Sdk_variant_only *bool
289
Jiyong Parkde866cb2018-12-07 23:08:36 +0900290 AndroidMkSharedLibs []string `blueprint:"mutated"`
291 AndroidMkStaticLibs []string `blueprint:"mutated"`
292 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
293 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700294 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900295 HideFromMake bool `blueprint:"mutated"`
296 PreventInstall bool `blueprint:"mutated"`
297 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700298
Yo Chiang219968c2020-09-22 18:45:04 +0800299 // Set by DepsMutator.
300 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
301
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900302 // The name of the image this module is built for
303 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200304
305 // The VNDK version this module is built against. If empty, the module is not
306 // build against the VNDK.
307 VndkVersion string `blueprint:"mutated"`
308
309 // Suffix for the name of Android.mk entries generated by this module
310 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800311
312 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
313 // file
314 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900315
Yifan Hong39143a92020-10-26 12:43:12 -0700316 // Make this module available when building for ramdisk.
317 // On device without a dedicated recovery partition, the module is only
318 // available after switching root into
319 // /first_stage_ramdisk. To expose the module before switching root, install
320 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800321 Ramdisk_available *bool
322
Yifan Hong39143a92020-10-26 12:43:12 -0700323 // Make this module available when building for vendor ramdisk.
324 // On device without a dedicated recovery partition, the module is only
325 // available after switching root into
326 // /first_stage_ramdisk. To expose the module before switching root, install
327 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700328 Vendor_ramdisk_available *bool
329
Jiyong Parkf9332f12018-02-01 00:54:12 +0900330 // Make this module available when building for recovery
331 Recovery_available *bool
332
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200333 // Used by imageMutator, set by ImageMutatorBegin()
334 CoreVariantNeeded bool `blueprint:"mutated"`
335 RamdiskVariantNeeded bool `blueprint:"mutated"`
336 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
337 RecoveryVariantNeeded bool `blueprint:"mutated"`
338
339 // A list of variations for the "image" mutator of the form
340 //<image name> '.' <version char>, for example, 'vendor.S'
341 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900342
343 // Allows this module to use non-APEX version of libraries. Useful
344 // for building binaries that are started before APEXes are activated.
345 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900346
347 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
348 // see soong/cc/config/vndk.go
349 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900350
351 // Used by vendor snapshot to record dependencies from snapshot modules.
352 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900353 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900354 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000355
Colin Cross1bc94122021-10-28 13:25:54 -0700356 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000357
358 // Set by factories of module types that can only be referenced from variants compiled against
359 // the SDK.
360 AlwaysSdk bool `blueprint:"mutated"`
361
362 // Variant is an SDK variant created by sdkMutator
363 IsSdkVariant bool `blueprint:"mutated"`
364 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
365 // variant to have a ".sdk" suffix.
366 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700367
368 // Normally Soong uses the directory structure to decide which modules
369 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800370 // different snapshots (vendor, recovery, etc.), but this property
371 // allows a partner to exclude a module normally thought of as a
372 // framework module from the vendor snapshot.
373 Exclude_from_vendor_snapshot *bool
374
375 // Normally Soong uses the directory structure to decide which modules
376 // should be included (framework) or excluded (non-framework) from the
377 // different snapshots (vendor, recovery, etc.), but this property
378 // allows a partner to exclude a module normally thought of as a
379 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800380 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900381
382 // List of APEXes that this module has private access to for testing purpose. The module
383 // can depend on libraries that are not exported by the APEXes and use private symbols
384 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000385 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800386
387 Target struct {
388 Platform struct {
389 // List of modules required by the core variant.
390 Required []string `android:"arch_variant"`
391
392 // List of modules not required by the core variant.
393 Exclude_required []string `android:"arch_variant"`
394 } `android:"arch_variant"`
395
396 Recovery struct {
397 // List of modules required by the recovery variant.
398 Required []string `android:"arch_variant"`
399
400 // List of modules not required by the recovery variant.
401 Exclude_required []string `android:"arch_variant"`
402 } `android:"arch_variant"`
403 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700404}
405
406type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900407 // whether this module should be allowed to be directly depended by other
408 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900409 // If set to true, two variants will be built separately, one like
410 // normal, and the other limited to the set of libraries and headers
411 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700412 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900413 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700414 // so it shouldn't have any unversioned runtime dependencies, or
415 // make assumptions about the system that may not be true in the
416 // future.
417 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900418 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900419 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900420 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900421 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900422 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700423 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
424 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900425
Justin Yunebcf0c52021-01-08 18:00:19 +0900426 // This is the same as the "vendor_available" except that the install path
427 // of the vendor variant is /odm or /vendor/odm.
428 // By replacing "vendor_available: true" with "odm_available: true", the
429 // module will install its vendor variant to the /odm partition or /vendor/odm.
430 // As the modules with "odm_available: true" still create the vendor variants,
431 // they can link to the other vendor modules as the vendor_available modules do.
432 // Also, the vendor modules can link to odm_available modules.
433 //
434 // It may not be used for VNDK modules.
435 Odm_available *bool
436
Justin Yun63e9ec72020-10-29 16:49:43 +0900437 // whether this module should be allowed to be directly depended by other
438 // modules with `product_specific: true` or `product_available: true`.
439 // If set to true, an additional product variant will be built separately
440 // that is limited to the set of libraries and headers that are exposed to
441 // /product modules.
442 //
443 // The product variant may be used with a different (newer) /system,
444 // so it shouldn't have any unversioned runtime dependencies, or
445 // make assumptions about the system that may not be true in the
446 // future.
447 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900448 // If set to false, this module becomes inaccessible from /product modules.
449 //
450 // Different from the 'vendor_available' property, the modules with
451 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
452 // library without 'product_available' may not be depended on by any other
453 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900454 //
455 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
456 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
457 Product_available *bool
458
Jiyong Park5fb8c102018-04-09 12:03:06 +0900459 // whether this module is capable of being loaded with other instance
460 // (possibly an older version) of the same module in the same process.
461 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
462 // can be double loaded in a vendor process if the library is also a
463 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
464 // explicitly marked as `double_loadable: true` by the owner, or the dependency
465 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
466 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800467
468 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
469 IsLLNDK bool `blueprint:"mutated"`
470
Colin Cross78212242021-01-06 14:51:30 -0800471 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
472 // set and the module is not listed in VndkMustUseVendorVariantList.
473 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
474
475 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
476 IsVNDKCore bool `blueprint:"mutated"`
477
478 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
479 IsVNDKSP bool `blueprint:"mutated"`
480
481 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
482 // module sets the llndk.private property.
483 IsVNDKPrivate bool `blueprint:"mutated"`
484
485 // IsVNDKProduct is set if a VNDK module sets the product_available property.
486 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700487
488 // IsVendorPublicLibrary is set for the core and product variants of a library that has
489 // vendor_public_library stubs.
490 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800491}
492
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500493// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
494// to understanding details about the type of the current module.
495// For example, one might call these functions to determine whether the current module is a static
496// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800497type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800498 static() bool
499 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700500 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800501 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900502 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900503 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900504 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700505 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900506 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700507 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800508 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900509 minSdkVersion() string
510 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700511 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700512 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800513 IsLlndk() bool
514 IsLlndkPublic() bool
515 isImplementationForLLNDKPublic() bool
516 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900517 isVndk() bool
518 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500519 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700520 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900521 inProduct() bool
522 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800523 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700524 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900525 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900526 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700527 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700528 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800529 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800530 isAfdoCompile() bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000531 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800532 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900533 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800534 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800535 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800536 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700537 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700538 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900539 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800540 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700541 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700542 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800543 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800544 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800545 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800546 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800547}
548
549type SharedFlags struct {
550 numSharedFlags int
551 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800552}
553
554type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700555 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800556 ModuleContextIntf
557}
558
559type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700560 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800561 ModuleContextIntf
562}
563
Colin Cross37047f12016-12-13 17:06:13 -0800564type DepsContext interface {
565 android.BottomUpMutatorContext
566 ModuleContextIntf
567}
568
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500569// feature represents additional (optional) steps to building cc-related modules, such as invocation
570// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800571type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800572 flags(ctx ModuleContext, flags Flags) Flags
573 props() []interface{}
574}
575
Joe Onorato37f900c2023-07-18 16:58:16 -0700576// Information returned from Generator about the source code it's generating
577type GeneratedSource struct {
578 IncludeDirs android.Paths
579 Sources android.Paths
580 Headers android.Paths
581 ReexportedDirs android.Paths
582}
583
584// generator allows injection of generated code
585type Generator interface {
586 GeneratorProps() []interface{}
587 GeneratorInit(ctx BaseModuleContext)
588 GeneratorDeps(ctx DepsContext, deps Deps) Deps
589 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
590 GeneratorSources(ctx ModuleContext) GeneratedSource
591 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
592}
593
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500594// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500595// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800596type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700597 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800598 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800599 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700600 compilerProps() []interface{}
601
Colin Cross76fada02016-07-27 10:31:13 -0700602 appendCflags([]string)
603 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700604 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800605}
606
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500607// linker is the interface for a linker decorator object. Individual module types can provide
608// their own implementation for this decorator, and thus specify custom logic regarding build
609// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800610type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700611 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800612 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700613 linkerFlags(ctx ModuleContext, flags Flags) Flags
614 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800615 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700616
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700617 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700618 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900619 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800620 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700621
622 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900623 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000624
625 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000626 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800627
628 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000629}
630
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500631// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000632type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500633 sharedLibs []string
634 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
635 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700636 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800637}
638
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500639// installer is the interface for an installer helper object. This helper is responsible for
640// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800641type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700642 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700643 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000644 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800645 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700646 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700647 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900648 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000649 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900650 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800651}
652
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800653type xref interface {
654 XrefCcFiles() android.Paths
655}
656
Inseob Kima1888ce2022-10-04 14:42:02 +0900657type overridable interface {
658 overriddenModules() []string
659}
660
Colin Cross6e511a92020-07-27 21:26:48 -0700661type libraryDependencyKind int
662
663const (
664 headerLibraryDependency = iota
665 sharedLibraryDependency
666 staticLibraryDependency
667)
668
669func (k libraryDependencyKind) String() string {
670 switch k {
671 case headerLibraryDependency:
672 return "headerLibraryDependency"
673 case sharedLibraryDependency:
674 return "sharedLibraryDependency"
675 case staticLibraryDependency:
676 return "staticLibraryDependency"
677 default:
678 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
679 }
680}
681
682type libraryDependencyOrder int
683
684const (
685 earlyLibraryDependency = -1
686 normalLibraryDependency = 0
687 lateLibraryDependency = 1
688)
689
690func (o libraryDependencyOrder) String() string {
691 switch o {
692 case earlyLibraryDependency:
693 return "earlyLibraryDependency"
694 case normalLibraryDependency:
695 return "normalLibraryDependency"
696 case lateLibraryDependency:
697 return "lateLibraryDependency"
698 default:
699 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
700 }
701}
702
703// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
704// tags that have a set of predefined tag objects that are reused for each dependency, a
705// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
706// That means that comparing a libraryDependencyTag for equality will only be equal if all
707// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
708// then check individual metadata fields instead.
709type libraryDependencyTag struct {
710 blueprint.BaseDependencyTag
711
712 // These are exported so that fmt.Printf("%#v") can call their String methods.
713 Kind libraryDependencyKind
714 Order libraryDependencyOrder
715
716 wholeStatic bool
717
718 reexportFlags bool
719 explicitlyVersioned bool
720 dataLib bool
721 ndk bool
722
723 staticUnwinder bool
724
725 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900726
Cindy Zhou18417cb2020-12-10 07:12:38 -0800727 // Whether or not this dependency should skip the apex dependency check
728 skipApexAllowedDependenciesCheck bool
729
Jiyong Parke3867542020-12-03 17:28:25 +0900730 // Whether or not this dependency has to be followed for the apex variants
731 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900732 // Whether or not this dependency has to be followed for the non-apex variants
733 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000734
735 // If true, don't automatically export symbols from the static library into a shared library.
736 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700737}
738
739// header returns true if the libraryDependencyTag is tagging a header lib dependency.
740func (d libraryDependencyTag) header() bool {
741 return d.Kind == headerLibraryDependency
742}
743
744// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
745func (d libraryDependencyTag) shared() bool {
746 return d.Kind == sharedLibraryDependency
747}
748
749// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
750func (d libraryDependencyTag) static() bool {
751 return d.Kind == staticLibraryDependency
752}
753
Colin Cross65cb3142021-12-10 23:05:02 +0000754func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
755 if d.shared() {
756 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
757 }
758 return nil
759}
760
761var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
762
Colin Crosse9fe2942020-11-10 18:12:15 -0800763// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
764// binaries or other shared libraries are installed as dependencies.
765func (d libraryDependencyTag) InstallDepNeeded() bool {
766 return d.shared()
767}
768
769var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
770
771// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700772// libraryDependencyTag. Each tag object is created globally and reused for multiple
773// dependencies (although since the object contains no references, assigning a tag to a
774// variable and modifying it will not modify the original). Users can compare the tag
775// returned by ctx.OtherModuleDependencyTag against the global original
776type dependencyTag struct {
777 blueprint.BaseDependencyTag
778 name string
779}
780
Colin Crosse9fe2942020-11-10 18:12:15 -0800781// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
782// libraryDependencyTag, but where the dependency needs to be installed when the parent is
783// installed.
784type installDependencyTag struct {
785 blueprint.BaseDependencyTag
786 android.InstallAlwaysNeededDependencyTag
787 name string
788}
789
Colin Crossc99deeb2016-04-11 15:06:20 -0700790var (
Colin Cross6e511a92020-07-27 21:26:48 -0700791 genSourceDepTag = dependencyTag{name: "gen source"}
792 genHeaderDepTag = dependencyTag{name: "gen header"}
793 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
794 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900795 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700796 reuseObjTag = dependencyTag{name: "reuse objects"}
797 staticVariantTag = dependencyTag{name: "static variant"}
798 vndkExtDepTag = dependencyTag{name: "vndk extends"}
799 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700800 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800801 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700802 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700803 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000804 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500805 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400806 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700807)
808
Roland Levillainf89cd092019-07-29 16:22:59 +0100809func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700810 ccLibDepTag, ok := depTag.(libraryDependencyTag)
811 return ok && ccLibDepTag.shared()
812}
813
814func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
815 ccLibDepTag, ok := depTag.(libraryDependencyTag)
816 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100817}
818
Zach Johnson3df4e632020-11-06 11:56:27 -0800819func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
820 ccLibDepTag, ok := depTag.(libraryDependencyTag)
821 return ok && ccLibDepTag.header()
822}
823
Roland Levillainf89cd092019-07-29 16:22:59 +0100824func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800825 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100826}
827
828func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700829 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100830 return ok && ccDepTag == testPerSrcDepTag
831}
832
Colin Crossca860ac2016-01-04 14:34:37 -0800833// Module contains the properties and members used by all C/C++ module types, and implements
834// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500835// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
836// interface.
837//
838// To define a C/C++ related module, construct a new Module object and point its delegates to
839// type-specific structs. These delegates will be invoked to register module-specific build
840// statements which may be unique to the module type. For example, module.compiler.compile() should
841// be defined so as to register build statements which are responsible for compiling the module.
842//
843// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
844// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
845// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
846// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800847type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700848 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700849
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700850 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700851 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700852
Colin Crossca860ac2016-01-04 14:34:37 -0800853 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000854 hod android.HostOrDeviceSupported
855 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000856 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700857
Paul Duffina0843f62019-12-13 19:50:38 +0000858 // Allowable SdkMemberTypes of this module type.
859 sdkMemberTypes []android.SdkMemberType
860
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500861 // decorator delegates, initialize before calling Init
862 // these may contain module-specific implementations, and effectively allow for custom
863 // type-specific logic. These members may reference different objects or the same object.
864 // Functions of these decorators will be invoked to initialize and register type-specific
865 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800866 generators []Generator
867 compiler compiler
868 linker linker
869 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500870
Spandan Dase12d2522023-09-12 21:42:31 +0000871 features []feature
872 stl *stl
873 sanitize *sanitize
874 coverage *coverage
875 fuzzer *fuzzer
876 sabi *sabi
877 vndkdep *vndkdep
878 lto *lto
879 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000880 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800881
Colin Cross31076b32020-10-23 17:22:06 -0700882 library libraryInterface
883
Colin Cross635c3b02016-05-18 15:37:25 -0700884 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800885
Colin Crossb98c8b02016-07-29 13:44:28 -0700886 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700887
888 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800889
890 // Flags used to compile this module
891 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700892
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800893 // Shared flags among build rules of this module
894 sharedFlags SharedFlags
895
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800896 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700897 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900898
899 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800900 // Kythe (source file indexer) paths for this compilation module
901 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700902 // Object .o file output paths for this compilation module
903 objFiles android.Paths
904 // Tidy .tidy file output paths for this compilation module
905 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900906
907 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700908 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700909
910 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800911
912 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800913 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700914}
915
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200916func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400917 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
918 if b, ok := c.compiler.(*baseCompiler); ok {
919 hasAidl = b.hasSrcExt(".aidl")
920 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
921 hasProto = b.hasSrcExt(".proto")
922 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
923 hasSysprop = b.hasSrcExt(".sysprop")
924 hasWinMsg = b.hasSrcExt(".mc")
925 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
926 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200927 c.AndroidModuleBase().AddJSONData(d)
928 (*d)["Cc"] = map[string]interface{}{
929 "SdkVersion": c.SdkVersion(),
930 "MinSdkVersion": c.MinSdkVersion(),
931 "VndkVersion": c.VndkVersion(),
932 "ProductSpecific": c.ProductSpecific(),
933 "SocSpecific": c.SocSpecific(),
934 "DeviceSpecific": c.DeviceSpecific(),
935 "InProduct": c.InProduct(),
936 "InVendor": c.InVendor(),
937 "InRamdisk": c.InRamdisk(),
938 "InVendorRamdisk": c.InVendorRamdisk(),
939 "InRecovery": c.InRecovery(),
940 "VendorAvailable": c.VendorAvailable(),
941 "ProductAvailable": c.ProductAvailable(),
942 "RamdiskAvailable": c.RamdiskAvailable(),
943 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
944 "RecoveryAvailable": c.RecoveryAvailable(),
945 "OdmAvailable": c.OdmAvailable(),
946 "InstallInData": c.InstallInData(),
947 "InstallInRamdisk": c.InstallInRamdisk(),
948 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
949 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
950 "InstallInRecovery": c.InstallInRecovery(),
951 "InstallInRoot": c.InstallInRoot(),
952 "IsVndk": c.IsVndk(),
953 "IsVndkExt": c.IsVndkExt(),
954 "IsVndkPrivate": c.IsVndkPrivate(),
955 "IsVndkSp": c.IsVndkSp(),
956 "IsLlndk": c.IsLlndk(),
957 "IsLlndkPublic": c.IsLlndkPublic(),
958 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
959 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
960 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
961 "ApexSdkVersion": c.apexSdkVersion,
962 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400963 "AidlSrcs": hasAidl,
964 "LexSrcs": hasLex,
965 "ProtoSrcs": hasProto,
966 "RenderscriptSrcs": hasRenderscript,
967 "SyspropSrcs": hasSysprop,
968 "WinMsgSrcs": hasWinMsg,
969 "YaccSrsc": hasYacc,
970 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200971 }
972}
973
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500974func (c *Module) SetPreventInstall() {
975 c.Properties.PreventInstall = true
976}
977
978func (c *Module) SetHideFromMake() {
979 c.Properties.HideFromMake = true
980}
981
Ivan Lozanod7586b62021-04-01 09:49:36 -0400982func (c *Module) HiddenFromMake() bool {
983 return c.Properties.HideFromMake
984}
985
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800986func (c *Module) RequiredModuleNames() []string {
987 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
988 if c.ImageVariation().Variation == android.CoreVariation {
989 required = append(required, c.Properties.Target.Platform.Required...)
990 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
991 } else if c.InRecovery() {
992 required = append(required, c.Properties.Target.Recovery.Required...)
993 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
994 }
995 return android.FirstUniqueStrings(required)
996}
997
Ivan Lozano52767be2019-10-18 14:49:46 -0700998func (c *Module) Toc() android.OptionalPath {
999 if c.linker != nil {
1000 if library, ok := c.linker.(libraryInterface); ok {
1001 return library.toc()
1002 }
1003 }
1004 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1005}
1006
1007func (c *Module) ApiLevel() string {
1008 if c.linker != nil {
1009 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001010 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001011 }
1012 }
1013 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1014}
1015
1016func (c *Module) Static() bool {
1017 if c.linker != nil {
1018 if library, ok := c.linker.(libraryInterface); ok {
1019 return library.static()
1020 }
1021 }
1022 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1023}
1024
1025func (c *Module) Shared() bool {
1026 if c.linker != nil {
1027 if library, ok := c.linker.(libraryInterface); ok {
1028 return library.shared()
1029 }
1030 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001031
Ivan Lozano52767be2019-10-18 14:49:46 -07001032 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1033}
1034
1035func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001036 if c.stl != nil {
1037 return c.stl.Properties.SelectedStl
1038 }
1039 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001040}
1041
Ivan Lozano52767be2019-10-18 14:49:46 -07001042func (c *Module) NdkPrebuiltStl() bool {
1043 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1044 return true
1045 }
1046 return false
1047}
1048
1049func (c *Module) StubDecorator() bool {
1050 if _, ok := c.linker.(*stubDecorator); ok {
1051 return true
1052 }
1053 return false
1054}
1055
1056func (c *Module) SdkVersion() string {
1057 return String(c.Properties.Sdk_version)
1058}
1059
Artur Satayev480e25b2020-04-27 18:53:18 +01001060func (c *Module) MinSdkVersion() string {
1061 return String(c.Properties.Min_sdk_version)
1062}
1063
Jiyong Park5df7bd32021-08-25 16:18:46 +09001064func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001065 if linker, ok := c.linker.(*objectLinker); ok {
1066 return linker.isCrt()
1067 }
1068 return false
1069}
1070
Jiyong Park5df7bd32021-08-25 16:18:46 +09001071func (c *Module) SplitPerApiLevel() bool {
1072 return c.canUseSdk() && c.isCrt()
1073}
1074
Colin Crossc511bc52020-04-07 16:50:32 +00001075func (c *Module) AlwaysSdk() bool {
1076 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1077}
1078
Ivan Lozano183a3212019-10-18 14:18:45 -07001079func (c *Module) CcLibrary() bool {
1080 if c.linker != nil {
1081 if _, ok := c.linker.(*libraryDecorator); ok {
1082 return true
1083 }
Colin Crossd48fe732020-09-23 20:37:24 -07001084 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1085 return true
1086 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001087 }
1088 return false
1089}
1090
1091func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001092 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001093 return true
1094 }
1095 return false
1096}
1097
Spandan Dase12d2522023-09-12 21:42:31 +00001098func (c *Module) IsNdkPrebuiltStl() bool {
1099 if c.linker == nil {
1100 return false
1101 }
1102 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1103 return true
1104 }
1105 return false
1106}
1107
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001108func (c *Module) RlibStd() bool {
1109 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1110}
1111
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001112func (c *Module) RustLibraryInterface() bool {
1113 return false
1114}
1115
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001116func (c *Module) IsFuzzModule() bool {
1117 if _, ok := c.compiler.(*fuzzBinary); ok {
1118 return true
1119 }
1120 return false
1121}
1122
1123func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1124 return c.FuzzModule
1125}
1126
1127func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1128 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1129 return fuzzer.fuzzPackagedModule
1130 }
1131 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1132}
1133
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001134func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001135 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1136 return fuzzer.sharedLibraries
1137 }
1138 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1139}
1140
Ivan Lozano2b262972019-11-21 12:30:50 -08001141func (c *Module) NonCcVariants() bool {
1142 return false
1143}
1144
Ivan Lozano183a3212019-10-18 14:18:45 -07001145func (c *Module) SetStatic() {
1146 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001147 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001148 library.setStatic()
1149 return
1150 }
1151 }
1152 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1153}
1154
1155func (c *Module) SetShared() {
1156 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001157 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001158 library.setShared()
1159 return
1160 }
1161 }
1162 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1163}
1164
1165func (c *Module) BuildStaticVariant() bool {
1166 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001167 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001168 return library.buildStatic()
1169 }
1170 }
1171 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1172}
1173
1174func (c *Module) BuildSharedVariant() bool {
1175 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001176 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001177 return library.buildShared()
1178 }
1179 }
1180 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1181}
1182
1183func (c *Module) Module() android.Module {
1184 return c
1185}
1186
Jiyong Parkc20eee32018-09-05 22:36:17 +09001187func (c *Module) OutputFile() android.OptionalPath {
1188 return c.outputFile
1189}
1190
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001191func (c *Module) CoverageFiles() android.Paths {
1192 if c.linker != nil {
1193 if library, ok := c.linker.(libraryInterface); ok {
1194 return library.objs().coverageFiles
1195 }
1196 }
1197 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1198}
1199
Ivan Lozano183a3212019-10-18 14:18:45 -07001200var _ LinkableInterface = (*Module)(nil)
1201
Jiyong Park719b4462019-01-13 00:39:51 +09001202func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001203 if c.linker != nil {
1204 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001205 }
1206 return nil
1207}
1208
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001209func (c *Module) CoverageOutputFile() android.OptionalPath {
1210 if c.linker != nil {
1211 return c.linker.coverageOutputFilePath()
1212 }
1213 return android.OptionalPath{}
1214}
1215
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001216func (c *Module) RelativeInstallPath() string {
1217 if c.installer != nil {
1218 return c.installer.relativeInstallPath()
1219 }
1220 return ""
1221}
1222
Jooyung Han344d5432019-08-23 11:17:39 +09001223func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001224 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001225}
1226
Colin Cross36242852017-06-23 15:06:31 -07001227func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001228 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001229 for _, generator := range c.generators {
1230 c.AddProperties(generator.GeneratorProps()...)
1231 }
Colin Crossca860ac2016-01-04 14:34:37 -08001232 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001233 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001234 }
1235 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001236 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001237 }
1238 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001239 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001240 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001241 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001242 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001243 }
Colin Cross16b23492016-01-06 14:41:07 -08001244 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001245 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001246 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001247 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001248 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001249 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001250 if c.fuzzer != nil {
1251 c.AddProperties(c.fuzzer.props()...)
1252 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001253 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001254 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001255 }
Justin Yun8effde42017-06-23 19:24:43 +09001256 if c.vndkdep != nil {
1257 c.AddProperties(c.vndkdep.props()...)
1258 }
Stephen Craneba090d12017-05-09 15:44:35 -07001259 if c.lto != nil {
1260 c.AddProperties(c.lto.props()...)
1261 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001262 if c.afdo != nil {
1263 c.AddProperties(c.afdo.props()...)
1264 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001265 if c.orderfile != nil {
1266 c.AddProperties(c.orderfile.props()...)
1267 }
Colin Crossca860ac2016-01-04 14:34:37 -08001268 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001269 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001270 }
Colin Crossc472d572015-03-17 15:06:21 -07001271
Colin Cross36242852017-06-23 15:06:31 -07001272 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001273 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001274 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001275
Colin Cross36242852017-06-23 15:06:31 -07001276 return c
Colin Crossc472d572015-03-17 15:06:21 -07001277}
1278
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001279// UseVndk() returns true if this module is built against VNDK.
1280// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001281func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001282 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001283}
1284
Colin Crossc511bc52020-04-07 16:50:32 +00001285func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001286 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001287 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001288}
1289
1290func (c *Module) UseSdk() bool {
1291 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001292 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001293 }
1294 return false
1295}
1296
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001297func (c *Module) isCoverageVariant() bool {
1298 return c.coverage.Properties.IsCoverageVariant
1299}
1300
Colin Cross95f1ca02020-10-29 20:47:22 -07001301func (c *Module) IsNdk(config android.Config) bool {
1302 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001303}
1304
Colin Cross127bb8b2020-12-16 16:46:01 -08001305func (c *Module) IsLlndk() bool {
1306 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001307}
1308
Colin Cross127bb8b2020-12-16 16:46:01 -08001309func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001310 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001311}
1312
Colin Cross1f3f1302021-04-26 18:37:44 -07001313func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001314 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001315 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001316}
1317
Colin Cross5271fea2021-04-27 13:06:04 -07001318func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1319 lib := moduleLibraryInterface(m)
1320 return lib != nil && (lib.hasVendorPublicLibrary())
1321}
1322
1323// IsVendorPublicLibrary returns true for vendor public libraries.
1324func (c *Module) IsVendorPublicLibrary() bool {
1325 return c.VendorProperties.IsVendorPublicLibrary
1326}
1327
Ivan Lozanof1868af2022-04-12 13:08:36 -04001328func (c *Module) IsVndkPrebuiltLibrary() bool {
1329 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1330 return true
1331 }
1332 return false
1333}
1334
1335func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1336 return c.Properties.SdkAndPlatformVariantVisibleToMake
1337}
1338
Ivan Lozanod7586b62021-04-01 09:49:36 -04001339func (c *Module) HasLlndkStubs() bool {
1340 lib := moduleLibraryInterface(c)
1341 return lib != nil && lib.hasLLNDKStubs()
1342}
1343
1344func (c *Module) StubsVersion() string {
1345 if lib, ok := c.linker.(versionedInterface); ok {
1346 return lib.stubsVersion()
1347 }
1348 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1349}
1350
Colin Cross127bb8b2020-12-16 16:46:01 -08001351// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1352// and does not set llndk.vendor_available: false.
1353func (c *Module) isImplementationForLLNDKPublic() bool {
1354 library, _ := c.library.(*libraryDecorator)
1355 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001356 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001357}
1358
Justin Yunfd9e8042020-12-23 18:23:14 +09001359// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001360func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001361 // Check if VNDK-core-private or VNDK-SP-private
1362 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001363 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001364 }
1365
1366 // Check if LLNDK-private
1367 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001368 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001369 }
1370
1371 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001372}
1373
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001374// IsVndk() returns true if this module has a vndk variant.
1375// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1376// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001377func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001378 if vndkdep := c.vndkdep; vndkdep != nil {
1379 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001380 }
1381 return false
1382}
1383
Yi Kong4ef54592022-02-14 20:00:10 +08001384func (c *Module) isAfdoCompile() bool {
1385 if afdo := c.afdo; afdo != nil {
Ke-Yu Lu351d3642024-02-06 02:15:03 +00001386 return afdo.Properties.FdoProfilePath != nil
Yi Kong4ef54592022-02-14 20:00:10 +08001387 }
1388 return false
1389}
1390
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001391func (c *Module) isOrderfileCompile() bool {
1392 if orderfile := c.orderfile; orderfile != nil {
1393 return orderfile.Properties.OrderfileLoad
1394 }
1395 return false
1396}
1397
Yi Kongc702ebd2022-08-19 16:02:45 +08001398func (c *Module) isCfi() bool {
1399 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001400 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001401 }
1402 return false
1403}
1404
Yi Konged79fa32023-06-04 17:15:42 +09001405func (c *Module) isFuzzer() bool {
1406 if sanitize := c.sanitize; sanitize != nil {
1407 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1408 }
1409 return false
1410}
1411
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001412func (c *Module) isNDKStubLibrary() bool {
1413 if _, ok := c.compiler.(*stubDecorator); ok {
1414 return true
1415 }
1416 return false
1417}
1418
Ivan Lozanod7586b62021-04-01 09:49:36 -04001419func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001420 if vndkdep := c.vndkdep; vndkdep != nil {
1421 return vndkdep.isVndkSp()
1422 }
1423 return false
1424}
1425
Ivan Lozanof9e21722020-12-02 09:00:51 -05001426func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001427 if vndkdep := c.vndkdep; vndkdep != nil {
1428 return vndkdep.isVndkExt()
1429 }
1430 return false
1431}
1432
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001433func (c *Module) SubName() string {
1434 return c.Properties.SubName
1435}
1436
Ivan Lozano52767be2019-10-18 14:49:46 -07001437func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001438 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001439}
1440
Logan Chienf3511742017-10-31 18:04:35 +08001441func (c *Module) getVndkExtendsModuleName() string {
1442 if vndkdep := c.vndkdep; vndkdep != nil {
1443 return vndkdep.getVndkExtendsModuleName()
1444 }
1445 return ""
1446}
1447
Jiyong Park25fc6a92018-11-18 18:02:45 +09001448func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001449 if lib := c.library; lib != nil {
1450 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001451 }
1452 return false
1453}
1454
1455func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001456 if lib := c.library; lib != nil {
1457 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001458 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001459 return false
1460}
1461
Alan Stokes73feba32022-11-14 12:21:24 +00001462func (c *Module) IsStubsImplementationRequired() bool {
1463 if lib := c.library; lib != nil {
1464 return lib.isStubsImplementationRequired()
1465 }
1466 return false
1467}
1468
Colin Cross0477b422020-10-13 18:43:54 -07001469// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1470// the implementation. If it is an implementation library it returns its own name.
1471func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1472 name := ctx.OtherModuleName(c)
1473 if versioned, ok := c.linker.(versionedInterface); ok {
1474 name = versioned.implementationModuleName(name)
1475 }
1476 return name
1477}
1478
Martin Stjernholm2856c662020-12-02 15:03:42 +00001479// Similar to ImplementationModuleName, but uses the Make variant of the module
1480// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1481// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1482// under the premise that the prebuilt module overrides its source counterpart
1483// if it is exposed to Make).
1484func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1485 name := c.BaseModuleName()
1486 if versioned, ok := c.linker.(versionedInterface); ok {
1487 name = versioned.implementationModuleName(name)
1488 }
1489 return name
1490}
1491
Jiyong Park7d55b612021-06-11 17:22:09 +09001492func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001493 return Bool(c.Properties.Bootstrap)
1494}
1495
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001496func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001497 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1498 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1499 return false
1500 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001501 return c.linker != nil && c.linker.nativeCoverage()
1502}
1503
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001504func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001505 if p, ok := c.linker.(SnapshotInterface); ok {
1506 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001507 }
1508 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001509}
1510
Bill Peckham945441c2020-08-31 16:07:58 -07001511func (c *Module) ExcludeFromVendorSnapshot() bool {
1512 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1513}
1514
Jose Galmesf7294582020-11-13 12:07:36 -08001515func (c *Module) ExcludeFromRecoverySnapshot() bool {
1516 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1517}
1518
Jiyong Parkf1194352019-02-25 11:05:47 +09001519func isBionic(name string) bool {
1520 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001521 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001522 return true
1523 }
1524 return false
1525}
1526
Martin Stjernholm279de572019-09-10 23:18:20 +01001527func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001528 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001529 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001530 }
1531 return isBionic(name)
1532}
1533
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001534func (c *Module) XrefCcFiles() android.Paths {
1535 return c.kytheFiles
1536}
1537
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001538func (c *Module) isCfiAssemblySupportEnabled() bool {
1539 return c.sanitize != nil &&
1540 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1541}
1542
Inseob Kim800d1142021-06-14 12:03:51 +09001543func (c *Module) InstallInRoot() bool {
1544 return c.installer != nil && c.installer.installInRoot()
1545}
1546
Colin Crossca860ac2016-01-04 14:34:37 -08001547type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001548 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001549 moduleContextImpl
1550}
1551
Colin Cross37047f12016-12-13 17:06:13 -08001552type depsContext struct {
1553 android.BottomUpMutatorContext
1554 moduleContextImpl
1555}
1556
Colin Crossca860ac2016-01-04 14:34:37 -08001557type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001558 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001559 moduleContextImpl
1560}
1561
1562type moduleContextImpl struct {
1563 mod *Module
1564 ctx BaseModuleContext
1565}
1566
Colin Crossb98c8b02016-07-29 13:44:28 -07001567func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001568 return ctx.mod.toolchain(ctx.ctx)
1569}
1570
1571func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001572 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001573}
1574
1575func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001576 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001577}
1578
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001579func (ctx *moduleContextImpl) testBinary() bool {
1580 return ctx.mod.testBinary()
1581}
1582
Yi Kong56fc1b62022-09-06 16:24:00 +08001583func (ctx *moduleContextImpl) testLibrary() bool {
1584 return ctx.mod.testLibrary()
1585}
1586
Jiyong Park1d1119f2019-07-29 21:27:18 +09001587func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001588 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001589}
1590
Inseob Kim7f283f42020-06-01 21:53:49 +09001591func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001592 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001593}
1594
Inseob Kim1042d292020-06-01 23:23:05 +09001595func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001596 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001597}
1598
Jooyung Hanccce2f22020-03-07 03:45:53 +09001599func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001600 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001601}
1602
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001603func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001604 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001605}
1606
1607func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001608 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001609 config := ctx.ctx.Config()
1610 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001611 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001612 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001613 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001614 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001615 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001616 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001617 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001618 }
1619 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001620}
1621
Jiyong Parkb35a8192020-08-10 15:59:36 +09001622func (ctx *moduleContextImpl) minSdkVersion() string {
1623 ver := ctx.mod.MinSdkVersion()
1624 if ver == "apex_inherit" && !ctx.isForPlatform() {
1625 ver = ctx.apexSdkVersion().String()
1626 }
1627 if ver == "apex_inherit" || ver == "" {
1628 ver = ctx.sdkVersion()
1629 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001630
1631 if ctx.ctx.Device() {
1632 config := ctx.ctx.Config()
1633 if config.IsVndkDeprecated() && ctx.inVendor() {
1634 // If building for vendor with final API, then use the latest _stable_ API as "current".
1635 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1636 ver = config.PlatformSdkVersion().String()
1637 }
1638 }
1639 }
1640
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001641 // For crt objects, the meaning of min_sdk_version is very different from other types of
1642 // module. For them, min_sdk_version defines the oldest version that the build system will
1643 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1644 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1645 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001646 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1647 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1648 // support such an old version. The version is set to the later version in case when the
1649 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1650 // it's for an APEX.
1651 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1652 if ctx.isForPlatform() {
1653 ver = strconv.Itoa(android.FutureApiLevelInt)
1654 } else { // for apex
1655 ver = ctx.apexSdkVersion().String()
1656 if ver == "" { // in case when min_sdk_version was not set by the APEX
1657 ver = ctx.sdkVersion()
1658 }
1659 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001660 }
1661
Jiyong Parkb35a8192020-08-10 15:59:36 +09001662 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1663 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1664 minSdkVersionInt, err2 := strconv.Atoi(ver)
1665 if err == nil && err2 == nil {
1666 if sdkVersionInt < minSdkVersionInt {
1667 return strconv.Itoa(sdkVersionInt)
1668 }
1669 }
1670 return ver
1671}
1672
1673func (ctx *moduleContextImpl) isSdkVariant() bool {
1674 return ctx.mod.IsSdkVariant()
1675}
1676
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001677func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001678 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001679}
Justin Yun8effde42017-06-23 19:24:43 +09001680
Kiyoung Kimaa394802024-01-08 12:55:45 +09001681func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1682 return ctx.mod.InVendorOrProduct()
1683}
1684
Colin Cross95f1ca02020-10-29 20:47:22 -07001685func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1686 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001687}
1688
Colin Cross127bb8b2020-12-16 16:46:01 -08001689func (ctx *moduleContextImpl) IsLlndk() bool {
1690 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001691}
1692
Colin Cross127bb8b2020-12-16 16:46:01 -08001693func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1694 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001695}
1696
Colin Cross127bb8b2020-12-16 16:46:01 -08001697func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1698 return ctx.mod.isImplementationForLLNDKPublic()
1699}
1700
1701func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1702 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001703}
1704
Logan Chienf3511742017-10-31 18:04:35 +08001705func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001706 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001707}
1708
Yi Kong4ef54592022-02-14 20:00:10 +08001709func (ctx *moduleContextImpl) isAfdoCompile() bool {
1710 return ctx.mod.isAfdoCompile()
1711}
1712
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001713func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1714 return ctx.mod.isOrderfileCompile()
1715}
1716
Yi Kongc702ebd2022-08-19 16:02:45 +08001717func (ctx *moduleContextImpl) isCfi() bool {
1718 return ctx.mod.isCfi()
1719}
1720
Yi Konged79fa32023-06-04 17:15:42 +09001721func (ctx *moduleContextImpl) isFuzzer() bool {
1722 return ctx.mod.isFuzzer()
1723}
1724
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001725func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1726 return ctx.mod.isNDKStubLibrary()
1727}
1728
Justin Yun8effde42017-06-23 19:24:43 +09001729func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001730 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001731}
1732
Ivan Lozanof9e21722020-12-02 09:00:51 -05001733func (ctx *moduleContextImpl) IsVndkExt() bool {
1734 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001735}
1736
Colin Cross5271fea2021-04-27 13:06:04 -07001737func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1738 return ctx.mod.IsVendorPublicLibrary()
1739}
1740
Vic Yangefd249e2018-11-12 20:19:56 -08001741func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001742 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001743}
1744
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001745func (ctx *moduleContextImpl) selectedStl() string {
1746 if stl := ctx.mod.stl; stl != nil {
1747 return stl.Properties.SelectedStl
1748 }
1749 return ""
1750}
1751
Ivan Lozanobd721262018-11-27 14:33:03 -08001752func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1753 return ctx.mod.linker.useClangLld(actx)
1754}
1755
Colin Crossce75d2c2016-10-06 16:12:58 -07001756func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001757 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001758}
1759
Logan Chienf3511742017-10-31 18:04:35 +08001760func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1761 return ctx.mod.getVndkExtendsModuleName()
1762}
1763
Logan Chiene274fc92019-12-03 11:18:32 -08001764func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001765 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1766 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001767}
1768
Colin Crosse07f2312020-08-13 11:24:56 -07001769func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001770 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1771 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001772}
1773
Dan Albertc8060532020-07-22 22:32:17 -07001774func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001775 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001776}
1777
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001778func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001779 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001780}
1781
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001782func (ctx *moduleContextImpl) nativeCoverage() bool {
1783 return ctx.mod.nativeCoverage()
1784}
1785
Colin Cross56a83212020-09-15 18:30:11 -07001786func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1787 return ctx.mod.DirectlyInAnyApex()
1788}
1789
Colin Cross95b07f22020-12-16 11:06:50 -08001790func (ctx *moduleContextImpl) isPreventInstall() bool {
1791 return ctx.mod.Properties.PreventInstall
1792}
1793
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001794func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1795 shared := &ctx.mod.sharedFlags
1796 if shared.flagsMap == nil {
1797 shared.numSharedFlags = 0
1798 shared.flagsMap = make(map[string]string)
1799 }
1800 return shared
1801}
1802
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001803func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1804 return ctx.mod.isCfiAssemblySupportEnabled()
1805}
1806
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001807func (ctx *moduleContextImpl) notInPlatform() bool {
1808 return ctx.mod.NotInPlatform()
1809}
1810
Colin Cross635c3b02016-05-18 15:37:25 -07001811func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001812 return &Module{
1813 hod: hod,
1814 multilib: multilib,
1815 }
1816}
1817
Colin Cross635c3b02016-05-18 15:37:25 -07001818func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001819 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001820 module.features = []feature{
1821 &tidyFeature{},
1822 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001823 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001824 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001825 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001826 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001827 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001828 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001829 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001830 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001831 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001832 return module
1833}
1834
Colin Crossce75d2c2016-10-06 16:12:58 -07001835func (c *Module) Prebuilt() *android.Prebuilt {
1836 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1837 return p.prebuilt()
1838 }
1839 return nil
1840}
1841
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001842func (c *Module) IsPrebuilt() bool {
1843 return c.Prebuilt() != nil
1844}
1845
Colin Crossce75d2c2016-10-06 16:12:58 -07001846func (c *Module) Name() string {
1847 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001848 if p, ok := c.linker.(interface {
1849 Name(string) string
1850 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001851 name = p.Name(name)
1852 }
1853 return name
1854}
1855
Alex Light3d673592019-01-18 14:37:31 -08001856func (c *Module) Symlinks() []string {
1857 if p, ok := c.installer.(interface {
1858 symlinkList() []string
1859 }); ok {
1860 return p.symlinkList()
1861 }
1862 return nil
1863}
1864
Roland Levillainf89cd092019-07-29 16:22:59 +01001865func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1866 test, ok := c.linker.(testPerSrc)
1867 return ok && test.isAllTestsVariation()
1868}
1869
Chris Parsons216e10a2020-07-09 17:12:52 -04001870func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001871 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001872 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001873 }); ok {
1874 return p.dataPaths()
1875 }
1876 return nil
1877}
1878
Ivan Lozanof1868af2022-04-12 13:08:36 -04001879func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001880 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1881 // "current", it will append the VNDK version to the name suffix.
1882 var vndkVersion string
1883 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001884 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001885 if c.ProductSpecific() {
1886 // If the module is product specific with 'product_specific: true',
1887 // do not add a name suffix because it is a base module.
1888 return ""
1889 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001890 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001891 } else {
1892 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001893 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001894 }
1895 if vndkVersion == "current" {
1896 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1897 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001898 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001899 // add version suffix only if the module is using different vndk version than the
1900 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001901 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001902 }
1903 return nameSuffix
1904}
1905
Ivan Lozanof1868af2022-04-12 13:08:36 -04001906func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1907 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001908
1909 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001910 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001911 }
1912
Colin Cross127bb8b2020-12-16 16:46:01 -08001913 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001914 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001915 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1916 // added for product variant only when we have vendor and product variants with core
1917 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001918 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001919 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001920 subName += vendorPublicLibrarySuffix
1921 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001922 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1923 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001924 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001925 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001926 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001927 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001928 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001929 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001930 subName += RecoverySuffix
1931 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1932 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001933 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001934 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001935 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001936 } else if c.IsStubs() && c.IsSdkVariant() {
1937 // Public API surface (NDK)
1938 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1939 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001940 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001941
1942 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001943}
1944
Sam Delmerico75dbca22023-04-20 13:13:25 +00001945func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1946 ctx := &moduleContext{
1947 ModuleContext: actx,
1948 moduleContextImpl: moduleContextImpl{
1949 mod: c,
1950 },
1951 }
1952 ctx.ctx = ctx
1953 return ctx
1954}
1955
Spandan Das20fce2d2023-04-12 17:21:39 +00001956// TODO (b/277651159): Remove this allowlist
1957var (
1958 skipStubLibraryMultipleApexViolation = map[string]bool{
1959 "libclang_rt.asan": true,
1960 "libclang_rt.hwasan": true,
1961 // runtime apex
1962 "libc": true,
1963 "libc_hwasan": true,
1964 "libdl_android": true,
1965 "libm": true,
1966 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001967 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001968 // art apex
1969 "libandroidio": true,
1970 "libdexfile": true,
1971 "libnativebridge": true,
1972 "libnativehelper": true,
1973 "libnativeloader": true,
1974 "libsigchain": true,
1975 }
1976)
1977
1978// Returns true if a stub library could be installed in multiple apexes
1979func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1980 // If this is not an apex variant, no check necessary
1981 if !c.InAnyApex() {
1982 return false
1983 }
1984 // If this is not a stub library, no check necessary
1985 if !c.HasStubsVariants() {
1986 return false
1987 }
1988 // Skip the allowlist
1989 // Use BaseModuleName so that this matches prebuilts.
1990 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1991 return false
1992 }
1993
1994 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1995 // Stub libraries should not have more than one apex_available
1996 if len(aaWithoutTestApexes) > 1 {
1997 return true
1998 }
1999 // Stub libraries should not use the wildcard
2000 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2001 return true
2002 }
2003 // Default: no violation
2004 return false
2005}
2006
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002007func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2008 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2009}
2010
Chris Parsons8d6e4332021-02-22 16:13:50 -05002011func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
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
Sam Delmerico75dbca22023-04-20 13:13:25 +00002030 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002031
Colin Crossf18e1102017-11-16 14:33:08 -08002032 deps := c.depsToPaths(ctx)
2033 if ctx.Failed() {
2034 return
2035 }
2036
Joe Onorato37f900c2023-07-18 16:58:16 -07002037 for _, generator := range c.generators {
2038 gen := generator.GeneratorSources(ctx)
2039 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2040 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2041 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2042 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2043 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2044 if len(deps.Objs.objFiles) == 0 {
2045 // If we are reusuing object files (which happens when we're a shared library and we're
2046 // reusing our static variant's object files), then skip adding the actual source files,
2047 // because we already have the object for it.
2048 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2049 }
2050 }
2051
2052 if ctx.Failed() {
2053 return
2054 }
2055
Spandan Das20fce2d2023-04-12 17:21:39 +00002056 if c.stubLibraryMultipleApexViolation(actx) {
2057 actx.PropertyErrorf("apex_available",
2058 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2059 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002060 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2061 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002062 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2063 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002064 }
2065
Colin Crossca860ac2016-01-04 14:34:37 -08002066 flags := Flags{
2067 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002068 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002069 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002070 for _, generator := range c.generators {
2071 flags = generator.GeneratorFlags(ctx, flags, deps)
2072 }
Colin Crossca860ac2016-01-04 14:34:37 -08002073 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002074 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002075 }
2076 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002077 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002078 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002079 if c.stl != nil {
2080 flags = c.stl.flags(ctx, flags)
2081 }
Colin Cross16b23492016-01-06 14:41:07 -08002082 if c.sanitize != nil {
2083 flags = c.sanitize.flags(ctx, flags)
2084 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002085 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002086 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002087 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002088 if c.fuzzer != nil {
2089 flags = c.fuzzer.flags(ctx, flags)
2090 }
Stephen Craneba090d12017-05-09 15:44:35 -07002091 if c.lto != nil {
2092 flags = c.lto.flags(ctx, flags)
2093 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002094 if c.afdo != nil {
2095 flags = c.afdo.flags(ctx, flags)
2096 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002097 if c.orderfile != nil {
2098 flags = c.orderfile.flags(ctx, flags)
2099 }
Colin Crossca860ac2016-01-04 14:34:37 -08002100 for _, feature := range c.features {
2101 flags = feature.flags(ctx, flags)
2102 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002103 if ctx.Failed() {
2104 return
2105 }
2106
Colin Cross4af21ed2019-11-04 09:37:55 -08002107 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2108 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2109 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002110
Colin Cross4af21ed2019-11-04 09:37:55 -08002111 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002112
2113 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002114 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002115 }
2116 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002117 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002118 }
2119
Colin Cross3e5e7782022-06-17 22:17:05 +00002120 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2121
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002122 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002123 // We need access to all the flags seen by a source file.
2124 if c.sabi != nil {
2125 flags = c.sabi.flags(ctx, flags)
2126 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002127
Colin Cross4af21ed2019-11-04 09:37:55 -08002128 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002129
Joe Onorato37f900c2023-07-18 16:58:16 -07002130 for _, generator := range c.generators {
2131 generator.GeneratorBuildActions(ctx, flags, deps)
2132 }
2133
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002134 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002135 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002136 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002137 if ctx.Failed() {
2138 return
2139 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002140 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002141 c.objFiles = objs.objFiles
2142 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002143 }
2144
Colin Crossca860ac2016-01-04 14:34:37 -08002145 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002146 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002147 if ctx.Failed() {
2148 return
2149 }
Colin Cross635c3b02016-05-18 15:37:25 -07002150 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002151
Chris Parsons94a0bba2021-06-04 15:03:47 -04002152 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002153
Jose Galmes6f843bc2020-12-11 13:36:29 -08002154 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2155 // RECOVERY_SNAPSHOT_VERSION is current.
2156 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002157 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002158 i.collectHeadersForSnapshot(ctx)
2159 }
2160 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002161 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002162 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002163 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002164 }
Colin Cross40213022023-12-13 15:19:49 -08002165 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002166
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002167 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002168
Chris Parsons94a0bba2021-06-04 15:03:47 -04002169 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002170
2171 if c.linker != nil {
2172 moduleInfoJSON := ctx.ModuleInfoJSON()
2173 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2174 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2175 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2176 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2177 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2178
2179 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2180 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2181 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2182 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2183
2184 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2185 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2186 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2187 moduleInfoJSON.SubName += ".cfi"
2188 }
2189 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2190 moduleInfoJSON.SubName += ".hwasan"
2191 }
2192 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2193 moduleInfoJSON.SubName += ".scs"
2194 }
2195 }
2196 moduleInfoJSON.SubName += c.Properties.SubName
2197
2198 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2199 moduleInfoJSON.Uninstallable = true
2200 }
2201
2202 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002203}
2204
2205func (c *Module) maybeUnhideFromMake() {
2206 // If a lib is directly included in any of the APEXes or is not available to the
2207 // platform (which is often the case when the stub is provided as a prebuilt),
2208 // unhide the stubs variant having the latest version gets visible to make. In
2209 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2210 // force anything in the make world to link against the stubs library. (unless it
2211 // is explicitly referenced via .bootstrap suffix or the module is marked with
2212 // 'bootstrap: true').
2213 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002214 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002215 c.IsStubs() && !c.InVendorRamdisk() {
2216 c.Properties.HideFromMake = false // unhide
2217 // Note: this is still non-installable
2218 }
2219}
2220
Colin Cross8ff10582023-12-07 13:10:56 -08002221// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2222// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002223func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002224 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002225 // If the module has been specifically configure to not be installed then
2226 // hide from make as otherwise it will break when running inside make
2227 // as the output path to install will not be specified. Not all uninstallable
2228 // modules can be hidden from make as some are needed for resolving make side
2229 // dependencies.
2230 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002231 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002232 c.SkipInstall()
2233 }
2234
2235 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2236 // to allow using the outputs in a genrule.
2237 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002238 c.installer.install(ctx, c.outputFile.Path())
2239 if ctx.Failed() {
2240 return
Colin Crossca860ac2016-01-04 14:34:37 -08002241 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002242 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002243}
2244
Colin Cross0ea8ba82019-06-06 14:33:29 -07002245func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002246 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002247 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002248 }
Colin Crossca860ac2016-01-04 14:34:37 -08002249 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002250}
2251
Colin Crossca860ac2016-01-04 14:34:37 -08002252func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002253 for _, generator := range c.generators {
2254 generator.GeneratorInit(ctx)
2255 }
Colin Crossca860ac2016-01-04 14:34:37 -08002256 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002257 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002258 }
Colin Crossca860ac2016-01-04 14:34:37 -08002259 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002260 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002261 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002262 if c.stl != nil {
2263 c.stl.begin(ctx)
2264 }
Colin Cross16b23492016-01-06 14:41:07 -08002265 if c.sanitize != nil {
2266 c.sanitize.begin(ctx)
2267 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002268 if c.coverage != nil {
2269 c.coverage.begin(ctx)
2270 }
Yi Kong9723e332023-12-04 14:52:53 +09002271 if c.afdo != nil {
2272 c.afdo.begin(ctx)
2273 }
Stephen Craneba090d12017-05-09 15:44:35 -07002274 if c.lto != nil {
2275 c.lto.begin(ctx)
2276 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002277 if c.orderfile != nil {
2278 c.orderfile.begin(ctx)
2279 }
Dan Albert92fe7402020-07-15 13:33:30 -07002280 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002281 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002282 if err != nil {
2283 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002284 c.Properties.Sdk_version = nil
2285 } else {
2286 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002287 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002288 }
Colin Crossca860ac2016-01-04 14:34:37 -08002289}
2290
Colin Cross37047f12016-12-13 17:06:13 -08002291func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002292 deps := Deps{}
2293
Joe Onorato37f900c2023-07-18 16:58:16 -07002294 for _, generator := range c.generators {
2295 deps = generator.GeneratorDeps(ctx, deps)
2296 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002297 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002298 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002299 }
2300 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002301 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002302 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002303 if c.stl != nil {
2304 deps = c.stl.deps(ctx, deps)
2305 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002306 if c.coverage != nil {
2307 deps = c.coverage.deps(ctx, deps)
2308 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002309
Colin Crossb6715442017-10-24 11:13:31 -07002310 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2311 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2312 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2313 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2314 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2315 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002316 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002317
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002318 for _, lib := range deps.ReexportSharedLibHeaders {
2319 if !inList(lib, deps.SharedLibs) {
2320 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2321 }
2322 }
2323
2324 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002325 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2326 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 -07002327 }
2328 }
2329
Colin Cross5950f382016-12-13 12:50:57 -08002330 for _, lib := range deps.ReexportHeaderLibHeaders {
2331 if !inList(lib, deps.HeaderLibs) {
2332 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2333 }
2334 }
2335
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002336 for _, gen := range deps.ReexportGeneratedHeaders {
2337 if !inList(gen, deps.GeneratedHeaders) {
2338 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2339 }
2340 }
2341
Colin Crossc99deeb2016-04-11 15:06:20 -07002342 return deps
2343}
2344
Dan Albert7e9d2952016-08-04 13:02:36 -07002345func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002346 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002347 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002348 moduleContextImpl: moduleContextImpl{
2349 mod: c,
2350 },
2351 }
2352 ctx.ctx = ctx
2353
Ke-Yu Lu0be9d602024-02-06 02:15:03 +00002354 if !actx.Host() || !ctx.static() || ctx.staticBinary() {
2355 c.afdo.addDep(ctx, actx)
2356 }
2357
Colin Crossca860ac2016-01-04 14:34:37 -08002358 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002359}
2360
Jiyong Park7ed9de32018-10-15 22:25:07 +09002361// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002362func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002363 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2364 version := name[sharp+1:]
2365 libname := name[:sharp]
2366 return libname, version
2367 }
2368 return name, ""
2369}
2370
Dan Albert92fe7402020-07-15 13:33:30 -07002371func GetCrtVariations(ctx android.BottomUpMutatorContext,
2372 m LinkableInterface) []blueprint.Variation {
2373 if ctx.Os() != android.Android {
2374 return nil
2375 }
2376 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002377 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2378 minSdkVersion := m.MinSdkVersion()
2379 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2380 minSdkVersion = m.SdkVersion()
2381 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002382 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2383 if err != nil {
2384 ctx.PropertyErrorf("min_sdk_version", err.Error())
2385 }
Colin Cross363ec762023-01-13 13:45:14 -08002386
2387 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002388 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002389 if apiLevel.LessThan(minApiForArch) {
2390 apiLevel = minApiForArch
2391 }
2392
Dan Albert92fe7402020-07-15 13:33:30 -07002393 return []blueprint.Variation{
2394 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002395 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002396 }
2397 }
2398 return []blueprint.Variation{
2399 {Mutator: "sdk", Variation: ""},
2400 }
2401}
2402
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002403func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2404 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002405
2406 variations = append([]blueprint.Variation(nil), variations...)
2407
Liz Kammer23942242022-04-08 15:41:00 -04002408 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002409 // Version is explicitly specified. i.e. libFoo#30
2410 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002411 if tag, ok := depTag.(libraryDependencyTag); ok {
2412 tag.explicitlyVersioned = true
2413 } else {
2414 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2415 }
Colin Crosse7257d22020-09-24 09:56:18 -07002416 }
Colin Crosse7257d22020-09-24 09:56:18 -07002417
Colin Cross0de8a1e2020-09-18 14:15:30 -07002418 if far {
2419 ctx.AddFarVariationDependencies(variations, depTag, name)
2420 } else {
2421 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002422 }
2423}
2424
Kiyoung Kim487689e2022-07-26 09:48:22 +09002425func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2426 apiImportInfo := multitree.ApiImportInfo{}
2427
2428 if c.Device() {
2429 var apiImportModule []blueprint.Module
2430 if actx.OtherModuleExists("api_imports") {
2431 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2432 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002433 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002434 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002435 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002436 }
2437 }
2438 }
2439
2440 return apiImportInfo
2441}
2442
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002443func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002444 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002445 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002446 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002447 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2448 // between the modules in the snapshot and the snapshot itself.
2449 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002450 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002451 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002452 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002453 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2454 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002455 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002456 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002457 *snapshotInfo = &snapshot
2458 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002459 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002460 }
2461 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002462 if *snapshotInfo == nil {
2463 *snapshotInfo = &SnapshotInfo{}
2464 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002465 return **snapshotInfo
2466}
2467
Kiyoung Kim487689e2022-07-26 09:48:22 +09002468func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2469 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002470 return snapshot
2471 }
2472
2473 return lib
2474}
2475
2476// RewriteLibs takes a list of names of shared libraries and scans it for three types
2477// of names:
2478//
2479// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002480//
2481// For each of these, it adds the name of the prebuilt module (which will be in
2482// prebuilts/ndk) to the list of nonvariant libs.
2483//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002484// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002485//
2486// For each of these, it adds the name of the ndk_library module to the list of
2487// variant libs.
2488//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002489// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002490//
2491// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002492//
2493// The caller can then know to add the variantLibs dependencies differently from the
2494// nonvariantLibs
2495func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2496 variantLibs = []string{}
2497
2498 nonvariantLibs = []string{}
2499 for _, entry := range list {
2500 // strip #version suffix out
2501 name, _ := StubsLibNameAndVersion(entry)
2502 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002503 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002504 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2505 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2506 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002507 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002508 } else {
2509 // put name#version back
2510 nonvariantLibs = append(nonvariantLibs, entry)
2511 }
2512 }
2513 return nonvariantLibs, variantLibs
2514}
2515
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002516func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2517 nonVariantLibs := []string{}
2518 variantLibs := []string{}
2519
2520 for _, lib := range libs {
2521 replaceLibName := GetReplaceModuleName(lib, replaceList)
2522 if replaceLibName == lib {
2523 // Do not handle any libs which are not in API imports
2524 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2525 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2526 variantLibs = append(variantLibs, replaceLibName)
2527 } else {
2528 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2529 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002530 }
2531
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002532 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002533}
2534
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002535func (c *Module) shouldUseApiSurface() bool {
2536 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2537 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2538 // LLNDK Variant
2539 return true
2540 }
2541
2542 if c.Properties.IsSdkVariant {
2543 // NDK Variant
2544 return true
2545 }
2546
2547 if c.isImportedApiLibrary() {
2548 // API Library should depend on API headers
2549 return true
2550 }
2551 }
2552
2553 return false
2554}
2555
Colin Cross1e676be2016-10-12 14:38:15 -07002556func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002557 if !c.Enabled() {
2558 return
2559 }
2560
Colin Cross37047f12016-12-13 17:06:13 -08002561 ctx := &depsContext{
2562 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002563 moduleContextImpl: moduleContextImpl{
2564 mod: c,
2565 },
2566 }
2567 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002568
Colin Crossc99deeb2016-04-11 15:06:20 -07002569 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002570 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002571
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002572 apiNdkLibs := []string{}
2573 apiLateNdkLibs := []string{}
2574
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002575 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002576 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2577 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2578 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2579 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2580 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002581 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002582
Yo Chiang219968c2020-09-22 18:45:04 +08002583 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2584
Colin Crosse0edaf92021-01-11 17:31:17 -08002585 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002586
Dan Albert914449f2016-06-17 16:45:24 -07002587 variantNdkLibs := []string{}
2588 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002589 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002590 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2591 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2592 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002593
2594 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002595 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002596 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002597 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002598
Colin Cross32ec36c2016-12-15 07:39:51 -08002599 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002600 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002601 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002602 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002603 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002604
Kiyoung Kim51279d32022-08-24 14:10:46 +09002605 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002606 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002607 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2608 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002609 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002610
Spandan Das73bcafc2022-08-18 23:26:00 +00002611 if c.isNDKStubLibrary() {
2612 // ndk_headers do not have any variations
2613 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002614 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002615 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002616 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002617 } else {
2618 actx.AddVariationDependencies(nil, depTag, lib)
2619 }
2620 }
2621
Dan Albertf1d14c72020-07-30 14:32:55 -07002622 if c.isNDKStubLibrary() {
2623 // NDK stubs depend on their implementation because the ABI dumps are
2624 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002625
Spandan Das8b08aea2023-03-14 19:29:34 +00002626 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2627 c.ImageVariation(),
2628 blueprint.Variation{Mutator: "link", Variation: "shared"},
2629 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002630 }
2631
Jiyong Park5d1598f2019-02-25 22:14:17 +09002632 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002633 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002634
Kiyoung Kim487689e2022-07-26 09:48:22 +09002635 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002636
Jiyong Park5d1598f2019-02-25 22:14:17 +09002637 actx.AddVariationDependencies([]blueprint.Variation{
2638 {Mutator: "link", Variation: "static"},
2639 }, depTag, lib)
2640 }
2641
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002642 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002643 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002644 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002645 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002646 }
Jiyong Parke3867542020-12-03 17:28:25 +09002647 if inList(lib, deps.ExcludeLibsForApex) {
2648 depTag.excludeInApex = true
2649 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002650
Kiyoung Kim487689e2022-07-26 09:48:22 +09002651 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002652
Dan Willemsen59339a22018-07-22 21:18:45 -07002653 actx.AddVariationDependencies([]blueprint.Variation{
2654 {Mutator: "link", Variation: "static"},
2655 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002656 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002657
Jooyung Han75568392020-03-20 04:29:24 +09002658 // staticUnwinderDep is treated as staticDep for Q apexes
2659 // so that native libraries/binaries are linked with static unwinder
2660 // because Q libc doesn't have unwinder APIs
2661 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002662 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002663 actx.AddVariationDependencies([]blueprint.Variation{
2664 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002665 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002666 }
2667
Jiyong Park7ed9de32018-10-15 22:25:07 +09002668 // shared lib names without the #version suffix
2669 var sharedLibNames []string
2670
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002671 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002672 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002673 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002674 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002675 }
Jiyong Parke3867542020-12-03 17:28:25 +09002676 if inList(lib, deps.ExcludeLibsForApex) {
2677 depTag.excludeInApex = true
2678 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002679 if inList(lib, deps.ExcludeLibsForNonApex) {
2680 depTag.excludeInNonApex = true
2681 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002682
Jiyong Park73c54ee2019-10-22 20:31:18 +09002683 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002684 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2685 name = apiLibraryName
2686 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002687 sharedLibNames = append(sharedLibNames, name)
2688
Colin Crosse7257d22020-09-24 09:56:18 -07002689 variations := []blueprint.Variation{
2690 {Mutator: "link", Variation: "shared"},
2691 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002692
2693 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2694 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2695 }
2696
2697 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2698 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2699 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002700 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002701
Colin Crossfe9acfe2021-06-14 16:13:03 -07002702 for _, lib := range deps.LateStaticLibs {
2703 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2704 actx.AddVariationDependencies([]blueprint.Variation{
2705 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002706 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002707 }
2708
Colin Cross3e5e7782022-06-17 22:17:05 +00002709 for _, lib := range deps.UnexportedStaticLibs {
2710 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2711 actx.AddVariationDependencies([]blueprint.Variation{
2712 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002713 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002714 }
2715
Jiyong Park7ed9de32018-10-15 22:25:07 +09002716 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002717 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002718 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2719 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2720 // linking against both the stubs lib and the non-stubs lib at the same time.
2721 continue
2722 }
Colin Cross6e511a92020-07-27 21:26:48 -07002723 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002724 variations := []blueprint.Variation{
2725 {Mutator: "link", Variation: "shared"},
2726 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002727 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002728 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002729
Dan Willemsen59339a22018-07-22 21:18:45 -07002730 actx.AddVariationDependencies([]blueprint.Variation{
2731 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002732 }, dataLibDepTag, deps.DataLibs...)
2733
Colin Crossc8caa062021-09-24 16:50:14 -07002734 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2735
Chris Parsons79d66a52020-06-05 17:26:16 -04002736 actx.AddVariationDependencies([]blueprint.Variation{
2737 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002738 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002739
Colin Cross68861832016-07-08 10:41:41 -07002740 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002741
2742 for _, gen := range deps.GeneratedHeaders {
2743 depTag := genHeaderDepTag
2744 if inList(gen, deps.ReexportGeneratedHeaders) {
2745 depTag = genHeaderExportDepTag
2746 }
2747 actx.AddDependency(c, depTag, gen)
2748 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002749
Dan Albert92fe7402020-07-15 13:33:30 -07002750 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002751 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002752 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002753 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002754 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002755 }
Colin Crossc465efd2021-06-11 18:00:04 -07002756 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002757 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002758 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002759 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002760 if deps.DynamicLinker != "" {
2761 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002762 }
Dan Albert914449f2016-06-17 16:45:24 -07002763
2764 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002765
2766 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002767 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002768 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002769 {Mutator: "link", Variation: "shared"},
2770 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002771 actx.AddVariationDependencies([]blueprint.Variation{
2772 {Mutator: "version", Variation: version},
2773 {Mutator: "link", Variation: "shared"},
2774 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002775
2776 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002777 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002778 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002779 {Mutator: "link", Variation: "shared"},
2780 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002781 actx.AddVariationDependencies([]blueprint.Variation{
2782 {Mutator: "version", Variation: version},
2783 {Mutator: "link", Variation: "shared"},
2784 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002785
2786 if vndkdep := c.vndkdep; vndkdep != nil {
2787 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002788 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002789 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002790 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002791 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002792 }
2793 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002794
Vinh Tran367d89d2023-04-28 11:21:25 -04002795 if len(deps.AidlLibs) > 0 {
2796 actx.AddDependency(
2797 c,
2798 aidlLibraryTag,
2799 deps.AidlLibs...,
2800 )
2801 }
2802
Kiyoung Kimee58c932022-10-25 22:59:41 +09002803 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002804}
Colin Cross21b9a242015-03-24 14:15:58 -07002805
Colin Crosse40b4ea2018-10-02 22:25:58 -07002806func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002807 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2808 c.beginMutator(ctx)
2809 }
2810}
2811
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002812// Whether a module can link to another module, taking into
2813// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002814func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002815 tag blueprint.DependencyTag) {
2816
2817 switch t := tag.(type) {
2818 case dependencyTag:
2819 if t != vndkExtDepTag {
2820 return
2821 }
2822 case libraryDependencyTag:
2823 default:
2824 return
2825 }
2826
Ivan Lozanof9e21722020-12-02 09:00:51 -05002827 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002828 // Host code is not restricted
2829 return
2830 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002831
2832 // VNDK is cc.Module supported only for now.
2833 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002834 // Though allowed dependency is limited by the image mutator,
2835 // each vendor and product module needs to check link-type
2836 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002837 if ccTo, ok := to.(*Module); ok {
2838 if ccFrom.vndkdep != nil {
2839 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2840 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002841 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002842 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002843 }
2844 return
2845 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002846 // TODO(b/244244438) : Remove this once all variants are implemented
2847 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2848 return
2849 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002850 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002851 // Platform code can link to anything
2852 return
2853 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002854 if from.InRamdisk() {
2855 // Ramdisk code is not NDK
2856 return
2857 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002858 if from.InVendorRamdisk() {
2859 // Vendor ramdisk code is not NDK
2860 return
2861 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002862 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002863 // Recovery code is not NDK
2864 return
2865 }
Colin Cross31076b32020-10-23 17:22:06 -07002866 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002867 if c.NdkPrebuiltStl() {
2868 // These are allowed, but they don't set sdk_version
2869 return
2870 }
2871 if c.StubDecorator() {
2872 // These aren't real libraries, but are the stub shared libraries that are included in
2873 // the NDK.
2874 return
2875 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002876 if c.isImportedApiLibrary() {
2877 // Imported library from the API surface is a stub library built against interface definition.
2878 return
2879 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002880 }
Logan Chien834b9a62019-01-14 15:39:03 +08002881
Ivan Lozano52767be2019-10-18 14:49:46 -07002882 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002883 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2884 // to link to libc++ (non-NDK and without sdk_version).
2885 return
2886 }
2887
Ivan Lozano52767be2019-10-18 14:49:46 -07002888 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002889 // NDK code linking to platform code is never okay.
2890 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002891 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002892 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002893 }
2894
2895 // At this point we know we have two NDK libraries, but we need to
2896 // check that we're not linking against anything built against a higher
2897 // API level, as it is only valid to link against older or equivalent
2898 // APIs.
2899
Inseob Kim01a28722018-04-11 09:48:45 +09002900 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002901 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002902 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002903 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002904 // Current can't be linked against by anything else.
2905 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002906 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002907 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002908 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002909 if err != nil {
2910 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002911 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002912 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002913 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002914 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002915 if err != nil {
2916 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002917 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002918 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002919 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002920
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002921 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002922 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002923 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002924 }
2925 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002926 }
Dan Albert202fe492017-12-15 13:56:59 -08002927
2928 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002929 fromStl := from.SelectedStl()
2930 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002931 if fromStl == "" || toStl == "" {
2932 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002933 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002934 // We can be permissive with the system "STL" since it is only the C++
2935 // ABI layer, but in the future we should make sure that everyone is
2936 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002937 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002938 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002939 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2940 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002941 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002942}
2943
Jooyung Han479ca172020-10-19 18:51:07 +09002944func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2945 if c, ok := ctx.Module().(*Module); ok {
2946 ctx.VisitDirectDeps(func(dep android.Module) {
2947 depTag := ctx.OtherModuleDependencyTag(dep)
2948 ccDep, ok := dep.(LinkableInterface)
2949 if ok {
2950 checkLinkType(ctx, c, ccDep, depTag)
2951 }
2952 })
2953 }
2954}
2955
Jiyong Park5fb8c102018-04-09 12:03:06 +09002956// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002957// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2958// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002959// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002960func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2961 check := func(child, parent android.Module) bool {
2962 to, ok := child.(*Module)
2963 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002964 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002965 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002966
Jooyung Hana70f0672019-01-18 15:20:43 +09002967 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2968 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002969 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002970
Jiyong Park0474e1f2021-01-14 14:26:06 +09002971 // These dependencies are not excercised at runtime. Tracking these will give us
2972 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002973 depTag := ctx.OtherModuleDependencyTag(child)
2974 if IsHeaderDepTag(depTag) {
2975 return false
2976 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002977 if depTag == staticVariantTag {
2978 return false
2979 }
2980 if depTag == stubImplDepTag {
2981 return false
2982 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002983
Justin Yun63e9ec72020-10-29 16:49:43 +09002984 // Even if target lib has no vendor variant, keep checking dependency
2985 // graph in case it depends on vendor_available or product_available
2986 // but not double_loadable transtively.
2987 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002988 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002989 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002990
Jiyong Park0474e1f2021-01-14 14:26:06 +09002991 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2992 // one.
2993 if Bool(to.VendorProperties.Double_loadable) {
2994 return true
2995 }
2996
Ivan Lozanod7586b62021-04-01 09:49:36 -04002997 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002998 return false
2999 }
3000
Jooyung Hana70f0672019-01-18 15:20:43 +09003001 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3002 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003003 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003004 return false
3005 }
3006 if module, ok := ctx.Module().(*Module); ok {
3007 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003008 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003009 ctx.WalkDeps(check)
3010 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003011 }
3012 }
3013}
3014
Yu Liue4312402023-01-18 09:15:31 -08003015func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3016 // For the dependency from platform to apex, use the latest stubs
3017 apexSdkVersion := android.FutureApiLevel
3018 if !apexInfo.IsForPlatform() {
3019 apexSdkVersion = apexInfo.MinSdkVersion
3020 }
3021
3022 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3023 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3024 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3025 // (b/144430859)
3026 apexSdkVersion = android.FutureApiLevel
3027 }
3028
3029 return apexSdkVersion
3030}
3031
Colin Crossc99deeb2016-04-11 15:06:20 -07003032// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003033func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003034 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003035
Colin Cross0de8a1e2020-09-18 14:15:30 -07003036 var directStaticDeps []StaticLibraryInfo
3037 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003038
Colin Cross0de8a1e2020-09-18 14:15:30 -07003039 reexportExporter := func(exporter FlagExporterInfo) {
3040 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3041 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3042 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3043 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3044 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003045 }
3046
Colin Crossff694a82023-12-13 15:54:49 -08003047 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003048 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003049
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003050 skipModuleList := map[string]bool{}
3051
3052 var apiImportInfo multitree.ApiImportInfo
3053 hasApiImportInfo := false
3054
3055 ctx.VisitDirectDeps(func(dep android.Module) {
3056 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003057 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003058 hasApiImportInfo = true
3059 }
3060 })
3061
3062 if hasApiImportInfo {
3063 targetStubModuleList := map[string]string{}
3064 targetOrigModuleList := map[string]string{}
3065
3066 // Search for dependency which both original module and API imported library with APEX stub exists
3067 ctx.VisitDirectDeps(func(dep android.Module) {
3068 depName := ctx.OtherModuleName(dep)
3069 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3070 targetStubModuleList[apiLibrary] = depName
3071 }
3072 })
3073 ctx.VisitDirectDeps(func(dep android.Module) {
3074 depName := ctx.OtherModuleName(dep)
3075 if origLibrary, ok := targetStubModuleList[depName]; ok {
3076 targetOrigModuleList[origLibrary] = depName
3077 }
3078 })
3079
3080 // Decide which library should be used between original and API imported library
3081 ctx.VisitDirectDeps(func(dep android.Module) {
3082 depName := ctx.OtherModuleName(dep)
3083 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003084 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003085 skipModuleList[depName] = true
3086 } else {
3087 skipModuleList[apiLibrary] = true
3088 }
3089 }
3090 })
3091 }
3092
Colin Crossd11fcda2017-10-23 17:59:01 -07003093 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003094 depName := ctx.OtherModuleName(dep)
3095 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003096
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003097 if _, ok := skipModuleList[depName]; ok {
3098 // skip this module because original module or API imported module matching with this should be used instead.
3099 return
3100 }
3101
Dan Willemsen47450072021-10-19 20:24:49 -07003102 if depTag == android.DarwinUniversalVariantTag {
3103 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3104 return
3105 }
3106
Vinh Tran367d89d2023-04-28 11:21:25 -04003107 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003108 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003109 depPaths.AidlLibraryInfos = append(
3110 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003111 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003112 )
3113 }
3114 }
3115
Ivan Lozano52767be2019-10-18 14:49:46 -07003116 ccDep, ok := dep.(LinkableInterface)
3117 if !ok {
3118
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003119 // handling for a few module types that aren't cc Module but that are also supported
3120 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003121 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003122 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003123 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3124 genRule.GeneratedSourceFiles()...)
3125 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003126 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003127 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003128 // Support exported headers from a generated_sources dependency
3129 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003130 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003131 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003132 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003133 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003134 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003135 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003136 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003137 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003138 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3139 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003140 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003141 // 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 +09003142 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003143
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003144 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003145 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003146 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003147 }
Colin Crosscef792e2021-06-11 18:01:26 -07003148 case CrtBeginDepTag:
3149 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3150 case CrtEndDepTag:
3151 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003152 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003153 return
3154 }
3155
Colin Crossfe17f6f2019-03-28 19:30:56 -07003156 if depTag == android.ProtoPluginDepTag {
3157 return
3158 }
3159
Colin Crossd11fcda2017-10-23 17:59:01 -07003160 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003161 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3162 return
3163 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003164 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003165 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3166 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003167 return
3168 }
3169
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003170 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003171 // Skip reused objects for stub libraries, they use their own stub object file instead.
3172 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3173 // version mutator, so the stubs variant is created from the shared variant that
3174 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003175 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003176 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003177 objs := staticAnalogue.ReuseObjects
3178 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003179 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003180 reexportExporter(depExporterInfo)
3181 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003182 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003183 }
3184
Colin Cross6e511a92020-07-27 21:26:48 -07003185 linkFile := ccDep.OutputFile()
3186
3187 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3188 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003189 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003190 return
3191 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003192
Jiyong Parke3867542020-12-03 17:28:25 +09003193 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3194 return
3195 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003196 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3197 return
3198 }
Jiyong Parke3867542020-12-03 17:28:25 +09003199
Colin Cross313aa542023-12-13 13:47:44 -08003200 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003201
Colin Cross6e511a92020-07-27 21:26:48 -07003202 var ptr *android.Paths
3203 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003204
Colin Cross6e511a92020-07-27 21:26:48 -07003205 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003206
Colin Cross6e511a92020-07-27 21:26:48 -07003207 switch {
3208 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003209 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003210 if !ctx.Config().AllowMissingDependencies() {
3211 ctx.ModuleErrorf("module %q is not a header library", depName)
3212 } else {
3213 ctx.AddMissingDependencies([]string{depName})
3214 }
3215 return
3216 }
Colin Cross6e511a92020-07-27 21:26:48 -07003217 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003218 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003219 if !ctx.Config().AllowMissingDependencies() {
3220 ctx.ModuleErrorf("module %q is not a shared library", depName)
3221 } else {
3222 ctx.AddMissingDependencies([]string{depName})
3223 }
3224 return
3225 }
Jiyong Parke3867542020-12-03 17:28:25 +09003226
Jiyong Park7d55b612021-06-11 17:22:09 +09003227 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3228 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003229
Jiyong Park1ad8e162020-12-01 23:40:09 +09003230 // Stubs lib doesn't link to the shared 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(sharedLibraryInfo.SharedLibrary)
3237 depFile = sharedLibraryInfo.TableOfContents
3238
Colin Cross6e511a92020-07-27 21:26:48 -07003239 ptr = &depPaths.SharedLibs
3240 switch libDepTag.Order {
3241 case earlyLibraryDependency:
3242 ptr = &depPaths.EarlySharedLibs
3243 depPtr = &depPaths.EarlySharedLibsDeps
3244 case normalLibraryDependency:
3245 ptr = &depPaths.SharedLibs
3246 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003247 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003248 case lateLibraryDependency:
3249 ptr = &depPaths.LateSharedLibs
3250 depPtr = &depPaths.LateSharedLibsDeps
3251 default:
3252 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003253 }
Colin Cross6e511a92020-07-27 21:26:48 -07003254 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003255 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3256 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003257 if !ctx.Config().AllowMissingDependencies() {
3258 ctx.ModuleErrorf("module %q is not a static library", depName)
3259 } else {
3260 ctx.AddMissingDependencies([]string{depName})
3261 }
3262 return
3263 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003264
3265 // Stubs lib doesn't link to the static lib dependencies. Don't set
3266 // linkFile, depFile, and ptr.
3267 if c.IsStubs() {
3268 break
3269 }
3270
Colin Cross0de8a1e2020-09-18 14:15:30 -07003271 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003272 if libDepTag.wholeStatic {
3273 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003274 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3275 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003276 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003277 // This case normally catches prebuilt static
3278 // libraries, but it can also occur when
3279 // AllowMissingDependencies is on and the
3280 // dependencies has no sources of its own
3281 // but has a whole_static_libs dependency
3282 // on a missing library. We want to depend
3283 // on the .a file so that there is something
3284 // in the dependency tree that contains the
3285 // error rule for the missing transitive
3286 // dependency.
3287 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003288 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003289 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3290 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003291 } else {
3292 switch libDepTag.Order {
3293 case earlyLibraryDependency:
3294 panic(fmt.Errorf("early static libs not suppported"))
3295 case normalLibraryDependency:
3296 // static dependencies will be handled separately so they can be ordered
3297 // using transitive dependencies.
3298 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003299 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003300 case lateLibraryDependency:
3301 ptr = &depPaths.LateStaticLibs
3302 default:
3303 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003304 }
3305 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003306 if libDepTag.unexportedSymbols {
3307 depPaths.LdFlags = append(depPaths.LdFlags,
3308 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3309 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003310 }
3311
Colin Cross6e511a92020-07-27 21:26:48 -07003312 if libDepTag.static() && !libDepTag.wholeStatic {
3313 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3314 ctx.ModuleErrorf("module %q not a static library", depName)
3315 return
3316 }
Logan Chien43d34c32017-12-20 01:17:32 +08003317
Colin Cross6e511a92020-07-27 21:26:48 -07003318 // When combining coverage files for shared libraries and executables, coverage files
3319 // in static libraries act as if they were whole static libraries. The same goes for
3320 // source based Abi dump files.
3321 if c, ok := ccDep.(*Module); ok {
3322 staticLib := c.linker.(libraryInterface)
3323 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3324 staticLib.objs().coverageFiles...)
3325 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3326 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003327 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003328 // Handle non-CC modules here
3329 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003330 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003331 }
3332 }
3333
Colin Cross6e511a92020-07-27 21:26:48 -07003334 if ptr != nil {
3335 if !linkFile.Valid() {
3336 if !ctx.Config().AllowMissingDependencies() {
3337 ctx.ModuleErrorf("module %q missing output file", depName)
3338 } else {
3339 ctx.AddMissingDependencies([]string{depName})
3340 }
3341 return
3342 }
3343 *ptr = append(*ptr, linkFile.Path())
3344 }
3345
3346 if depPtr != nil {
3347 dep := depFile
3348 if !dep.Valid() {
3349 dep = linkFile
3350 }
3351 *depPtr = append(*depPtr, dep.Path())
3352 }
3353
Colin Cross0de8a1e2020-09-18 14:15:30 -07003354 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3355 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3356 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3357 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3358
3359 if libDepTag.reexportFlags {
3360 reexportExporter(depExporterInfo)
3361 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3362 // Re-exported shared library headers must be included as well since they can help us with type information
3363 // about template instantiations (instantiated from their headers).
3364 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3365 // scripts.
3366 c.sabi.Properties.ReexportedIncludes = append(
3367 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3368 }
3369
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003370 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003371 switch {
3372 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003373 c.Properties.AndroidMkHeaderLibs = append(
3374 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003375 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003376 if lib := moduleLibraryInterface(dep); lib != nil {
3377 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003378 // Add the dependency to the APEX(es) providing the library so that
3379 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003380 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003381 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003382 c.Properties.ApexesProvidingSharedLibs = append(
3383 c.Properties.ApexesProvidingSharedLibs, an)
3384 }
3385 }
3386 }
3387
3388 // Note: the order of libs in this list is not important because
3389 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003390 c.Properties.AndroidMkSharedLibs = append(
3391 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003392 // Record BaseLibName for snapshots.
3393 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003394 case libDepTag.static():
3395 if libDepTag.wholeStatic {
3396 c.Properties.AndroidMkWholeStaticLibs = append(
3397 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3398 } else {
3399 c.Properties.AndroidMkStaticLibs = append(
3400 c.Properties.AndroidMkStaticLibs, makeLibName)
3401 }
Justin Yun5e035862021-06-29 20:50:37 +09003402 // Record BaseLibName for snapshots.
3403 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003404 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003405 } else if !c.IsStubs() {
3406 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3407
Colin Cross6e511a92020-07-27 21:26:48 -07003408 switch depTag {
3409 case runtimeDepTag:
3410 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003411 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003412 // Record BaseLibName for snapshots.
3413 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003414 case objDepTag:
3415 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3416 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003417 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003418 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003419 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003420 case dynamicLinkerDepTag:
3421 depPaths.DynamicLinker = linkFile
3422 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003423 }
Colin Crossca860ac2016-01-04 14:34:37 -08003424 })
3425
Jeff Gaston294356f2017-09-27 17:05:30 -07003426 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003427 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3428 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3429 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003430
Colin Crossdd84e052017-05-17 13:44:16 -07003431 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003432 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003433 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3434 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003435 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003436 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3437 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003438 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003439 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003440 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003441
3442 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003443 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003444 }
Colin Crossdd84e052017-05-17 13:44:16 -07003445
Colin Crossca860ac2016-01-04 14:34:37 -08003446 return depPaths
3447}
3448
Spandan Das604f3762023-03-16 22:51:40 +00003449func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003450 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003451 thisModule, ok := ctx.Module().(android.ApexModule)
3452 if !ok {
3453 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3454 }
3455
Kiyoung Kimaa394802024-01-08 12:55:45 +09003456 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003457 bootstrap := false
3458 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3459 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3460 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003461 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003462 bootstrap = linkable.Bootstrap()
3463 }
3464
Colin Crossff694a82023-12-13 15:54:49 -08003465 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003466
3467 useStubs := false
3468
Kiyoung Kimaa394802024-01-08 12:55:45 +09003469 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003470 if !apexInfo.IsForPlatform() {
3471 // For platform libraries, use current version of LLNDK
3472 // If this is for use_vendor apex we will apply the same rules
3473 // of apex sdk enforcement below to choose right version.
3474 useStubs = true
3475 }
3476 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3477 // If not building for APEX or the containing APEX allows the use of
3478 // platform APIs, use stubs only when it is from an APEX (and not from
3479 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3480 // bootstrap modules, always link to non-stub variant
3481 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3482
3483 isApexImportedApiLibrary := false
3484
3485 if cc, ok := dep.(*Module); ok {
3486 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3487 if apiLibrary.hasApexStubs() {
3488 isApexImportedApiLibrary = true
3489 }
3490 }
3491 }
3492
3493 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3494
3495 if useStubs {
3496 // Another exception: if this module is a test for an APEX, then
3497 // it is linked with the non-stub variant of a module in the APEX
3498 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003499 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003500 for _, apexContents := range testFor.ApexContents {
3501 if apexContents.DirectlyInApex(depName) {
3502 useStubs = false
3503 break
3504 }
3505 }
3506 }
3507 if useStubs {
3508 // Yet another exception: If this module and the dependency are
3509 // available to the same APEXes then skip stubs between their
3510 // platform variants. This complements the test_for case above,
3511 // which avoids the stubs on a direct APEX library dependency, by
3512 // avoiding stubs for indirect test dependencies as well.
3513 //
3514 // TODO(b/183882457): This doesn't work if the two libraries have
3515 // only partially overlapping apex_available. For that test_for
3516 // modules would need to be split into APEX variants and resolved
3517 // separately for each APEX they have access to.
3518 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3519 useStubs = false
3520 }
3521 }
3522 } else {
3523 // If building for APEX, use stubs when the parent is in any APEX that
3524 // the child is not in.
3525 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3526 }
3527
3528 return useStubs
3529}
3530
3531// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3532// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3533// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3534// has different level of updatability. For example, if a library foo in an APEX depends on a
3535// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3536// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3537// same APEX as foo, the non-stub variant of bar is used.
3538func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3539 depTag := ctx.OtherModuleDependencyTag(dep)
3540 libDepTag, ok := depTag.(libraryDependencyTag)
3541 if !ok || !libDepTag.shared() {
3542 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3543 }
3544
Colin Cross313aa542023-12-13 13:47:44 -08003545 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3546 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3547 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003548
3549 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003550 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003551 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003552 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3553 toUse := stubs[len(stubs)-1]
3554 sharedLibraryInfo = toUse.SharedLibraryInfo
3555 depExporterInfo = toUse.FlagExporterInfo
3556 }
3557 }
3558 return sharedLibraryInfo, depExporterInfo
3559}
3560
Colin Cross0de8a1e2020-09-18 14:15:30 -07003561// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3562// to match the topological order of the dependency tree, including any static analogues of
3563// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3564// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003565func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3566 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003567 var staticPaths android.Paths
3568 for _, staticDep := range staticDeps {
3569 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3570 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3571 }
3572 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003573 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3574 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003575 }
3576 }
3577 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3578
3579 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3580
3581 // reorder the dependencies based on transitive dependencies
3582 staticPaths = android.FirstUniquePaths(staticPaths)
3583 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3584
3585 if len(orderedStaticPaths) != len(staticPaths) {
3586 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3587 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3588 }
3589
3590 return orderedStaticPaths, transitiveStaticLibs
3591}
3592
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003593// BaseLibName trims known prefixes and suffixes
3594func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003595 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3596 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003597 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003598 return libName
3599}
3600
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003601func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003602 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003603 ccDepModule, _ := ccDep.(*Module)
3604 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003605 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003606
Justin Yuncbca3732021-02-03 19:24:13 +09003607 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003608 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003609 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003610 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003611
Ivan Lozanod1dec542021-05-26 15:33:11 -04003612 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003613 }
3614 }
3615
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003616 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3617 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003618 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3619 // core module instead.
3620 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003621 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003622 // The vendor and product modules in Make will have been renamed to not conflict with the
3623 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003624 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003625 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003626 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003627 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003628 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003629 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003630 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003631 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003632 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003633 } else {
3634 return libName
3635 }
3636}
3637
Colin Crossca860ac2016-01-04 14:34:37 -08003638func (c *Module) InstallInData() bool {
3639 if c.installer == nil {
3640 return false
3641 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003642 return c.installer.inData()
3643}
3644
3645func (c *Module) InstallInSanitizerDir() bool {
3646 if c.installer == nil {
3647 return false
3648 }
3649 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003650 return true
3651 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003652 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003653}
3654
Yifan Hong1b3348d2020-01-21 15:53:22 -08003655func (c *Module) InstallInRamdisk() bool {
3656 return c.InRamdisk()
3657}
3658
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003659func (c *Module) InstallInVendorRamdisk() bool {
3660 return c.InVendorRamdisk()
3661}
3662
Jiyong Parkf9332f12018-02-01 00:54:12 +09003663func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003664 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003665}
3666
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003667func (c *Module) MakeUninstallable() {
3668 if c.installer == nil {
3669 c.ModuleBase.MakeUninstallable()
3670 return
3671 }
3672 c.installer.makeUninstallable(c)
3673}
3674
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003675func (c *Module) HostToolPath() android.OptionalPath {
3676 if c.installer == nil {
3677 return android.OptionalPath{}
3678 }
3679 return c.installer.hostToolPath()
3680}
3681
Nan Zhangd4e641b2017-07-12 12:55:28 -07003682func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3683 return c.outputFile
3684}
3685
Colin Cross41955e82019-05-29 14:40:35 -07003686func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3687 switch tag {
3688 case "":
3689 if c.outputFile.Valid() {
3690 return android.Paths{c.outputFile.Path()}, nil
3691 }
3692 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003693 case "unstripped":
3694 if c.linker != nil {
3695 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3696 }
3697 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003698 case "stripped_all":
3699 if c.linker != nil {
3700 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3701 }
3702 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003703 default:
3704 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003705 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003706}
3707
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003708func (c *Module) static() bool {
3709 if static, ok := c.linker.(interface {
3710 static() bool
3711 }); ok {
3712 return static.static()
3713 }
3714 return false
3715}
3716
Jiyong Park379de2f2018-12-19 02:47:14 +09003717func (c *Module) staticBinary() bool {
3718 if static, ok := c.linker.(interface {
3719 staticBinary() bool
3720 }); ok {
3721 return static.staticBinary()
3722 }
3723 return false
3724}
3725
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003726func (c *Module) testBinary() bool {
3727 if test, ok := c.linker.(interface {
3728 testBinary() bool
3729 }); ok {
3730 return test.testBinary()
3731 }
3732 return false
3733}
3734
Jingwen Chen537242c2022-08-24 11:53:27 +00003735func (c *Module) testLibrary() bool {
3736 if test, ok := c.linker.(interface {
3737 testLibrary() bool
3738 }); ok {
3739 return test.testLibrary()
3740 }
3741 return false
3742}
3743
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003744func (c *Module) benchmarkBinary() bool {
3745 if b, ok := c.linker.(interface {
3746 benchmarkBinary() bool
3747 }); ok {
3748 return b.benchmarkBinary()
3749 }
3750 return false
3751}
3752
3753func (c *Module) fuzzBinary() bool {
3754 if f, ok := c.linker.(interface {
3755 fuzzBinary() bool
3756 }); ok {
3757 return f.fuzzBinary()
3758 }
3759 return false
3760}
3761
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003762// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3763func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003764 if h, ok := c.linker.(interface {
3765 header() bool
3766 }); ok {
3767 return h.header()
3768 }
3769 return false
3770}
3771
Ivan Lozanod7586b62021-04-01 09:49:36 -04003772func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003773 if b, ok := c.linker.(interface {
3774 binary() bool
3775 }); ok {
3776 return b.binary()
3777 }
3778 return false
3779}
3780
Justin Yun5e035862021-06-29 20:50:37 +09003781func (c *Module) StaticExecutable() bool {
3782 if b, ok := c.linker.(*binaryDecorator); ok {
3783 return b.static()
3784 }
3785 return false
3786}
3787
Ivan Lozanod7586b62021-04-01 09:49:36 -04003788func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003789 if o, ok := c.linker.(interface {
3790 object() bool
3791 }); ok {
3792 return o.object()
3793 }
3794 return false
3795}
3796
Ivan Lozanof9e21722020-12-02 09:00:51 -05003797func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003798 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003799 if c.IsLlndk() {
3800 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003801 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003802 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003803 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003804 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003805 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003806 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003807 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003808 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003809 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003810 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003811 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003812 return "native:product"
3813 }
Jooyung Han38002912019-05-16 04:01:54 +09003814 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003815 } else if c.InRamdisk() {
3816 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003817 } else if c.InVendorRamdisk() {
3818 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003819 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003820 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003821 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003822 return "native:ndk:none:none"
3823 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3824 //family, link := getNdkStlFamilyAndLinkType(c)
3825 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003826 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003827 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003828 } else {
3829 return "native:platform"
3830 }
3831}
3832
Jiyong Park9d452992018-10-03 00:38:19 +09003833// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003834// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003835func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003836 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003837 // Stub libs and prebuilt libs in a versioned SDK are not
3838 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003839 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003840 } else if _, ok := c.linker.(testPerSrc); ok {
3841 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003842 }
3843 return false
3844}
3845
Jiyong Parka90ca002019-10-07 15:47:24 +09003846func (c *Module) AvailableFor(what string) bool {
3847 if linker, ok := c.linker.(interface {
3848 availableFor(string) bool
3849 }); ok {
3850 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3851 } else {
3852 return c.ApexModuleBase.AvailableFor(what)
3853 }
3854}
3855
Jiyong Park62304bb2020-04-13 16:19:48 +09003856func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003857 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003858}
3859
Paul Duffin0cb37b92020-03-04 14:52:46 +00003860func (c *Module) EverInstallable() bool {
3861 return c.installer != nil &&
3862 // Check to see whether the module is actually ever installable.
3863 c.installer.everInstallable()
3864}
3865
Ivan Lozanod7586b62021-04-01 09:49:36 -04003866func (c *Module) PreventInstall() bool {
3867 return c.Properties.PreventInstall
3868}
3869
3870func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003871 if c.library != nil {
3872 if i := c.library.installable(); i != nil {
3873 return i
3874 }
3875 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003876 return c.Properties.Installable
3877}
3878
3879func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003880 ret := c.EverInstallable() &&
3881 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003882 proptools.BoolDefault(c.Installable(), true) &&
3883 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003884
3885 // The platform variant doesn't need further condition. Apex variants however might not
3886 // be installable because it will likely to be included in the APEX and won't appear
3887 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003888 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003889 return ret
3890 }
3891
3892 // Special case for modules that are configured to be installed to /data, which includes
3893 // test modules. For these modules, both APEX and non-APEX variants are considered as
3894 // installable. This is because even the APEX variants won't be included in the APEX, but
3895 // will anyway be installed to /data/*.
3896 // See b/146995717
3897 if c.InstallInData() {
3898 return ret
3899 }
3900
3901 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003902}
3903
Logan Chien41eabe62019-04-10 13:33:58 +08003904func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3905 if c.linker != nil {
3906 if library, ok := c.linker.(*libraryDecorator); ok {
3907 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3908 }
3909 }
3910}
3911
Jiyong Park45bf82e2020-12-15 22:29:02 +09003912var _ android.ApexModule = (*Module)(nil)
3913
3914// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003915func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003916 depTag := ctx.OtherModuleDependencyTag(dep)
3917 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3918
3919 if cc, ok := dep.(*Module); ok {
3920 if cc.HasStubsVariants() {
3921 if isLibDepTag && libDepTag.shared() {
3922 // dynamic dep to a stubs lib crosses APEX boundary
3923 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003924 }
Colin Cross6e511a92020-07-27 21:26:48 -07003925 if IsRuntimeDepTag(depTag) {
3926 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003927 return false
3928 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003929 }
Zhijun Heec285872021-04-24 10:47:08 -07003930 if cc.IsLlndk() {
3931 return false
3932 }
Colin Crossaac32222020-07-29 12:51:56 -07003933 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003934 // shared_lib dependency from a static lib is considered as crossing
3935 // the APEX boundary because the dependency doesn't actually is
3936 // linked; the dependency is used only during the compilation phase.
3937 return false
3938 }
Jiyong Parke3867542020-12-03 17:28:25 +09003939
3940 if isLibDepTag && libDepTag.excludeInApex {
3941 return false
3942 }
Colin Cross6e511a92020-07-27 21:26:48 -07003943 }
Colin Crossc1b36442021-05-06 13:42:48 -07003944 if depTag == stubImplDepTag {
3945 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003946 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003947 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003948 if depTag == staticVariantTag {
3949 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3950 // actually mean that the static lib (and its dependencies) are copied into the
3951 // APEX.
3952 return false
3953 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003954 return true
3955}
3956
Jiyong Park45bf82e2020-12-15 22:29:02 +09003957// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003958func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3959 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003960 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3961 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3962 return nil
3963 }
Jooyung Han749dc692020-04-15 11:03:39 +09003964 // We don't check for prebuilt modules
3965 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3966 return nil
3967 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003968
Jooyung Han749dc692020-04-15 11:03:39 +09003969 minSdkVersion := c.MinSdkVersion()
3970 if minSdkVersion == "apex_inherit" {
3971 return nil
3972 }
3973 if minSdkVersion == "" {
3974 // JNI libs within APK-in-APEX fall into here
3975 // Those are okay to set sdk_version instead
3976 // We don't have to check if this is a SDK variant because
3977 // non-SDK variant resets sdk_version, which works too.
3978 minSdkVersion = c.SdkVersion()
3979 }
Dan Albertc8060532020-07-22 22:32:17 -07003980 if minSdkVersion == "" {
3981 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3982 }
3983 // Not using nativeApiLevelFromUser because the context here is not
3984 // necessarily a native context.
3985 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003986 if err != nil {
3987 return err
3988 }
Dan Albertc8060532020-07-22 22:32:17 -07003989
Colin Cross8ca61c12022-10-06 21:00:14 -07003990 // A dependency only needs to support a min_sdk_version at least
3991 // as high as the api level that the architecture was introduced in.
3992 // This allows introducing new architectures in the platform that
3993 // need to be included in apexes that normally require an older
3994 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003995 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003996 if sdkVersion.LessThan(minApiForArch) {
3997 sdkVersion = minApiForArch
3998 }
3999
Dan Albertc8060532020-07-22 22:32:17 -07004000 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004001 return fmt.Errorf("newer SDK(%v)", ver)
4002 }
4003 return nil
4004}
4005
Paul Duffinb5769c12021-05-12 16:16:51 +01004006// Implements android.ApexModule
4007func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4008 // stub libraries and native bridge libraries are always available to platform
4009 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4010}
4011
Jooyung Han91f92032022-02-04 12:36:33 +09004012// Overrides android.ApexModuleBase.UniqueApexVariations
4013func (c *Module) UniqueApexVariations() bool {
4014 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4015 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4016 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004017 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004018 return c.UseVndk() && c.IsVndk()
4019}
4020
Inseob Kima1888ce2022-10-04 14:42:02 +09004021func (c *Module) overriddenModules() []string {
4022 if o, ok := c.linker.(overridable); ok {
4023 return o.overriddenModules()
4024 }
4025 return nil
4026}
4027
Rob Seymour925aa092021-08-10 20:42:03 +00004028var _ snapshot.RelativeInstallPath = (*Module)(nil)
4029
Liz Kammer35ca77e2021-12-22 15:31:40 -05004030type moduleType int
4031
4032const (
4033 unknownType moduleType = iota
4034 binary
4035 object
4036 fullLibrary
4037 staticLibrary
4038 sharedLibrary
4039 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004040 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004041 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004042 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004043)
4044
4045func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004046 if c.testBinary() {
4047 // testBinary is also a binary, so this comes before the c.Binary()
4048 // conditional. A testBinary has additional implicit dependencies and
4049 // other test-only semantics.
4050 return testBin
4051 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004052 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004053 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004054 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004055 } else if c.testLibrary() {
4056 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4057 // will let them add implicit compile deps on gtest, for example.
4058 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004059 // For now, treat them as regular libraries.
4060 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004061 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004062 static := false
4063 shared := false
4064 if library, ok := c.linker.(*libraryDecorator); ok {
4065 static = library.MutatedProperties.BuildStatic
4066 shared = library.MutatedProperties.BuildShared
4067 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4068 static = library.MutatedProperties.BuildStatic
4069 shared = library.MutatedProperties.BuildShared
4070 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004071 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004072 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004073 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004074 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004075 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004076 return staticLibrary
4077 }
4078 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004079 } else if c.isNDKStubLibrary() {
4080 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004081 } else if c.IsNdkPrebuiltStl() {
4082 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004083 }
4084 return unknownType
4085}
4086
Colin Crosscfad1192015-11-02 16:43:11 -08004087// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004088type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004089 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004090 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004091 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004092
4093 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4094 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004095}
4096
Patrice Arrudac249c712019-03-19 17:00:29 -07004097// cc_defaults provides a set of properties that can be inherited by other cc
4098// modules. A module can use the properties from a cc_defaults using
4099// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4100// merged (when possible) by prepending the default module's values to the
4101// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004102func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004103 return DefaultsFactory()
4104}
4105
Colin Cross36242852017-06-23 15:06:31 -07004106func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004107 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004108
Colin Cross36242852017-06-23 15:06:31 -07004109 module.AddProperties(props...)
4110 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004111 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004112 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004113 &BaseCompilerProperties{},
4114 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004115 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004116 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004117 &StaticProperties{},
4118 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004119 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004120 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004121 &TestLinkerProperties{},
4122 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004123 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004124 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004125 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004126 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004127 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004128 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004129 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004130 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004131 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004132 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004133 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004134 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004135 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004136 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004137 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004138 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4139 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004140 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004141 )
Colin Crosscfad1192015-11-02 16:43:11 -08004142
Jooyung Hancc372c52019-09-25 15:18:44 +09004143 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004144
4145 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004146}
4147
Jiyong Park2286afd2020-06-16 21:58:53 +09004148func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004149 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004150}
4151
Kiyoung Kim51279d32022-08-24 14:10:46 +09004152func (c *Module) isImportedApiLibrary() bool {
4153 _, ok := c.linker.(*apiLibraryDecorator)
4154 return ok
4155}
4156
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004157func kytheExtractAllFactory() android.Singleton {
4158 return &kytheExtractAllSingleton{}
4159}
4160
4161type kytheExtractAllSingleton struct {
4162}
4163
4164func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4165 var xrefTargets android.Paths
4166 ctx.VisitAllModules(func(module android.Module) {
4167 if ccModule, ok := module.(xref); ok {
4168 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4169 }
4170 })
4171 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4172 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004173 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004174 }
4175}
4176
Jihoon Kangf78a8902022-09-01 22:47:07 +00004177func (c *Module) Partition() string {
4178 if p, ok := c.installer.(interface {
4179 getPartition() string
4180 }); ok {
4181 return p.getPartition()
4182 }
4183 return ""
4184}
4185
Spandan Das2b6dfb52024-01-19 00:22:22 +00004186type sourceModuleName interface {
4187 sourceModuleName() string
4188}
4189
4190func (c *Module) BaseModuleName() string {
4191 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4192 // if the prebuilt module sets a source_module_name in Android.bp, use that
4193 return smn.sourceModuleName()
4194 }
4195 return c.ModuleBase.BaseModuleName()
4196}
4197
Colin Cross06a931b2015-10-28 17:23:31 -07004198var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004199var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004200var BoolPtr = proptools.BoolPtr
4201var String = proptools.String
4202var StringPtr = proptools.StringPtr