blob: 2770fb23bc98f662d494e72b24eb51d740e66adf [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).
Colin Cross4af21ed2019-11-04 09:37:55 -0800218 Global LocalOrGlobalFlags
219
220 aidlFlags []string // Flags that apply to aidl source files
221 rsFlags []string // Flags that apply to renderscript source files
222 libFlags []string // Flags to add libraries early to the link order
223 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
224 TidyFlags []string // Flags that apply to clang-tidy
225 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700226
Colin Crossc3199482017-03-30 15:03:04 -0700227 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800228 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700229 SystemIncludeFlags []string
230
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800231 Toolchain config.Toolchain
232 Tidy bool // True if ninja .tidy rules should be generated.
233 NeedTidyFiles bool // True if module link should depend on .tidy files
234 GcovCoverage bool // True if coverage files should be generated.
235 SAbiDump bool // True if header abi dumps should be generated.
236 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800237
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500238 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800239 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500240 // The target-device system path to the dynamic linker.
241 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800242
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700243 CFlagsDeps android.Paths // Files depended on by compiler flags
244 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800245
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500246 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700247 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800248
Colin Cross19878da2019-03-28 14:45:07 -0700249 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700250 protoC bool // Whether to use C instead of C++
251 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700252
253 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200254 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700255}
256
Colin Crossca860ac2016-01-04 14:34:37 -0800257// Properties used to compile all C or C++ modules
258type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700259 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800260 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700261
Jiyong Parkb35a8192020-08-10 15:59:36 +0900262 // The API level that this module is built against. The APIs of this API level will be
263 // visible at build time, but use of any APIs newer than min_sdk_version will render the
264 // module unloadable on older devices. In the future it will be possible to weakly-link new
265 // APIs, making the behavior match Java: such modules will load on older devices, but
266 // calling new APIs on devices that do not support them will result in a crash.
267 //
268 // This property has the same behavior as sdk_version does for Java modules. For those
269 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
270 // does for Java code.
271 //
272 // In addition, setting this property causes two variants to be built, one for the platform
273 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800274 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700275
Jiyong Parkb35a8192020-08-10 15:59:36 +0900276 // Minimum OS API level supported by this C or C++ module. This property becomes the value
277 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
278 // this property is also used to ensure that the min_sdk_version of the containing module is
279 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
280 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
281 // min_sdk_version of the containing APEX. When the module
282 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900283 Min_sdk_version *string
284
Colin Crossc511bc52020-04-07 16:50:32 +0000285 // If true, always create an sdk variant and don't create a platform variant.
286 Sdk_variant_only *bool
287
Jiyong Parkde866cb2018-12-07 23:08:36 +0900288 AndroidMkSharedLibs []string `blueprint:"mutated"`
289 AndroidMkStaticLibs []string `blueprint:"mutated"`
290 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
291 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700292 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900293 HideFromMake bool `blueprint:"mutated"`
294 PreventInstall bool `blueprint:"mutated"`
295 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700296
Yo Chiang219968c2020-09-22 18:45:04 +0800297 // Set by DepsMutator.
298 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
299
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900300 // The name of the image this module is built for
301 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200302
303 // The VNDK version this module is built against. If empty, the module is not
304 // build against the VNDK.
305 VndkVersion string `blueprint:"mutated"`
306
307 // Suffix for the name of Android.mk entries generated by this module
308 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800309
310 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
311 // file
312 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900313
Yifan Hong39143a92020-10-26 12:43:12 -0700314 // Make this module available when building for ramdisk.
315 // On device without a dedicated recovery partition, the module is only
316 // available after switching root into
317 // /first_stage_ramdisk. To expose the module before switching root, install
318 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800319 Ramdisk_available *bool
320
Yifan Hong39143a92020-10-26 12:43:12 -0700321 // Make this module available when building for vendor ramdisk.
322 // On device without a dedicated recovery partition, the module is only
323 // available after switching root into
324 // /first_stage_ramdisk. To expose the module before switching root, install
325 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700326 Vendor_ramdisk_available *bool
327
Jiyong Parkf9332f12018-02-01 00:54:12 +0900328 // Make this module available when building for recovery
329 Recovery_available *bool
330
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200331 // Used by imageMutator, set by ImageMutatorBegin()
332 CoreVariantNeeded bool `blueprint:"mutated"`
333 RamdiskVariantNeeded bool `blueprint:"mutated"`
334 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
335 RecoveryVariantNeeded bool `blueprint:"mutated"`
336
337 // A list of variations for the "image" mutator of the form
338 //<image name> '.' <version char>, for example, 'vendor.S'
339 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900340
341 // Allows this module to use non-APEX version of libraries. Useful
342 // for building binaries that are started before APEXes are activated.
343 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900344
345 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
346 // see soong/cc/config/vndk.go
347 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900348
349 // Used by vendor snapshot to record dependencies from snapshot modules.
350 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900351 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900352 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000353
Colin Cross1bc94122021-10-28 13:25:54 -0700354 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000355
356 // Set by factories of module types that can only be referenced from variants compiled against
357 // the SDK.
358 AlwaysSdk bool `blueprint:"mutated"`
359
360 // Variant is an SDK variant created by sdkMutator
361 IsSdkVariant bool `blueprint:"mutated"`
362 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
363 // variant to have a ".sdk" suffix.
364 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700365
366 // Normally Soong uses the directory structure to decide which modules
367 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800368 // different snapshots (vendor, recovery, etc.), but this property
369 // allows a partner to exclude a module normally thought of as a
370 // framework module from the vendor snapshot.
371 Exclude_from_vendor_snapshot *bool
372
373 // Normally Soong uses the directory structure to decide which modules
374 // should be included (framework) or excluded (non-framework) from the
375 // different snapshots (vendor, recovery, etc.), but this property
376 // allows a partner to exclude a module normally thought of as a
377 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800378 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900379
380 // List of APEXes that this module has private access to for testing purpose. The module
381 // can depend on libraries that are not exported by the APEXes and use private symbols
382 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000383 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800384
385 Target struct {
386 Platform struct {
387 // List of modules required by the core variant.
388 Required []string `android:"arch_variant"`
389
390 // List of modules not required by the core variant.
391 Exclude_required []string `android:"arch_variant"`
392 } `android:"arch_variant"`
393
394 Recovery struct {
395 // List of modules required by the recovery variant.
396 Required []string `android:"arch_variant"`
397
398 // List of modules not required by the recovery variant.
399 Exclude_required []string `android:"arch_variant"`
400 } `android:"arch_variant"`
401 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700402}
403
404type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900405 // whether this module should be allowed to be directly depended by other
406 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900407 // If set to true, two variants will be built separately, one like
408 // normal, and the other limited to the set of libraries and headers
409 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700410 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900411 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700412 // so it shouldn't have any unversioned runtime dependencies, or
413 // make assumptions about the system that may not be true in the
414 // future.
415 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900416 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900417 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900418 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900419 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900420 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700421 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
422 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900423
Justin Yunebcf0c52021-01-08 18:00:19 +0900424 // This is the same as the "vendor_available" except that the install path
425 // of the vendor variant is /odm or /vendor/odm.
426 // By replacing "vendor_available: true" with "odm_available: true", the
427 // module will install its vendor variant to the /odm partition or /vendor/odm.
428 // As the modules with "odm_available: true" still create the vendor variants,
429 // they can link to the other vendor modules as the vendor_available modules do.
430 // Also, the vendor modules can link to odm_available modules.
431 //
432 // It may not be used for VNDK modules.
433 Odm_available *bool
434
Justin Yun63e9ec72020-10-29 16:49:43 +0900435 // whether this module should be allowed to be directly depended by other
436 // modules with `product_specific: true` or `product_available: true`.
437 // If set to true, an additional product variant will be built separately
438 // that is limited to the set of libraries and headers that are exposed to
439 // /product modules.
440 //
441 // The product variant may be used with a different (newer) /system,
442 // so it shouldn't have any unversioned runtime dependencies, or
443 // make assumptions about the system that may not be true in the
444 // future.
445 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900446 // If set to false, this module becomes inaccessible from /product modules.
447 //
448 // Different from the 'vendor_available' property, the modules with
449 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
450 // library without 'product_available' may not be depended on by any other
451 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900452 //
453 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
454 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
455 Product_available *bool
456
Jiyong Park5fb8c102018-04-09 12:03:06 +0900457 // whether this module is capable of being loaded with other instance
458 // (possibly an older version) of the same module in the same process.
459 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
460 // can be double loaded in a vendor process if the library is also a
461 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
462 // explicitly marked as `double_loadable: true` by the owner, or the dependency
463 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
464 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800465
466 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
467 IsLLNDK bool `blueprint:"mutated"`
468
Colin Cross78212242021-01-06 14:51:30 -0800469 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
470 // set and the module is not listed in VndkMustUseVendorVariantList.
471 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
472
473 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
474 IsVNDKCore bool `blueprint:"mutated"`
475
476 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
477 IsVNDKSP bool `blueprint:"mutated"`
478
479 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
480 // module sets the llndk.private property.
481 IsVNDKPrivate bool `blueprint:"mutated"`
482
483 // IsVNDKProduct is set if a VNDK module sets the product_available property.
484 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700485
486 // IsVendorPublicLibrary is set for the core and product variants of a library that has
487 // vendor_public_library stubs.
488 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800489}
490
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500491// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
492// to understanding details about the type of the current module.
493// For example, one might call these functions to determine whether the current module is a static
494// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800495type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800496 static() bool
497 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700498 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800499 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900500 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900501 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900502 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700503 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900504 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700505 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800506 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900507 minSdkVersion() string
508 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700509 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700510 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800511 IsLlndk() bool
512 IsLlndkPublic() bool
513 isImplementationForLLNDKPublic() bool
514 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900515 isVndk() bool
516 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500517 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700518 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900519 inProduct() bool
520 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800521 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700522 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900523 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900524 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700525 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700526 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800527 getVndkExtendsModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800528 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000529 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800530 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900531 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800532 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800533 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800534 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700535 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700536 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900537 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800538 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700539 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700540 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800541 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800542 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800543 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800544 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800545}
546
547type SharedFlags struct {
548 numSharedFlags int
549 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800550}
551
552type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700553 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800554 ModuleContextIntf
555}
556
557type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700558 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800559 ModuleContextIntf
560}
561
Colin Cross37047f12016-12-13 17:06:13 -0800562type DepsContext interface {
563 android.BottomUpMutatorContext
564 ModuleContextIntf
565}
566
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500567// feature represents additional (optional) steps to building cc-related modules, such as invocation
568// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800569type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800570 flags(ctx ModuleContext, flags Flags) Flags
571 props() []interface{}
572}
573
Joe Onorato37f900c2023-07-18 16:58:16 -0700574// Information returned from Generator about the source code it's generating
575type GeneratedSource struct {
576 IncludeDirs android.Paths
577 Sources android.Paths
578 Headers android.Paths
579 ReexportedDirs android.Paths
580}
581
582// generator allows injection of generated code
583type Generator interface {
584 GeneratorProps() []interface{}
585 GeneratorInit(ctx BaseModuleContext)
586 GeneratorDeps(ctx DepsContext, deps Deps) Deps
587 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
588 GeneratorSources(ctx ModuleContext) GeneratedSource
589 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
590}
591
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500592// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500593// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800594type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700595 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800596 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800597 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700598 compilerProps() []interface{}
599
Colin Cross76fada02016-07-27 10:31:13 -0700600 appendCflags([]string)
601 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700602 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800603}
604
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500605// linker is the interface for a linker decorator object. Individual module types can provide
606// their own implementation for this decorator, and thus specify custom logic regarding build
607// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800608type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700609 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800610 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700611 linkerFlags(ctx ModuleContext, flags Flags) Flags
612 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800613 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700614
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700615 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700616 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900617 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800618 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700619
620 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900621 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000622
623 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000624 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800625
626 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000627}
628
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500629// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000630type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500631 sharedLibs []string
632 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
633 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700634 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800635}
636
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500637// installer is the interface for an installer helper object. This helper is responsible for
638// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800639type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700640 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700641 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000642 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800643 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700644 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700645 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900646 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000647 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900648 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800649}
650
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800651type xref interface {
652 XrefCcFiles() android.Paths
653}
654
Inseob Kima1888ce2022-10-04 14:42:02 +0900655type overridable interface {
656 overriddenModules() []string
657}
658
Colin Cross6e511a92020-07-27 21:26:48 -0700659type libraryDependencyKind int
660
661const (
662 headerLibraryDependency = iota
663 sharedLibraryDependency
664 staticLibraryDependency
665)
666
667func (k libraryDependencyKind) String() string {
668 switch k {
669 case headerLibraryDependency:
670 return "headerLibraryDependency"
671 case sharedLibraryDependency:
672 return "sharedLibraryDependency"
673 case staticLibraryDependency:
674 return "staticLibraryDependency"
675 default:
676 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
677 }
678}
679
680type libraryDependencyOrder int
681
682const (
683 earlyLibraryDependency = -1
684 normalLibraryDependency = 0
685 lateLibraryDependency = 1
686)
687
688func (o libraryDependencyOrder) String() string {
689 switch o {
690 case earlyLibraryDependency:
691 return "earlyLibraryDependency"
692 case normalLibraryDependency:
693 return "normalLibraryDependency"
694 case lateLibraryDependency:
695 return "lateLibraryDependency"
696 default:
697 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
698 }
699}
700
701// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
702// tags that have a set of predefined tag objects that are reused for each dependency, a
703// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
704// That means that comparing a libraryDependencyTag for equality will only be equal if all
705// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
706// then check individual metadata fields instead.
707type libraryDependencyTag struct {
708 blueprint.BaseDependencyTag
709
710 // These are exported so that fmt.Printf("%#v") can call their String methods.
711 Kind libraryDependencyKind
712 Order libraryDependencyOrder
713
714 wholeStatic bool
715
716 reexportFlags bool
717 explicitlyVersioned bool
718 dataLib bool
719 ndk bool
720
721 staticUnwinder bool
722
723 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900724
Cindy Zhou18417cb2020-12-10 07:12:38 -0800725 // Whether or not this dependency should skip the apex dependency check
726 skipApexAllowedDependenciesCheck bool
727
Jiyong Parke3867542020-12-03 17:28:25 +0900728 // Whether or not this dependency has to be followed for the apex variants
729 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900730 // Whether or not this dependency has to be followed for the non-apex variants
731 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000732
733 // If true, don't automatically export symbols from the static library into a shared library.
734 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700735}
736
737// header returns true if the libraryDependencyTag is tagging a header lib dependency.
738func (d libraryDependencyTag) header() bool {
739 return d.Kind == headerLibraryDependency
740}
741
742// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
743func (d libraryDependencyTag) shared() bool {
744 return d.Kind == sharedLibraryDependency
745}
746
747// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
748func (d libraryDependencyTag) static() bool {
749 return d.Kind == staticLibraryDependency
750}
751
Colin Cross65cb3142021-12-10 23:05:02 +0000752func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
753 if d.shared() {
754 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
755 }
756 return nil
757}
758
759var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
760
Colin Crosse9fe2942020-11-10 18:12:15 -0800761// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
762// binaries or other shared libraries are installed as dependencies.
763func (d libraryDependencyTag) InstallDepNeeded() bool {
764 return d.shared()
765}
766
767var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
768
769// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700770// libraryDependencyTag. Each tag object is created globally and reused for multiple
771// dependencies (although since the object contains no references, assigning a tag to a
772// variable and modifying it will not modify the original). Users can compare the tag
773// returned by ctx.OtherModuleDependencyTag against the global original
774type dependencyTag struct {
775 blueprint.BaseDependencyTag
776 name string
777}
778
Colin Crosse9fe2942020-11-10 18:12:15 -0800779// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
780// libraryDependencyTag, but where the dependency needs to be installed when the parent is
781// installed.
782type installDependencyTag struct {
783 blueprint.BaseDependencyTag
784 android.InstallAlwaysNeededDependencyTag
785 name string
786}
787
Colin Crossc99deeb2016-04-11 15:06:20 -0700788var (
Colin Cross6e511a92020-07-27 21:26:48 -0700789 genSourceDepTag = dependencyTag{name: "gen source"}
790 genHeaderDepTag = dependencyTag{name: "gen header"}
791 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
792 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900793 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700794 reuseObjTag = dependencyTag{name: "reuse objects"}
795 staticVariantTag = dependencyTag{name: "static variant"}
796 vndkExtDepTag = dependencyTag{name: "vndk extends"}
797 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700798 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800799 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700800 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700801 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000802 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500803 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400804 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700805)
806
Roland Levillainf89cd092019-07-29 16:22:59 +0100807func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700808 ccLibDepTag, ok := depTag.(libraryDependencyTag)
809 return ok && ccLibDepTag.shared()
810}
811
812func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
813 ccLibDepTag, ok := depTag.(libraryDependencyTag)
814 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100815}
816
Zach Johnson3df4e632020-11-06 11:56:27 -0800817func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
818 ccLibDepTag, ok := depTag.(libraryDependencyTag)
819 return ok && ccLibDepTag.header()
820}
821
Roland Levillainf89cd092019-07-29 16:22:59 +0100822func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800823 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100824}
825
826func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700827 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100828 return ok && ccDepTag == testPerSrcDepTag
829}
830
Colin Crossca860ac2016-01-04 14:34:37 -0800831// Module contains the properties and members used by all C/C++ module types, and implements
832// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500833// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
834// interface.
835//
836// To define a C/C++ related module, construct a new Module object and point its delegates to
837// type-specific structs. These delegates will be invoked to register module-specific build
838// statements which may be unique to the module type. For example, module.compiler.compile() should
839// be defined so as to register build statements which are responsible for compiling the module.
840//
841// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
842// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
843// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
844// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800845type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700846 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700847
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700848 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700849 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700850
Colin Crossca860ac2016-01-04 14:34:37 -0800851 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000852 hod android.HostOrDeviceSupported
853 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000854 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700855
Paul Duffina0843f62019-12-13 19:50:38 +0000856 // Allowable SdkMemberTypes of this module type.
857 sdkMemberTypes []android.SdkMemberType
858
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500859 // decorator delegates, initialize before calling Init
860 // these may contain module-specific implementations, and effectively allow for custom
861 // type-specific logic. These members may reference different objects or the same object.
862 // Functions of these decorators will be invoked to initialize and register type-specific
863 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800864 generators []Generator
865 compiler compiler
866 linker linker
867 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500868
Spandan Dase12d2522023-09-12 21:42:31 +0000869 features []feature
870 stl *stl
871 sanitize *sanitize
872 coverage *coverage
873 fuzzer *fuzzer
874 sabi *sabi
875 vndkdep *vndkdep
876 lto *lto
877 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000878 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800879
Colin Cross31076b32020-10-23 17:22:06 -0700880 library libraryInterface
881
Colin Cross635c3b02016-05-18 15:37:25 -0700882 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800883
Colin Crossb98c8b02016-07-29 13:44:28 -0700884 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700885
886 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800887
888 // Flags used to compile this module
889 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700890
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800891 // Shared flags among build rules of this module
892 sharedFlags SharedFlags
893
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800894 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700895 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900896
897 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800898 // Kythe (source file indexer) paths for this compilation module
899 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700900 // Object .o file output paths for this compilation module
901 objFiles android.Paths
902 // Tidy .tidy file output paths for this compilation module
903 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900904
905 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700906 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700907
908 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800909
910 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800911 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700912}
913
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200914func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400915 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
916 if b, ok := c.compiler.(*baseCompiler); ok {
917 hasAidl = b.hasSrcExt(".aidl")
918 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
919 hasProto = b.hasSrcExt(".proto")
920 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
921 hasSysprop = b.hasSrcExt(".sysprop")
922 hasWinMsg = b.hasSrcExt(".mc")
923 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
924 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200925 c.AndroidModuleBase().AddJSONData(d)
926 (*d)["Cc"] = map[string]interface{}{
927 "SdkVersion": c.SdkVersion(),
928 "MinSdkVersion": c.MinSdkVersion(),
929 "VndkVersion": c.VndkVersion(),
930 "ProductSpecific": c.ProductSpecific(),
931 "SocSpecific": c.SocSpecific(),
932 "DeviceSpecific": c.DeviceSpecific(),
933 "InProduct": c.InProduct(),
934 "InVendor": c.InVendor(),
935 "InRamdisk": c.InRamdisk(),
936 "InVendorRamdisk": c.InVendorRamdisk(),
937 "InRecovery": c.InRecovery(),
938 "VendorAvailable": c.VendorAvailable(),
939 "ProductAvailable": c.ProductAvailable(),
940 "RamdiskAvailable": c.RamdiskAvailable(),
941 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
942 "RecoveryAvailable": c.RecoveryAvailable(),
943 "OdmAvailable": c.OdmAvailable(),
944 "InstallInData": c.InstallInData(),
945 "InstallInRamdisk": c.InstallInRamdisk(),
946 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
947 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
948 "InstallInRecovery": c.InstallInRecovery(),
949 "InstallInRoot": c.InstallInRoot(),
950 "IsVndk": c.IsVndk(),
951 "IsVndkExt": c.IsVndkExt(),
952 "IsVndkPrivate": c.IsVndkPrivate(),
953 "IsVndkSp": c.IsVndkSp(),
954 "IsLlndk": c.IsLlndk(),
955 "IsLlndkPublic": c.IsLlndkPublic(),
956 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
957 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
958 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
959 "ApexSdkVersion": c.apexSdkVersion,
960 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400961 "AidlSrcs": hasAidl,
962 "LexSrcs": hasLex,
963 "ProtoSrcs": hasProto,
964 "RenderscriptSrcs": hasRenderscript,
965 "SyspropSrcs": hasSysprop,
966 "WinMsgSrcs": hasWinMsg,
967 "YaccSrsc": hasYacc,
968 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200969 }
970}
971
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500972func (c *Module) SetPreventInstall() {
973 c.Properties.PreventInstall = true
974}
975
976func (c *Module) SetHideFromMake() {
977 c.Properties.HideFromMake = true
978}
979
Ivan Lozanod7586b62021-04-01 09:49:36 -0400980func (c *Module) HiddenFromMake() bool {
981 return c.Properties.HideFromMake
982}
983
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800984func (c *Module) RequiredModuleNames() []string {
985 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
986 if c.ImageVariation().Variation == android.CoreVariation {
987 required = append(required, c.Properties.Target.Platform.Required...)
988 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
989 } else if c.InRecovery() {
990 required = append(required, c.Properties.Target.Recovery.Required...)
991 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
992 }
993 return android.FirstUniqueStrings(required)
994}
995
Ivan Lozano52767be2019-10-18 14:49:46 -0700996func (c *Module) Toc() android.OptionalPath {
997 if c.linker != nil {
998 if library, ok := c.linker.(libraryInterface); ok {
999 return library.toc()
1000 }
1001 }
1002 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1003}
1004
1005func (c *Module) ApiLevel() string {
1006 if c.linker != nil {
1007 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001008 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001009 }
1010 }
1011 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1012}
1013
1014func (c *Module) Static() bool {
1015 if c.linker != nil {
1016 if library, ok := c.linker.(libraryInterface); ok {
1017 return library.static()
1018 }
1019 }
1020 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1021}
1022
1023func (c *Module) Shared() bool {
1024 if c.linker != nil {
1025 if library, ok := c.linker.(libraryInterface); ok {
1026 return library.shared()
1027 }
1028 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001029
Ivan Lozano52767be2019-10-18 14:49:46 -07001030 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1031}
1032
1033func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001034 if c.stl != nil {
1035 return c.stl.Properties.SelectedStl
1036 }
1037 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001038}
1039
Ivan Lozano52767be2019-10-18 14:49:46 -07001040func (c *Module) NdkPrebuiltStl() bool {
1041 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1042 return true
1043 }
1044 return false
1045}
1046
1047func (c *Module) StubDecorator() bool {
1048 if _, ok := c.linker.(*stubDecorator); ok {
1049 return true
1050 }
1051 return false
1052}
1053
1054func (c *Module) SdkVersion() string {
1055 return String(c.Properties.Sdk_version)
1056}
1057
Artur Satayev480e25b2020-04-27 18:53:18 +01001058func (c *Module) MinSdkVersion() string {
1059 return String(c.Properties.Min_sdk_version)
1060}
1061
Jiyong Park5df7bd32021-08-25 16:18:46 +09001062func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001063 if linker, ok := c.linker.(*objectLinker); ok {
1064 return linker.isCrt()
1065 }
1066 return false
1067}
1068
Jiyong Park5df7bd32021-08-25 16:18:46 +09001069func (c *Module) SplitPerApiLevel() bool {
1070 return c.canUseSdk() && c.isCrt()
1071}
1072
Colin Crossc511bc52020-04-07 16:50:32 +00001073func (c *Module) AlwaysSdk() bool {
1074 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1075}
1076
Ivan Lozano183a3212019-10-18 14:18:45 -07001077func (c *Module) CcLibrary() bool {
1078 if c.linker != nil {
1079 if _, ok := c.linker.(*libraryDecorator); ok {
1080 return true
1081 }
Colin Crossd48fe732020-09-23 20:37:24 -07001082 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1083 return true
1084 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001085 }
1086 return false
1087}
1088
1089func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001090 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001091 return true
1092 }
1093 return false
1094}
1095
Spandan Dase12d2522023-09-12 21:42:31 +00001096func (c *Module) IsNdkPrebuiltStl() bool {
1097 if c.linker == nil {
1098 return false
1099 }
1100 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1101 return true
1102 }
1103 return false
1104}
1105
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001106func (c *Module) RlibStd() bool {
1107 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1108}
1109
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001110func (c *Module) RustLibraryInterface() bool {
1111 return false
1112}
1113
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001114func (c *Module) IsFuzzModule() bool {
1115 if _, ok := c.compiler.(*fuzzBinary); ok {
1116 return true
1117 }
1118 return false
1119}
1120
1121func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1122 return c.FuzzModule
1123}
1124
1125func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1126 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1127 return fuzzer.fuzzPackagedModule
1128 }
1129 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1130}
1131
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001132func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001133 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1134 return fuzzer.sharedLibraries
1135 }
1136 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1137}
1138
Ivan Lozano2b262972019-11-21 12:30:50 -08001139func (c *Module) NonCcVariants() bool {
1140 return false
1141}
1142
Ivan Lozano183a3212019-10-18 14:18:45 -07001143func (c *Module) SetStatic() {
1144 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001145 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001146 library.setStatic()
1147 return
1148 }
1149 }
1150 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1151}
1152
1153func (c *Module) SetShared() {
1154 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001155 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001156 library.setShared()
1157 return
1158 }
1159 }
1160 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1161}
1162
1163func (c *Module) BuildStaticVariant() bool {
1164 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001165 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001166 return library.buildStatic()
1167 }
1168 }
1169 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1170}
1171
1172func (c *Module) BuildSharedVariant() bool {
1173 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001174 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001175 return library.buildShared()
1176 }
1177 }
1178 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1179}
1180
1181func (c *Module) Module() android.Module {
1182 return c
1183}
1184
Jiyong Parkc20eee32018-09-05 22:36:17 +09001185func (c *Module) OutputFile() android.OptionalPath {
1186 return c.outputFile
1187}
1188
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001189func (c *Module) CoverageFiles() android.Paths {
1190 if c.linker != nil {
1191 if library, ok := c.linker.(libraryInterface); ok {
1192 return library.objs().coverageFiles
1193 }
1194 }
1195 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1196}
1197
Ivan Lozano183a3212019-10-18 14:18:45 -07001198var _ LinkableInterface = (*Module)(nil)
1199
Jiyong Park719b4462019-01-13 00:39:51 +09001200func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001201 if c.linker != nil {
1202 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001203 }
1204 return nil
1205}
1206
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001207func (c *Module) CoverageOutputFile() android.OptionalPath {
1208 if c.linker != nil {
1209 return c.linker.coverageOutputFilePath()
1210 }
1211 return android.OptionalPath{}
1212}
1213
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001214func (c *Module) RelativeInstallPath() string {
1215 if c.installer != nil {
1216 return c.installer.relativeInstallPath()
1217 }
1218 return ""
1219}
1220
Jooyung Han344d5432019-08-23 11:17:39 +09001221func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001222 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001223}
1224
Colin Cross36242852017-06-23 15:06:31 -07001225func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001226 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001227 for _, generator := range c.generators {
1228 c.AddProperties(generator.GeneratorProps()...)
1229 }
Colin Crossca860ac2016-01-04 14:34:37 -08001230 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001231 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001232 }
1233 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001234 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001235 }
1236 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001237 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001238 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001239 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001240 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001241 }
Colin Cross16b23492016-01-06 14:41:07 -08001242 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001243 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001244 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001245 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001246 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001247 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001248 if c.fuzzer != nil {
1249 c.AddProperties(c.fuzzer.props()...)
1250 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001251 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001252 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001253 }
Justin Yun8effde42017-06-23 19:24:43 +09001254 if c.vndkdep != nil {
1255 c.AddProperties(c.vndkdep.props()...)
1256 }
Stephen Craneba090d12017-05-09 15:44:35 -07001257 if c.lto != nil {
1258 c.AddProperties(c.lto.props()...)
1259 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001260 if c.afdo != nil {
1261 c.AddProperties(c.afdo.props()...)
1262 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001263 if c.orderfile != nil {
1264 c.AddProperties(c.orderfile.props()...)
1265 }
Colin Crossca860ac2016-01-04 14:34:37 -08001266 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001267 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001268 }
Colin Crossc472d572015-03-17 15:06:21 -07001269
Colin Cross36242852017-06-23 15:06:31 -07001270 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001271 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001272 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001273
Colin Cross36242852017-06-23 15:06:31 -07001274 return c
Colin Crossc472d572015-03-17 15:06:21 -07001275}
1276
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001277// UseVndk() returns true if this module is built against VNDK.
1278// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001279func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001280 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001281}
1282
Colin Crossc511bc52020-04-07 16:50:32 +00001283func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001284 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001285 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001286}
1287
1288func (c *Module) UseSdk() bool {
1289 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001290 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001291 }
1292 return false
1293}
1294
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001295func (c *Module) isCoverageVariant() bool {
1296 return c.coverage.Properties.IsCoverageVariant
1297}
1298
Colin Cross95f1ca02020-10-29 20:47:22 -07001299func (c *Module) IsNdk(config android.Config) bool {
1300 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001301}
1302
Colin Cross127bb8b2020-12-16 16:46:01 -08001303func (c *Module) IsLlndk() bool {
1304 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001305}
1306
Colin Cross127bb8b2020-12-16 16:46:01 -08001307func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001308 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001309}
1310
Colin Cross1f3f1302021-04-26 18:37:44 -07001311func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001312 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001313 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001314}
1315
Colin Cross5271fea2021-04-27 13:06:04 -07001316func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1317 lib := moduleLibraryInterface(m)
1318 return lib != nil && (lib.hasVendorPublicLibrary())
1319}
1320
1321// IsVendorPublicLibrary returns true for vendor public libraries.
1322func (c *Module) IsVendorPublicLibrary() bool {
1323 return c.VendorProperties.IsVendorPublicLibrary
1324}
1325
Ivan Lozanof1868af2022-04-12 13:08:36 -04001326func (c *Module) IsVndkPrebuiltLibrary() bool {
1327 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1328 return true
1329 }
1330 return false
1331}
1332
1333func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1334 return c.Properties.SdkAndPlatformVariantVisibleToMake
1335}
1336
Ivan Lozanod7586b62021-04-01 09:49:36 -04001337func (c *Module) HasLlndkStubs() bool {
1338 lib := moduleLibraryInterface(c)
1339 return lib != nil && lib.hasLLNDKStubs()
1340}
1341
1342func (c *Module) StubsVersion() string {
1343 if lib, ok := c.linker.(versionedInterface); ok {
1344 return lib.stubsVersion()
1345 }
1346 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1347}
1348
Colin Cross127bb8b2020-12-16 16:46:01 -08001349// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1350// and does not set llndk.vendor_available: false.
1351func (c *Module) isImplementationForLLNDKPublic() bool {
1352 library, _ := c.library.(*libraryDecorator)
1353 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001354 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001355}
1356
Justin Yunfd9e8042020-12-23 18:23:14 +09001357// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001358func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001359 // Check if VNDK-core-private or VNDK-SP-private
1360 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001361 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001362 }
1363
1364 // Check if LLNDK-private
1365 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001366 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001367 }
1368
1369 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001370}
1371
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001372// IsVndk() returns true if this module has a vndk variant.
1373// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1374// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001375func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001376 if vndkdep := c.vndkdep; vndkdep != nil {
1377 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001378 }
1379 return false
1380}
1381
Colin Cross3513fb12024-01-24 14:44:47 -08001382func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001383 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001384 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001385 }
1386 return false
1387}
1388
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001389func (c *Module) isOrderfileCompile() bool {
1390 if orderfile := c.orderfile; orderfile != nil {
1391 return orderfile.Properties.OrderfileLoad
1392 }
1393 return false
1394}
1395
Yi Kongc702ebd2022-08-19 16:02:45 +08001396func (c *Module) isCfi() bool {
1397 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001398 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001399 }
1400 return false
1401}
1402
Yi Konged79fa32023-06-04 17:15:42 +09001403func (c *Module) isFuzzer() bool {
1404 if sanitize := c.sanitize; sanitize != nil {
1405 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1406 }
1407 return false
1408}
1409
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001410func (c *Module) isNDKStubLibrary() bool {
1411 if _, ok := c.compiler.(*stubDecorator); ok {
1412 return true
1413 }
1414 return false
1415}
1416
Ivan Lozanod7586b62021-04-01 09:49:36 -04001417func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001418 if vndkdep := c.vndkdep; vndkdep != nil {
1419 return vndkdep.isVndkSp()
1420 }
1421 return false
1422}
1423
Ivan Lozanof9e21722020-12-02 09:00:51 -05001424func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001425 if vndkdep := c.vndkdep; vndkdep != nil {
1426 return vndkdep.isVndkExt()
1427 }
1428 return false
1429}
1430
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001431func (c *Module) SubName() string {
1432 return c.Properties.SubName
1433}
1434
Ivan Lozano52767be2019-10-18 14:49:46 -07001435func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001436 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001437}
1438
Logan Chienf3511742017-10-31 18:04:35 +08001439func (c *Module) getVndkExtendsModuleName() string {
1440 if vndkdep := c.vndkdep; vndkdep != nil {
1441 return vndkdep.getVndkExtendsModuleName()
1442 }
1443 return ""
1444}
1445
Jiyong Park25fc6a92018-11-18 18:02:45 +09001446func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001447 if lib := c.library; lib != nil {
1448 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001449 }
1450 return false
1451}
1452
1453func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001454 if lib := c.library; lib != nil {
1455 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001456 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001457 return false
1458}
1459
Alan Stokes73feba32022-11-14 12:21:24 +00001460func (c *Module) IsStubsImplementationRequired() bool {
1461 if lib := c.library; lib != nil {
1462 return lib.isStubsImplementationRequired()
1463 }
1464 return false
1465}
1466
Colin Cross0477b422020-10-13 18:43:54 -07001467// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1468// the implementation. If it is an implementation library it returns its own name.
1469func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1470 name := ctx.OtherModuleName(c)
1471 if versioned, ok := c.linker.(versionedInterface); ok {
1472 name = versioned.implementationModuleName(name)
1473 }
1474 return name
1475}
1476
Martin Stjernholm2856c662020-12-02 15:03:42 +00001477// Similar to ImplementationModuleName, but uses the Make variant of the module
1478// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1479// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1480// under the premise that the prebuilt module overrides its source counterpart
1481// if it is exposed to Make).
1482func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1483 name := c.BaseModuleName()
1484 if versioned, ok := c.linker.(versionedInterface); ok {
1485 name = versioned.implementationModuleName(name)
1486 }
1487 return name
1488}
1489
Jiyong Park7d55b612021-06-11 17:22:09 +09001490func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001491 return Bool(c.Properties.Bootstrap)
1492}
1493
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001494func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001495 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1496 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1497 return false
1498 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001499 return c.linker != nil && c.linker.nativeCoverage()
1500}
1501
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001502func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001503 if p, ok := c.linker.(SnapshotInterface); ok {
1504 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001505 }
1506 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001507}
1508
Bill Peckham945441c2020-08-31 16:07:58 -07001509func (c *Module) ExcludeFromVendorSnapshot() bool {
1510 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1511}
1512
Jose Galmesf7294582020-11-13 12:07:36 -08001513func (c *Module) ExcludeFromRecoverySnapshot() bool {
1514 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1515}
1516
Jiyong Parkf1194352019-02-25 11:05:47 +09001517func isBionic(name string) bool {
1518 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001519 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001520 return true
1521 }
1522 return false
1523}
1524
Martin Stjernholm279de572019-09-10 23:18:20 +01001525func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001526 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001527 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001528 }
1529 return isBionic(name)
1530}
1531
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001532func (c *Module) XrefCcFiles() android.Paths {
1533 return c.kytheFiles
1534}
1535
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001536func (c *Module) isCfiAssemblySupportEnabled() bool {
1537 return c.sanitize != nil &&
1538 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1539}
1540
Inseob Kim800d1142021-06-14 12:03:51 +09001541func (c *Module) InstallInRoot() bool {
1542 return c.installer != nil && c.installer.installInRoot()
1543}
1544
Colin Crossca860ac2016-01-04 14:34:37 -08001545type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001546 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001547 moduleContextImpl
1548}
1549
Colin Cross37047f12016-12-13 17:06:13 -08001550type depsContext struct {
1551 android.BottomUpMutatorContext
1552 moduleContextImpl
1553}
1554
Colin Crossca860ac2016-01-04 14:34:37 -08001555type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001556 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001557 moduleContextImpl
1558}
1559
1560type moduleContextImpl struct {
1561 mod *Module
1562 ctx BaseModuleContext
1563}
1564
Colin Crossb98c8b02016-07-29 13:44:28 -07001565func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001566 return ctx.mod.toolchain(ctx.ctx)
1567}
1568
1569func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001570 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001571}
1572
1573func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001574 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001575}
1576
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001577func (ctx *moduleContextImpl) testBinary() bool {
1578 return ctx.mod.testBinary()
1579}
1580
Yi Kong56fc1b62022-09-06 16:24:00 +08001581func (ctx *moduleContextImpl) testLibrary() bool {
1582 return ctx.mod.testLibrary()
1583}
1584
Jiyong Park1d1119f2019-07-29 21:27:18 +09001585func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001586 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001587}
1588
Inseob Kim7f283f42020-06-01 21:53:49 +09001589func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001590 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001591}
1592
Inseob Kim1042d292020-06-01 23:23:05 +09001593func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001594 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001595}
1596
Jooyung Hanccce2f22020-03-07 03:45:53 +09001597func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001598 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001599}
1600
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001601func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001602 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001603}
1604
1605func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001606 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001607 config := ctx.ctx.Config()
1608 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001609 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001610 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001611 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001612 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001613 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001614 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001615 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001616 }
1617 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001618}
1619
Jiyong Parkb35a8192020-08-10 15:59:36 +09001620func (ctx *moduleContextImpl) minSdkVersion() string {
1621 ver := ctx.mod.MinSdkVersion()
1622 if ver == "apex_inherit" && !ctx.isForPlatform() {
1623 ver = ctx.apexSdkVersion().String()
1624 }
1625 if ver == "apex_inherit" || ver == "" {
1626 ver = ctx.sdkVersion()
1627 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001628
1629 if ctx.ctx.Device() {
1630 config := ctx.ctx.Config()
1631 if config.IsVndkDeprecated() && ctx.inVendor() {
1632 // If building for vendor with final API, then use the latest _stable_ API as "current".
1633 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1634 ver = config.PlatformSdkVersion().String()
1635 }
1636 }
1637 }
1638
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001639 // For crt objects, the meaning of min_sdk_version is very different from other types of
1640 // module. For them, min_sdk_version defines the oldest version that the build system will
1641 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1642 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1643 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001644 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1645 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1646 // support such an old version. The version is set to the later version in case when the
1647 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1648 // it's for an APEX.
1649 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1650 if ctx.isForPlatform() {
1651 ver = strconv.Itoa(android.FutureApiLevelInt)
1652 } else { // for apex
1653 ver = ctx.apexSdkVersion().String()
1654 if ver == "" { // in case when min_sdk_version was not set by the APEX
1655 ver = ctx.sdkVersion()
1656 }
1657 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001658 }
1659
Jiyong Parkb35a8192020-08-10 15:59:36 +09001660 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1661 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1662 minSdkVersionInt, err2 := strconv.Atoi(ver)
1663 if err == nil && err2 == nil {
1664 if sdkVersionInt < minSdkVersionInt {
1665 return strconv.Itoa(sdkVersionInt)
1666 }
1667 }
1668 return ver
1669}
1670
1671func (ctx *moduleContextImpl) isSdkVariant() bool {
1672 return ctx.mod.IsSdkVariant()
1673}
1674
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001675func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001676 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001677}
Justin Yun8effde42017-06-23 19:24:43 +09001678
Kiyoung Kimaa394802024-01-08 12:55:45 +09001679func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1680 return ctx.mod.InVendorOrProduct()
1681}
1682
Colin Cross95f1ca02020-10-29 20:47:22 -07001683func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1684 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001685}
1686
Colin Cross127bb8b2020-12-16 16:46:01 -08001687func (ctx *moduleContextImpl) IsLlndk() bool {
1688 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001689}
1690
Colin Cross127bb8b2020-12-16 16:46:01 -08001691func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1692 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001693}
1694
Colin Cross127bb8b2020-12-16 16:46:01 -08001695func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1696 return ctx.mod.isImplementationForLLNDKPublic()
1697}
1698
1699func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1700 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001701}
1702
Logan Chienf3511742017-10-31 18:04:35 +08001703func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001704 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001705}
1706
Colin Cross3513fb12024-01-24 14:44:47 -08001707func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1708 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001709}
1710
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001711func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1712 return ctx.mod.isOrderfileCompile()
1713}
1714
Yi Kongc702ebd2022-08-19 16:02:45 +08001715func (ctx *moduleContextImpl) isCfi() bool {
1716 return ctx.mod.isCfi()
1717}
1718
Yi Konged79fa32023-06-04 17:15:42 +09001719func (ctx *moduleContextImpl) isFuzzer() bool {
1720 return ctx.mod.isFuzzer()
1721}
1722
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001723func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1724 return ctx.mod.isNDKStubLibrary()
1725}
1726
Justin Yun8effde42017-06-23 19:24:43 +09001727func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001728 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001729}
1730
Ivan Lozanof9e21722020-12-02 09:00:51 -05001731func (ctx *moduleContextImpl) IsVndkExt() bool {
1732 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001733}
1734
Colin Cross5271fea2021-04-27 13:06:04 -07001735func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1736 return ctx.mod.IsVendorPublicLibrary()
1737}
1738
Vic Yangefd249e2018-11-12 20:19:56 -08001739func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001740 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001741}
1742
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001743func (ctx *moduleContextImpl) selectedStl() string {
1744 if stl := ctx.mod.stl; stl != nil {
1745 return stl.Properties.SelectedStl
1746 }
1747 return ""
1748}
1749
Ivan Lozanobd721262018-11-27 14:33:03 -08001750func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1751 return ctx.mod.linker.useClangLld(actx)
1752}
1753
Colin Crossce75d2c2016-10-06 16:12:58 -07001754func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001755 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001756}
1757
Logan Chienf3511742017-10-31 18:04:35 +08001758func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1759 return ctx.mod.getVndkExtendsModuleName()
1760}
1761
Logan Chiene274fc92019-12-03 11:18:32 -08001762func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001763 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1764 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001765}
1766
Colin Crosse07f2312020-08-13 11:24:56 -07001767func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001768 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1769 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001770}
1771
Dan Albertc8060532020-07-22 22:32:17 -07001772func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001773 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001774}
1775
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001776func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001777 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001778}
1779
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001780func (ctx *moduleContextImpl) nativeCoverage() bool {
1781 return ctx.mod.nativeCoverage()
1782}
1783
Colin Cross56a83212020-09-15 18:30:11 -07001784func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1785 return ctx.mod.DirectlyInAnyApex()
1786}
1787
Colin Cross95b07f22020-12-16 11:06:50 -08001788func (ctx *moduleContextImpl) isPreventInstall() bool {
1789 return ctx.mod.Properties.PreventInstall
1790}
1791
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001792func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1793 shared := &ctx.mod.sharedFlags
1794 if shared.flagsMap == nil {
1795 shared.numSharedFlags = 0
1796 shared.flagsMap = make(map[string]string)
1797 }
1798 return shared
1799}
1800
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001801func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1802 return ctx.mod.isCfiAssemblySupportEnabled()
1803}
1804
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001805func (ctx *moduleContextImpl) notInPlatform() bool {
1806 return ctx.mod.NotInPlatform()
1807}
1808
Colin Cross635c3b02016-05-18 15:37:25 -07001809func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001810 return &Module{
1811 hod: hod,
1812 multilib: multilib,
1813 }
1814}
1815
Colin Cross635c3b02016-05-18 15:37:25 -07001816func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001817 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001818 module.features = []feature{
1819 &tidyFeature{},
1820 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001821 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001822 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001823 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001824 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001825 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001826 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001827 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001828 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001829 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001830 return module
1831}
1832
Colin Crossce75d2c2016-10-06 16:12:58 -07001833func (c *Module) Prebuilt() *android.Prebuilt {
1834 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1835 return p.prebuilt()
1836 }
1837 return nil
1838}
1839
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001840func (c *Module) IsPrebuilt() bool {
1841 return c.Prebuilt() != nil
1842}
1843
Colin Crossce75d2c2016-10-06 16:12:58 -07001844func (c *Module) Name() string {
1845 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001846 if p, ok := c.linker.(interface {
1847 Name(string) string
1848 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001849 name = p.Name(name)
1850 }
1851 return name
1852}
1853
Alex Light3d673592019-01-18 14:37:31 -08001854func (c *Module) Symlinks() []string {
1855 if p, ok := c.installer.(interface {
1856 symlinkList() []string
1857 }); ok {
1858 return p.symlinkList()
1859 }
1860 return nil
1861}
1862
Roland Levillainf89cd092019-07-29 16:22:59 +01001863func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1864 test, ok := c.linker.(testPerSrc)
1865 return ok && test.isAllTestsVariation()
1866}
1867
Chris Parsons216e10a2020-07-09 17:12:52 -04001868func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001869 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001870 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001871 }); ok {
1872 return p.dataPaths()
1873 }
1874 return nil
1875}
1876
Ivan Lozanof1868af2022-04-12 13:08:36 -04001877func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001878 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1879 // "current", it will append the VNDK version to the name suffix.
1880 var vndkVersion string
1881 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001882 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001883 if c.ProductSpecific() {
1884 // If the module is product specific with 'product_specific: true',
1885 // do not add a name suffix because it is a base module.
1886 return ""
1887 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001888 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001889 } else {
1890 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001891 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001892 }
1893 if vndkVersion == "current" {
1894 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1895 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001896 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001897 // add version suffix only if the module is using different vndk version than the
1898 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001899 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001900 }
1901 return nameSuffix
1902}
1903
Ivan Lozanof1868af2022-04-12 13:08:36 -04001904func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1905 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001906
1907 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001908 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001909 }
1910
Colin Cross127bb8b2020-12-16 16:46:01 -08001911 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001912 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001913 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1914 // added for product variant only when we have vendor and product variants with core
1915 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001916 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001917 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001918 subName += vendorPublicLibrarySuffix
1919 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001920 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1921 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001922 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001923 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001924 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001925 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001926 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001927 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001928 subName += RecoverySuffix
1929 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1930 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001931 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001932 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001933 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001934 } else if c.IsStubs() && c.IsSdkVariant() {
1935 // Public API surface (NDK)
1936 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1937 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001938 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001939
1940 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001941}
1942
Sam Delmerico75dbca22023-04-20 13:13:25 +00001943func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1944 ctx := &moduleContext{
1945 ModuleContext: actx,
1946 moduleContextImpl: moduleContextImpl{
1947 mod: c,
1948 },
1949 }
1950 ctx.ctx = ctx
1951 return ctx
1952}
1953
Spandan Das20fce2d2023-04-12 17:21:39 +00001954// TODO (b/277651159): Remove this allowlist
1955var (
1956 skipStubLibraryMultipleApexViolation = map[string]bool{
1957 "libclang_rt.asan": true,
1958 "libclang_rt.hwasan": true,
1959 // runtime apex
1960 "libc": true,
1961 "libc_hwasan": true,
1962 "libdl_android": true,
1963 "libm": true,
1964 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001965 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001966 // art apex
1967 "libandroidio": true,
1968 "libdexfile": true,
1969 "libnativebridge": true,
1970 "libnativehelper": true,
1971 "libnativeloader": true,
1972 "libsigchain": true,
1973 }
1974)
1975
1976// Returns true if a stub library could be installed in multiple apexes
1977func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1978 // If this is not an apex variant, no check necessary
1979 if !c.InAnyApex() {
1980 return false
1981 }
1982 // If this is not a stub library, no check necessary
1983 if !c.HasStubsVariants() {
1984 return false
1985 }
1986 // Skip the allowlist
1987 // Use BaseModuleName so that this matches prebuilts.
1988 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1989 return false
1990 }
1991
1992 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1993 // Stub libraries should not have more than one apex_available
1994 if len(aaWithoutTestApexes) > 1 {
1995 return true
1996 }
1997 // Stub libraries should not use the wildcard
1998 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
1999 return true
2000 }
2001 // Default: no violation
2002 return false
2003}
2004
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002005func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2006 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2007}
2008
Chris Parsons8d6e4332021-02-22 16:13:50 -05002009func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002010 // Handle the case of a test module split by `test_per_src` mutator.
2011 //
2012 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2013 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2014 // module and return early, as this module does not produce an output file per se.
2015 if c.IsTestPerSrcAllTestsVariation() {
2016 c.outputFile = android.OptionalPath{}
2017 return
2018 }
2019
Ivan Lozanof1868af2022-04-12 13:08:36 -04002020 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002021 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002022 if !apexInfo.IsForPlatform() {
2023 c.hideApexVariantFromMake = true
2024 }
2025
Chris Parsonseefc9e62021-04-02 17:36:47 -04002026 c.makeLinkType = GetMakeLinkType(actx, c)
2027
Sam Delmerico75dbca22023-04-20 13:13:25 +00002028 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002029
Colin Crossf18e1102017-11-16 14:33:08 -08002030 deps := c.depsToPaths(ctx)
2031 if ctx.Failed() {
2032 return
2033 }
2034
Joe Onorato37f900c2023-07-18 16:58:16 -07002035 for _, generator := range c.generators {
2036 gen := generator.GeneratorSources(ctx)
2037 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2038 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2039 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2040 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2041 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2042 if len(deps.Objs.objFiles) == 0 {
2043 // If we are reusuing object files (which happens when we're a shared library and we're
2044 // reusing our static variant's object files), then skip adding the actual source files,
2045 // because we already have the object for it.
2046 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2047 }
2048 }
2049
2050 if ctx.Failed() {
2051 return
2052 }
2053
Spandan Das20fce2d2023-04-12 17:21:39 +00002054 if c.stubLibraryMultipleApexViolation(actx) {
2055 actx.PropertyErrorf("apex_available",
2056 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2057 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002058 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2059 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002060 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2061 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002062 }
2063
Colin Crossca860ac2016-01-04 14:34:37 -08002064 flags := Flags{
2065 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002066 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002067 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002068 for _, generator := range c.generators {
2069 flags = generator.GeneratorFlags(ctx, flags, deps)
2070 }
Colin Crossca860ac2016-01-04 14:34:37 -08002071 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002072 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002073 }
2074 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002075 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002076 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002077 if c.stl != nil {
2078 flags = c.stl.flags(ctx, flags)
2079 }
Colin Cross16b23492016-01-06 14:41:07 -08002080 if c.sanitize != nil {
2081 flags = c.sanitize.flags(ctx, flags)
2082 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002083 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002084 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002085 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002086 if c.fuzzer != nil {
2087 flags = c.fuzzer.flags(ctx, flags)
2088 }
Stephen Craneba090d12017-05-09 15:44:35 -07002089 if c.lto != nil {
2090 flags = c.lto.flags(ctx, flags)
2091 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002092 if c.afdo != nil {
2093 flags = c.afdo.flags(ctx, flags)
2094 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002095 if c.orderfile != nil {
2096 flags = c.orderfile.flags(ctx, flags)
2097 }
Colin Crossca860ac2016-01-04 14:34:37 -08002098 for _, feature := range c.features {
2099 flags = feature.flags(ctx, flags)
2100 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002101 if ctx.Failed() {
2102 return
2103 }
2104
Colin Cross4af21ed2019-11-04 09:37:55 -08002105 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2106 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2107 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002108
Colin Cross4af21ed2019-11-04 09:37:55 -08002109 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002110
2111 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002112 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002113 }
2114 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002115 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002116 }
2117
Colin Cross3e5e7782022-06-17 22:17:05 +00002118 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2119
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002120 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002121 // We need access to all the flags seen by a source file.
2122 if c.sabi != nil {
2123 flags = c.sabi.flags(ctx, flags)
2124 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002125
Colin Cross4af21ed2019-11-04 09:37:55 -08002126 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002127
Joe Onorato37f900c2023-07-18 16:58:16 -07002128 for _, generator := range c.generators {
2129 generator.GeneratorBuildActions(ctx, flags, deps)
2130 }
2131
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002132 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002133 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002134 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002135 if ctx.Failed() {
2136 return
2137 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002138 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002139 c.objFiles = objs.objFiles
2140 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002141 }
2142
Colin Crossca860ac2016-01-04 14:34:37 -08002143 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002144 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002145 if ctx.Failed() {
2146 return
2147 }
Colin Cross635c3b02016-05-18 15:37:25 -07002148 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002149
Chris Parsons94a0bba2021-06-04 15:03:47 -04002150 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002151
Jose Galmes6f843bc2020-12-11 13:36:29 -08002152 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2153 // RECOVERY_SNAPSHOT_VERSION is current.
2154 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002155 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002156 i.collectHeadersForSnapshot(ctx)
2157 }
2158 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002159 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002160 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002161 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002162 }
Colin Cross40213022023-12-13 15:19:49 -08002163 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002164
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002165 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002166
Chris Parsons94a0bba2021-06-04 15:03:47 -04002167 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002168
2169 if c.linker != nil {
2170 moduleInfoJSON := ctx.ModuleInfoJSON()
2171 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2172 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2173 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2174 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2175 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2176
2177 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2178 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2179 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2180 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2181
2182 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2183 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2184 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2185 moduleInfoJSON.SubName += ".cfi"
2186 }
2187 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2188 moduleInfoJSON.SubName += ".hwasan"
2189 }
2190 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2191 moduleInfoJSON.SubName += ".scs"
2192 }
2193 }
2194 moduleInfoJSON.SubName += c.Properties.SubName
2195
2196 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2197 moduleInfoJSON.Uninstallable = true
2198 }
2199
2200 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002201}
2202
2203func (c *Module) maybeUnhideFromMake() {
2204 // If a lib is directly included in any of the APEXes or is not available to the
2205 // platform (which is often the case when the stub is provided as a prebuilt),
2206 // unhide the stubs variant having the latest version gets visible to make. In
2207 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2208 // force anything in the make world to link against the stubs library. (unless it
2209 // is explicitly referenced via .bootstrap suffix or the module is marked with
2210 // 'bootstrap: true').
2211 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002212 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002213 c.IsStubs() && !c.InVendorRamdisk() {
2214 c.Properties.HideFromMake = false // unhide
2215 // Note: this is still non-installable
2216 }
2217}
2218
Colin Cross8ff10582023-12-07 13:10:56 -08002219// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2220// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002221func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002222 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002223 // If the module has been specifically configure to not be installed then
2224 // hide from make as otherwise it will break when running inside make
2225 // as the output path to install will not be specified. Not all uninstallable
2226 // modules can be hidden from make as some are needed for resolving make side
2227 // dependencies.
2228 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002229 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002230 c.SkipInstall()
2231 }
2232
2233 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2234 // to allow using the outputs in a genrule.
2235 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002236 c.installer.install(ctx, c.outputFile.Path())
2237 if ctx.Failed() {
2238 return
Colin Crossca860ac2016-01-04 14:34:37 -08002239 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002240 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002241}
2242
Colin Cross0ea8ba82019-06-06 14:33:29 -07002243func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002244 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002245 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002246 }
Colin Crossca860ac2016-01-04 14:34:37 -08002247 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002248}
2249
Colin Crossca860ac2016-01-04 14:34:37 -08002250func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002251 for _, generator := range c.generators {
2252 generator.GeneratorInit(ctx)
2253 }
Colin Crossca860ac2016-01-04 14:34:37 -08002254 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002255 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002256 }
Colin Crossca860ac2016-01-04 14:34:37 -08002257 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002258 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002259 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002260 if c.stl != nil {
2261 c.stl.begin(ctx)
2262 }
Colin Cross16b23492016-01-06 14:41:07 -08002263 if c.sanitize != nil {
2264 c.sanitize.begin(ctx)
2265 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002266 if c.coverage != nil {
2267 c.coverage.begin(ctx)
2268 }
Yi Kong9723e332023-12-04 14:52:53 +09002269 if c.afdo != nil {
2270 c.afdo.begin(ctx)
2271 }
Stephen Craneba090d12017-05-09 15:44:35 -07002272 if c.lto != nil {
2273 c.lto.begin(ctx)
2274 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002275 if c.orderfile != nil {
2276 c.orderfile.begin(ctx)
2277 }
Dan Albert92fe7402020-07-15 13:33:30 -07002278 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002279 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002280 if err != nil {
2281 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002282 c.Properties.Sdk_version = nil
2283 } else {
2284 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002285 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002286 }
Colin Crossca860ac2016-01-04 14:34:37 -08002287}
2288
Colin Cross37047f12016-12-13 17:06:13 -08002289func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002290 deps := Deps{}
2291
Joe Onorato37f900c2023-07-18 16:58:16 -07002292 for _, generator := range c.generators {
2293 deps = generator.GeneratorDeps(ctx, deps)
2294 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002295 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002296 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002297 }
2298 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002299 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002300 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002301 if c.stl != nil {
2302 deps = c.stl.deps(ctx, deps)
2303 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002304 if c.coverage != nil {
2305 deps = c.coverage.deps(ctx, deps)
2306 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002307
Colin Crossb6715442017-10-24 11:13:31 -07002308 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2309 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2310 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2311 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2312 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2313 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002314 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002315
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002316 for _, lib := range deps.ReexportSharedLibHeaders {
2317 if !inList(lib, deps.SharedLibs) {
2318 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2319 }
2320 }
2321
2322 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002323 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2324 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 -07002325 }
2326 }
2327
Colin Cross5950f382016-12-13 12:50:57 -08002328 for _, lib := range deps.ReexportHeaderLibHeaders {
2329 if !inList(lib, deps.HeaderLibs) {
2330 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2331 }
2332 }
2333
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002334 for _, gen := range deps.ReexportGeneratedHeaders {
2335 if !inList(gen, deps.GeneratedHeaders) {
2336 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2337 }
2338 }
2339
Colin Crossc99deeb2016-04-11 15:06:20 -07002340 return deps
2341}
2342
Dan Albert7e9d2952016-08-04 13:02:36 -07002343func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002344 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002345 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002346 moduleContextImpl: moduleContextImpl{
2347 mod: c,
2348 },
2349 }
2350 ctx.ctx = ctx
2351
Colin Crossca860ac2016-01-04 14:34:37 -08002352 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002353}
2354
Jiyong Park7ed9de32018-10-15 22:25:07 +09002355// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002356func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002357 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2358 version := name[sharp+1:]
2359 libname := name[:sharp]
2360 return libname, version
2361 }
2362 return name, ""
2363}
2364
Dan Albert92fe7402020-07-15 13:33:30 -07002365func GetCrtVariations(ctx android.BottomUpMutatorContext,
2366 m LinkableInterface) []blueprint.Variation {
2367 if ctx.Os() != android.Android {
2368 return nil
2369 }
2370 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002371 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2372 minSdkVersion := m.MinSdkVersion()
2373 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2374 minSdkVersion = m.SdkVersion()
2375 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002376 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2377 if err != nil {
2378 ctx.PropertyErrorf("min_sdk_version", err.Error())
2379 }
Colin Cross363ec762023-01-13 13:45:14 -08002380
2381 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002382 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002383 if apiLevel.LessThan(minApiForArch) {
2384 apiLevel = minApiForArch
2385 }
2386
Dan Albert92fe7402020-07-15 13:33:30 -07002387 return []blueprint.Variation{
2388 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002389 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002390 }
2391 }
2392 return []blueprint.Variation{
2393 {Mutator: "sdk", Variation: ""},
2394 }
2395}
2396
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002397func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2398 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002399
2400 variations = append([]blueprint.Variation(nil), variations...)
2401
Liz Kammer23942242022-04-08 15:41:00 -04002402 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002403 // Version is explicitly specified. i.e. libFoo#30
2404 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002405 if tag, ok := depTag.(libraryDependencyTag); ok {
2406 tag.explicitlyVersioned = true
2407 } else {
2408 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2409 }
Colin Crosse7257d22020-09-24 09:56:18 -07002410 }
Colin Crosse7257d22020-09-24 09:56:18 -07002411
Colin Cross0de8a1e2020-09-18 14:15:30 -07002412 if far {
2413 ctx.AddFarVariationDependencies(variations, depTag, name)
2414 } else {
2415 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002416 }
2417}
2418
Kiyoung Kim487689e2022-07-26 09:48:22 +09002419func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2420 apiImportInfo := multitree.ApiImportInfo{}
2421
2422 if c.Device() {
2423 var apiImportModule []blueprint.Module
2424 if actx.OtherModuleExists("api_imports") {
2425 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2426 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002427 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002428 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002429 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002430 }
2431 }
2432 }
2433
2434 return apiImportInfo
2435}
2436
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002437func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002438 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002439 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002440 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002441 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2442 // between the modules in the snapshot and the snapshot itself.
2443 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002444 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002445 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002446 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002447 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2448 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002449 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002450 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002451 *snapshotInfo = &snapshot
2452 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002453 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002454 }
2455 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002456 if *snapshotInfo == nil {
2457 *snapshotInfo = &SnapshotInfo{}
2458 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002459 return **snapshotInfo
2460}
2461
Kiyoung Kim487689e2022-07-26 09:48:22 +09002462func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2463 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002464 return snapshot
2465 }
2466
2467 return lib
2468}
2469
2470// RewriteLibs takes a list of names of shared libraries and scans it for three types
2471// of names:
2472//
2473// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002474//
2475// For each of these, it adds the name of the prebuilt module (which will be in
2476// prebuilts/ndk) to the list of nonvariant libs.
2477//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002478// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002479//
2480// For each of these, it adds the name of the ndk_library module to the list of
2481// variant libs.
2482//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002483// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002484//
2485// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002486//
2487// The caller can then know to add the variantLibs dependencies differently from the
2488// nonvariantLibs
2489func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2490 variantLibs = []string{}
2491
2492 nonvariantLibs = []string{}
2493 for _, entry := range list {
2494 // strip #version suffix out
2495 name, _ := StubsLibNameAndVersion(entry)
2496 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002497 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002498 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2499 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2500 } else if c.UseVndk() {
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 {
2503 // put name#version back
2504 nonvariantLibs = append(nonvariantLibs, entry)
2505 }
2506 }
2507 return nonvariantLibs, variantLibs
2508}
2509
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002510func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2511 nonVariantLibs := []string{}
2512 variantLibs := []string{}
2513
2514 for _, lib := range libs {
2515 replaceLibName := GetReplaceModuleName(lib, replaceList)
2516 if replaceLibName == lib {
2517 // Do not handle any libs which are not in API imports
2518 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2519 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2520 variantLibs = append(variantLibs, replaceLibName)
2521 } else {
2522 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2523 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002524 }
2525
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002526 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002527}
2528
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002529func (c *Module) shouldUseApiSurface() bool {
2530 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2531 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2532 // LLNDK Variant
2533 return true
2534 }
2535
2536 if c.Properties.IsSdkVariant {
2537 // NDK Variant
2538 return true
2539 }
2540
2541 if c.isImportedApiLibrary() {
2542 // API Library should depend on API headers
2543 return true
2544 }
2545 }
2546
2547 return false
2548}
2549
Colin Cross1e676be2016-10-12 14:38:15 -07002550func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002551 if !c.Enabled() {
2552 return
2553 }
2554
Colin Cross37047f12016-12-13 17:06:13 -08002555 ctx := &depsContext{
2556 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002557 moduleContextImpl: moduleContextImpl{
2558 mod: c,
2559 },
2560 }
2561 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002562
Colin Crossc99deeb2016-04-11 15:06:20 -07002563 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002564 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002565
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002566 apiNdkLibs := []string{}
2567 apiLateNdkLibs := []string{}
2568
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002569 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002570 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2571 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2572 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2573 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2574 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002575 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002576
Yo Chiang219968c2020-09-22 18:45:04 +08002577 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2578
Colin Crosse0edaf92021-01-11 17:31:17 -08002579 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002580
Dan Albert914449f2016-06-17 16:45:24 -07002581 variantNdkLibs := []string{}
2582 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002583 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002584 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2585 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2586 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002587
2588 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002589 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002590 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002591 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002592
Colin Cross32ec36c2016-12-15 07:39:51 -08002593 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002594 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002595 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002596 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002597 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002598
Kiyoung Kim51279d32022-08-24 14:10:46 +09002599 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002600 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002601 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2602 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002603 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002604
Spandan Das73bcafc2022-08-18 23:26:00 +00002605 if c.isNDKStubLibrary() {
2606 // ndk_headers do not have any variations
2607 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002608 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002609 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002610 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002611 } else {
2612 actx.AddVariationDependencies(nil, depTag, lib)
2613 }
2614 }
2615
Dan Albertf1d14c72020-07-30 14:32:55 -07002616 if c.isNDKStubLibrary() {
2617 // NDK stubs depend on their implementation because the ABI dumps are
2618 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002619
Spandan Das8b08aea2023-03-14 19:29:34 +00002620 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2621 c.ImageVariation(),
2622 blueprint.Variation{Mutator: "link", Variation: "shared"},
2623 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002624 }
2625
Jiyong Park5d1598f2019-02-25 22:14:17 +09002626 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002627 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002628
Kiyoung Kim487689e2022-07-26 09:48:22 +09002629 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002630
Jiyong Park5d1598f2019-02-25 22:14:17 +09002631 actx.AddVariationDependencies([]blueprint.Variation{
2632 {Mutator: "link", Variation: "static"},
2633 }, depTag, lib)
2634 }
2635
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002636 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002637 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002638 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002639 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002640 }
Jiyong Parke3867542020-12-03 17:28:25 +09002641 if inList(lib, deps.ExcludeLibsForApex) {
2642 depTag.excludeInApex = true
2643 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002644
Kiyoung Kim487689e2022-07-26 09:48:22 +09002645 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002646
Dan Willemsen59339a22018-07-22 21:18:45 -07002647 actx.AddVariationDependencies([]blueprint.Variation{
2648 {Mutator: "link", Variation: "static"},
2649 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002650 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002651
Jooyung Han75568392020-03-20 04:29:24 +09002652 // staticUnwinderDep is treated as staticDep for Q apexes
2653 // so that native libraries/binaries are linked with static unwinder
2654 // because Q libc doesn't have unwinder APIs
2655 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002656 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002657 actx.AddVariationDependencies([]blueprint.Variation{
2658 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002659 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002660 }
2661
Jiyong Park7ed9de32018-10-15 22:25:07 +09002662 // shared lib names without the #version suffix
2663 var sharedLibNames []string
2664
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002665 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002666 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002667 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002668 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002669 }
Jiyong Parke3867542020-12-03 17:28:25 +09002670 if inList(lib, deps.ExcludeLibsForApex) {
2671 depTag.excludeInApex = true
2672 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002673 if inList(lib, deps.ExcludeLibsForNonApex) {
2674 depTag.excludeInNonApex = true
2675 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002676
Jiyong Park73c54ee2019-10-22 20:31:18 +09002677 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002678 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2679 name = apiLibraryName
2680 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002681 sharedLibNames = append(sharedLibNames, name)
2682
Colin Crosse7257d22020-09-24 09:56:18 -07002683 variations := []blueprint.Variation{
2684 {Mutator: "link", Variation: "shared"},
2685 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002686
2687 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2688 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2689 }
2690
2691 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2692 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2693 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002694 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002695
Colin Crossfe9acfe2021-06-14 16:13:03 -07002696 for _, lib := range deps.LateStaticLibs {
2697 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2698 actx.AddVariationDependencies([]blueprint.Variation{
2699 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002700 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002701 }
2702
Colin Cross3e5e7782022-06-17 22:17:05 +00002703 for _, lib := range deps.UnexportedStaticLibs {
2704 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2705 actx.AddVariationDependencies([]blueprint.Variation{
2706 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002707 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002708 }
2709
Jiyong Park7ed9de32018-10-15 22:25:07 +09002710 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002711 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002712 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2713 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2714 // linking against both the stubs lib and the non-stubs lib at the same time.
2715 continue
2716 }
Colin Cross6e511a92020-07-27 21:26:48 -07002717 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002718 variations := []blueprint.Variation{
2719 {Mutator: "link", Variation: "shared"},
2720 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002721 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002722 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002723
Dan Willemsen59339a22018-07-22 21:18:45 -07002724 actx.AddVariationDependencies([]blueprint.Variation{
2725 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002726 }, dataLibDepTag, deps.DataLibs...)
2727
Colin Crossc8caa062021-09-24 16:50:14 -07002728 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2729
Chris Parsons79d66a52020-06-05 17:26:16 -04002730 actx.AddVariationDependencies([]blueprint.Variation{
2731 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002732 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002733
Colin Cross68861832016-07-08 10:41:41 -07002734 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002735
2736 for _, gen := range deps.GeneratedHeaders {
2737 depTag := genHeaderDepTag
2738 if inList(gen, deps.ReexportGeneratedHeaders) {
2739 depTag = genHeaderExportDepTag
2740 }
2741 actx.AddDependency(c, depTag, gen)
2742 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002743
Dan Albert92fe7402020-07-15 13:33:30 -07002744 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002745 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002746 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002747 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002748 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002749 }
Colin Crossc465efd2021-06-11 18:00:04 -07002750 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002751 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002752 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002753 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002754 if deps.DynamicLinker != "" {
2755 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002756 }
Dan Albert914449f2016-06-17 16:45:24 -07002757
2758 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002759
2760 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002761 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002762 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002763 {Mutator: "link", Variation: "shared"},
2764 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002765 actx.AddVariationDependencies([]blueprint.Variation{
2766 {Mutator: "version", Variation: version},
2767 {Mutator: "link", Variation: "shared"},
2768 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002769
2770 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002771 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002772 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002773 {Mutator: "link", Variation: "shared"},
2774 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002775 actx.AddVariationDependencies([]blueprint.Variation{
2776 {Mutator: "version", Variation: version},
2777 {Mutator: "link", Variation: "shared"},
2778 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002779
2780 if vndkdep := c.vndkdep; vndkdep != nil {
2781 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002782 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002783 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002784 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002785 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002786 }
2787 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002788
Vinh Tran367d89d2023-04-28 11:21:25 -04002789 if len(deps.AidlLibs) > 0 {
2790 actx.AddDependency(
2791 c,
2792 aidlLibraryTag,
2793 deps.AidlLibs...,
2794 )
2795 }
2796
Kiyoung Kimee58c932022-10-25 22:59:41 +09002797 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002798}
Colin Cross21b9a242015-03-24 14:15:58 -07002799
Colin Crosse40b4ea2018-10-02 22:25:58 -07002800func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002801 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2802 c.beginMutator(ctx)
2803 }
2804}
2805
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002806// Whether a module can link to another module, taking into
2807// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002808func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002809 tag blueprint.DependencyTag) {
2810
2811 switch t := tag.(type) {
2812 case dependencyTag:
2813 if t != vndkExtDepTag {
2814 return
2815 }
2816 case libraryDependencyTag:
2817 default:
2818 return
2819 }
2820
Ivan Lozanof9e21722020-12-02 09:00:51 -05002821 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002822 // Host code is not restricted
2823 return
2824 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002825
2826 // VNDK is cc.Module supported only for now.
2827 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002828 // Though allowed dependency is limited by the image mutator,
2829 // each vendor and product module needs to check link-type
2830 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002831 if ccTo, ok := to.(*Module); ok {
2832 if ccFrom.vndkdep != nil {
2833 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2834 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002835 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002836 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002837 }
2838 return
2839 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002840 // TODO(b/244244438) : Remove this once all variants are implemented
2841 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2842 return
2843 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002844 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002845 // Platform code can link to anything
2846 return
2847 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002848 if from.InRamdisk() {
2849 // Ramdisk code is not NDK
2850 return
2851 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002852 if from.InVendorRamdisk() {
2853 // Vendor ramdisk code is not NDK
2854 return
2855 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002856 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002857 // Recovery code is not NDK
2858 return
2859 }
Colin Cross31076b32020-10-23 17:22:06 -07002860 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002861 if c.NdkPrebuiltStl() {
2862 // These are allowed, but they don't set sdk_version
2863 return
2864 }
2865 if c.StubDecorator() {
2866 // These aren't real libraries, but are the stub shared libraries that are included in
2867 // the NDK.
2868 return
2869 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002870 if c.isImportedApiLibrary() {
2871 // Imported library from the API surface is a stub library built against interface definition.
2872 return
2873 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002874 }
Logan Chien834b9a62019-01-14 15:39:03 +08002875
Ivan Lozano52767be2019-10-18 14:49:46 -07002876 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002877 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2878 // to link to libc++ (non-NDK and without sdk_version).
2879 return
2880 }
2881
Ivan Lozano52767be2019-10-18 14:49:46 -07002882 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002883 // NDK code linking to platform code is never okay.
2884 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002885 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002886 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002887 }
2888
2889 // At this point we know we have two NDK libraries, but we need to
2890 // check that we're not linking against anything built against a higher
2891 // API level, as it is only valid to link against older or equivalent
2892 // APIs.
2893
Inseob Kim01a28722018-04-11 09:48:45 +09002894 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002895 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002896 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002897 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002898 // Current can't be linked against by anything else.
2899 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002900 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002901 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002902 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002903 if err != nil {
2904 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002905 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002906 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002907 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002908 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002909 if err != nil {
2910 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002911 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002912 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002913 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002914
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002915 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002916 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002917 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002918 }
2919 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002920 }
Dan Albert202fe492017-12-15 13:56:59 -08002921
2922 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002923 fromStl := from.SelectedStl()
2924 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002925 if fromStl == "" || toStl == "" {
2926 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002927 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002928 // We can be permissive with the system "STL" since it is only the C++
2929 // ABI layer, but in the future we should make sure that everyone is
2930 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002931 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002932 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002933 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2934 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002935 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002936}
2937
Jooyung Han479ca172020-10-19 18:51:07 +09002938func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2939 if c, ok := ctx.Module().(*Module); ok {
2940 ctx.VisitDirectDeps(func(dep android.Module) {
2941 depTag := ctx.OtherModuleDependencyTag(dep)
2942 ccDep, ok := dep.(LinkableInterface)
2943 if ok {
2944 checkLinkType(ctx, c, ccDep, depTag)
2945 }
2946 })
2947 }
2948}
2949
Jiyong Park5fb8c102018-04-09 12:03:06 +09002950// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002951// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2952// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002953// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002954func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2955 check := func(child, parent android.Module) bool {
2956 to, ok := child.(*Module)
2957 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002958 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002959 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002960
Jooyung Hana70f0672019-01-18 15:20:43 +09002961 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2962 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002963 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002964
Jiyong Park0474e1f2021-01-14 14:26:06 +09002965 // These dependencies are not excercised at runtime. Tracking these will give us
2966 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002967 depTag := ctx.OtherModuleDependencyTag(child)
2968 if IsHeaderDepTag(depTag) {
2969 return false
2970 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002971 if depTag == staticVariantTag {
2972 return false
2973 }
2974 if depTag == stubImplDepTag {
2975 return false
2976 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002977
Justin Yun63e9ec72020-10-29 16:49:43 +09002978 // Even if target lib has no vendor variant, keep checking dependency
2979 // graph in case it depends on vendor_available or product_available
2980 // but not double_loadable transtively.
2981 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002982 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002983 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002984
Jiyong Park0474e1f2021-01-14 14:26:06 +09002985 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2986 // one.
2987 if Bool(to.VendorProperties.Double_loadable) {
2988 return true
2989 }
2990
Ivan Lozanod7586b62021-04-01 09:49:36 -04002991 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002992 return false
2993 }
2994
Jooyung Hana70f0672019-01-18 15:20:43 +09002995 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2996 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002997 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002998 return false
2999 }
3000 if module, ok := ctx.Module().(*Module); ok {
3001 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003002 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003003 ctx.WalkDeps(check)
3004 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003005 }
3006 }
3007}
3008
Yu Liue4312402023-01-18 09:15:31 -08003009func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3010 // For the dependency from platform to apex, use the latest stubs
3011 apexSdkVersion := android.FutureApiLevel
3012 if !apexInfo.IsForPlatform() {
3013 apexSdkVersion = apexInfo.MinSdkVersion
3014 }
3015
3016 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3017 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3018 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3019 // (b/144430859)
3020 apexSdkVersion = android.FutureApiLevel
3021 }
3022
3023 return apexSdkVersion
3024}
3025
Colin Crossc99deeb2016-04-11 15:06:20 -07003026// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003027func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003028 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003029
Colin Cross0de8a1e2020-09-18 14:15:30 -07003030 var directStaticDeps []StaticLibraryInfo
3031 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003032
Colin Cross0de8a1e2020-09-18 14:15:30 -07003033 reexportExporter := func(exporter FlagExporterInfo) {
3034 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3035 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3036 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3037 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3038 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003039 }
3040
Colin Crossff694a82023-12-13 15:54:49 -08003041 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003042 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003043
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003044 skipModuleList := map[string]bool{}
3045
3046 var apiImportInfo multitree.ApiImportInfo
3047 hasApiImportInfo := false
3048
3049 ctx.VisitDirectDeps(func(dep android.Module) {
3050 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003051 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003052 hasApiImportInfo = true
3053 }
3054 })
3055
3056 if hasApiImportInfo {
3057 targetStubModuleList := map[string]string{}
3058 targetOrigModuleList := map[string]string{}
3059
3060 // Search for dependency which both original module and API imported library with APEX stub exists
3061 ctx.VisitDirectDeps(func(dep android.Module) {
3062 depName := ctx.OtherModuleName(dep)
3063 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3064 targetStubModuleList[apiLibrary] = depName
3065 }
3066 })
3067 ctx.VisitDirectDeps(func(dep android.Module) {
3068 depName := ctx.OtherModuleName(dep)
3069 if origLibrary, ok := targetStubModuleList[depName]; ok {
3070 targetOrigModuleList[origLibrary] = depName
3071 }
3072 })
3073
3074 // Decide which library should be used between original and API imported library
3075 ctx.VisitDirectDeps(func(dep android.Module) {
3076 depName := ctx.OtherModuleName(dep)
3077 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003078 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003079 skipModuleList[depName] = true
3080 } else {
3081 skipModuleList[apiLibrary] = true
3082 }
3083 }
3084 })
3085 }
3086
Colin Crossd11fcda2017-10-23 17:59:01 -07003087 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003088 depName := ctx.OtherModuleName(dep)
3089 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003090
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003091 if _, ok := skipModuleList[depName]; ok {
3092 // skip this module because original module or API imported module matching with this should be used instead.
3093 return
3094 }
3095
Dan Willemsen47450072021-10-19 20:24:49 -07003096 if depTag == android.DarwinUniversalVariantTag {
3097 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3098 return
3099 }
3100
Vinh Tran367d89d2023-04-28 11:21:25 -04003101 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003102 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003103 depPaths.AidlLibraryInfos = append(
3104 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003105 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003106 )
3107 }
3108 }
3109
Ivan Lozano52767be2019-10-18 14:49:46 -07003110 ccDep, ok := dep.(LinkableInterface)
3111 if !ok {
3112
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003113 // handling for a few module types that aren't cc Module but that are also supported
3114 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003115 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003116 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003117 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3118 genRule.GeneratedSourceFiles()...)
3119 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003120 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003121 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003122 // Support exported headers from a generated_sources dependency
3123 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003124 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003125 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003126 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003127 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003128 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003129 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003130 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003131 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003132 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3133 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003134 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003135 // 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 +09003136 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003137
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003138 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003139 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003140 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003141 }
Colin Crosscef792e2021-06-11 18:01:26 -07003142 case CrtBeginDepTag:
3143 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3144 case CrtEndDepTag:
3145 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003146 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003147 return
3148 }
3149
Colin Crossfe17f6f2019-03-28 19:30:56 -07003150 if depTag == android.ProtoPluginDepTag {
3151 return
3152 }
3153
Colin Crossd11fcda2017-10-23 17:59:01 -07003154 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003155 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3156 return
3157 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003158 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003159 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3160 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003161 return
3162 }
3163
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003164 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003165 // Skip reused objects for stub libraries, they use their own stub object file instead.
3166 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3167 // version mutator, so the stubs variant is created from the shared variant that
3168 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003169 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003170 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003171 objs := staticAnalogue.ReuseObjects
3172 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003173 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003174 reexportExporter(depExporterInfo)
3175 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003176 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003177 }
3178
Colin Cross6e511a92020-07-27 21:26:48 -07003179 linkFile := ccDep.OutputFile()
3180
3181 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3182 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003183 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003184 return
3185 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003186
Jiyong Parke3867542020-12-03 17:28:25 +09003187 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3188 return
3189 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003190 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3191 return
3192 }
Jiyong Parke3867542020-12-03 17:28:25 +09003193
Colin Cross313aa542023-12-13 13:47:44 -08003194 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003195
Colin Cross6e511a92020-07-27 21:26:48 -07003196 var ptr *android.Paths
3197 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003198
Colin Cross6e511a92020-07-27 21:26:48 -07003199 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003200
Colin Cross6e511a92020-07-27 21:26:48 -07003201 switch {
3202 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003203 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003204 if !ctx.Config().AllowMissingDependencies() {
3205 ctx.ModuleErrorf("module %q is not a header library", depName)
3206 } else {
3207 ctx.AddMissingDependencies([]string{depName})
3208 }
3209 return
3210 }
Colin Cross6e511a92020-07-27 21:26:48 -07003211 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003212 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003213 if !ctx.Config().AllowMissingDependencies() {
3214 ctx.ModuleErrorf("module %q is not a shared library", depName)
3215 } else {
3216 ctx.AddMissingDependencies([]string{depName})
3217 }
3218 return
3219 }
Jiyong Parke3867542020-12-03 17:28:25 +09003220
Jiyong Park7d55b612021-06-11 17:22:09 +09003221 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3222 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003223
Jiyong Park1ad8e162020-12-01 23:40:09 +09003224 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3225 // linkFile, depFile, and ptr.
3226 if c.IsStubs() {
3227 break
3228 }
3229
Colin Cross0de8a1e2020-09-18 14:15:30 -07003230 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3231 depFile = sharedLibraryInfo.TableOfContents
3232
Colin Cross6e511a92020-07-27 21:26:48 -07003233 ptr = &depPaths.SharedLibs
3234 switch libDepTag.Order {
3235 case earlyLibraryDependency:
3236 ptr = &depPaths.EarlySharedLibs
3237 depPtr = &depPaths.EarlySharedLibsDeps
3238 case normalLibraryDependency:
3239 ptr = &depPaths.SharedLibs
3240 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003241 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003242 case lateLibraryDependency:
3243 ptr = &depPaths.LateSharedLibs
3244 depPtr = &depPaths.LateSharedLibsDeps
3245 default:
3246 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003247 }
Colin Cross6e511a92020-07-27 21:26:48 -07003248 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003249 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3250 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003251 if !ctx.Config().AllowMissingDependencies() {
3252 ctx.ModuleErrorf("module %q is not a static library", depName)
3253 } else {
3254 ctx.AddMissingDependencies([]string{depName})
3255 }
3256 return
3257 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003258
3259 // Stubs lib doesn't link to the static lib dependencies. Don't set
3260 // linkFile, depFile, and ptr.
3261 if c.IsStubs() {
3262 break
3263 }
3264
Colin Cross0de8a1e2020-09-18 14:15:30 -07003265 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003266 if libDepTag.wholeStatic {
3267 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003268 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3269 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003270 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003271 // This case normally catches prebuilt static
3272 // libraries, but it can also occur when
3273 // AllowMissingDependencies is on and the
3274 // dependencies has no sources of its own
3275 // but has a whole_static_libs dependency
3276 // on a missing library. We want to depend
3277 // on the .a file so that there is something
3278 // in the dependency tree that contains the
3279 // error rule for the missing transitive
3280 // dependency.
3281 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003282 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003283 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3284 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003285 } else {
3286 switch libDepTag.Order {
3287 case earlyLibraryDependency:
3288 panic(fmt.Errorf("early static libs not suppported"))
3289 case normalLibraryDependency:
3290 // static dependencies will be handled separately so they can be ordered
3291 // using transitive dependencies.
3292 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003293 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003294 case lateLibraryDependency:
3295 ptr = &depPaths.LateStaticLibs
3296 default:
3297 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003298 }
3299 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003300 if libDepTag.unexportedSymbols {
3301 depPaths.LdFlags = append(depPaths.LdFlags,
3302 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3303 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003304 }
3305
Colin Cross6e511a92020-07-27 21:26:48 -07003306 if libDepTag.static() && !libDepTag.wholeStatic {
3307 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3308 ctx.ModuleErrorf("module %q not a static library", depName)
3309 return
3310 }
Logan Chien43d34c32017-12-20 01:17:32 +08003311
Colin Cross6e511a92020-07-27 21:26:48 -07003312 // When combining coverage files for shared libraries and executables, coverage files
3313 // in static libraries act as if they were whole static libraries. The same goes for
3314 // source based Abi dump files.
3315 if c, ok := ccDep.(*Module); ok {
3316 staticLib := c.linker.(libraryInterface)
3317 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3318 staticLib.objs().coverageFiles...)
3319 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3320 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003321 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003322 // Handle non-CC modules here
3323 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003324 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003325 }
3326 }
3327
Colin Cross6e511a92020-07-27 21:26:48 -07003328 if ptr != nil {
3329 if !linkFile.Valid() {
3330 if !ctx.Config().AllowMissingDependencies() {
3331 ctx.ModuleErrorf("module %q missing output file", depName)
3332 } else {
3333 ctx.AddMissingDependencies([]string{depName})
3334 }
3335 return
3336 }
3337 *ptr = append(*ptr, linkFile.Path())
3338 }
3339
3340 if depPtr != nil {
3341 dep := depFile
3342 if !dep.Valid() {
3343 dep = linkFile
3344 }
3345 *depPtr = append(*depPtr, dep.Path())
3346 }
3347
Colin Cross0de8a1e2020-09-18 14:15:30 -07003348 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3349 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3350 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3351 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3352
3353 if libDepTag.reexportFlags {
3354 reexportExporter(depExporterInfo)
3355 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3356 // Re-exported shared library headers must be included as well since they can help us with type information
3357 // about template instantiations (instantiated from their headers).
3358 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3359 // scripts.
3360 c.sabi.Properties.ReexportedIncludes = append(
3361 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3362 }
3363
Spandan Das3faa7922024-02-26 19:42:32 +00003364 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003365 switch {
3366 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003367 c.Properties.AndroidMkHeaderLibs = append(
3368 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003369 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003370 if lib := moduleLibraryInterface(dep); lib != nil {
3371 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003372 // Add the dependency to the APEX(es) providing the library so that
3373 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003374 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003375 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003376 c.Properties.ApexesProvidingSharedLibs = append(
3377 c.Properties.ApexesProvidingSharedLibs, an)
3378 }
3379 }
3380 }
3381
3382 // Note: the order of libs in this list is not important because
3383 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003384 c.Properties.AndroidMkSharedLibs = append(
3385 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003386 // Record BaseLibName for snapshots.
3387 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003388 case libDepTag.static():
3389 if libDepTag.wholeStatic {
3390 c.Properties.AndroidMkWholeStaticLibs = append(
3391 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3392 } else {
3393 c.Properties.AndroidMkStaticLibs = append(
3394 c.Properties.AndroidMkStaticLibs, makeLibName)
3395 }
Justin Yun5e035862021-06-29 20:50:37 +09003396 // Record BaseLibName for snapshots.
3397 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003398 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003399 } else if !c.IsStubs() {
3400 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3401
Colin Cross6e511a92020-07-27 21:26:48 -07003402 switch depTag {
3403 case runtimeDepTag:
3404 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003405 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003406 // Record BaseLibName for snapshots.
3407 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003408 case objDepTag:
3409 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3410 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003411 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003412 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003413 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003414 case dynamicLinkerDepTag:
3415 depPaths.DynamicLinker = linkFile
3416 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003417 }
Colin Crossca860ac2016-01-04 14:34:37 -08003418 })
3419
Jeff Gaston294356f2017-09-27 17:05:30 -07003420 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003421 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3422 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3423 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003424
Colin Crossdd84e052017-05-17 13:44:16 -07003425 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003426 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003427 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3428 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003429 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003430 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3431 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003432 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003433 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003434 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003435
3436 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003437 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003438 }
Colin Crossdd84e052017-05-17 13:44:16 -07003439
Colin Crossca860ac2016-01-04 14:34:37 -08003440 return depPaths
3441}
3442
Spandan Das604f3762023-03-16 22:51:40 +00003443func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003444 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003445 thisModule, ok := ctx.Module().(android.ApexModule)
3446 if !ok {
3447 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3448 }
3449
Kiyoung Kimaa394802024-01-08 12:55:45 +09003450 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003451 bootstrap := false
3452 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3453 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3454 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003455 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003456 bootstrap = linkable.Bootstrap()
3457 }
3458
Colin Crossff694a82023-12-13 15:54:49 -08003459 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003460
3461 useStubs := false
3462
Kiyoung Kimaa394802024-01-08 12:55:45 +09003463 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003464 if !apexInfo.IsForPlatform() {
3465 // For platform libraries, use current version of LLNDK
3466 // If this is for use_vendor apex we will apply the same rules
3467 // of apex sdk enforcement below to choose right version.
3468 useStubs = true
3469 }
3470 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3471 // If not building for APEX or the containing APEX allows the use of
3472 // platform APIs, use stubs only when it is from an APEX (and not from
3473 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3474 // bootstrap modules, always link to non-stub variant
3475 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3476
3477 isApexImportedApiLibrary := false
3478
3479 if cc, ok := dep.(*Module); ok {
3480 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3481 if apiLibrary.hasApexStubs() {
3482 isApexImportedApiLibrary = true
3483 }
3484 }
3485 }
3486
3487 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3488
3489 if useStubs {
3490 // Another exception: if this module is a test for an APEX, then
3491 // it is linked with the non-stub variant of a module in the APEX
3492 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003493 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003494 for _, apexContents := range testFor.ApexContents {
3495 if apexContents.DirectlyInApex(depName) {
3496 useStubs = false
3497 break
3498 }
3499 }
3500 }
3501 if useStubs {
3502 // Yet another exception: If this module and the dependency are
3503 // available to the same APEXes then skip stubs between their
3504 // platform variants. This complements the test_for case above,
3505 // which avoids the stubs on a direct APEX library dependency, by
3506 // avoiding stubs for indirect test dependencies as well.
3507 //
3508 // TODO(b/183882457): This doesn't work if the two libraries have
3509 // only partially overlapping apex_available. For that test_for
3510 // modules would need to be split into APEX variants and resolved
3511 // separately for each APEX they have access to.
3512 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3513 useStubs = false
3514 }
3515 }
3516 } else {
3517 // If building for APEX, use stubs when the parent is in any APEX that
3518 // the child is not in.
3519 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3520 }
3521
3522 return useStubs
3523}
3524
3525// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3526// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3527// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3528// has different level of updatability. For example, if a library foo in an APEX depends on a
3529// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3530// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3531// same APEX as foo, the non-stub variant of bar is used.
3532func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3533 depTag := ctx.OtherModuleDependencyTag(dep)
3534 libDepTag, ok := depTag.(libraryDependencyTag)
3535 if !ok || !libDepTag.shared() {
3536 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3537 }
3538
Colin Cross313aa542023-12-13 13:47:44 -08003539 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3540 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3541 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003542
3543 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003544 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003545 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003546 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3547 toUse := stubs[len(stubs)-1]
3548 sharedLibraryInfo = toUse.SharedLibraryInfo
3549 depExporterInfo = toUse.FlagExporterInfo
3550 }
3551 }
3552 return sharedLibraryInfo, depExporterInfo
3553}
3554
Colin Cross0de8a1e2020-09-18 14:15:30 -07003555// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3556// to match the topological order of the dependency tree, including any static analogues of
3557// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3558// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003559func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3560 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003561 var staticPaths android.Paths
3562 for _, staticDep := range staticDeps {
3563 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3564 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3565 }
3566 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003567 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3568 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003569 }
3570 }
3571 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3572
3573 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3574
3575 // reorder the dependencies based on transitive dependencies
3576 staticPaths = android.FirstUniquePaths(staticPaths)
3577 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3578
3579 if len(orderedStaticPaths) != len(staticPaths) {
3580 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3581 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3582 }
3583
3584 return orderedStaticPaths, transitiveStaticLibs
3585}
3586
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003587// BaseLibName trims known prefixes and suffixes
3588func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003589 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3590 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003591 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003592 return libName
3593}
3594
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003595func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003596 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003597 ccDepModule, _ := ccDep.(*Module)
3598 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003599 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003600
Justin Yuncbca3732021-02-03 19:24:13 +09003601 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003602 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003603 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003604 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003605
Ivan Lozanod1dec542021-05-26 15:33:11 -04003606 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003607 }
3608 }
3609
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003610 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3611 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003612 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3613 // core module instead.
3614 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003615 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003616 // The vendor and product modules in Make will have been renamed to not conflict with the
3617 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003618 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003619 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003620 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003621 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003622 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003623 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003624 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003625 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003626 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003627 } else {
3628 return libName
3629 }
3630}
3631
Colin Crossca860ac2016-01-04 14:34:37 -08003632func (c *Module) InstallInData() bool {
3633 if c.installer == nil {
3634 return false
3635 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003636 return c.installer.inData()
3637}
3638
3639func (c *Module) InstallInSanitizerDir() bool {
3640 if c.installer == nil {
3641 return false
3642 }
3643 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003644 return true
3645 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003646 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003647}
3648
Yifan Hong1b3348d2020-01-21 15:53:22 -08003649func (c *Module) InstallInRamdisk() bool {
3650 return c.InRamdisk()
3651}
3652
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003653func (c *Module) InstallInVendorRamdisk() bool {
3654 return c.InVendorRamdisk()
3655}
3656
Jiyong Parkf9332f12018-02-01 00:54:12 +09003657func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003658 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003659}
3660
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003661func (c *Module) MakeUninstallable() {
3662 if c.installer == nil {
3663 c.ModuleBase.MakeUninstallable()
3664 return
3665 }
3666 c.installer.makeUninstallable(c)
3667}
3668
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003669func (c *Module) HostToolPath() android.OptionalPath {
3670 if c.installer == nil {
3671 return android.OptionalPath{}
3672 }
3673 return c.installer.hostToolPath()
3674}
3675
Nan Zhangd4e641b2017-07-12 12:55:28 -07003676func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3677 return c.outputFile
3678}
3679
Colin Cross41955e82019-05-29 14:40:35 -07003680func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3681 switch tag {
3682 case "":
3683 if c.outputFile.Valid() {
3684 return android.Paths{c.outputFile.Path()}, nil
3685 }
3686 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003687 case "unstripped":
3688 if c.linker != nil {
3689 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3690 }
3691 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003692 case "stripped_all":
3693 if c.linker != nil {
3694 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3695 }
3696 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003697 default:
3698 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003699 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003700}
3701
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003702func (c *Module) static() bool {
3703 if static, ok := c.linker.(interface {
3704 static() bool
3705 }); ok {
3706 return static.static()
3707 }
3708 return false
3709}
3710
Jiyong Park379de2f2018-12-19 02:47:14 +09003711func (c *Module) staticBinary() bool {
3712 if static, ok := c.linker.(interface {
3713 staticBinary() bool
3714 }); ok {
3715 return static.staticBinary()
3716 }
3717 return false
3718}
3719
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003720func (c *Module) testBinary() bool {
3721 if test, ok := c.linker.(interface {
3722 testBinary() bool
3723 }); ok {
3724 return test.testBinary()
3725 }
3726 return false
3727}
3728
Jingwen Chen537242c2022-08-24 11:53:27 +00003729func (c *Module) testLibrary() bool {
3730 if test, ok := c.linker.(interface {
3731 testLibrary() bool
3732 }); ok {
3733 return test.testLibrary()
3734 }
3735 return false
3736}
3737
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003738func (c *Module) benchmarkBinary() bool {
3739 if b, ok := c.linker.(interface {
3740 benchmarkBinary() bool
3741 }); ok {
3742 return b.benchmarkBinary()
3743 }
3744 return false
3745}
3746
3747func (c *Module) fuzzBinary() bool {
3748 if f, ok := c.linker.(interface {
3749 fuzzBinary() bool
3750 }); ok {
3751 return f.fuzzBinary()
3752 }
3753 return false
3754}
3755
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003756// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3757func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003758 if h, ok := c.linker.(interface {
3759 header() bool
3760 }); ok {
3761 return h.header()
3762 }
3763 return false
3764}
3765
Ivan Lozanod7586b62021-04-01 09:49:36 -04003766func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003767 if b, ok := c.linker.(interface {
3768 binary() bool
3769 }); ok {
3770 return b.binary()
3771 }
3772 return false
3773}
3774
Justin Yun5e035862021-06-29 20:50:37 +09003775func (c *Module) StaticExecutable() bool {
3776 if b, ok := c.linker.(*binaryDecorator); ok {
3777 return b.static()
3778 }
3779 return false
3780}
3781
Ivan Lozanod7586b62021-04-01 09:49:36 -04003782func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003783 if o, ok := c.linker.(interface {
3784 object() bool
3785 }); ok {
3786 return o.object()
3787 }
3788 return false
3789}
3790
Ivan Lozanof9e21722020-12-02 09:00:51 -05003791func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003792 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003793 if c.IsLlndk() {
3794 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003795 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003796 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003797 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003798 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003799 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003800 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003801 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003802 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003803 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003804 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003805 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003806 return "native:product"
3807 }
Jooyung Han38002912019-05-16 04:01:54 +09003808 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003809 } else if c.InRamdisk() {
3810 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003811 } else if c.InVendorRamdisk() {
3812 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003813 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003814 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003815 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003816 return "native:ndk:none:none"
3817 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3818 //family, link := getNdkStlFamilyAndLinkType(c)
3819 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003820 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003821 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003822 } else {
3823 return "native:platform"
3824 }
3825}
3826
Jiyong Park9d452992018-10-03 00:38:19 +09003827// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003828// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003829func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003830 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003831 // Stub libs and prebuilt libs in a versioned SDK are not
3832 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003833 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003834 } else if _, ok := c.linker.(testPerSrc); ok {
3835 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003836 }
3837 return false
3838}
3839
Jiyong Parka90ca002019-10-07 15:47:24 +09003840func (c *Module) AvailableFor(what string) bool {
3841 if linker, ok := c.linker.(interface {
3842 availableFor(string) bool
3843 }); ok {
3844 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3845 } else {
3846 return c.ApexModuleBase.AvailableFor(what)
3847 }
3848}
3849
Jiyong Park62304bb2020-04-13 16:19:48 +09003850func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003851 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003852}
3853
Paul Duffin0cb37b92020-03-04 14:52:46 +00003854func (c *Module) EverInstallable() bool {
3855 return c.installer != nil &&
3856 // Check to see whether the module is actually ever installable.
3857 c.installer.everInstallable()
3858}
3859
Ivan Lozanod7586b62021-04-01 09:49:36 -04003860func (c *Module) PreventInstall() bool {
3861 return c.Properties.PreventInstall
3862}
3863
3864func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003865 if c.library != nil {
3866 if i := c.library.installable(); i != nil {
3867 return i
3868 }
3869 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003870 return c.Properties.Installable
3871}
3872
3873func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003874 ret := c.EverInstallable() &&
3875 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003876 proptools.BoolDefault(c.Installable(), true) &&
3877 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003878
3879 // The platform variant doesn't need further condition. Apex variants however might not
3880 // be installable because it will likely to be included in the APEX and won't appear
3881 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003882 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003883 return ret
3884 }
3885
3886 // Special case for modules that are configured to be installed to /data, which includes
3887 // test modules. For these modules, both APEX and non-APEX variants are considered as
3888 // installable. This is because even the APEX variants won't be included in the APEX, but
3889 // will anyway be installed to /data/*.
3890 // See b/146995717
3891 if c.InstallInData() {
3892 return ret
3893 }
3894
3895 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003896}
3897
Logan Chien41eabe62019-04-10 13:33:58 +08003898func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3899 if c.linker != nil {
3900 if library, ok := c.linker.(*libraryDecorator); ok {
3901 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3902 }
3903 }
3904}
3905
Jiyong Park45bf82e2020-12-15 22:29:02 +09003906var _ android.ApexModule = (*Module)(nil)
3907
3908// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003909func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003910 depTag := ctx.OtherModuleDependencyTag(dep)
3911 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3912
3913 if cc, ok := dep.(*Module); ok {
3914 if cc.HasStubsVariants() {
3915 if isLibDepTag && libDepTag.shared() {
3916 // dynamic dep to a stubs lib crosses APEX boundary
3917 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003918 }
Colin Cross6e511a92020-07-27 21:26:48 -07003919 if IsRuntimeDepTag(depTag) {
3920 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003921 return false
3922 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003923 }
Zhijun Heec285872021-04-24 10:47:08 -07003924 if cc.IsLlndk() {
3925 return false
3926 }
Colin Crossaac32222020-07-29 12:51:56 -07003927 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003928 // shared_lib dependency from a static lib is considered as crossing
3929 // the APEX boundary because the dependency doesn't actually is
3930 // linked; the dependency is used only during the compilation phase.
3931 return false
3932 }
Jiyong Parke3867542020-12-03 17:28:25 +09003933
3934 if isLibDepTag && libDepTag.excludeInApex {
3935 return false
3936 }
Colin Cross6e511a92020-07-27 21:26:48 -07003937 }
Colin Crossc1b36442021-05-06 13:42:48 -07003938 if depTag == stubImplDepTag {
3939 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003940 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003941 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003942 if depTag == staticVariantTag {
3943 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3944 // actually mean that the static lib (and its dependencies) are copied into the
3945 // APEX.
3946 return false
3947 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003948 return true
3949}
3950
Jiyong Park45bf82e2020-12-15 22:29:02 +09003951// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003952func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3953 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003954 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3955 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3956 return nil
3957 }
Jooyung Han749dc692020-04-15 11:03:39 +09003958 // We don't check for prebuilt modules
3959 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3960 return nil
3961 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003962
Jooyung Han749dc692020-04-15 11:03:39 +09003963 minSdkVersion := c.MinSdkVersion()
3964 if minSdkVersion == "apex_inherit" {
3965 return nil
3966 }
3967 if minSdkVersion == "" {
3968 // JNI libs within APK-in-APEX fall into here
3969 // Those are okay to set sdk_version instead
3970 // We don't have to check if this is a SDK variant because
3971 // non-SDK variant resets sdk_version, which works too.
3972 minSdkVersion = c.SdkVersion()
3973 }
Dan Albertc8060532020-07-22 22:32:17 -07003974 if minSdkVersion == "" {
3975 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3976 }
3977 // Not using nativeApiLevelFromUser because the context here is not
3978 // necessarily a native context.
3979 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003980 if err != nil {
3981 return err
3982 }
Dan Albertc8060532020-07-22 22:32:17 -07003983
Colin Cross8ca61c12022-10-06 21:00:14 -07003984 // A dependency only needs to support a min_sdk_version at least
3985 // as high as the api level that the architecture was introduced in.
3986 // This allows introducing new architectures in the platform that
3987 // need to be included in apexes that normally require an older
3988 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003989 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003990 if sdkVersion.LessThan(minApiForArch) {
3991 sdkVersion = minApiForArch
3992 }
3993
Dan Albertc8060532020-07-22 22:32:17 -07003994 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003995 return fmt.Errorf("newer SDK(%v)", ver)
3996 }
3997 return nil
3998}
3999
Paul Duffinb5769c12021-05-12 16:16:51 +01004000// Implements android.ApexModule
4001func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4002 // stub libraries and native bridge libraries are always available to platform
4003 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4004}
4005
Jooyung Han91f92032022-02-04 12:36:33 +09004006// Overrides android.ApexModuleBase.UniqueApexVariations
4007func (c *Module) UniqueApexVariations() bool {
4008 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4009 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4010 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004011 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004012 return c.UseVndk() && c.IsVndk()
4013}
4014
Inseob Kima1888ce2022-10-04 14:42:02 +09004015func (c *Module) overriddenModules() []string {
4016 if o, ok := c.linker.(overridable); ok {
4017 return o.overriddenModules()
4018 }
4019 return nil
4020}
4021
Rob Seymour925aa092021-08-10 20:42:03 +00004022var _ snapshot.RelativeInstallPath = (*Module)(nil)
4023
Liz Kammer35ca77e2021-12-22 15:31:40 -05004024type moduleType int
4025
4026const (
4027 unknownType moduleType = iota
4028 binary
4029 object
4030 fullLibrary
4031 staticLibrary
4032 sharedLibrary
4033 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004034 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004035 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004036 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004037)
4038
4039func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004040 if c.testBinary() {
4041 // testBinary is also a binary, so this comes before the c.Binary()
4042 // conditional. A testBinary has additional implicit dependencies and
4043 // other test-only semantics.
4044 return testBin
4045 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004046 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004047 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004048 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004049 } else if c.testLibrary() {
4050 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4051 // will let them add implicit compile deps on gtest, for example.
4052 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004053 // For now, treat them as regular libraries.
4054 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004055 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004056 static := false
4057 shared := false
4058 if library, ok := c.linker.(*libraryDecorator); ok {
4059 static = library.MutatedProperties.BuildStatic
4060 shared = library.MutatedProperties.BuildShared
4061 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4062 static = library.MutatedProperties.BuildStatic
4063 shared = library.MutatedProperties.BuildShared
4064 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004065 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004066 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004067 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004068 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004069 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004070 return staticLibrary
4071 }
4072 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004073 } else if c.isNDKStubLibrary() {
4074 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004075 } else if c.IsNdkPrebuiltStl() {
4076 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004077 }
4078 return unknownType
4079}
4080
Colin Crosscfad1192015-11-02 16:43:11 -08004081// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004082type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004083 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004084 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004085 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004086
4087 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4088 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004089}
4090
Patrice Arrudac249c712019-03-19 17:00:29 -07004091// cc_defaults provides a set of properties that can be inherited by other cc
4092// modules. A module can use the properties from a cc_defaults using
4093// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4094// merged (when possible) by prepending the default module's values to the
4095// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004096func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004097 return DefaultsFactory()
4098}
4099
Colin Cross36242852017-06-23 15:06:31 -07004100func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004101 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004102
Colin Cross36242852017-06-23 15:06:31 -07004103 module.AddProperties(props...)
4104 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004105 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004106 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004107 &BaseCompilerProperties{},
4108 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004109 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004110 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004111 &StaticProperties{},
4112 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004113 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004114 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004115 &TestLinkerProperties{},
4116 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004117 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004118 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004119 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004120 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004121 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004122 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004123 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004124 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004125 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004126 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004127 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004128 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004129 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004130 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004131 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004132 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4133 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004134 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004135 )
Colin Crosscfad1192015-11-02 16:43:11 -08004136
Jooyung Hancc372c52019-09-25 15:18:44 +09004137 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004138
4139 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004140}
4141
Jiyong Park2286afd2020-06-16 21:58:53 +09004142func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004143 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004144}
4145
Kiyoung Kim51279d32022-08-24 14:10:46 +09004146func (c *Module) isImportedApiLibrary() bool {
4147 _, ok := c.linker.(*apiLibraryDecorator)
4148 return ok
4149}
4150
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004151func kytheExtractAllFactory() android.Singleton {
4152 return &kytheExtractAllSingleton{}
4153}
4154
4155type kytheExtractAllSingleton struct {
4156}
4157
4158func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4159 var xrefTargets android.Paths
4160 ctx.VisitAllModules(func(module android.Module) {
4161 if ccModule, ok := module.(xref); ok {
4162 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4163 }
4164 })
4165 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4166 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004167 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004168 }
4169}
4170
Jihoon Kangf78a8902022-09-01 22:47:07 +00004171func (c *Module) Partition() string {
4172 if p, ok := c.installer.(interface {
4173 getPartition() string
4174 }); ok {
4175 return p.getPartition()
4176 }
4177 return ""
4178}
4179
Spandan Das2b6dfb52024-01-19 00:22:22 +00004180type sourceModuleName interface {
4181 sourceModuleName() string
4182}
4183
4184func (c *Module) BaseModuleName() string {
4185 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4186 // if the prebuilt module sets a source_module_name in Android.bp, use that
4187 return smn.sourceModuleName()
4188 }
4189 return c.ModuleBase.BaseModuleName()
4190}
4191
Colin Cross06a931b2015-10-28 17:23:31 -07004192var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004193var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004194var BoolPtr = proptools.BoolPtr
4195var String = proptools.String
4196var StringPtr = proptools.StringPtr