blob: fb5d0966b0b0170302ccaaa74277f7a432f3116c [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Aditya Choudhary87b2ab22023-11-17 15:27:06 +000027 "android/soong/testing"
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090028
Colin Cross97ba0732015-03-23 17:50:24 -070029 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070030 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070031
Vinh Tran367d89d2023-04-28 11:21:25 -040032 "android/soong/aidl_library"
Colin Cross635c3b02016-05-18 15:37:25 -070033 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070034 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070035 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070036 "android/soong/genrule"
Kiyoung Kim487689e2022-07-26 09:48:22 +090037 "android/soong/multitree"
Rob Seymour925aa092021-08-10 20:42:03 +000038 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080039)
40
Colin Cross463a90e2015-06-17 14:20:06 -070041func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000042 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070043
Inseob Kim3b244062023-07-11 13:31:36 +090044 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000045 pctx.Import("android/soong/cc/config")
46}
47
48func RegisterCCBuildComponents(ctx android.RegistrationContext) {
49 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
50
51 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000052 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090053 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070054 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010055 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070056 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070057 ctx.BottomUp("begin", BeginMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070058 })
Colin Cross16b23492016-01-06 14:41:07 -080059
Paul Duffin036e7002019-12-19 19:16:28 +000060 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040061 for _, san := range Sanitizers {
62 san.registerMutators(ctx)
63 }
Dan Willemsen581341d2017-02-09 16:16:31 -080064
Colin Cross0b908332019-06-19 23:00:20 -070065 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090066 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080067
Cory Barkera1da26f2022-06-07 20:12:06 +000068 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000069
Colin Crossf5f4ad32024-01-19 15:41:48 -080070 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070071
Colin Crossd38feb02024-01-23 16:38:06 -080072 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +080073
Colin Cross33e0c812024-01-23 16:36:07 -080074 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000075
Colin Cross6ac83a82024-01-23 11:23:10 -080076 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090077
Jooyung Han479ca172020-10-19 18:51:07 +090078 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090079 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070080 })
Colin Crossb98c8b02016-07-29 13:44:28 -070081
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080082 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
83 // sabi mutator needs to be run after apex mutator finishes.
84 ctx.TopDown("sabi_deps", sabiDepsMutator)
85 })
86
LaMont Jones0c10e4d2023-05-16 00:58:37 +000087 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070088}
89
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050090// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
91// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
92// edges to these modules.
93// This object is constructed in DepsMutator, by calling to various module delegates to set
94// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
95// dependencies.
96// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
97// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080098type Deps struct {
99 SharedLibs, LateSharedLibs []string
100 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800101 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800102 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700103
Colin Cross3e5e7782022-06-17 22:17:05 +0000104 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
105 // prevent automatically exporting symbols.
106 UnexportedStaticLibs []string
107
Chris Parsons79d66a52020-06-05 17:26:16 -0400108 // Used for data dependencies adjacent to tests
109 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700110 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400111
Yo Chiang219968c2020-09-22 18:45:04 +0800112 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
113 SystemSharedLibs []string
114
Vinh Tran367d89d2023-04-28 11:21:25 -0400115 // Used by DepMutator to pass aidl_library modules to aidl compiler
116 AidlLibs []string
117
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500118 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800119 StaticUnwinderIfLegacy bool
120
Colin Cross5950f382016-12-13 12:50:57 -0800121 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700122
Colin Cross81413472016-04-11 14:37:39 -0700123 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700124
Dan Willemsenb40aab62016-04-20 14:21:14 -0700125 GeneratedSources []string
126 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900127 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700128
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700129 ReexportGeneratedHeaders []string
130
Colin Crossc465efd2021-06-11 18:00:04 -0700131 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700132
133 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700134 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900135
136 // List of libs that need to be excluded for APEX variant
137 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900138 // List of libs that need to be excluded for non-APEX variant
139 ExcludeLibsForNonApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700140}
141
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500142// PathDeps is a struct containing file paths to dependencies of a module.
143// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
144// It's used to construct flags for various build statements (such as for compiling and linking).
145// It is then passed to module decorator functions responsible for registering build statements
146// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800147type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700148 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900149 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700150 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900151 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700152 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700153 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700154
Colin Cross0de8a1e2020-09-18 14:15:30 -0700155 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700156 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700157
Colin Cross26c34ed2016-09-30 17:10:16 -0700158 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100159 Objs Objects
160 // Paths to .o files in dependencies that provide them. Note that these lists
161 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800162 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700163 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700164
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100165 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
166 // the libs from all whole_static_lib dependencies.
167 WholeStaticLibsFromPrebuilts android.Paths
168
Colin Cross26c34ed2016-09-30 17:10:16 -0700169 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700170 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900171 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700172
Inseob Kimd110f872019-12-06 13:15:38 +0900173 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000174 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900175 IncludeDirs android.Paths
176 SystemIncludeDirs android.Paths
177 ReexportedDirs android.Paths
178 ReexportedSystemDirs android.Paths
179 ReexportedFlags []string
180 ReexportedGeneratedHeaders android.Paths
181 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700182
Colin Cross26c34ed2016-09-30 17:10:16 -0700183 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700184 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700185
Dan Willemsena0790e32018-10-12 00:24:23 -0700186 // Path to the dynamic linker binary
187 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700188
189 // For Darwin builds, the path to the second architecture's output that should
190 // be combined with this architectures's output into a FAT MachO file.
191 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400192
193 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
194 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700195}
196
Colin Cross4af21ed2019-11-04 09:37:55 -0800197// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
198// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
199// command line so they can be overridden by the local module flags).
200type LocalOrGlobalFlags struct {
201 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700202 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800203 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700204 CFlags []string // Flags that apply to C and C++ source files
205 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
206 ConlyFlags []string // Flags that apply to C source files
207 CppFlags []string // Flags that apply to C++ source files
208 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700209 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800210}
211
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500212// Flags contains various types of command line flags (and settings) for use in building build
213// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800214type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500215 // Local flags (which individual modules are responsible for). These may override global flags.
216 Local LocalOrGlobalFlags
217 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700218 Global LocalOrGlobalFlags
219 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800220
221 aidlFlags []string // Flags that apply to aidl source files
222 rsFlags []string // Flags that apply to renderscript source files
223 libFlags []string // Flags to add libraries early to the link order
224 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
225 TidyFlags []string // Flags that apply to clang-tidy
226 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700227
Colin Crossc3199482017-03-30 15:03:04 -0700228 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800229 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700230 SystemIncludeFlags []string
231
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800232 Toolchain config.Toolchain
233 Tidy bool // True if ninja .tidy rules should be generated.
234 NeedTidyFiles bool // True if module link should depend on .tidy files
235 GcovCoverage bool // True if coverage files should be generated.
236 SAbiDump bool // True if header abi dumps should be generated.
237 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800238
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500239 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800240 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500241 // The target-device system path to the dynamic linker.
242 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800243
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700244 CFlagsDeps android.Paths // Files depended on by compiler flags
245 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800246
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500247 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700248 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800249
Colin Cross19878da2019-03-28 14:45:07 -0700250 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700251 protoC bool // Whether to use C instead of C++
252 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700253
254 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200255 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700256}
257
Colin Crossca860ac2016-01-04 14:34:37 -0800258// Properties used to compile all C or C++ modules
259type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700260 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800261 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700262
Jiyong Parkb35a8192020-08-10 15:59:36 +0900263 // The API level that this module is built against. The APIs of this API level will be
264 // visible at build time, but use of any APIs newer than min_sdk_version will render the
265 // module unloadable on older devices. In the future it will be possible to weakly-link new
266 // APIs, making the behavior match Java: such modules will load on older devices, but
267 // calling new APIs on devices that do not support them will result in a crash.
268 //
269 // This property has the same behavior as sdk_version does for Java modules. For those
270 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
271 // does for Java code.
272 //
273 // In addition, setting this property causes two variants to be built, one for the platform
274 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800275 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700276
Jiyong Parkb35a8192020-08-10 15:59:36 +0900277 // Minimum OS API level supported by this C or C++ module. This property becomes the value
278 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
279 // this property is also used to ensure that the min_sdk_version of the containing module is
280 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
281 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
282 // min_sdk_version of the containing APEX. When the module
283 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900284 Min_sdk_version *string
285
Colin Crossc511bc52020-04-07 16:50:32 +0000286 // If true, always create an sdk variant and don't create a platform variant.
287 Sdk_variant_only *bool
288
Jiyong Parkde866cb2018-12-07 23:08:36 +0900289 AndroidMkSharedLibs []string `blueprint:"mutated"`
290 AndroidMkStaticLibs []string `blueprint:"mutated"`
291 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
292 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700293 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900294 HideFromMake bool `blueprint:"mutated"`
295 PreventInstall bool `blueprint:"mutated"`
296 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700297
Yo Chiang219968c2020-09-22 18:45:04 +0800298 // Set by DepsMutator.
299 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
300
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900301 // The name of the image this module is built for
302 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200303
304 // The VNDK version this module is built against. If empty, the module is not
305 // build against the VNDK.
306 VndkVersion string `blueprint:"mutated"`
307
308 // Suffix for the name of Android.mk entries generated by this module
309 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800310
311 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
312 // file
313 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900314
Yifan Hong39143a92020-10-26 12:43:12 -0700315 // Make this module available when building for ramdisk.
316 // On device without a dedicated recovery partition, the module is only
317 // available after switching root into
318 // /first_stage_ramdisk. To expose the module before switching root, install
319 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800320 Ramdisk_available *bool
321
Yifan Hong39143a92020-10-26 12:43:12 -0700322 // Make this module available when building for vendor ramdisk.
323 // On device without a dedicated recovery partition, the module is only
324 // available after switching root into
325 // /first_stage_ramdisk. To expose the module before switching root, install
326 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700327 Vendor_ramdisk_available *bool
328
Jiyong Parkf9332f12018-02-01 00:54:12 +0900329 // Make this module available when building for recovery
330 Recovery_available *bool
331
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200332 // Used by imageMutator, set by ImageMutatorBegin()
333 CoreVariantNeeded bool `blueprint:"mutated"`
334 RamdiskVariantNeeded bool `blueprint:"mutated"`
335 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
336 RecoveryVariantNeeded bool `blueprint:"mutated"`
337
338 // A list of variations for the "image" mutator of the form
339 //<image name> '.' <version char>, for example, 'vendor.S'
340 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900341
342 // Allows this module to use non-APEX version of libraries. Useful
343 // for building binaries that are started before APEXes are activated.
344 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900345
346 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
347 // see soong/cc/config/vndk.go
348 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900349
350 // Used by vendor snapshot to record dependencies from snapshot modules.
351 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900352 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900353 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000354
Colin Cross1bc94122021-10-28 13:25:54 -0700355 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000356
357 // Set by factories of module types that can only be referenced from variants compiled against
358 // the SDK.
359 AlwaysSdk bool `blueprint:"mutated"`
360
361 // Variant is an SDK variant created by sdkMutator
362 IsSdkVariant bool `blueprint:"mutated"`
363 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
364 // variant to have a ".sdk" suffix.
365 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700366
367 // Normally Soong uses the directory structure to decide which modules
368 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800369 // different snapshots (vendor, recovery, etc.), but this property
370 // allows a partner to exclude a module normally thought of as a
371 // framework module from the vendor snapshot.
372 Exclude_from_vendor_snapshot *bool
373
374 // Normally Soong uses the directory structure to decide which modules
375 // should be included (framework) or excluded (non-framework) from the
376 // different snapshots (vendor, recovery, etc.), but this property
377 // allows a partner to exclude a module normally thought of as a
378 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800379 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900380
381 // List of APEXes that this module has private access to for testing purpose. The module
382 // can depend on libraries that are not exported by the APEXes and use private symbols
383 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000384 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800385
386 Target struct {
387 Platform struct {
388 // List of modules required by the core variant.
389 Required []string `android:"arch_variant"`
390
391 // List of modules not required by the core variant.
392 Exclude_required []string `android:"arch_variant"`
393 } `android:"arch_variant"`
394
395 Recovery struct {
396 // List of modules required by the recovery variant.
397 Required []string `android:"arch_variant"`
398
399 // List of modules not required by the recovery variant.
400 Exclude_required []string `android:"arch_variant"`
401 } `android:"arch_variant"`
402 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700403}
404
405type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900406 // whether this module should be allowed to be directly depended by other
407 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900408 // If set to true, two variants will be built separately, one like
409 // normal, and the other limited to the set of libraries and headers
410 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700411 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900412 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700413 // so it shouldn't have any unversioned runtime dependencies, or
414 // make assumptions about the system that may not be true in the
415 // future.
416 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900417 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900418 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900419 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900420 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900421 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700422 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
423 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900424
Justin Yunebcf0c52021-01-08 18:00:19 +0900425 // This is the same as the "vendor_available" except that the install path
426 // of the vendor variant is /odm or /vendor/odm.
427 // By replacing "vendor_available: true" with "odm_available: true", the
428 // module will install its vendor variant to the /odm partition or /vendor/odm.
429 // As the modules with "odm_available: true" still create the vendor variants,
430 // they can link to the other vendor modules as the vendor_available modules do.
431 // Also, the vendor modules can link to odm_available modules.
432 //
433 // It may not be used for VNDK modules.
434 Odm_available *bool
435
Justin Yun63e9ec72020-10-29 16:49:43 +0900436 // whether this module should be allowed to be directly depended by other
437 // modules with `product_specific: true` or `product_available: true`.
438 // If set to true, an additional product variant will be built separately
439 // that is limited to the set of libraries and headers that are exposed to
440 // /product modules.
441 //
442 // The product variant may be used with a different (newer) /system,
443 // so it shouldn't have any unversioned runtime dependencies, or
444 // make assumptions about the system that may not be true in the
445 // future.
446 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900447 // If set to false, this module becomes inaccessible from /product modules.
448 //
449 // Different from the 'vendor_available' property, the modules with
450 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
451 // library without 'product_available' may not be depended on by any other
452 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900453 //
454 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
455 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
456 Product_available *bool
457
Jiyong Park5fb8c102018-04-09 12:03:06 +0900458 // whether this module is capable of being loaded with other instance
459 // (possibly an older version) of the same module in the same process.
460 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
461 // can be double loaded in a vendor process if the library is also a
462 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
463 // explicitly marked as `double_loadable: true` by the owner, or the dependency
464 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
465 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800466
467 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
468 IsLLNDK bool `blueprint:"mutated"`
469
Colin Cross78212242021-01-06 14:51:30 -0800470 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
471 // set and the module is not listed in VndkMustUseVendorVariantList.
472 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
473
474 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
475 IsVNDKCore bool `blueprint:"mutated"`
476
477 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
478 IsVNDKSP bool `blueprint:"mutated"`
479
480 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
481 // module sets the llndk.private property.
482 IsVNDKPrivate bool `blueprint:"mutated"`
483
484 // IsVNDKProduct is set if a VNDK module sets the product_available property.
485 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700486
487 // IsVendorPublicLibrary is set for the core and product variants of a library that has
488 // vendor_public_library stubs.
489 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800490}
491
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500492// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
493// to understanding details about the type of the current module.
494// For example, one might call these functions to determine whether the current module is a static
495// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800496type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800497 static() bool
498 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700499 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800500 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900501 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900502 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900503 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700504 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900505 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700506 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800507 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900508 minSdkVersion() string
509 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700510 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700511 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800512 IsLlndk() bool
513 IsLlndkPublic() bool
514 isImplementationForLLNDKPublic() bool
515 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900516 isVndk() bool
517 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500518 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700519 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900520 inProduct() bool
521 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800522 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700523 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900524 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900525 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700526 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700527 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800528 getVndkExtendsModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800529 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000530 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800531 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900532 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800533 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800534 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800535 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700536 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700537 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900538 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800539 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700540 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700541 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800542 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800543 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800544 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800545 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800546}
547
548type SharedFlags struct {
549 numSharedFlags int
550 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800551}
552
553type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700554 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800555 ModuleContextIntf
556}
557
558type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700559 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800560 ModuleContextIntf
561}
562
Colin Cross37047f12016-12-13 17:06:13 -0800563type DepsContext interface {
564 android.BottomUpMutatorContext
565 ModuleContextIntf
566}
567
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500568// feature represents additional (optional) steps to building cc-related modules, such as invocation
569// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800570type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800571 flags(ctx ModuleContext, flags Flags) Flags
572 props() []interface{}
573}
574
Joe Onorato37f900c2023-07-18 16:58:16 -0700575// Information returned from Generator about the source code it's generating
576type GeneratedSource struct {
577 IncludeDirs android.Paths
578 Sources android.Paths
579 Headers android.Paths
580 ReexportedDirs android.Paths
581}
582
583// generator allows injection of generated code
584type Generator interface {
585 GeneratorProps() []interface{}
586 GeneratorInit(ctx BaseModuleContext)
587 GeneratorDeps(ctx DepsContext, deps Deps) Deps
588 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
589 GeneratorSources(ctx ModuleContext) GeneratedSource
590 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
591}
592
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500593// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500594// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800595type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700596 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800597 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800598 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700599 compilerProps() []interface{}
600
Colin Cross76fada02016-07-27 10:31:13 -0700601 appendCflags([]string)
602 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700603 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800604}
605
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500606// linker is the interface for a linker decorator object. Individual module types can provide
607// their own implementation for this decorator, and thus specify custom logic regarding build
608// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800609type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700610 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800611 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700612 linkerFlags(ctx ModuleContext, flags Flags) Flags
613 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800614 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700615
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700616 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700617 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900618 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800619 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700620
621 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900622 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000623
624 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000625 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800626
627 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000628}
629
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500630// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000631type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500632 sharedLibs []string
633 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
634 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700635 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800636}
637
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500638// installer is the interface for an installer helper object. This helper is responsible for
639// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800640type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700641 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700642 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000643 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800644 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700645 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700646 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900647 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000648 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900649 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800650}
651
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800652type xref interface {
653 XrefCcFiles() android.Paths
654}
655
Inseob Kima1888ce2022-10-04 14:42:02 +0900656type overridable interface {
657 overriddenModules() []string
658}
659
Colin Cross6e511a92020-07-27 21:26:48 -0700660type libraryDependencyKind int
661
662const (
663 headerLibraryDependency = iota
664 sharedLibraryDependency
665 staticLibraryDependency
666)
667
668func (k libraryDependencyKind) String() string {
669 switch k {
670 case headerLibraryDependency:
671 return "headerLibraryDependency"
672 case sharedLibraryDependency:
673 return "sharedLibraryDependency"
674 case staticLibraryDependency:
675 return "staticLibraryDependency"
676 default:
677 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
678 }
679}
680
681type libraryDependencyOrder int
682
683const (
684 earlyLibraryDependency = -1
685 normalLibraryDependency = 0
686 lateLibraryDependency = 1
687)
688
689func (o libraryDependencyOrder) String() string {
690 switch o {
691 case earlyLibraryDependency:
692 return "earlyLibraryDependency"
693 case normalLibraryDependency:
694 return "normalLibraryDependency"
695 case lateLibraryDependency:
696 return "lateLibraryDependency"
697 default:
698 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
699 }
700}
701
702// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
703// tags that have a set of predefined tag objects that are reused for each dependency, a
704// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
705// That means that comparing a libraryDependencyTag for equality will only be equal if all
706// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
707// then check individual metadata fields instead.
708type libraryDependencyTag struct {
709 blueprint.BaseDependencyTag
710
711 // These are exported so that fmt.Printf("%#v") can call their String methods.
712 Kind libraryDependencyKind
713 Order libraryDependencyOrder
714
715 wholeStatic bool
716
717 reexportFlags bool
718 explicitlyVersioned bool
719 dataLib bool
720 ndk bool
721
722 staticUnwinder bool
723
724 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900725
Cindy Zhou18417cb2020-12-10 07:12:38 -0800726 // Whether or not this dependency should skip the apex dependency check
727 skipApexAllowedDependenciesCheck bool
728
Jiyong Parke3867542020-12-03 17:28:25 +0900729 // Whether or not this dependency has to be followed for the apex variants
730 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900731 // Whether or not this dependency has to be followed for the non-apex variants
732 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000733
734 // If true, don't automatically export symbols from the static library into a shared library.
735 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700736}
737
738// header returns true if the libraryDependencyTag is tagging a header lib dependency.
739func (d libraryDependencyTag) header() bool {
740 return d.Kind == headerLibraryDependency
741}
742
743// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
744func (d libraryDependencyTag) shared() bool {
745 return d.Kind == sharedLibraryDependency
746}
747
748// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
749func (d libraryDependencyTag) static() bool {
750 return d.Kind == staticLibraryDependency
751}
752
Colin Cross65cb3142021-12-10 23:05:02 +0000753func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
754 if d.shared() {
755 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
756 }
757 return nil
758}
759
760var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
761
Colin Crosse9fe2942020-11-10 18:12:15 -0800762// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
763// binaries or other shared libraries are installed as dependencies.
764func (d libraryDependencyTag) InstallDepNeeded() bool {
765 return d.shared()
766}
767
768var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
769
Yu Liu67a28422024-03-05 00:36:31 +0000770func (d libraryDependencyTag) PropagateAconfigValidation() bool {
771 return d.static()
772}
773
774var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
775
Colin Crosse9fe2942020-11-10 18:12:15 -0800776// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700777// libraryDependencyTag. Each tag object is created globally and reused for multiple
778// dependencies (although since the object contains no references, assigning a tag to a
779// variable and modifying it will not modify the original). Users can compare the tag
780// returned by ctx.OtherModuleDependencyTag against the global original
781type dependencyTag struct {
782 blueprint.BaseDependencyTag
783 name string
784}
785
Colin Crosse9fe2942020-11-10 18:12:15 -0800786// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
787// libraryDependencyTag, but where the dependency needs to be installed when the parent is
788// installed.
789type installDependencyTag struct {
790 blueprint.BaseDependencyTag
791 android.InstallAlwaysNeededDependencyTag
792 name string
793}
794
Colin Crossc99deeb2016-04-11 15:06:20 -0700795var (
Colin Cross6e511a92020-07-27 21:26:48 -0700796 genSourceDepTag = dependencyTag{name: "gen source"}
797 genHeaderDepTag = dependencyTag{name: "gen header"}
798 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
799 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900800 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700801 reuseObjTag = dependencyTag{name: "reuse objects"}
802 staticVariantTag = dependencyTag{name: "static variant"}
803 vndkExtDepTag = dependencyTag{name: "vndk extends"}
804 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700805 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800806 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700807 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700808 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000809 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500810 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400811 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700812)
813
Roland Levillainf89cd092019-07-29 16:22:59 +0100814func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700815 ccLibDepTag, ok := depTag.(libraryDependencyTag)
816 return ok && ccLibDepTag.shared()
817}
818
819func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
820 ccLibDepTag, ok := depTag.(libraryDependencyTag)
821 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100822}
823
Zach Johnson3df4e632020-11-06 11:56:27 -0800824func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
825 ccLibDepTag, ok := depTag.(libraryDependencyTag)
826 return ok && ccLibDepTag.header()
827}
828
Roland Levillainf89cd092019-07-29 16:22:59 +0100829func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800830 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100831}
832
833func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700834 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100835 return ok && ccDepTag == testPerSrcDepTag
836}
837
Colin Crossca860ac2016-01-04 14:34:37 -0800838// Module contains the properties and members used by all C/C++ module types, and implements
839// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500840// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
841// interface.
842//
843// To define a C/C++ related module, construct a new Module object and point its delegates to
844// type-specific structs. These delegates will be invoked to register module-specific build
845// statements which may be unique to the module type. For example, module.compiler.compile() should
846// be defined so as to register build statements which are responsible for compiling the module.
847//
848// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
849// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
850// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
851// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800852type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700853 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700854
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700855 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700856 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700857
Colin Crossca860ac2016-01-04 14:34:37 -0800858 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000859 hod android.HostOrDeviceSupported
860 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000861 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700862
Paul Duffina0843f62019-12-13 19:50:38 +0000863 // Allowable SdkMemberTypes of this module type.
864 sdkMemberTypes []android.SdkMemberType
865
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500866 // decorator delegates, initialize before calling Init
867 // these may contain module-specific implementations, and effectively allow for custom
868 // type-specific logic. These members may reference different objects or the same object.
869 // Functions of these decorators will be invoked to initialize and register type-specific
870 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800871 generators []Generator
872 compiler compiler
873 linker linker
874 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500875
Spandan Dase12d2522023-09-12 21:42:31 +0000876 features []feature
877 stl *stl
878 sanitize *sanitize
879 coverage *coverage
880 fuzzer *fuzzer
881 sabi *sabi
882 vndkdep *vndkdep
883 lto *lto
884 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000885 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800886
Colin Cross31076b32020-10-23 17:22:06 -0700887 library libraryInterface
888
Colin Cross635c3b02016-05-18 15:37:25 -0700889 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800890
Colin Crossb98c8b02016-07-29 13:44:28 -0700891 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700892
893 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800894
895 // Flags used to compile this module
896 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700897
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800898 // Shared flags among build rules of this module
899 sharedFlags SharedFlags
900
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800901 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700902 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900903
904 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800905 // Kythe (source file indexer) paths for this compilation module
906 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700907 // Object .o file output paths for this compilation module
908 objFiles android.Paths
909 // Tidy .tidy file output paths for this compilation module
910 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900911
912 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700913 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700914
915 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800916
917 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800918 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700919}
920
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200921func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400922 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
923 if b, ok := c.compiler.(*baseCompiler); ok {
924 hasAidl = b.hasSrcExt(".aidl")
925 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
926 hasProto = b.hasSrcExt(".proto")
927 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
928 hasSysprop = b.hasSrcExt(".sysprop")
929 hasWinMsg = b.hasSrcExt(".mc")
930 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
931 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200932 c.AndroidModuleBase().AddJSONData(d)
933 (*d)["Cc"] = map[string]interface{}{
934 "SdkVersion": c.SdkVersion(),
935 "MinSdkVersion": c.MinSdkVersion(),
936 "VndkVersion": c.VndkVersion(),
937 "ProductSpecific": c.ProductSpecific(),
938 "SocSpecific": c.SocSpecific(),
939 "DeviceSpecific": c.DeviceSpecific(),
940 "InProduct": c.InProduct(),
941 "InVendor": c.InVendor(),
942 "InRamdisk": c.InRamdisk(),
943 "InVendorRamdisk": c.InVendorRamdisk(),
944 "InRecovery": c.InRecovery(),
945 "VendorAvailable": c.VendorAvailable(),
946 "ProductAvailable": c.ProductAvailable(),
947 "RamdiskAvailable": c.RamdiskAvailable(),
948 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
949 "RecoveryAvailable": c.RecoveryAvailable(),
950 "OdmAvailable": c.OdmAvailable(),
951 "InstallInData": c.InstallInData(),
952 "InstallInRamdisk": c.InstallInRamdisk(),
953 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
954 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
955 "InstallInRecovery": c.InstallInRecovery(),
956 "InstallInRoot": c.InstallInRoot(),
957 "IsVndk": c.IsVndk(),
958 "IsVndkExt": c.IsVndkExt(),
959 "IsVndkPrivate": c.IsVndkPrivate(),
960 "IsVndkSp": c.IsVndkSp(),
961 "IsLlndk": c.IsLlndk(),
962 "IsLlndkPublic": c.IsLlndkPublic(),
963 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
964 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
965 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
966 "ApexSdkVersion": c.apexSdkVersion,
967 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400968 "AidlSrcs": hasAidl,
969 "LexSrcs": hasLex,
970 "ProtoSrcs": hasProto,
971 "RenderscriptSrcs": hasRenderscript,
972 "SyspropSrcs": hasSysprop,
973 "WinMsgSrcs": hasWinMsg,
974 "YaccSrsc": hasYacc,
975 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200976 }
977}
978
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500979func (c *Module) SetPreventInstall() {
980 c.Properties.PreventInstall = true
981}
982
983func (c *Module) SetHideFromMake() {
984 c.Properties.HideFromMake = true
985}
986
Ivan Lozanod7586b62021-04-01 09:49:36 -0400987func (c *Module) HiddenFromMake() bool {
988 return c.Properties.HideFromMake
989}
990
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800991func (c *Module) RequiredModuleNames() []string {
992 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
993 if c.ImageVariation().Variation == android.CoreVariation {
994 required = append(required, c.Properties.Target.Platform.Required...)
995 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
996 } else if c.InRecovery() {
997 required = append(required, c.Properties.Target.Recovery.Required...)
998 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
999 }
1000 return android.FirstUniqueStrings(required)
1001}
1002
Ivan Lozano52767be2019-10-18 14:49:46 -07001003func (c *Module) Toc() android.OptionalPath {
1004 if c.linker != nil {
1005 if library, ok := c.linker.(libraryInterface); ok {
1006 return library.toc()
1007 }
1008 }
1009 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1010}
1011
1012func (c *Module) ApiLevel() string {
1013 if c.linker != nil {
1014 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001015 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001016 }
1017 }
1018 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1019}
1020
1021func (c *Module) Static() bool {
1022 if c.linker != nil {
1023 if library, ok := c.linker.(libraryInterface); ok {
1024 return library.static()
1025 }
1026 }
1027 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1028}
1029
1030func (c *Module) Shared() bool {
1031 if c.linker != nil {
1032 if library, ok := c.linker.(libraryInterface); ok {
1033 return library.shared()
1034 }
1035 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001036
Ivan Lozano52767be2019-10-18 14:49:46 -07001037 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1038}
1039
1040func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001041 if c.stl != nil {
1042 return c.stl.Properties.SelectedStl
1043 }
1044 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001045}
1046
Ivan Lozano52767be2019-10-18 14:49:46 -07001047func (c *Module) NdkPrebuiltStl() bool {
1048 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1049 return true
1050 }
1051 return false
1052}
1053
1054func (c *Module) StubDecorator() bool {
1055 if _, ok := c.linker.(*stubDecorator); ok {
1056 return true
1057 }
1058 return false
1059}
1060
1061func (c *Module) SdkVersion() string {
1062 return String(c.Properties.Sdk_version)
1063}
1064
Artur Satayev480e25b2020-04-27 18:53:18 +01001065func (c *Module) MinSdkVersion() string {
1066 return String(c.Properties.Min_sdk_version)
1067}
1068
Jiyong Park5df7bd32021-08-25 16:18:46 +09001069func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001070 if linker, ok := c.linker.(*objectLinker); ok {
1071 return linker.isCrt()
1072 }
1073 return false
1074}
1075
Jiyong Park5df7bd32021-08-25 16:18:46 +09001076func (c *Module) SplitPerApiLevel() bool {
1077 return c.canUseSdk() && c.isCrt()
1078}
1079
Colin Crossc511bc52020-04-07 16:50:32 +00001080func (c *Module) AlwaysSdk() bool {
1081 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1082}
1083
Ivan Lozano183a3212019-10-18 14:18:45 -07001084func (c *Module) CcLibrary() bool {
1085 if c.linker != nil {
1086 if _, ok := c.linker.(*libraryDecorator); ok {
1087 return true
1088 }
Colin Crossd48fe732020-09-23 20:37:24 -07001089 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1090 return true
1091 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001092 }
1093 return false
1094}
1095
1096func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001097 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001098 return true
1099 }
1100 return false
1101}
1102
Spandan Dase12d2522023-09-12 21:42:31 +00001103func (c *Module) IsNdkPrebuiltStl() bool {
1104 if c.linker == nil {
1105 return false
1106 }
1107 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1108 return true
1109 }
1110 return false
1111}
1112
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001113func (c *Module) RlibStd() bool {
1114 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1115}
1116
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001117func (c *Module) RustLibraryInterface() bool {
1118 return false
1119}
1120
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001121func (c *Module) IsFuzzModule() bool {
1122 if _, ok := c.compiler.(*fuzzBinary); ok {
1123 return true
1124 }
1125 return false
1126}
1127
1128func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1129 return c.FuzzModule
1130}
1131
1132func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1133 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1134 return fuzzer.fuzzPackagedModule
1135 }
1136 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1137}
1138
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001139func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001140 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1141 return fuzzer.sharedLibraries
1142 }
1143 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1144}
1145
Ivan Lozano2b262972019-11-21 12:30:50 -08001146func (c *Module) NonCcVariants() bool {
1147 return false
1148}
1149
Ivan Lozano183a3212019-10-18 14:18:45 -07001150func (c *Module) SetStatic() {
1151 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001152 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001153 library.setStatic()
1154 return
1155 }
1156 }
1157 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1158}
1159
1160func (c *Module) SetShared() {
1161 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001162 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001163 library.setShared()
1164 return
1165 }
1166 }
1167 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1168}
1169
1170func (c *Module) BuildStaticVariant() bool {
1171 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001172 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001173 return library.buildStatic()
1174 }
1175 }
1176 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1177}
1178
1179func (c *Module) BuildSharedVariant() bool {
1180 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001181 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001182 return library.buildShared()
1183 }
1184 }
1185 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1186}
1187
1188func (c *Module) Module() android.Module {
1189 return c
1190}
1191
Jiyong Parkc20eee32018-09-05 22:36:17 +09001192func (c *Module) OutputFile() android.OptionalPath {
1193 return c.outputFile
1194}
1195
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001196func (c *Module) CoverageFiles() android.Paths {
1197 if c.linker != nil {
1198 if library, ok := c.linker.(libraryInterface); ok {
1199 return library.objs().coverageFiles
1200 }
1201 }
1202 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1203}
1204
Ivan Lozano183a3212019-10-18 14:18:45 -07001205var _ LinkableInterface = (*Module)(nil)
1206
Jiyong Park719b4462019-01-13 00:39:51 +09001207func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001208 if c.linker != nil {
1209 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001210 }
1211 return nil
1212}
1213
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001214func (c *Module) CoverageOutputFile() android.OptionalPath {
1215 if c.linker != nil {
1216 return c.linker.coverageOutputFilePath()
1217 }
1218 return android.OptionalPath{}
1219}
1220
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001221func (c *Module) RelativeInstallPath() string {
1222 if c.installer != nil {
1223 return c.installer.relativeInstallPath()
1224 }
1225 return ""
1226}
1227
Jooyung Han344d5432019-08-23 11:17:39 +09001228func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001229 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001230}
1231
Colin Cross36242852017-06-23 15:06:31 -07001232func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001233 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001234 for _, generator := range c.generators {
1235 c.AddProperties(generator.GeneratorProps()...)
1236 }
Colin Crossca860ac2016-01-04 14:34:37 -08001237 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001238 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001239 }
1240 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001241 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001242 }
1243 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001244 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001245 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001246 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001247 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001248 }
Colin Cross16b23492016-01-06 14:41:07 -08001249 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001250 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001251 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001252 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001253 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001254 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001255 if c.fuzzer != nil {
1256 c.AddProperties(c.fuzzer.props()...)
1257 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001258 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001259 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001260 }
Justin Yun8effde42017-06-23 19:24:43 +09001261 if c.vndkdep != nil {
1262 c.AddProperties(c.vndkdep.props()...)
1263 }
Stephen Craneba090d12017-05-09 15:44:35 -07001264 if c.lto != nil {
1265 c.AddProperties(c.lto.props()...)
1266 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001267 if c.afdo != nil {
1268 c.AddProperties(c.afdo.props()...)
1269 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001270 if c.orderfile != nil {
1271 c.AddProperties(c.orderfile.props()...)
1272 }
Colin Crossca860ac2016-01-04 14:34:37 -08001273 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001274 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001275 }
Colin Crossc472d572015-03-17 15:06:21 -07001276
Colin Cross36242852017-06-23 15:06:31 -07001277 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001278 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001279 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001280
Colin Cross36242852017-06-23 15:06:31 -07001281 return c
Colin Crossc472d572015-03-17 15:06:21 -07001282}
1283
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001284// UseVndk() returns true if this module is built against VNDK.
1285// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001286func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001287 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001288}
1289
Colin Crossc511bc52020-04-07 16:50:32 +00001290func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001291 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001292 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001293}
1294
1295func (c *Module) UseSdk() bool {
1296 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001297 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001298 }
1299 return false
1300}
1301
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001302func (c *Module) isCoverageVariant() bool {
1303 return c.coverage.Properties.IsCoverageVariant
1304}
1305
Colin Cross95f1ca02020-10-29 20:47:22 -07001306func (c *Module) IsNdk(config android.Config) bool {
1307 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001308}
1309
Colin Cross127bb8b2020-12-16 16:46:01 -08001310func (c *Module) IsLlndk() bool {
1311 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001312}
1313
Colin Cross127bb8b2020-12-16 16:46:01 -08001314func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001315 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001316}
1317
Colin Cross1f3f1302021-04-26 18:37:44 -07001318func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001319 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001320 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001321}
1322
Colin Cross5271fea2021-04-27 13:06:04 -07001323func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1324 lib := moduleLibraryInterface(m)
1325 return lib != nil && (lib.hasVendorPublicLibrary())
1326}
1327
1328// IsVendorPublicLibrary returns true for vendor public libraries.
1329func (c *Module) IsVendorPublicLibrary() bool {
1330 return c.VendorProperties.IsVendorPublicLibrary
1331}
1332
Ivan Lozanof1868af2022-04-12 13:08:36 -04001333func (c *Module) IsVndkPrebuiltLibrary() bool {
1334 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1335 return true
1336 }
1337 return false
1338}
1339
1340func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1341 return c.Properties.SdkAndPlatformVariantVisibleToMake
1342}
1343
Ivan Lozanod7586b62021-04-01 09:49:36 -04001344func (c *Module) HasLlndkStubs() bool {
1345 lib := moduleLibraryInterface(c)
1346 return lib != nil && lib.hasLLNDKStubs()
1347}
1348
1349func (c *Module) StubsVersion() string {
1350 if lib, ok := c.linker.(versionedInterface); ok {
1351 return lib.stubsVersion()
1352 }
1353 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1354}
1355
Colin Cross127bb8b2020-12-16 16:46:01 -08001356// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1357// and does not set llndk.vendor_available: false.
1358func (c *Module) isImplementationForLLNDKPublic() bool {
1359 library, _ := c.library.(*libraryDecorator)
1360 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001361 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001362}
1363
Justin Yunfd9e8042020-12-23 18:23:14 +09001364// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001365func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001366 // Check if VNDK-core-private or VNDK-SP-private
1367 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001368 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001369 }
1370
1371 // Check if LLNDK-private
1372 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001373 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001374 }
1375
1376 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001377}
1378
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001379// IsVndk() returns true if this module has a vndk variant.
1380// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1381// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001382func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001383 if vndkdep := c.vndkdep; vndkdep != nil {
1384 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001385 }
1386 return false
1387}
1388
Colin Cross3513fb12024-01-24 14:44:47 -08001389func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001390 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001391 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001392 }
1393 return false
1394}
1395
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001396func (c *Module) isOrderfileCompile() bool {
1397 if orderfile := c.orderfile; orderfile != nil {
1398 return orderfile.Properties.OrderfileLoad
1399 }
1400 return false
1401}
1402
Yi Kongc702ebd2022-08-19 16:02:45 +08001403func (c *Module) isCfi() bool {
1404 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001405 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001406 }
1407 return false
1408}
1409
Yi Konged79fa32023-06-04 17:15:42 +09001410func (c *Module) isFuzzer() bool {
1411 if sanitize := c.sanitize; sanitize != nil {
1412 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1413 }
1414 return false
1415}
1416
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001417func (c *Module) isNDKStubLibrary() bool {
1418 if _, ok := c.compiler.(*stubDecorator); ok {
1419 return true
1420 }
1421 return false
1422}
1423
Ivan Lozanod7586b62021-04-01 09:49:36 -04001424func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001425 if vndkdep := c.vndkdep; vndkdep != nil {
1426 return vndkdep.isVndkSp()
1427 }
1428 return false
1429}
1430
Ivan Lozanof9e21722020-12-02 09:00:51 -05001431func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001432 if vndkdep := c.vndkdep; vndkdep != nil {
1433 return vndkdep.isVndkExt()
1434 }
1435 return false
1436}
1437
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001438func (c *Module) SubName() string {
1439 return c.Properties.SubName
1440}
1441
Ivan Lozano52767be2019-10-18 14:49:46 -07001442func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001443 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001444}
1445
Logan Chienf3511742017-10-31 18:04:35 +08001446func (c *Module) getVndkExtendsModuleName() string {
1447 if vndkdep := c.vndkdep; vndkdep != nil {
1448 return vndkdep.getVndkExtendsModuleName()
1449 }
1450 return ""
1451}
1452
Jiyong Park25fc6a92018-11-18 18:02:45 +09001453func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001454 if lib := c.library; lib != nil {
1455 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001456 }
1457 return false
1458}
1459
1460func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001461 if lib := c.library; lib != nil {
1462 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001463 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001464 return false
1465}
1466
Alan Stokes73feba32022-11-14 12:21:24 +00001467func (c *Module) IsStubsImplementationRequired() bool {
1468 if lib := c.library; lib != nil {
1469 return lib.isStubsImplementationRequired()
1470 }
1471 return false
1472}
1473
Colin Cross0477b422020-10-13 18:43:54 -07001474// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1475// the implementation. If it is an implementation library it returns its own name.
1476func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1477 name := ctx.OtherModuleName(c)
1478 if versioned, ok := c.linker.(versionedInterface); ok {
1479 name = versioned.implementationModuleName(name)
1480 }
1481 return name
1482}
1483
Martin Stjernholm2856c662020-12-02 15:03:42 +00001484// Similar to ImplementationModuleName, but uses the Make variant of the module
1485// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1486// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1487// under the premise that the prebuilt module overrides its source counterpart
1488// if it is exposed to Make).
1489func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1490 name := c.BaseModuleName()
1491 if versioned, ok := c.linker.(versionedInterface); ok {
1492 name = versioned.implementationModuleName(name)
1493 }
1494 return name
1495}
1496
Jiyong Park7d55b612021-06-11 17:22:09 +09001497func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001498 return Bool(c.Properties.Bootstrap)
1499}
1500
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001501func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001502 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1503 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1504 return false
1505 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001506 return c.linker != nil && c.linker.nativeCoverage()
1507}
1508
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001509func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001510 if p, ok := c.linker.(SnapshotInterface); ok {
1511 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001512 }
1513 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001514}
1515
Bill Peckham945441c2020-08-31 16:07:58 -07001516func (c *Module) ExcludeFromVendorSnapshot() bool {
1517 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1518}
1519
Jose Galmesf7294582020-11-13 12:07:36 -08001520func (c *Module) ExcludeFromRecoverySnapshot() bool {
1521 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1522}
1523
Jiyong Parkf1194352019-02-25 11:05:47 +09001524func isBionic(name string) bool {
1525 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001526 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001527 return true
1528 }
1529 return false
1530}
1531
Martin Stjernholm279de572019-09-10 23:18:20 +01001532func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001533 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001534 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001535 }
1536 return isBionic(name)
1537}
1538
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001539func (c *Module) XrefCcFiles() android.Paths {
1540 return c.kytheFiles
1541}
1542
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001543func (c *Module) isCfiAssemblySupportEnabled() bool {
1544 return c.sanitize != nil &&
1545 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1546}
1547
Inseob Kim800d1142021-06-14 12:03:51 +09001548func (c *Module) InstallInRoot() bool {
1549 return c.installer != nil && c.installer.installInRoot()
1550}
1551
Colin Crossca860ac2016-01-04 14:34:37 -08001552type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001553 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001554 moduleContextImpl
1555}
1556
Colin Cross37047f12016-12-13 17:06:13 -08001557type depsContext struct {
1558 android.BottomUpMutatorContext
1559 moduleContextImpl
1560}
1561
Colin Crossca860ac2016-01-04 14:34:37 -08001562type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001563 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001564 moduleContextImpl
1565}
1566
1567type moduleContextImpl struct {
1568 mod *Module
1569 ctx BaseModuleContext
1570}
1571
Colin Crossb98c8b02016-07-29 13:44:28 -07001572func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001573 return ctx.mod.toolchain(ctx.ctx)
1574}
1575
1576func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001577 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001578}
1579
1580func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001581 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001582}
1583
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001584func (ctx *moduleContextImpl) testBinary() bool {
1585 return ctx.mod.testBinary()
1586}
1587
Yi Kong56fc1b62022-09-06 16:24:00 +08001588func (ctx *moduleContextImpl) testLibrary() bool {
1589 return ctx.mod.testLibrary()
1590}
1591
Jiyong Park1d1119f2019-07-29 21:27:18 +09001592func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001593 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001594}
1595
Inseob Kim7f283f42020-06-01 21:53:49 +09001596func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001597 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001598}
1599
Inseob Kim1042d292020-06-01 23:23:05 +09001600func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001601 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001602}
1603
Jooyung Hanccce2f22020-03-07 03:45:53 +09001604func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001605 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001606}
1607
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001608func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001609 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001610}
1611
1612func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001613 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001614 config := ctx.ctx.Config()
1615 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001616 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001617 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001618 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001619 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001620 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001621 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001622 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001623 }
1624 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001625}
1626
Jiyong Parkb35a8192020-08-10 15:59:36 +09001627func (ctx *moduleContextImpl) minSdkVersion() string {
1628 ver := ctx.mod.MinSdkVersion()
1629 if ver == "apex_inherit" && !ctx.isForPlatform() {
1630 ver = ctx.apexSdkVersion().String()
1631 }
1632 if ver == "apex_inherit" || ver == "" {
1633 ver = ctx.sdkVersion()
1634 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001635
1636 if ctx.ctx.Device() {
1637 config := ctx.ctx.Config()
1638 if config.IsVndkDeprecated() && ctx.inVendor() {
1639 // If building for vendor with final API, then use the latest _stable_ API as "current".
1640 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1641 ver = config.PlatformSdkVersion().String()
1642 }
1643 }
1644 }
1645
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001646 // For crt objects, the meaning of min_sdk_version is very different from other types of
1647 // module. For them, min_sdk_version defines the oldest version that the build system will
1648 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1649 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1650 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001651 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1652 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1653 // support such an old version. The version is set to the later version in case when the
1654 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1655 // it's for an APEX.
1656 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1657 if ctx.isForPlatform() {
1658 ver = strconv.Itoa(android.FutureApiLevelInt)
1659 } else { // for apex
1660 ver = ctx.apexSdkVersion().String()
1661 if ver == "" { // in case when min_sdk_version was not set by the APEX
1662 ver = ctx.sdkVersion()
1663 }
1664 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001665 }
1666
Jiyong Parkb35a8192020-08-10 15:59:36 +09001667 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1668 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1669 minSdkVersionInt, err2 := strconv.Atoi(ver)
1670 if err == nil && err2 == nil {
1671 if sdkVersionInt < minSdkVersionInt {
1672 return strconv.Itoa(sdkVersionInt)
1673 }
1674 }
1675 return ver
1676}
1677
1678func (ctx *moduleContextImpl) isSdkVariant() bool {
1679 return ctx.mod.IsSdkVariant()
1680}
1681
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001682func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001683 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001684}
Justin Yun8effde42017-06-23 19:24:43 +09001685
Kiyoung Kimaa394802024-01-08 12:55:45 +09001686func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1687 return ctx.mod.InVendorOrProduct()
1688}
1689
Colin Cross95f1ca02020-10-29 20:47:22 -07001690func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1691 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001692}
1693
Colin Cross127bb8b2020-12-16 16:46:01 -08001694func (ctx *moduleContextImpl) IsLlndk() bool {
1695 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001696}
1697
Colin Cross127bb8b2020-12-16 16:46:01 -08001698func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1699 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001700}
1701
Colin Cross127bb8b2020-12-16 16:46:01 -08001702func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1703 return ctx.mod.isImplementationForLLNDKPublic()
1704}
1705
1706func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1707 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001708}
1709
Logan Chienf3511742017-10-31 18:04:35 +08001710func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001711 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001712}
1713
Colin Cross3513fb12024-01-24 14:44:47 -08001714func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1715 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001716}
1717
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001718func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1719 return ctx.mod.isOrderfileCompile()
1720}
1721
Yi Kongc702ebd2022-08-19 16:02:45 +08001722func (ctx *moduleContextImpl) isCfi() bool {
1723 return ctx.mod.isCfi()
1724}
1725
Yi Konged79fa32023-06-04 17:15:42 +09001726func (ctx *moduleContextImpl) isFuzzer() bool {
1727 return ctx.mod.isFuzzer()
1728}
1729
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001730func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1731 return ctx.mod.isNDKStubLibrary()
1732}
1733
Justin Yun8effde42017-06-23 19:24:43 +09001734func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001735 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001736}
1737
Ivan Lozanof9e21722020-12-02 09:00:51 -05001738func (ctx *moduleContextImpl) IsVndkExt() bool {
1739 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001740}
1741
Colin Cross5271fea2021-04-27 13:06:04 -07001742func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1743 return ctx.mod.IsVendorPublicLibrary()
1744}
1745
Vic Yangefd249e2018-11-12 20:19:56 -08001746func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001747 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001748}
1749
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001750func (ctx *moduleContextImpl) selectedStl() string {
1751 if stl := ctx.mod.stl; stl != nil {
1752 return stl.Properties.SelectedStl
1753 }
1754 return ""
1755}
1756
Ivan Lozanobd721262018-11-27 14:33:03 -08001757func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1758 return ctx.mod.linker.useClangLld(actx)
1759}
1760
Colin Crossce75d2c2016-10-06 16:12:58 -07001761func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001762 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001763}
1764
Logan Chienf3511742017-10-31 18:04:35 +08001765func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1766 return ctx.mod.getVndkExtendsModuleName()
1767}
1768
Logan Chiene274fc92019-12-03 11:18:32 -08001769func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001770 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1771 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001772}
1773
Colin Crosse07f2312020-08-13 11:24:56 -07001774func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001775 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1776 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001777}
1778
Dan Albertc8060532020-07-22 22:32:17 -07001779func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001780 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001781}
1782
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001783func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001784 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001785}
1786
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001787func (ctx *moduleContextImpl) nativeCoverage() bool {
1788 return ctx.mod.nativeCoverage()
1789}
1790
Colin Cross56a83212020-09-15 18:30:11 -07001791func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1792 return ctx.mod.DirectlyInAnyApex()
1793}
1794
Colin Cross95b07f22020-12-16 11:06:50 -08001795func (ctx *moduleContextImpl) isPreventInstall() bool {
1796 return ctx.mod.Properties.PreventInstall
1797}
1798
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001799func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1800 shared := &ctx.mod.sharedFlags
1801 if shared.flagsMap == nil {
1802 shared.numSharedFlags = 0
1803 shared.flagsMap = make(map[string]string)
1804 }
1805 return shared
1806}
1807
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001808func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1809 return ctx.mod.isCfiAssemblySupportEnabled()
1810}
1811
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001812func (ctx *moduleContextImpl) notInPlatform() bool {
1813 return ctx.mod.NotInPlatform()
1814}
1815
Colin Cross635c3b02016-05-18 15:37:25 -07001816func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001817 return &Module{
1818 hod: hod,
1819 multilib: multilib,
1820 }
1821}
1822
Colin Cross635c3b02016-05-18 15:37:25 -07001823func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001824 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001825 module.features = []feature{
1826 &tidyFeature{},
1827 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001828 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001829 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001830 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001831 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001832 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001833 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001834 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001835 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001836 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001837 return module
1838}
1839
Colin Crossce75d2c2016-10-06 16:12:58 -07001840func (c *Module) Prebuilt() *android.Prebuilt {
1841 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1842 return p.prebuilt()
1843 }
1844 return nil
1845}
1846
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001847func (c *Module) IsPrebuilt() bool {
1848 return c.Prebuilt() != nil
1849}
1850
Colin Crossce75d2c2016-10-06 16:12:58 -07001851func (c *Module) Name() string {
1852 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001853 if p, ok := c.linker.(interface {
1854 Name(string) string
1855 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001856 name = p.Name(name)
1857 }
1858 return name
1859}
1860
Alex Light3d673592019-01-18 14:37:31 -08001861func (c *Module) Symlinks() []string {
1862 if p, ok := c.installer.(interface {
1863 symlinkList() []string
1864 }); ok {
1865 return p.symlinkList()
1866 }
1867 return nil
1868}
1869
Roland Levillainf89cd092019-07-29 16:22:59 +01001870func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1871 test, ok := c.linker.(testPerSrc)
1872 return ok && test.isAllTestsVariation()
1873}
1874
Chris Parsons216e10a2020-07-09 17:12:52 -04001875func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001876 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001877 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001878 }); ok {
1879 return p.dataPaths()
1880 }
1881 return nil
1882}
1883
Ivan Lozanof1868af2022-04-12 13:08:36 -04001884func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001885 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1886 // "current", it will append the VNDK version to the name suffix.
1887 var vndkVersion string
1888 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001889 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001890 if c.ProductSpecific() {
1891 // If the module is product specific with 'product_specific: true',
1892 // do not add a name suffix because it is a base module.
1893 return ""
1894 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001895 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001896 } else {
1897 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001898 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001899 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001900 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001901 // add version suffix only if the module is using different vndk version than the
1902 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001903 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001904 }
1905 return nameSuffix
1906}
1907
Ivan Lozanof1868af2022-04-12 13:08:36 -04001908func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1909 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001910
1911 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001912 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001913 }
1914
Colin Cross127bb8b2020-12-16 16:46:01 -08001915 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001916 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001917 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1918 // added for product variant only when we have vendor and product variants with core
1919 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001920 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001921 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001922 subName += vendorPublicLibrarySuffix
1923 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001924 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1925 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001926 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001927 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001928 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001929 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001930 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001931 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001932 subName += RecoverySuffix
1933 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1934 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001935 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001936 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001937 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001938 } else if c.IsStubs() && c.IsSdkVariant() {
1939 // Public API surface (NDK)
1940 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1941 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001942 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001943
1944 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001945}
1946
Sam Delmerico75dbca22023-04-20 13:13:25 +00001947func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1948 ctx := &moduleContext{
1949 ModuleContext: actx,
1950 moduleContextImpl: moduleContextImpl{
1951 mod: c,
1952 },
1953 }
1954 ctx.ctx = ctx
1955 return ctx
1956}
1957
Spandan Das20fce2d2023-04-12 17:21:39 +00001958// TODO (b/277651159): Remove this allowlist
1959var (
1960 skipStubLibraryMultipleApexViolation = map[string]bool{
1961 "libclang_rt.asan": true,
1962 "libclang_rt.hwasan": true,
1963 // runtime apex
1964 "libc": true,
1965 "libc_hwasan": true,
1966 "libdl_android": true,
1967 "libm": true,
1968 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001969 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001970 // art apex
1971 "libandroidio": true,
1972 "libdexfile": true,
1973 "libnativebridge": true,
1974 "libnativehelper": true,
1975 "libnativeloader": true,
1976 "libsigchain": true,
1977 }
1978)
1979
1980// Returns true if a stub library could be installed in multiple apexes
1981func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1982 // If this is not an apex variant, no check necessary
1983 if !c.InAnyApex() {
1984 return false
1985 }
1986 // If this is not a stub library, no check necessary
1987 if !c.HasStubsVariants() {
1988 return false
1989 }
1990 // Skip the allowlist
1991 // Use BaseModuleName so that this matches prebuilts.
1992 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1993 return false
1994 }
1995
1996 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1997 // Stub libraries should not have more than one apex_available
1998 if len(aaWithoutTestApexes) > 1 {
1999 return true
2000 }
2001 // Stub libraries should not use the wildcard
2002 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2003 return true
2004 }
2005 // Default: no violation
2006 return false
2007}
2008
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002009func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2010 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2011}
2012
Chris Parsons8d6e4332021-02-22 16:13:50 -05002013func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002014 // Handle the case of a test module split by `test_per_src` mutator.
2015 //
2016 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2017 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2018 // module and return early, as this module does not produce an output file per se.
2019 if c.IsTestPerSrcAllTestsVariation() {
2020 c.outputFile = android.OptionalPath{}
2021 return
2022 }
2023
Ivan Lozanof1868af2022-04-12 13:08:36 -04002024 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002025 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002026 if !apexInfo.IsForPlatform() {
2027 c.hideApexVariantFromMake = true
2028 }
2029
Chris Parsonseefc9e62021-04-02 17:36:47 -04002030 c.makeLinkType = GetMakeLinkType(actx, c)
2031
Sam Delmerico75dbca22023-04-20 13:13:25 +00002032 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002033
Colin Crossf18e1102017-11-16 14:33:08 -08002034 deps := c.depsToPaths(ctx)
2035 if ctx.Failed() {
2036 return
2037 }
2038
Joe Onorato37f900c2023-07-18 16:58:16 -07002039 for _, generator := range c.generators {
2040 gen := generator.GeneratorSources(ctx)
2041 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2042 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2043 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2044 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2045 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2046 if len(deps.Objs.objFiles) == 0 {
2047 // If we are reusuing object files (which happens when we're a shared library and we're
2048 // reusing our static variant's object files), then skip adding the actual source files,
2049 // because we already have the object for it.
2050 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2051 }
2052 }
2053
2054 if ctx.Failed() {
2055 return
2056 }
2057
Spandan Das20fce2d2023-04-12 17:21:39 +00002058 if c.stubLibraryMultipleApexViolation(actx) {
2059 actx.PropertyErrorf("apex_available",
2060 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2061 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002062 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2063 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002064 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2065 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002066 }
2067
Colin Crossca860ac2016-01-04 14:34:37 -08002068 flags := Flags{
2069 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002070 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002071 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002072 for _, generator := range c.generators {
2073 flags = generator.GeneratorFlags(ctx, flags, deps)
2074 }
Colin Crossca860ac2016-01-04 14:34:37 -08002075 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002076 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002077 }
2078 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002079 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002080 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002081 if c.stl != nil {
2082 flags = c.stl.flags(ctx, flags)
2083 }
Colin Cross16b23492016-01-06 14:41:07 -08002084 if c.sanitize != nil {
2085 flags = c.sanitize.flags(ctx, flags)
2086 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002087 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002088 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002089 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002090 if c.fuzzer != nil {
2091 flags = c.fuzzer.flags(ctx, flags)
2092 }
Stephen Craneba090d12017-05-09 15:44:35 -07002093 if c.lto != nil {
2094 flags = c.lto.flags(ctx, flags)
2095 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002096 if c.afdo != nil {
2097 flags = c.afdo.flags(ctx, flags)
2098 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002099 if c.orderfile != nil {
2100 flags = c.orderfile.flags(ctx, flags)
2101 }
Colin Crossca860ac2016-01-04 14:34:37 -08002102 for _, feature := range c.features {
2103 flags = feature.flags(ctx, flags)
2104 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002105 if ctx.Failed() {
2106 return
2107 }
2108
Colin Cross4af21ed2019-11-04 09:37:55 -08002109 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2110 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2111 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002112
Colin Cross4af21ed2019-11-04 09:37:55 -08002113 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002114
2115 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002116 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002117 }
2118 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002119 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002120 }
2121
Colin Cross3e5e7782022-06-17 22:17:05 +00002122 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2123
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002124 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002125 // We need access to all the flags seen by a source file.
2126 if c.sabi != nil {
2127 flags = c.sabi.flags(ctx, flags)
2128 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002129
Colin Cross4af21ed2019-11-04 09:37:55 -08002130 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002131
Joe Onorato37f900c2023-07-18 16:58:16 -07002132 for _, generator := range c.generators {
2133 generator.GeneratorBuildActions(ctx, flags, deps)
2134 }
2135
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002136 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002137 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002138 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002139 if ctx.Failed() {
2140 return
2141 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002142 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002143 c.objFiles = objs.objFiles
2144 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002145 }
2146
Colin Crossca860ac2016-01-04 14:34:37 -08002147 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002148 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002149 if ctx.Failed() {
2150 return
2151 }
Colin Cross635c3b02016-05-18 15:37:25 -07002152 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002153
Chris Parsons94a0bba2021-06-04 15:03:47 -04002154 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002155
Jose Galmes6f843bc2020-12-11 13:36:29 -08002156 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2157 // RECOVERY_SNAPSHOT_VERSION is current.
2158 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002159 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002160 i.collectHeadersForSnapshot(ctx)
2161 }
2162 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002163 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002164 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002165 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002166 }
Colin Cross40213022023-12-13 15:19:49 -08002167 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002168
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002169 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002170
Chris Parsons94a0bba2021-06-04 15:03:47 -04002171 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002172
2173 if c.linker != nil {
2174 moduleInfoJSON := ctx.ModuleInfoJSON()
2175 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2176 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2177 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2178 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2179 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2180
2181 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2182 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2183 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2184 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2185
2186 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2187 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2188 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2189 moduleInfoJSON.SubName += ".cfi"
2190 }
2191 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2192 moduleInfoJSON.SubName += ".hwasan"
2193 }
2194 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2195 moduleInfoJSON.SubName += ".scs"
2196 }
2197 }
2198 moduleInfoJSON.SubName += c.Properties.SubName
2199
2200 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2201 moduleInfoJSON.Uninstallable = true
2202 }
2203
2204 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002205}
2206
2207func (c *Module) maybeUnhideFromMake() {
2208 // If a lib is directly included in any of the APEXes or is not available to the
2209 // platform (which is often the case when the stub is provided as a prebuilt),
2210 // unhide the stubs variant having the latest version gets visible to make. In
2211 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2212 // force anything in the make world to link against the stubs library. (unless it
2213 // is explicitly referenced via .bootstrap suffix or the module is marked with
2214 // 'bootstrap: true').
2215 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002216 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002217 c.IsStubs() && !c.InVendorRamdisk() {
2218 c.Properties.HideFromMake = false // unhide
2219 // Note: this is still non-installable
2220 }
2221}
2222
Colin Cross8ff10582023-12-07 13:10:56 -08002223// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2224// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002225func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002226 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002227 // If the module has been specifically configure to not be installed then
2228 // hide from make as otherwise it will break when running inside make
2229 // as the output path to install will not be specified. Not all uninstallable
2230 // modules can be hidden from make as some are needed for resolving make side
2231 // dependencies.
2232 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002233 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002234 c.SkipInstall()
2235 }
2236
2237 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2238 // to allow using the outputs in a genrule.
2239 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002240 c.installer.install(ctx, c.outputFile.Path())
2241 if ctx.Failed() {
2242 return
Colin Crossca860ac2016-01-04 14:34:37 -08002243 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002244 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002245}
2246
Colin Cross0ea8ba82019-06-06 14:33:29 -07002247func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002248 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002249 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002250 }
Colin Crossca860ac2016-01-04 14:34:37 -08002251 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002252}
2253
Colin Crossca860ac2016-01-04 14:34:37 -08002254func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002255 for _, generator := range c.generators {
2256 generator.GeneratorInit(ctx)
2257 }
Colin Crossca860ac2016-01-04 14:34:37 -08002258 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002259 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002260 }
Colin Crossca860ac2016-01-04 14:34:37 -08002261 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002262 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002263 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002264 if c.stl != nil {
2265 c.stl.begin(ctx)
2266 }
Colin Cross16b23492016-01-06 14:41:07 -08002267 if c.sanitize != nil {
2268 c.sanitize.begin(ctx)
2269 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002270 if c.coverage != nil {
2271 c.coverage.begin(ctx)
2272 }
Yi Kong9723e332023-12-04 14:52:53 +09002273 if c.afdo != nil {
2274 c.afdo.begin(ctx)
2275 }
Stephen Craneba090d12017-05-09 15:44:35 -07002276 if c.lto != nil {
2277 c.lto.begin(ctx)
2278 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002279 if c.orderfile != nil {
2280 c.orderfile.begin(ctx)
2281 }
Dan Albert92fe7402020-07-15 13:33:30 -07002282 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002283 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002284 if err != nil {
2285 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002286 c.Properties.Sdk_version = nil
2287 } else {
2288 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002289 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002290 }
Colin Crossca860ac2016-01-04 14:34:37 -08002291}
2292
Colin Cross37047f12016-12-13 17:06:13 -08002293func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002294 deps := Deps{}
2295
Joe Onorato37f900c2023-07-18 16:58:16 -07002296 for _, generator := range c.generators {
2297 deps = generator.GeneratorDeps(ctx, deps)
2298 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002299 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002300 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002301 }
2302 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002303 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002304 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002305 if c.stl != nil {
2306 deps = c.stl.deps(ctx, deps)
2307 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002308 if c.coverage != nil {
2309 deps = c.coverage.deps(ctx, deps)
2310 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002311
Colin Crossb6715442017-10-24 11:13:31 -07002312 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2313 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2314 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2315 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2316 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2317 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002318 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002319
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002320 for _, lib := range deps.ReexportSharedLibHeaders {
2321 if !inList(lib, deps.SharedLibs) {
2322 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2323 }
2324 }
2325
2326 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002327 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2328 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 -07002329 }
2330 }
2331
Colin Cross5950f382016-12-13 12:50:57 -08002332 for _, lib := range deps.ReexportHeaderLibHeaders {
2333 if !inList(lib, deps.HeaderLibs) {
2334 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2335 }
2336 }
2337
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002338 for _, gen := range deps.ReexportGeneratedHeaders {
2339 if !inList(gen, deps.GeneratedHeaders) {
2340 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2341 }
2342 }
2343
Colin Crossc99deeb2016-04-11 15:06:20 -07002344 return deps
2345}
2346
Dan Albert7e9d2952016-08-04 13:02:36 -07002347func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002348 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002349 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002350 moduleContextImpl: moduleContextImpl{
2351 mod: c,
2352 },
2353 }
2354 ctx.ctx = ctx
2355
Colin Crossca860ac2016-01-04 14:34:37 -08002356 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002357}
2358
Jiyong Park7ed9de32018-10-15 22:25:07 +09002359// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002360func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002361 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2362 version := name[sharp+1:]
2363 libname := name[:sharp]
2364 return libname, version
2365 }
2366 return name, ""
2367}
2368
Dan Albert92fe7402020-07-15 13:33:30 -07002369func GetCrtVariations(ctx android.BottomUpMutatorContext,
2370 m LinkableInterface) []blueprint.Variation {
2371 if ctx.Os() != android.Android {
2372 return nil
2373 }
2374 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002375 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2376 minSdkVersion := m.MinSdkVersion()
2377 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2378 minSdkVersion = m.SdkVersion()
2379 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002380 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2381 if err != nil {
2382 ctx.PropertyErrorf("min_sdk_version", err.Error())
2383 }
Colin Cross363ec762023-01-13 13:45:14 -08002384
2385 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002386 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002387 if apiLevel.LessThan(minApiForArch) {
2388 apiLevel = minApiForArch
2389 }
2390
Dan Albert92fe7402020-07-15 13:33:30 -07002391 return []blueprint.Variation{
2392 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002393 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002394 }
2395 }
2396 return []blueprint.Variation{
2397 {Mutator: "sdk", Variation: ""},
2398 }
2399}
2400
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002401func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2402 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002403
2404 variations = append([]blueprint.Variation(nil), variations...)
2405
Liz Kammer23942242022-04-08 15:41:00 -04002406 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002407 // Version is explicitly specified. i.e. libFoo#30
2408 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002409 if tag, ok := depTag.(libraryDependencyTag); ok {
2410 tag.explicitlyVersioned = true
2411 } else {
2412 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2413 }
Colin Crosse7257d22020-09-24 09:56:18 -07002414 }
Colin Crosse7257d22020-09-24 09:56:18 -07002415
Colin Cross0de8a1e2020-09-18 14:15:30 -07002416 if far {
2417 ctx.AddFarVariationDependencies(variations, depTag, name)
2418 } else {
2419 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002420 }
2421}
2422
Kiyoung Kim487689e2022-07-26 09:48:22 +09002423func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2424 apiImportInfo := multitree.ApiImportInfo{}
2425
2426 if c.Device() {
2427 var apiImportModule []blueprint.Module
2428 if actx.OtherModuleExists("api_imports") {
2429 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2430 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002431 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002432 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002433 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002434 }
2435 }
2436 }
2437
2438 return apiImportInfo
2439}
2440
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002441func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002442 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002443 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002444 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002445 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2446 // between the modules in the snapshot and the snapshot itself.
2447 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002448 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002449 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002450 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002451 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2452 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002453 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002454 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002455 *snapshotInfo = &snapshot
2456 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002457 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002458 }
2459 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002460 if *snapshotInfo == nil {
2461 *snapshotInfo = &SnapshotInfo{}
2462 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002463 return **snapshotInfo
2464}
2465
Kiyoung Kim487689e2022-07-26 09:48:22 +09002466func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2467 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002468 return snapshot
2469 }
2470
2471 return lib
2472}
2473
2474// RewriteLibs takes a list of names of shared libraries and scans it for three types
2475// of names:
2476//
2477// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002478//
2479// For each of these, it adds the name of the prebuilt module (which will be in
2480// prebuilts/ndk) to the list of nonvariant libs.
2481//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002482// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002483//
2484// For each of these, it adds the name of the ndk_library module to the list of
2485// variant libs.
2486//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002487// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002488//
2489// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002490//
2491// The caller can then know to add the variantLibs dependencies differently from the
2492// nonvariantLibs
2493func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2494 variantLibs = []string{}
2495
2496 nonvariantLibs = []string{}
2497 for _, entry := range list {
2498 // strip #version suffix out
2499 name, _ := StubsLibNameAndVersion(entry)
2500 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002501 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002502 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2503 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2504 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002505 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002506 } else {
2507 // put name#version back
2508 nonvariantLibs = append(nonvariantLibs, entry)
2509 }
2510 }
2511 return nonvariantLibs, variantLibs
2512}
2513
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002514func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2515 nonVariantLibs := []string{}
2516 variantLibs := []string{}
2517
2518 for _, lib := range libs {
2519 replaceLibName := GetReplaceModuleName(lib, replaceList)
2520 if replaceLibName == lib {
2521 // Do not handle any libs which are not in API imports
2522 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2523 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2524 variantLibs = append(variantLibs, replaceLibName)
2525 } else {
2526 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2527 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002528 }
2529
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002530 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002531}
2532
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002533func (c *Module) shouldUseApiSurface() bool {
2534 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2535 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2536 // LLNDK Variant
2537 return true
2538 }
2539
2540 if c.Properties.IsSdkVariant {
2541 // NDK Variant
2542 return true
2543 }
2544
2545 if c.isImportedApiLibrary() {
2546 // API Library should depend on API headers
2547 return true
2548 }
2549 }
2550
2551 return false
2552}
2553
Colin Cross1e676be2016-10-12 14:38:15 -07002554func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002555 if !c.Enabled() {
2556 return
2557 }
2558
Colin Cross37047f12016-12-13 17:06:13 -08002559 ctx := &depsContext{
2560 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002561 moduleContextImpl: moduleContextImpl{
2562 mod: c,
2563 },
2564 }
2565 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002566
Colin Crossc99deeb2016-04-11 15:06:20 -07002567 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002568 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002569
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002570 apiNdkLibs := []string{}
2571 apiLateNdkLibs := []string{}
2572
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002573 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002574 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2575 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2576 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2577 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2578 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002579 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002580
Yo Chiang219968c2020-09-22 18:45:04 +08002581 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2582
Colin Crosse0edaf92021-01-11 17:31:17 -08002583 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002584
Dan Albert914449f2016-06-17 16:45:24 -07002585 variantNdkLibs := []string{}
2586 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002587 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002588 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2589 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2590 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002591
2592 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002593 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002594 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002595 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002596
Colin Cross32ec36c2016-12-15 07:39:51 -08002597 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002598 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002599 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002600 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002601 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002602
Kiyoung Kim51279d32022-08-24 14:10:46 +09002603 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002604 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002605 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2606 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002607 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002608
Spandan Das73bcafc2022-08-18 23:26:00 +00002609 if c.isNDKStubLibrary() {
2610 // ndk_headers do not have any variations
2611 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002612 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002613 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002614 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002615 } else {
2616 actx.AddVariationDependencies(nil, depTag, lib)
2617 }
2618 }
2619
Dan Albertf1d14c72020-07-30 14:32:55 -07002620 if c.isNDKStubLibrary() {
2621 // NDK stubs depend on their implementation because the ABI dumps are
2622 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002623
Spandan Das8b08aea2023-03-14 19:29:34 +00002624 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2625 c.ImageVariation(),
2626 blueprint.Variation{Mutator: "link", Variation: "shared"},
2627 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002628 }
2629
Jiyong Park5d1598f2019-02-25 22:14:17 +09002630 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002631 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002632
Kiyoung Kim487689e2022-07-26 09:48:22 +09002633 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002634
Jiyong Park5d1598f2019-02-25 22:14:17 +09002635 actx.AddVariationDependencies([]blueprint.Variation{
2636 {Mutator: "link", Variation: "static"},
2637 }, depTag, lib)
2638 }
2639
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002640 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002641 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002642 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002643 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002644 }
Jiyong Parke3867542020-12-03 17:28:25 +09002645 if inList(lib, deps.ExcludeLibsForApex) {
2646 depTag.excludeInApex = true
2647 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002648
Kiyoung Kim487689e2022-07-26 09:48:22 +09002649 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002650
Dan Willemsen59339a22018-07-22 21:18:45 -07002651 actx.AddVariationDependencies([]blueprint.Variation{
2652 {Mutator: "link", Variation: "static"},
2653 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002654 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002655
Jooyung Han75568392020-03-20 04:29:24 +09002656 // staticUnwinderDep is treated as staticDep for Q apexes
2657 // so that native libraries/binaries are linked with static unwinder
2658 // because Q libc doesn't have unwinder APIs
2659 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002660 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002661 actx.AddVariationDependencies([]blueprint.Variation{
2662 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002663 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002664 }
2665
Jiyong Park7ed9de32018-10-15 22:25:07 +09002666 // shared lib names without the #version suffix
2667 var sharedLibNames []string
2668
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002669 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002670 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002671 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002672 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002673 }
Jiyong Parke3867542020-12-03 17:28:25 +09002674 if inList(lib, deps.ExcludeLibsForApex) {
2675 depTag.excludeInApex = true
2676 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002677 if inList(lib, deps.ExcludeLibsForNonApex) {
2678 depTag.excludeInNonApex = true
2679 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002680
Jiyong Park73c54ee2019-10-22 20:31:18 +09002681 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002682 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2683 name = apiLibraryName
2684 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002685 sharedLibNames = append(sharedLibNames, name)
2686
Colin Crosse7257d22020-09-24 09:56:18 -07002687 variations := []blueprint.Variation{
2688 {Mutator: "link", Variation: "shared"},
2689 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002690
2691 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2692 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2693 }
2694
2695 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2696 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2697 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002698 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002699
Colin Crossfe9acfe2021-06-14 16:13:03 -07002700 for _, lib := range deps.LateStaticLibs {
2701 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2702 actx.AddVariationDependencies([]blueprint.Variation{
2703 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002704 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002705 }
2706
Colin Cross3e5e7782022-06-17 22:17:05 +00002707 for _, lib := range deps.UnexportedStaticLibs {
2708 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2709 actx.AddVariationDependencies([]blueprint.Variation{
2710 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002711 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002712 }
2713
Jiyong Park7ed9de32018-10-15 22:25:07 +09002714 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002715 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002716 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2717 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2718 // linking against both the stubs lib and the non-stubs lib at the same time.
2719 continue
2720 }
Colin Cross6e511a92020-07-27 21:26:48 -07002721 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002722 variations := []blueprint.Variation{
2723 {Mutator: "link", Variation: "shared"},
2724 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002725 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002726 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002727
Dan Willemsen59339a22018-07-22 21:18:45 -07002728 actx.AddVariationDependencies([]blueprint.Variation{
2729 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002730 }, dataLibDepTag, deps.DataLibs...)
2731
Colin Crossc8caa062021-09-24 16:50:14 -07002732 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2733
Chris Parsons79d66a52020-06-05 17:26:16 -04002734 actx.AddVariationDependencies([]blueprint.Variation{
2735 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002736 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002737
Colin Cross68861832016-07-08 10:41:41 -07002738 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002739
2740 for _, gen := range deps.GeneratedHeaders {
2741 depTag := genHeaderDepTag
2742 if inList(gen, deps.ReexportGeneratedHeaders) {
2743 depTag = genHeaderExportDepTag
2744 }
2745 actx.AddDependency(c, depTag, gen)
2746 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002747
Dan Albert92fe7402020-07-15 13:33:30 -07002748 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002749 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002750 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002751 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002752 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002753 }
Colin Crossc465efd2021-06-11 18:00:04 -07002754 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002755 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002756 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002757 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002758 if deps.DynamicLinker != "" {
2759 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002760 }
Dan Albert914449f2016-06-17 16:45:24 -07002761
2762 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002763
2764 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002765 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002766 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002767 {Mutator: "link", Variation: "shared"},
2768 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002769 actx.AddVariationDependencies([]blueprint.Variation{
2770 {Mutator: "version", Variation: version},
2771 {Mutator: "link", Variation: "shared"},
2772 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002773
2774 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002775 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002776 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002777 {Mutator: "link", Variation: "shared"},
2778 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002779 actx.AddVariationDependencies([]blueprint.Variation{
2780 {Mutator: "version", Variation: version},
2781 {Mutator: "link", Variation: "shared"},
2782 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002783
2784 if vndkdep := c.vndkdep; vndkdep != nil {
2785 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002786 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002787 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002788 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002789 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002790 }
2791 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002792
Vinh Tran367d89d2023-04-28 11:21:25 -04002793 if len(deps.AidlLibs) > 0 {
2794 actx.AddDependency(
2795 c,
2796 aidlLibraryTag,
2797 deps.AidlLibs...,
2798 )
2799 }
2800
Kiyoung Kimee58c932022-10-25 22:59:41 +09002801 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002802}
Colin Cross21b9a242015-03-24 14:15:58 -07002803
Colin Crosse40b4ea2018-10-02 22:25:58 -07002804func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002805 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2806 c.beginMutator(ctx)
2807 }
2808}
2809
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002810// Whether a module can link to another module, taking into
2811// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002812func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002813 tag blueprint.DependencyTag) {
2814
2815 switch t := tag.(type) {
2816 case dependencyTag:
2817 if t != vndkExtDepTag {
2818 return
2819 }
2820 case libraryDependencyTag:
2821 default:
2822 return
2823 }
2824
Ivan Lozanof9e21722020-12-02 09:00:51 -05002825 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002826 // Host code is not restricted
2827 return
2828 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002829
2830 // VNDK is cc.Module supported only for now.
2831 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002832 // Though allowed dependency is limited by the image mutator,
2833 // each vendor and product module needs to check link-type
2834 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002835 if ccTo, ok := to.(*Module); ok {
2836 if ccFrom.vndkdep != nil {
2837 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2838 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002839 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002840 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002841 }
2842 return
2843 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002844 // TODO(b/244244438) : Remove this once all variants are implemented
2845 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2846 return
2847 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002848 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002849 // Platform code can link to anything
2850 return
2851 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002852 if from.InRamdisk() {
2853 // Ramdisk code is not NDK
2854 return
2855 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002856 if from.InVendorRamdisk() {
2857 // Vendor ramdisk code is not NDK
2858 return
2859 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002860 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002861 // Recovery code is not NDK
2862 return
2863 }
Colin Cross31076b32020-10-23 17:22:06 -07002864 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002865 if c.NdkPrebuiltStl() {
2866 // These are allowed, but they don't set sdk_version
2867 return
2868 }
2869 if c.StubDecorator() {
2870 // These aren't real libraries, but are the stub shared libraries that are included in
2871 // the NDK.
2872 return
2873 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002874 if c.isImportedApiLibrary() {
2875 // Imported library from the API surface is a stub library built against interface definition.
2876 return
2877 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002878 }
Logan Chien834b9a62019-01-14 15:39:03 +08002879
Ivan Lozano52767be2019-10-18 14:49:46 -07002880 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002881 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2882 // to link to libc++ (non-NDK and without sdk_version).
2883 return
2884 }
2885
Ivan Lozano52767be2019-10-18 14:49:46 -07002886 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002887 // NDK code linking to platform code is never okay.
2888 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002889 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002890 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002891 }
2892
2893 // At this point we know we have two NDK libraries, but we need to
2894 // check that we're not linking against anything built against a higher
2895 // API level, as it is only valid to link against older or equivalent
2896 // APIs.
2897
Inseob Kim01a28722018-04-11 09:48:45 +09002898 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002899 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002900 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002901 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002902 // Current can't be linked against by anything else.
2903 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002904 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002905 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002906 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002907 if err != nil {
2908 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002909 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002910 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002911 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002912 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002913 if err != nil {
2914 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002915 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002916 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002917 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002918
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002919 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002920 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002921 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002922 }
2923 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002924 }
Dan Albert202fe492017-12-15 13:56:59 -08002925
2926 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002927 fromStl := from.SelectedStl()
2928 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002929 if fromStl == "" || toStl == "" {
2930 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002931 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002932 // We can be permissive with the system "STL" since it is only the C++
2933 // ABI layer, but in the future we should make sure that everyone is
2934 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002935 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002936 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002937 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2938 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002939 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002940}
2941
Jooyung Han479ca172020-10-19 18:51:07 +09002942func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2943 if c, ok := ctx.Module().(*Module); ok {
2944 ctx.VisitDirectDeps(func(dep android.Module) {
2945 depTag := ctx.OtherModuleDependencyTag(dep)
2946 ccDep, ok := dep.(LinkableInterface)
2947 if ok {
2948 checkLinkType(ctx, c, ccDep, depTag)
2949 }
2950 })
2951 }
2952}
2953
Jiyong Park5fb8c102018-04-09 12:03:06 +09002954// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002955// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2956// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002957// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002958func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2959 check := func(child, parent android.Module) bool {
2960 to, ok := child.(*Module)
2961 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002962 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002963 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002964
Jooyung Hana70f0672019-01-18 15:20:43 +09002965 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2966 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002967 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002968
Jiyong Park0474e1f2021-01-14 14:26:06 +09002969 // These dependencies are not excercised at runtime. Tracking these will give us
2970 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002971 depTag := ctx.OtherModuleDependencyTag(child)
2972 if IsHeaderDepTag(depTag) {
2973 return false
2974 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002975 if depTag == staticVariantTag {
2976 return false
2977 }
2978 if depTag == stubImplDepTag {
2979 return false
2980 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002981 if depTag == android.RequiredDepTag {
2982 return false
2983 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002984
Justin Yun63e9ec72020-10-29 16:49:43 +09002985 // Even if target lib has no vendor variant, keep checking dependency
2986 // graph in case it depends on vendor_available or product_available
2987 // but not double_loadable transtively.
2988 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002989 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002990 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002991
Jiyong Park0474e1f2021-01-14 14:26:06 +09002992 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2993 // one.
2994 if Bool(to.VendorProperties.Double_loadable) {
2995 return true
2996 }
2997
Ivan Lozanod7586b62021-04-01 09:49:36 -04002998 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002999 return false
3000 }
3001
Jooyung Hana70f0672019-01-18 15:20:43 +09003002 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3003 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003004 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003005 return false
3006 }
3007 if module, ok := ctx.Module().(*Module); ok {
3008 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003009 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003010 ctx.WalkDeps(check)
3011 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003012 }
3013 }
3014}
3015
Yu Liue4312402023-01-18 09:15:31 -08003016func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3017 // For the dependency from platform to apex, use the latest stubs
3018 apexSdkVersion := android.FutureApiLevel
3019 if !apexInfo.IsForPlatform() {
3020 apexSdkVersion = apexInfo.MinSdkVersion
3021 }
3022
3023 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3024 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3025 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3026 // (b/144430859)
3027 apexSdkVersion = android.FutureApiLevel
3028 }
3029
3030 return apexSdkVersion
3031}
3032
Colin Crossc99deeb2016-04-11 15:06:20 -07003033// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003034func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003035 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003036
Colin Cross0de8a1e2020-09-18 14:15:30 -07003037 var directStaticDeps []StaticLibraryInfo
3038 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003039
Colin Cross0de8a1e2020-09-18 14:15:30 -07003040 reexportExporter := func(exporter FlagExporterInfo) {
3041 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3042 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3043 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3044 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3045 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003046 }
3047
Colin Crossff694a82023-12-13 15:54:49 -08003048 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003049 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003050
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003051 skipModuleList := map[string]bool{}
3052
3053 var apiImportInfo multitree.ApiImportInfo
3054 hasApiImportInfo := false
3055
3056 ctx.VisitDirectDeps(func(dep android.Module) {
3057 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003058 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003059 hasApiImportInfo = true
3060 }
3061 })
3062
3063 if hasApiImportInfo {
3064 targetStubModuleList := map[string]string{}
3065 targetOrigModuleList := map[string]string{}
3066
3067 // Search for dependency which both original module and API imported library with APEX stub exists
3068 ctx.VisitDirectDeps(func(dep android.Module) {
3069 depName := ctx.OtherModuleName(dep)
3070 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3071 targetStubModuleList[apiLibrary] = depName
3072 }
3073 })
3074 ctx.VisitDirectDeps(func(dep android.Module) {
3075 depName := ctx.OtherModuleName(dep)
3076 if origLibrary, ok := targetStubModuleList[depName]; ok {
3077 targetOrigModuleList[origLibrary] = depName
3078 }
3079 })
3080
3081 // Decide which library should be used between original and API imported library
3082 ctx.VisitDirectDeps(func(dep android.Module) {
3083 depName := ctx.OtherModuleName(dep)
3084 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003085 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003086 skipModuleList[depName] = true
3087 } else {
3088 skipModuleList[apiLibrary] = true
3089 }
3090 }
3091 })
3092 }
3093
Colin Crossd11fcda2017-10-23 17:59:01 -07003094 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003095 depName := ctx.OtherModuleName(dep)
3096 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003097
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003098 if _, ok := skipModuleList[depName]; ok {
3099 // skip this module because original module or API imported module matching with this should be used instead.
3100 return
3101 }
3102
Dan Willemsen47450072021-10-19 20:24:49 -07003103 if depTag == android.DarwinUniversalVariantTag {
3104 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3105 return
3106 }
3107
Vinh Tran367d89d2023-04-28 11:21:25 -04003108 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003109 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003110 depPaths.AidlLibraryInfos = append(
3111 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003112 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003113 )
3114 }
3115 }
3116
Ivan Lozano52767be2019-10-18 14:49:46 -07003117 ccDep, ok := dep.(LinkableInterface)
3118 if !ok {
3119
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003120 // handling for a few module types that aren't cc Module but that are also supported
3121 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003122 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003123 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003124 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3125 genRule.GeneratedSourceFiles()...)
3126 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003127 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003128 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003129 // Support exported headers from a generated_sources dependency
3130 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003131 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003132 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003133 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003134 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003135 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003136 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003137 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003138 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003139 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3140 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003141 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003142 // 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 +09003143 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003144
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003145 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003146 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003147 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003148 }
Colin Crosscef792e2021-06-11 18:01:26 -07003149 case CrtBeginDepTag:
3150 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3151 case CrtEndDepTag:
3152 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003153 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003154 return
3155 }
3156
Colin Crossfe17f6f2019-03-28 19:30:56 -07003157 if depTag == android.ProtoPluginDepTag {
3158 return
3159 }
3160
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003161 if depTag == android.RequiredDepTag {
3162 return
3163 }
3164
Colin Crossd11fcda2017-10-23 17:59:01 -07003165 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003166 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3167 return
3168 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003169 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003170 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3171 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003172 return
3173 }
3174
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003175 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003176 // Skip reused objects for stub libraries, they use their own stub object file instead.
3177 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3178 // version mutator, so the stubs variant is created from the shared variant that
3179 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003180 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003181 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003182 objs := staticAnalogue.ReuseObjects
3183 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003184 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003185 reexportExporter(depExporterInfo)
3186 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003187 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003188 }
3189
Colin Cross6e511a92020-07-27 21:26:48 -07003190 linkFile := ccDep.OutputFile()
3191
3192 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3193 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003194 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003195 return
3196 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003197
Jiyong Parke3867542020-12-03 17:28:25 +09003198 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3199 return
3200 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003201 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3202 return
3203 }
Jiyong Parke3867542020-12-03 17:28:25 +09003204
Colin Cross313aa542023-12-13 13:47:44 -08003205 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003206
Colin Cross6e511a92020-07-27 21:26:48 -07003207 var ptr *android.Paths
3208 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003209
Colin Cross6e511a92020-07-27 21:26:48 -07003210 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003211
Colin Cross6e511a92020-07-27 21:26:48 -07003212 switch {
3213 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003214 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003215 if !ctx.Config().AllowMissingDependencies() {
3216 ctx.ModuleErrorf("module %q is not a header library", depName)
3217 } else {
3218 ctx.AddMissingDependencies([]string{depName})
3219 }
3220 return
3221 }
Colin Cross6e511a92020-07-27 21:26:48 -07003222 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003223 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003224 if !ctx.Config().AllowMissingDependencies() {
3225 ctx.ModuleErrorf("module %q is not a shared library", depName)
3226 } else {
3227 ctx.AddMissingDependencies([]string{depName})
3228 }
3229 return
3230 }
Jiyong Parke3867542020-12-03 17:28:25 +09003231
Jiyong Park7d55b612021-06-11 17:22:09 +09003232 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3233 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003234
Jiyong Park1ad8e162020-12-01 23:40:09 +09003235 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3236 // linkFile, depFile, and ptr.
3237 if c.IsStubs() {
3238 break
3239 }
3240
Colin Cross0de8a1e2020-09-18 14:15:30 -07003241 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3242 depFile = sharedLibraryInfo.TableOfContents
3243
Colin Cross6e511a92020-07-27 21:26:48 -07003244 ptr = &depPaths.SharedLibs
3245 switch libDepTag.Order {
3246 case earlyLibraryDependency:
3247 ptr = &depPaths.EarlySharedLibs
3248 depPtr = &depPaths.EarlySharedLibsDeps
3249 case normalLibraryDependency:
3250 ptr = &depPaths.SharedLibs
3251 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003252 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003253 case lateLibraryDependency:
3254 ptr = &depPaths.LateSharedLibs
3255 depPtr = &depPaths.LateSharedLibsDeps
3256 default:
3257 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003258 }
Colin Cross6e511a92020-07-27 21:26:48 -07003259 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003260 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3261 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003262 if !ctx.Config().AllowMissingDependencies() {
3263 ctx.ModuleErrorf("module %q is not a static library", depName)
3264 } else {
3265 ctx.AddMissingDependencies([]string{depName})
3266 }
3267 return
3268 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003269
3270 // Stubs lib doesn't link to the static lib dependencies. Don't set
3271 // linkFile, depFile, and ptr.
3272 if c.IsStubs() {
3273 break
3274 }
3275
Colin Cross0de8a1e2020-09-18 14:15:30 -07003276 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003277 if libDepTag.wholeStatic {
3278 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003279 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3280 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003281 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003282 // This case normally catches prebuilt static
3283 // libraries, but it can also occur when
3284 // AllowMissingDependencies is on and the
3285 // dependencies has no sources of its own
3286 // but has a whole_static_libs dependency
3287 // on a missing library. We want to depend
3288 // on the .a file so that there is something
3289 // in the dependency tree that contains the
3290 // error rule for the missing transitive
3291 // dependency.
3292 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003293 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003294 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3295 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003296 } else {
3297 switch libDepTag.Order {
3298 case earlyLibraryDependency:
3299 panic(fmt.Errorf("early static libs not suppported"))
3300 case normalLibraryDependency:
3301 // static dependencies will be handled separately so they can be ordered
3302 // using transitive dependencies.
3303 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003304 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003305 case lateLibraryDependency:
3306 ptr = &depPaths.LateStaticLibs
3307 default:
3308 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003309 }
3310 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003311 if libDepTag.unexportedSymbols {
3312 depPaths.LdFlags = append(depPaths.LdFlags,
3313 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3314 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003315 }
3316
Colin Cross6e511a92020-07-27 21:26:48 -07003317 if libDepTag.static() && !libDepTag.wholeStatic {
3318 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3319 ctx.ModuleErrorf("module %q not a static library", depName)
3320 return
3321 }
Logan Chien43d34c32017-12-20 01:17:32 +08003322
Colin Cross6e511a92020-07-27 21:26:48 -07003323 // When combining coverage files for shared libraries and executables, coverage files
3324 // in static libraries act as if they were whole static libraries. The same goes for
3325 // source based Abi dump files.
3326 if c, ok := ccDep.(*Module); ok {
3327 staticLib := c.linker.(libraryInterface)
3328 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3329 staticLib.objs().coverageFiles...)
3330 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3331 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003332 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003333 // Handle non-CC modules here
3334 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003335 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003336 }
3337 }
3338
Colin Cross6e511a92020-07-27 21:26:48 -07003339 if ptr != nil {
3340 if !linkFile.Valid() {
3341 if !ctx.Config().AllowMissingDependencies() {
3342 ctx.ModuleErrorf("module %q missing output file", depName)
3343 } else {
3344 ctx.AddMissingDependencies([]string{depName})
3345 }
3346 return
3347 }
3348 *ptr = append(*ptr, linkFile.Path())
3349 }
3350
3351 if depPtr != nil {
3352 dep := depFile
3353 if !dep.Valid() {
3354 dep = linkFile
3355 }
3356 *depPtr = append(*depPtr, dep.Path())
3357 }
3358
Colin Cross0de8a1e2020-09-18 14:15:30 -07003359 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3360 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3361 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3362 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3363
3364 if libDepTag.reexportFlags {
3365 reexportExporter(depExporterInfo)
3366 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3367 // Re-exported shared library headers must be included as well since they can help us with type information
3368 // about template instantiations (instantiated from their headers).
3369 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3370 // scripts.
3371 c.sabi.Properties.ReexportedIncludes = append(
3372 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3373 }
3374
Spandan Das3faa7922024-02-26 19:42:32 +00003375 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003376 switch {
3377 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003378 c.Properties.AndroidMkHeaderLibs = append(
3379 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003380 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003381 if lib := moduleLibraryInterface(dep); lib != nil {
3382 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003383 // Add the dependency to the APEX(es) providing the library so that
3384 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003385 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003386 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003387 c.Properties.ApexesProvidingSharedLibs = append(
3388 c.Properties.ApexesProvidingSharedLibs, an)
3389 }
3390 }
3391 }
3392
3393 // Note: the order of libs in this list is not important because
3394 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003395 c.Properties.AndroidMkSharedLibs = append(
3396 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003397 // Record BaseLibName for snapshots.
3398 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003399 case libDepTag.static():
3400 if libDepTag.wholeStatic {
3401 c.Properties.AndroidMkWholeStaticLibs = append(
3402 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3403 } else {
3404 c.Properties.AndroidMkStaticLibs = append(
3405 c.Properties.AndroidMkStaticLibs, makeLibName)
3406 }
Justin Yun5e035862021-06-29 20:50:37 +09003407 // Record BaseLibName for snapshots.
3408 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003409 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003410 } else if !c.IsStubs() {
3411 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3412
Colin Cross6e511a92020-07-27 21:26:48 -07003413 switch depTag {
3414 case runtimeDepTag:
3415 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003416 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003417 // Record BaseLibName for snapshots.
3418 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003419 case objDepTag:
3420 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3421 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003422 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003423 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003424 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003425 case dynamicLinkerDepTag:
3426 depPaths.DynamicLinker = linkFile
3427 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003428 }
Colin Crossca860ac2016-01-04 14:34:37 -08003429 })
3430
Jeff Gaston294356f2017-09-27 17:05:30 -07003431 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003432 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3433 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3434 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003435
Colin Crossdd84e052017-05-17 13:44:16 -07003436 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003437 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003438 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3439 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003440 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003441 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3442 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003443 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003444 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003445 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003446
3447 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003448 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003449 }
Colin Crossdd84e052017-05-17 13:44:16 -07003450
Colin Crossca860ac2016-01-04 14:34:37 -08003451 return depPaths
3452}
3453
Spandan Das604f3762023-03-16 22:51:40 +00003454func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003455 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003456 thisModule, ok := ctx.Module().(android.ApexModule)
3457 if !ok {
3458 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3459 }
3460
Kiyoung Kimaa394802024-01-08 12:55:45 +09003461 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003462 bootstrap := false
3463 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3464 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3465 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003466 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003467 bootstrap = linkable.Bootstrap()
3468 }
3469
Colin Crossff694a82023-12-13 15:54:49 -08003470 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003471
3472 useStubs := false
3473
Kiyoung Kimaa394802024-01-08 12:55:45 +09003474 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003475 if !apexInfo.IsForPlatform() {
3476 // For platform libraries, use current version of LLNDK
3477 // If this is for use_vendor apex we will apply the same rules
3478 // of apex sdk enforcement below to choose right version.
3479 useStubs = true
3480 }
3481 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3482 // If not building for APEX or the containing APEX allows the use of
3483 // platform APIs, use stubs only when it is from an APEX (and not from
3484 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3485 // bootstrap modules, always link to non-stub variant
3486 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3487
3488 isApexImportedApiLibrary := false
3489
3490 if cc, ok := dep.(*Module); ok {
3491 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3492 if apiLibrary.hasApexStubs() {
3493 isApexImportedApiLibrary = true
3494 }
3495 }
3496 }
3497
3498 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3499
3500 if useStubs {
3501 // Another exception: if this module is a test for an APEX, then
3502 // it is linked with the non-stub variant of a module in the APEX
3503 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003504 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003505 for _, apexContents := range testFor.ApexContents {
3506 if apexContents.DirectlyInApex(depName) {
3507 useStubs = false
3508 break
3509 }
3510 }
3511 }
3512 if useStubs {
3513 // Yet another exception: If this module and the dependency are
3514 // available to the same APEXes then skip stubs between their
3515 // platform variants. This complements the test_for case above,
3516 // which avoids the stubs on a direct APEX library dependency, by
3517 // avoiding stubs for indirect test dependencies as well.
3518 //
3519 // TODO(b/183882457): This doesn't work if the two libraries have
3520 // only partially overlapping apex_available. For that test_for
3521 // modules would need to be split into APEX variants and resolved
3522 // separately for each APEX they have access to.
3523 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3524 useStubs = false
3525 }
3526 }
3527 } else {
3528 // If building for APEX, use stubs when the parent is in any APEX that
3529 // the child is not in.
3530 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3531 }
3532
3533 return useStubs
3534}
3535
3536// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3537// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3538// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3539// has different level of updatability. For example, if a library foo in an APEX depends on a
3540// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3541// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3542// same APEX as foo, the non-stub variant of bar is used.
3543func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3544 depTag := ctx.OtherModuleDependencyTag(dep)
3545 libDepTag, ok := depTag.(libraryDependencyTag)
3546 if !ok || !libDepTag.shared() {
3547 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3548 }
3549
Colin Cross313aa542023-12-13 13:47:44 -08003550 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3551 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3552 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003553
3554 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003555 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003556 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003557 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3558 toUse := stubs[len(stubs)-1]
3559 sharedLibraryInfo = toUse.SharedLibraryInfo
3560 depExporterInfo = toUse.FlagExporterInfo
3561 }
3562 }
3563 return sharedLibraryInfo, depExporterInfo
3564}
3565
Colin Cross0de8a1e2020-09-18 14:15:30 -07003566// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3567// to match the topological order of the dependency tree, including any static analogues of
3568// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3569// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003570func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3571 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003572 var staticPaths android.Paths
3573 for _, staticDep := range staticDeps {
3574 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3575 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3576 }
3577 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003578 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3579 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003580 }
3581 }
3582 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3583
3584 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3585
3586 // reorder the dependencies based on transitive dependencies
3587 staticPaths = android.FirstUniquePaths(staticPaths)
3588 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3589
3590 if len(orderedStaticPaths) != len(staticPaths) {
3591 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3592 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3593 }
3594
3595 return orderedStaticPaths, transitiveStaticLibs
3596}
3597
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003598// BaseLibName trims known prefixes and suffixes
3599func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003600 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3601 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003602 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003603 return libName
3604}
3605
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003606func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003607 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003608 ccDepModule, _ := ccDep.(*Module)
3609 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003610 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003611
Justin Yuncbca3732021-02-03 19:24:13 +09003612 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003613 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003614 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003615 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003616
Ivan Lozanod1dec542021-05-26 15:33:11 -04003617 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003618 }
3619 }
3620
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003621 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3622 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003623 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3624 // core module instead.
3625 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003626 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003627 // The vendor and product modules in Make will have been renamed to not conflict with the
3628 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003629 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003630 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003631 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003632 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003633 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003634 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003635 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003636 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003637 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003638 } else {
3639 return libName
3640 }
3641}
3642
Colin Crossca860ac2016-01-04 14:34:37 -08003643func (c *Module) InstallInData() bool {
3644 if c.installer == nil {
3645 return false
3646 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003647 return c.installer.inData()
3648}
3649
3650func (c *Module) InstallInSanitizerDir() bool {
3651 if c.installer == nil {
3652 return false
3653 }
3654 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003655 return true
3656 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003657 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003658}
3659
Yifan Hong1b3348d2020-01-21 15:53:22 -08003660func (c *Module) InstallInRamdisk() bool {
3661 return c.InRamdisk()
3662}
3663
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003664func (c *Module) InstallInVendorRamdisk() bool {
3665 return c.InVendorRamdisk()
3666}
3667
Jiyong Parkf9332f12018-02-01 00:54:12 +09003668func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003669 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003670}
3671
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003672func (c *Module) MakeUninstallable() {
3673 if c.installer == nil {
3674 c.ModuleBase.MakeUninstallable()
3675 return
3676 }
3677 c.installer.makeUninstallable(c)
3678}
3679
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003680func (c *Module) HostToolPath() android.OptionalPath {
3681 if c.installer == nil {
3682 return android.OptionalPath{}
3683 }
3684 return c.installer.hostToolPath()
3685}
3686
Nan Zhangd4e641b2017-07-12 12:55:28 -07003687func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3688 return c.outputFile
3689}
3690
Colin Cross41955e82019-05-29 14:40:35 -07003691func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3692 switch tag {
3693 case "":
3694 if c.outputFile.Valid() {
3695 return android.Paths{c.outputFile.Path()}, nil
3696 }
3697 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003698 case "unstripped":
3699 if c.linker != nil {
3700 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3701 }
3702 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003703 case "stripped_all":
3704 if c.linker != nil {
3705 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3706 }
3707 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003708 default:
3709 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003710 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003711}
3712
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003713func (c *Module) static() bool {
3714 if static, ok := c.linker.(interface {
3715 static() bool
3716 }); ok {
3717 return static.static()
3718 }
3719 return false
3720}
3721
Jiyong Park379de2f2018-12-19 02:47:14 +09003722func (c *Module) staticBinary() bool {
3723 if static, ok := c.linker.(interface {
3724 staticBinary() bool
3725 }); ok {
3726 return static.staticBinary()
3727 }
3728 return false
3729}
3730
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003731func (c *Module) testBinary() bool {
3732 if test, ok := c.linker.(interface {
3733 testBinary() bool
3734 }); ok {
3735 return test.testBinary()
3736 }
3737 return false
3738}
3739
Jingwen Chen537242c2022-08-24 11:53:27 +00003740func (c *Module) testLibrary() bool {
3741 if test, ok := c.linker.(interface {
3742 testLibrary() bool
3743 }); ok {
3744 return test.testLibrary()
3745 }
3746 return false
3747}
3748
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003749func (c *Module) benchmarkBinary() bool {
3750 if b, ok := c.linker.(interface {
3751 benchmarkBinary() bool
3752 }); ok {
3753 return b.benchmarkBinary()
3754 }
3755 return false
3756}
3757
3758func (c *Module) fuzzBinary() bool {
3759 if f, ok := c.linker.(interface {
3760 fuzzBinary() bool
3761 }); ok {
3762 return f.fuzzBinary()
3763 }
3764 return false
3765}
3766
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003767// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3768func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003769 if h, ok := c.linker.(interface {
3770 header() bool
3771 }); ok {
3772 return h.header()
3773 }
3774 return false
3775}
3776
Ivan Lozanod7586b62021-04-01 09:49:36 -04003777func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003778 if b, ok := c.linker.(interface {
3779 binary() bool
3780 }); ok {
3781 return b.binary()
3782 }
3783 return false
3784}
3785
Justin Yun5e035862021-06-29 20:50:37 +09003786func (c *Module) StaticExecutable() bool {
3787 if b, ok := c.linker.(*binaryDecorator); ok {
3788 return b.static()
3789 }
3790 return false
3791}
3792
Ivan Lozanod7586b62021-04-01 09:49:36 -04003793func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003794 if o, ok := c.linker.(interface {
3795 object() bool
3796 }); ok {
3797 return o.object()
3798 }
3799 return false
3800}
3801
Ivan Lozanof9e21722020-12-02 09:00:51 -05003802func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003803 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003804 if c.IsLlndk() {
3805 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003806 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003807 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003808 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003809 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003810 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003811 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003812 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003813 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003814 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003815 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003816 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003817 return "native:product"
3818 }
Jooyung Han38002912019-05-16 04:01:54 +09003819 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003820 } else if c.InRamdisk() {
3821 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003822 } else if c.InVendorRamdisk() {
3823 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003824 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003825 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003826 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003827 return "native:ndk:none:none"
3828 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3829 //family, link := getNdkStlFamilyAndLinkType(c)
3830 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003831 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003832 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003833 } else {
3834 return "native:platform"
3835 }
3836}
3837
Jiyong Park9d452992018-10-03 00:38:19 +09003838// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003839// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003840func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003841 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003842 // Stub libs and prebuilt libs in a versioned SDK are not
3843 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003844 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003845 } else if _, ok := c.linker.(testPerSrc); ok {
3846 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003847 }
3848 return false
3849}
3850
Jiyong Parka90ca002019-10-07 15:47:24 +09003851func (c *Module) AvailableFor(what string) bool {
3852 if linker, ok := c.linker.(interface {
3853 availableFor(string) bool
3854 }); ok {
3855 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3856 } else {
3857 return c.ApexModuleBase.AvailableFor(what)
3858 }
3859}
3860
Jiyong Park62304bb2020-04-13 16:19:48 +09003861func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003862 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003863}
3864
Paul Duffin0cb37b92020-03-04 14:52:46 +00003865func (c *Module) EverInstallable() bool {
3866 return c.installer != nil &&
3867 // Check to see whether the module is actually ever installable.
3868 c.installer.everInstallable()
3869}
3870
Ivan Lozanod7586b62021-04-01 09:49:36 -04003871func (c *Module) PreventInstall() bool {
3872 return c.Properties.PreventInstall
3873}
3874
3875func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003876 if c.library != nil {
3877 if i := c.library.installable(); i != nil {
3878 return i
3879 }
3880 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003881 return c.Properties.Installable
3882}
3883
3884func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003885 ret := c.EverInstallable() &&
3886 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003887 proptools.BoolDefault(c.Installable(), true) &&
3888 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003889
3890 // The platform variant doesn't need further condition. Apex variants however might not
3891 // be installable because it will likely to be included in the APEX and won't appear
3892 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003893 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003894 return ret
3895 }
3896
3897 // Special case for modules that are configured to be installed to /data, which includes
3898 // test modules. For these modules, both APEX and non-APEX variants are considered as
3899 // installable. This is because even the APEX variants won't be included in the APEX, but
3900 // will anyway be installed to /data/*.
3901 // See b/146995717
3902 if c.InstallInData() {
3903 return ret
3904 }
3905
3906 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003907}
3908
Logan Chien41eabe62019-04-10 13:33:58 +08003909func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3910 if c.linker != nil {
3911 if library, ok := c.linker.(*libraryDecorator); ok {
3912 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3913 }
3914 }
3915}
3916
Jiyong Park45bf82e2020-12-15 22:29:02 +09003917var _ android.ApexModule = (*Module)(nil)
3918
3919// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003920func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003921 depTag := ctx.OtherModuleDependencyTag(dep)
3922 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3923
3924 if cc, ok := dep.(*Module); ok {
3925 if cc.HasStubsVariants() {
3926 if isLibDepTag && libDepTag.shared() {
3927 // dynamic dep to a stubs lib crosses APEX boundary
3928 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003929 }
Colin Cross6e511a92020-07-27 21:26:48 -07003930 if IsRuntimeDepTag(depTag) {
3931 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003932 return false
3933 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003934 }
Zhijun Heec285872021-04-24 10:47:08 -07003935 if cc.IsLlndk() {
3936 return false
3937 }
Colin Crossaac32222020-07-29 12:51:56 -07003938 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003939 // shared_lib dependency from a static lib is considered as crossing
3940 // the APEX boundary because the dependency doesn't actually is
3941 // linked; the dependency is used only during the compilation phase.
3942 return false
3943 }
Jiyong Parke3867542020-12-03 17:28:25 +09003944
3945 if isLibDepTag && libDepTag.excludeInApex {
3946 return false
3947 }
Colin Cross6e511a92020-07-27 21:26:48 -07003948 }
Colin Crossc1b36442021-05-06 13:42:48 -07003949 if depTag == stubImplDepTag {
3950 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003951 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003952 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003953 if depTag == staticVariantTag {
3954 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3955 // actually mean that the static lib (and its dependencies) are copied into the
3956 // APEX.
3957 return false
3958 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003959 return true
3960}
3961
Jiyong Park45bf82e2020-12-15 22:29:02 +09003962// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003963func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3964 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003965 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3966 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3967 return nil
3968 }
Jooyung Han749dc692020-04-15 11:03:39 +09003969 // We don't check for prebuilt modules
3970 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3971 return nil
3972 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003973
Jooyung Han749dc692020-04-15 11:03:39 +09003974 minSdkVersion := c.MinSdkVersion()
3975 if minSdkVersion == "apex_inherit" {
3976 return nil
3977 }
3978 if minSdkVersion == "" {
3979 // JNI libs within APK-in-APEX fall into here
3980 // Those are okay to set sdk_version instead
3981 // We don't have to check if this is a SDK variant because
3982 // non-SDK variant resets sdk_version, which works too.
3983 minSdkVersion = c.SdkVersion()
3984 }
Dan Albertc8060532020-07-22 22:32:17 -07003985 if minSdkVersion == "" {
3986 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3987 }
3988 // Not using nativeApiLevelFromUser because the context here is not
3989 // necessarily a native context.
3990 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003991 if err != nil {
3992 return err
3993 }
Dan Albertc8060532020-07-22 22:32:17 -07003994
Colin Cross8ca61c12022-10-06 21:00:14 -07003995 // A dependency only needs to support a min_sdk_version at least
3996 // as high as the api level that the architecture was introduced in.
3997 // This allows introducing new architectures in the platform that
3998 // need to be included in apexes that normally require an older
3999 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08004000 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07004001 if sdkVersion.LessThan(minApiForArch) {
4002 sdkVersion = minApiForArch
4003 }
4004
Dan Albertc8060532020-07-22 22:32:17 -07004005 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004006 return fmt.Errorf("newer SDK(%v)", ver)
4007 }
4008 return nil
4009}
4010
Paul Duffinb5769c12021-05-12 16:16:51 +01004011// Implements android.ApexModule
4012func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4013 // stub libraries and native bridge libraries are always available to platform
4014 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4015}
4016
Jooyung Han91f92032022-02-04 12:36:33 +09004017// Overrides android.ApexModuleBase.UniqueApexVariations
4018func (c *Module) UniqueApexVariations() bool {
4019 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4020 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4021 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004022 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004023 return c.UseVndk() && c.IsVndk()
4024}
4025
Inseob Kima1888ce2022-10-04 14:42:02 +09004026func (c *Module) overriddenModules() []string {
4027 if o, ok := c.linker.(overridable); ok {
4028 return o.overriddenModules()
4029 }
4030 return nil
4031}
4032
Rob Seymour925aa092021-08-10 20:42:03 +00004033var _ snapshot.RelativeInstallPath = (*Module)(nil)
4034
Liz Kammer35ca77e2021-12-22 15:31:40 -05004035type moduleType int
4036
4037const (
4038 unknownType moduleType = iota
4039 binary
4040 object
4041 fullLibrary
4042 staticLibrary
4043 sharedLibrary
4044 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004045 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004046 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004047 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004048)
4049
4050func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004051 if c.testBinary() {
4052 // testBinary is also a binary, so this comes before the c.Binary()
4053 // conditional. A testBinary has additional implicit dependencies and
4054 // other test-only semantics.
4055 return testBin
4056 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004057 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004058 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004059 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004060 } else if c.testLibrary() {
4061 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4062 // will let them add implicit compile deps on gtest, for example.
4063 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004064 // For now, treat them as regular libraries.
4065 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004066 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004067 static := false
4068 shared := false
4069 if library, ok := c.linker.(*libraryDecorator); ok {
4070 static = library.MutatedProperties.BuildStatic
4071 shared = library.MutatedProperties.BuildShared
4072 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4073 static = library.MutatedProperties.BuildStatic
4074 shared = library.MutatedProperties.BuildShared
4075 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004076 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004077 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004078 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004079 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004080 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004081 return staticLibrary
4082 }
4083 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004084 } else if c.isNDKStubLibrary() {
4085 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004086 } else if c.IsNdkPrebuiltStl() {
4087 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004088 }
4089 return unknownType
4090}
4091
Colin Crosscfad1192015-11-02 16:43:11 -08004092// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004093type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004094 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004095 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004096 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004097
4098 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4099 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004100}
4101
Patrice Arrudac249c712019-03-19 17:00:29 -07004102// cc_defaults provides a set of properties that can be inherited by other cc
4103// modules. A module can use the properties from a cc_defaults using
4104// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4105// merged (when possible) by prepending the default module's values to the
4106// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004107func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004108 return DefaultsFactory()
4109}
4110
Colin Cross36242852017-06-23 15:06:31 -07004111func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004112 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004113
Colin Cross36242852017-06-23 15:06:31 -07004114 module.AddProperties(props...)
4115 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004116 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004117 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004118 &BaseCompilerProperties{},
4119 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004120 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004121 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004122 &StaticProperties{},
4123 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004124 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004125 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004126 &TestLinkerProperties{},
4127 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004128 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004129 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004130 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004131 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004132 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004133 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004134 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004135 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004136 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004137 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004138 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004139 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004140 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004141 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004142 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004143 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4144 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004145 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004146 )
Colin Crosscfad1192015-11-02 16:43:11 -08004147
Jooyung Hancc372c52019-09-25 15:18:44 +09004148 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004149
4150 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004151}
4152
Jiyong Park2286afd2020-06-16 21:58:53 +09004153func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004154 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004155}
4156
Kiyoung Kim51279d32022-08-24 14:10:46 +09004157func (c *Module) isImportedApiLibrary() bool {
4158 _, ok := c.linker.(*apiLibraryDecorator)
4159 return ok
4160}
4161
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004162func kytheExtractAllFactory() android.Singleton {
4163 return &kytheExtractAllSingleton{}
4164}
4165
4166type kytheExtractAllSingleton struct {
4167}
4168
4169func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4170 var xrefTargets android.Paths
4171 ctx.VisitAllModules(func(module android.Module) {
4172 if ccModule, ok := module.(xref); ok {
4173 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4174 }
4175 })
4176 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4177 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004178 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004179 }
4180}
4181
Jihoon Kangf78a8902022-09-01 22:47:07 +00004182func (c *Module) Partition() string {
4183 if p, ok := c.installer.(interface {
4184 getPartition() string
4185 }); ok {
4186 return p.getPartition()
4187 }
4188 return ""
4189}
4190
Spandan Das2b6dfb52024-01-19 00:22:22 +00004191type sourceModuleName interface {
4192 sourceModuleName() string
4193}
4194
4195func (c *Module) BaseModuleName() string {
4196 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4197 // if the prebuilt module sets a source_module_name in Android.bp, use that
4198 return smn.sourceModuleName()
4199 }
4200 return c.ModuleBase.BaseModuleName()
4201}
4202
Colin Cross06a931b2015-10-28 17:23:31 -07004203var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004204var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004205var BoolPtr = proptools.BoolPtr
4206var String = proptools.String
4207var StringPtr = proptools.StringPtr