blob: 0fa34571a7b0bffc3f44d034079ff8fd44f3733b [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
Yu Liu67a28422024-03-05 00:36:31 +0000769func (d libraryDependencyTag) PropagateAconfigValidation() bool {
770 return d.static()
771}
772
773var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
774
Colin Crosse9fe2942020-11-10 18:12:15 -0800775// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700776// libraryDependencyTag. Each tag object is created globally and reused for multiple
777// dependencies (although since the object contains no references, assigning a tag to a
778// variable and modifying it will not modify the original). Users can compare the tag
779// returned by ctx.OtherModuleDependencyTag against the global original
780type dependencyTag struct {
781 blueprint.BaseDependencyTag
782 name string
783}
784
Colin Crosse9fe2942020-11-10 18:12:15 -0800785// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
786// libraryDependencyTag, but where the dependency needs to be installed when the parent is
787// installed.
788type installDependencyTag struct {
789 blueprint.BaseDependencyTag
790 android.InstallAlwaysNeededDependencyTag
791 name string
792}
793
Colin Crossc99deeb2016-04-11 15:06:20 -0700794var (
Colin Cross6e511a92020-07-27 21:26:48 -0700795 genSourceDepTag = dependencyTag{name: "gen source"}
796 genHeaderDepTag = dependencyTag{name: "gen header"}
797 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
798 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900799 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700800 reuseObjTag = dependencyTag{name: "reuse objects"}
801 staticVariantTag = dependencyTag{name: "static variant"}
802 vndkExtDepTag = dependencyTag{name: "vndk extends"}
803 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700804 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800805 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700806 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700807 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000808 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500809 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400810 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700811)
812
Roland Levillainf89cd092019-07-29 16:22:59 +0100813func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700814 ccLibDepTag, ok := depTag.(libraryDependencyTag)
815 return ok && ccLibDepTag.shared()
816}
817
818func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
819 ccLibDepTag, ok := depTag.(libraryDependencyTag)
820 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100821}
822
Zach Johnson3df4e632020-11-06 11:56:27 -0800823func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
824 ccLibDepTag, ok := depTag.(libraryDependencyTag)
825 return ok && ccLibDepTag.header()
826}
827
Roland Levillainf89cd092019-07-29 16:22:59 +0100828func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800829 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100830}
831
832func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700833 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100834 return ok && ccDepTag == testPerSrcDepTag
835}
836
Colin Crossca860ac2016-01-04 14:34:37 -0800837// Module contains the properties and members used by all C/C++ module types, and implements
838// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500839// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
840// interface.
841//
842// To define a C/C++ related module, construct a new Module object and point its delegates to
843// type-specific structs. These delegates will be invoked to register module-specific build
844// statements which may be unique to the module type. For example, module.compiler.compile() should
845// be defined so as to register build statements which are responsible for compiling the module.
846//
847// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
848// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
849// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
850// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800851type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700852 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700853
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700854 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700855 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700856
Colin Crossca860ac2016-01-04 14:34:37 -0800857 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000858 hod android.HostOrDeviceSupported
859 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000860 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700861
Paul Duffina0843f62019-12-13 19:50:38 +0000862 // Allowable SdkMemberTypes of this module type.
863 sdkMemberTypes []android.SdkMemberType
864
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500865 // decorator delegates, initialize before calling Init
866 // these may contain module-specific implementations, and effectively allow for custom
867 // type-specific logic. These members may reference different objects or the same object.
868 // Functions of these decorators will be invoked to initialize and register type-specific
869 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800870 generators []Generator
871 compiler compiler
872 linker linker
873 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500874
Spandan Dase12d2522023-09-12 21:42:31 +0000875 features []feature
876 stl *stl
877 sanitize *sanitize
878 coverage *coverage
879 fuzzer *fuzzer
880 sabi *sabi
881 vndkdep *vndkdep
882 lto *lto
883 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000884 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800885
Colin Cross31076b32020-10-23 17:22:06 -0700886 library libraryInterface
887
Colin Cross635c3b02016-05-18 15:37:25 -0700888 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800889
Colin Crossb98c8b02016-07-29 13:44:28 -0700890 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700891
892 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800893
894 // Flags used to compile this module
895 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700896
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800897 // Shared flags among build rules of this module
898 sharedFlags SharedFlags
899
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800900 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700901 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900902
903 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800904 // Kythe (source file indexer) paths for this compilation module
905 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700906 // Object .o file output paths for this compilation module
907 objFiles android.Paths
908 // Tidy .tidy file output paths for this compilation module
909 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900910
911 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700912 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700913
914 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800915
916 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800917 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700918}
919
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200920func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400921 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
922 if b, ok := c.compiler.(*baseCompiler); ok {
923 hasAidl = b.hasSrcExt(".aidl")
924 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
925 hasProto = b.hasSrcExt(".proto")
926 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
927 hasSysprop = b.hasSrcExt(".sysprop")
928 hasWinMsg = b.hasSrcExt(".mc")
929 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
930 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200931 c.AndroidModuleBase().AddJSONData(d)
932 (*d)["Cc"] = map[string]interface{}{
933 "SdkVersion": c.SdkVersion(),
934 "MinSdkVersion": c.MinSdkVersion(),
935 "VndkVersion": c.VndkVersion(),
936 "ProductSpecific": c.ProductSpecific(),
937 "SocSpecific": c.SocSpecific(),
938 "DeviceSpecific": c.DeviceSpecific(),
939 "InProduct": c.InProduct(),
940 "InVendor": c.InVendor(),
941 "InRamdisk": c.InRamdisk(),
942 "InVendorRamdisk": c.InVendorRamdisk(),
943 "InRecovery": c.InRecovery(),
944 "VendorAvailable": c.VendorAvailable(),
945 "ProductAvailable": c.ProductAvailable(),
946 "RamdiskAvailable": c.RamdiskAvailable(),
947 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
948 "RecoveryAvailable": c.RecoveryAvailable(),
949 "OdmAvailable": c.OdmAvailable(),
950 "InstallInData": c.InstallInData(),
951 "InstallInRamdisk": c.InstallInRamdisk(),
952 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
953 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
954 "InstallInRecovery": c.InstallInRecovery(),
955 "InstallInRoot": c.InstallInRoot(),
956 "IsVndk": c.IsVndk(),
957 "IsVndkExt": c.IsVndkExt(),
958 "IsVndkPrivate": c.IsVndkPrivate(),
959 "IsVndkSp": c.IsVndkSp(),
960 "IsLlndk": c.IsLlndk(),
961 "IsLlndkPublic": c.IsLlndkPublic(),
962 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
963 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
964 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
965 "ApexSdkVersion": c.apexSdkVersion,
966 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400967 "AidlSrcs": hasAidl,
968 "LexSrcs": hasLex,
969 "ProtoSrcs": hasProto,
970 "RenderscriptSrcs": hasRenderscript,
971 "SyspropSrcs": hasSysprop,
972 "WinMsgSrcs": hasWinMsg,
973 "YaccSrsc": hasYacc,
974 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200975 }
976}
977
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500978func (c *Module) SetPreventInstall() {
979 c.Properties.PreventInstall = true
980}
981
982func (c *Module) SetHideFromMake() {
983 c.Properties.HideFromMake = true
984}
985
Ivan Lozanod7586b62021-04-01 09:49:36 -0400986func (c *Module) HiddenFromMake() bool {
987 return c.Properties.HideFromMake
988}
989
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800990func (c *Module) RequiredModuleNames() []string {
991 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
992 if c.ImageVariation().Variation == android.CoreVariation {
993 required = append(required, c.Properties.Target.Platform.Required...)
994 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
995 } else if c.InRecovery() {
996 required = append(required, c.Properties.Target.Recovery.Required...)
997 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
998 }
999 return android.FirstUniqueStrings(required)
1000}
1001
Ivan Lozano52767be2019-10-18 14:49:46 -07001002func (c *Module) Toc() android.OptionalPath {
1003 if c.linker != nil {
1004 if library, ok := c.linker.(libraryInterface); ok {
1005 return library.toc()
1006 }
1007 }
1008 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1009}
1010
1011func (c *Module) ApiLevel() string {
1012 if c.linker != nil {
1013 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001014 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001015 }
1016 }
1017 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1018}
1019
1020func (c *Module) Static() bool {
1021 if c.linker != nil {
1022 if library, ok := c.linker.(libraryInterface); ok {
1023 return library.static()
1024 }
1025 }
1026 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1027}
1028
1029func (c *Module) Shared() bool {
1030 if c.linker != nil {
1031 if library, ok := c.linker.(libraryInterface); ok {
1032 return library.shared()
1033 }
1034 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001035
Ivan Lozano52767be2019-10-18 14:49:46 -07001036 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1037}
1038
1039func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001040 if c.stl != nil {
1041 return c.stl.Properties.SelectedStl
1042 }
1043 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001044}
1045
Ivan Lozano52767be2019-10-18 14:49:46 -07001046func (c *Module) NdkPrebuiltStl() bool {
1047 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1048 return true
1049 }
1050 return false
1051}
1052
1053func (c *Module) StubDecorator() bool {
1054 if _, ok := c.linker.(*stubDecorator); ok {
1055 return true
1056 }
1057 return false
1058}
1059
1060func (c *Module) SdkVersion() string {
1061 return String(c.Properties.Sdk_version)
1062}
1063
Artur Satayev480e25b2020-04-27 18:53:18 +01001064func (c *Module) MinSdkVersion() string {
1065 return String(c.Properties.Min_sdk_version)
1066}
1067
Jiyong Park5df7bd32021-08-25 16:18:46 +09001068func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001069 if linker, ok := c.linker.(*objectLinker); ok {
1070 return linker.isCrt()
1071 }
1072 return false
1073}
1074
Jiyong Park5df7bd32021-08-25 16:18:46 +09001075func (c *Module) SplitPerApiLevel() bool {
1076 return c.canUseSdk() && c.isCrt()
1077}
1078
Colin Crossc511bc52020-04-07 16:50:32 +00001079func (c *Module) AlwaysSdk() bool {
1080 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1081}
1082
Ivan Lozano183a3212019-10-18 14:18:45 -07001083func (c *Module) CcLibrary() bool {
1084 if c.linker != nil {
1085 if _, ok := c.linker.(*libraryDecorator); ok {
1086 return true
1087 }
Colin Crossd48fe732020-09-23 20:37:24 -07001088 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1089 return true
1090 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001091 }
1092 return false
1093}
1094
1095func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001096 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001097 return true
1098 }
1099 return false
1100}
1101
Spandan Dase12d2522023-09-12 21:42:31 +00001102func (c *Module) IsNdkPrebuiltStl() bool {
1103 if c.linker == nil {
1104 return false
1105 }
1106 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1107 return true
1108 }
1109 return false
1110}
1111
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001112func (c *Module) RlibStd() bool {
1113 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1114}
1115
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001116func (c *Module) RustLibraryInterface() bool {
1117 return false
1118}
1119
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001120func (c *Module) IsFuzzModule() bool {
1121 if _, ok := c.compiler.(*fuzzBinary); ok {
1122 return true
1123 }
1124 return false
1125}
1126
1127func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1128 return c.FuzzModule
1129}
1130
1131func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1132 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1133 return fuzzer.fuzzPackagedModule
1134 }
1135 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1136}
1137
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001138func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001139 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1140 return fuzzer.sharedLibraries
1141 }
1142 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1143}
1144
Ivan Lozano2b262972019-11-21 12:30:50 -08001145func (c *Module) NonCcVariants() bool {
1146 return false
1147}
1148
Ivan Lozano183a3212019-10-18 14:18:45 -07001149func (c *Module) SetStatic() {
1150 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001151 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001152 library.setStatic()
1153 return
1154 }
1155 }
1156 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1157}
1158
1159func (c *Module) SetShared() {
1160 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001161 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001162 library.setShared()
1163 return
1164 }
1165 }
1166 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1167}
1168
1169func (c *Module) BuildStaticVariant() bool {
1170 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001171 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001172 return library.buildStatic()
1173 }
1174 }
1175 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1176}
1177
1178func (c *Module) BuildSharedVariant() bool {
1179 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001180 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001181 return library.buildShared()
1182 }
1183 }
1184 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1185}
1186
1187func (c *Module) Module() android.Module {
1188 return c
1189}
1190
Jiyong Parkc20eee32018-09-05 22:36:17 +09001191func (c *Module) OutputFile() android.OptionalPath {
1192 return c.outputFile
1193}
1194
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001195func (c *Module) CoverageFiles() android.Paths {
1196 if c.linker != nil {
1197 if library, ok := c.linker.(libraryInterface); ok {
1198 return library.objs().coverageFiles
1199 }
1200 }
1201 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1202}
1203
Ivan Lozano183a3212019-10-18 14:18:45 -07001204var _ LinkableInterface = (*Module)(nil)
1205
Jiyong Park719b4462019-01-13 00:39:51 +09001206func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001207 if c.linker != nil {
1208 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001209 }
1210 return nil
1211}
1212
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001213func (c *Module) CoverageOutputFile() android.OptionalPath {
1214 if c.linker != nil {
1215 return c.linker.coverageOutputFilePath()
1216 }
1217 return android.OptionalPath{}
1218}
1219
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001220func (c *Module) RelativeInstallPath() string {
1221 if c.installer != nil {
1222 return c.installer.relativeInstallPath()
1223 }
1224 return ""
1225}
1226
Jooyung Han344d5432019-08-23 11:17:39 +09001227func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001228 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001229}
1230
Colin Cross36242852017-06-23 15:06:31 -07001231func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001232 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001233 for _, generator := range c.generators {
1234 c.AddProperties(generator.GeneratorProps()...)
1235 }
Colin Crossca860ac2016-01-04 14:34:37 -08001236 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001237 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001238 }
1239 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001240 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001241 }
1242 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001243 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001244 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001245 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001246 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001247 }
Colin Cross16b23492016-01-06 14:41:07 -08001248 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001249 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001250 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001251 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001252 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001253 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001254 if c.fuzzer != nil {
1255 c.AddProperties(c.fuzzer.props()...)
1256 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001257 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001258 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001259 }
Justin Yun8effde42017-06-23 19:24:43 +09001260 if c.vndkdep != nil {
1261 c.AddProperties(c.vndkdep.props()...)
1262 }
Stephen Craneba090d12017-05-09 15:44:35 -07001263 if c.lto != nil {
1264 c.AddProperties(c.lto.props()...)
1265 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001266 if c.afdo != nil {
1267 c.AddProperties(c.afdo.props()...)
1268 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001269 if c.orderfile != nil {
1270 c.AddProperties(c.orderfile.props()...)
1271 }
Colin Crossca860ac2016-01-04 14:34:37 -08001272 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001273 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001274 }
Colin Crossc472d572015-03-17 15:06:21 -07001275
Colin Cross36242852017-06-23 15:06:31 -07001276 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001277 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001278 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001279
Colin Cross36242852017-06-23 15:06:31 -07001280 return c
Colin Crossc472d572015-03-17 15:06:21 -07001281}
1282
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001283// UseVndk() returns true if this module is built against VNDK.
1284// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001285func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001286 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001287}
1288
Colin Crossc511bc52020-04-07 16:50:32 +00001289func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001290 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001291 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001292}
1293
1294func (c *Module) UseSdk() bool {
1295 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001296 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001297 }
1298 return false
1299}
1300
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001301func (c *Module) isCoverageVariant() bool {
1302 return c.coverage.Properties.IsCoverageVariant
1303}
1304
Colin Cross95f1ca02020-10-29 20:47:22 -07001305func (c *Module) IsNdk(config android.Config) bool {
1306 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001307}
1308
Colin Cross127bb8b2020-12-16 16:46:01 -08001309func (c *Module) IsLlndk() bool {
1310 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001311}
1312
Colin Cross127bb8b2020-12-16 16:46:01 -08001313func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001314 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001315}
1316
Colin Cross1f3f1302021-04-26 18:37:44 -07001317func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001318 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001319 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001320}
1321
Colin Cross5271fea2021-04-27 13:06:04 -07001322func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1323 lib := moduleLibraryInterface(m)
1324 return lib != nil && (lib.hasVendorPublicLibrary())
1325}
1326
1327// IsVendorPublicLibrary returns true for vendor public libraries.
1328func (c *Module) IsVendorPublicLibrary() bool {
1329 return c.VendorProperties.IsVendorPublicLibrary
1330}
1331
Ivan Lozanof1868af2022-04-12 13:08:36 -04001332func (c *Module) IsVndkPrebuiltLibrary() bool {
1333 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1334 return true
1335 }
1336 return false
1337}
1338
1339func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1340 return c.Properties.SdkAndPlatformVariantVisibleToMake
1341}
1342
Ivan Lozanod7586b62021-04-01 09:49:36 -04001343func (c *Module) HasLlndkStubs() bool {
1344 lib := moduleLibraryInterface(c)
1345 return lib != nil && lib.hasLLNDKStubs()
1346}
1347
1348func (c *Module) StubsVersion() string {
1349 if lib, ok := c.linker.(versionedInterface); ok {
1350 return lib.stubsVersion()
1351 }
1352 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1353}
1354
Colin Cross127bb8b2020-12-16 16:46:01 -08001355// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1356// and does not set llndk.vendor_available: false.
1357func (c *Module) isImplementationForLLNDKPublic() bool {
1358 library, _ := c.library.(*libraryDecorator)
1359 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001360 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001361}
1362
Justin Yunfd9e8042020-12-23 18:23:14 +09001363// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001364func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001365 // Check if VNDK-core-private or VNDK-SP-private
1366 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001367 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001368 }
1369
1370 // Check if LLNDK-private
1371 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001372 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001373 }
1374
1375 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001376}
1377
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001378// IsVndk() returns true if this module has a vndk variant.
1379// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1380// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001381func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001382 if vndkdep := c.vndkdep; vndkdep != nil {
1383 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001384 }
1385 return false
1386}
1387
Colin Cross3513fb12024-01-24 14:44:47 -08001388func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001389 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001390 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001391 }
1392 return false
1393}
1394
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001395func (c *Module) isOrderfileCompile() bool {
1396 if orderfile := c.orderfile; orderfile != nil {
1397 return orderfile.Properties.OrderfileLoad
1398 }
1399 return false
1400}
1401
Yi Kongc702ebd2022-08-19 16:02:45 +08001402func (c *Module) isCfi() bool {
1403 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001404 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001405 }
1406 return false
1407}
1408
Yi Konged79fa32023-06-04 17:15:42 +09001409func (c *Module) isFuzzer() bool {
1410 if sanitize := c.sanitize; sanitize != nil {
1411 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1412 }
1413 return false
1414}
1415
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001416func (c *Module) isNDKStubLibrary() bool {
1417 if _, ok := c.compiler.(*stubDecorator); ok {
1418 return true
1419 }
1420 return false
1421}
1422
Ivan Lozanod7586b62021-04-01 09:49:36 -04001423func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001424 if vndkdep := c.vndkdep; vndkdep != nil {
1425 return vndkdep.isVndkSp()
1426 }
1427 return false
1428}
1429
Ivan Lozanof9e21722020-12-02 09:00:51 -05001430func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001431 if vndkdep := c.vndkdep; vndkdep != nil {
1432 return vndkdep.isVndkExt()
1433 }
1434 return false
1435}
1436
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001437func (c *Module) SubName() string {
1438 return c.Properties.SubName
1439}
1440
Ivan Lozano52767be2019-10-18 14:49:46 -07001441func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001442 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001443}
1444
Logan Chienf3511742017-10-31 18:04:35 +08001445func (c *Module) getVndkExtendsModuleName() string {
1446 if vndkdep := c.vndkdep; vndkdep != nil {
1447 return vndkdep.getVndkExtendsModuleName()
1448 }
1449 return ""
1450}
1451
Jiyong Park25fc6a92018-11-18 18:02:45 +09001452func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001453 if lib := c.library; lib != nil {
1454 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001455 }
1456 return false
1457}
1458
1459func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001460 if lib := c.library; lib != nil {
1461 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001462 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001463 return false
1464}
1465
Alan Stokes73feba32022-11-14 12:21:24 +00001466func (c *Module) IsStubsImplementationRequired() bool {
1467 if lib := c.library; lib != nil {
1468 return lib.isStubsImplementationRequired()
1469 }
1470 return false
1471}
1472
Colin Cross0477b422020-10-13 18:43:54 -07001473// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1474// the implementation. If it is an implementation library it returns its own name.
1475func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1476 name := ctx.OtherModuleName(c)
1477 if versioned, ok := c.linker.(versionedInterface); ok {
1478 name = versioned.implementationModuleName(name)
1479 }
1480 return name
1481}
1482
Martin Stjernholm2856c662020-12-02 15:03:42 +00001483// Similar to ImplementationModuleName, but uses the Make variant of the module
1484// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1485// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1486// under the premise that the prebuilt module overrides its source counterpart
1487// if it is exposed to Make).
1488func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1489 name := c.BaseModuleName()
1490 if versioned, ok := c.linker.(versionedInterface); ok {
1491 name = versioned.implementationModuleName(name)
1492 }
1493 return name
1494}
1495
Jiyong Park7d55b612021-06-11 17:22:09 +09001496func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001497 return Bool(c.Properties.Bootstrap)
1498}
1499
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001500func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001501 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1502 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1503 return false
1504 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001505 return c.linker != nil && c.linker.nativeCoverage()
1506}
1507
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001508func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001509 if p, ok := c.linker.(SnapshotInterface); ok {
1510 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001511 }
1512 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001513}
1514
Bill Peckham945441c2020-08-31 16:07:58 -07001515func (c *Module) ExcludeFromVendorSnapshot() bool {
1516 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1517}
1518
Jose Galmesf7294582020-11-13 12:07:36 -08001519func (c *Module) ExcludeFromRecoverySnapshot() bool {
1520 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1521}
1522
Jiyong Parkf1194352019-02-25 11:05:47 +09001523func isBionic(name string) bool {
1524 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001525 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001526 return true
1527 }
1528 return false
1529}
1530
Martin Stjernholm279de572019-09-10 23:18:20 +01001531func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001532 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001533 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001534 }
1535 return isBionic(name)
1536}
1537
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001538func (c *Module) XrefCcFiles() android.Paths {
1539 return c.kytheFiles
1540}
1541
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001542func (c *Module) isCfiAssemblySupportEnabled() bool {
1543 return c.sanitize != nil &&
1544 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1545}
1546
Inseob Kim800d1142021-06-14 12:03:51 +09001547func (c *Module) InstallInRoot() bool {
1548 return c.installer != nil && c.installer.installInRoot()
1549}
1550
Colin Crossca860ac2016-01-04 14:34:37 -08001551type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001552 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001553 moduleContextImpl
1554}
1555
Colin Cross37047f12016-12-13 17:06:13 -08001556type depsContext struct {
1557 android.BottomUpMutatorContext
1558 moduleContextImpl
1559}
1560
Colin Crossca860ac2016-01-04 14:34:37 -08001561type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001562 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001563 moduleContextImpl
1564}
1565
1566type moduleContextImpl struct {
1567 mod *Module
1568 ctx BaseModuleContext
1569}
1570
Colin Crossb98c8b02016-07-29 13:44:28 -07001571func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001572 return ctx.mod.toolchain(ctx.ctx)
1573}
1574
1575func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001576 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001577}
1578
1579func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001580 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001581}
1582
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001583func (ctx *moduleContextImpl) testBinary() bool {
1584 return ctx.mod.testBinary()
1585}
1586
Yi Kong56fc1b62022-09-06 16:24:00 +08001587func (ctx *moduleContextImpl) testLibrary() bool {
1588 return ctx.mod.testLibrary()
1589}
1590
Jiyong Park1d1119f2019-07-29 21:27:18 +09001591func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001592 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001593}
1594
Inseob Kim7f283f42020-06-01 21:53:49 +09001595func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001596 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001597}
1598
Inseob Kim1042d292020-06-01 23:23:05 +09001599func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001600 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001601}
1602
Jooyung Hanccce2f22020-03-07 03:45:53 +09001603func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001604 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001605}
1606
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001607func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001608 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001609}
1610
1611func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001612 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001613 config := ctx.ctx.Config()
1614 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001615 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001616 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001617 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001618 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001619 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001620 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001621 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001622 }
1623 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001624}
1625
Jiyong Parkb35a8192020-08-10 15:59:36 +09001626func (ctx *moduleContextImpl) minSdkVersion() string {
1627 ver := ctx.mod.MinSdkVersion()
1628 if ver == "apex_inherit" && !ctx.isForPlatform() {
1629 ver = ctx.apexSdkVersion().String()
1630 }
1631 if ver == "apex_inherit" || ver == "" {
1632 ver = ctx.sdkVersion()
1633 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001634
1635 if ctx.ctx.Device() {
1636 config := ctx.ctx.Config()
1637 if config.IsVndkDeprecated() && ctx.inVendor() {
1638 // If building for vendor with final API, then use the latest _stable_ API as "current".
1639 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1640 ver = config.PlatformSdkVersion().String()
1641 }
1642 }
1643 }
1644
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001645 // For crt objects, the meaning of min_sdk_version is very different from other types of
1646 // module. For them, min_sdk_version defines the oldest version that the build system will
1647 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1648 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1649 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001650 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1651 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1652 // support such an old version. The version is set to the later version in case when the
1653 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1654 // it's for an APEX.
1655 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1656 if ctx.isForPlatform() {
1657 ver = strconv.Itoa(android.FutureApiLevelInt)
1658 } else { // for apex
1659 ver = ctx.apexSdkVersion().String()
1660 if ver == "" { // in case when min_sdk_version was not set by the APEX
1661 ver = ctx.sdkVersion()
1662 }
1663 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001664 }
1665
Jiyong Parkb35a8192020-08-10 15:59:36 +09001666 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1667 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1668 minSdkVersionInt, err2 := strconv.Atoi(ver)
1669 if err == nil && err2 == nil {
1670 if sdkVersionInt < minSdkVersionInt {
1671 return strconv.Itoa(sdkVersionInt)
1672 }
1673 }
1674 return ver
1675}
1676
1677func (ctx *moduleContextImpl) isSdkVariant() bool {
1678 return ctx.mod.IsSdkVariant()
1679}
1680
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001681func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001682 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001683}
Justin Yun8effde42017-06-23 19:24:43 +09001684
Kiyoung Kimaa394802024-01-08 12:55:45 +09001685func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1686 return ctx.mod.InVendorOrProduct()
1687}
1688
Colin Cross95f1ca02020-10-29 20:47:22 -07001689func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1690 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001691}
1692
Colin Cross127bb8b2020-12-16 16:46:01 -08001693func (ctx *moduleContextImpl) IsLlndk() bool {
1694 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001695}
1696
Colin Cross127bb8b2020-12-16 16:46:01 -08001697func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1698 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001699}
1700
Colin Cross127bb8b2020-12-16 16:46:01 -08001701func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1702 return ctx.mod.isImplementationForLLNDKPublic()
1703}
1704
1705func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1706 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001707}
1708
Logan Chienf3511742017-10-31 18:04:35 +08001709func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001710 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001711}
1712
Colin Cross3513fb12024-01-24 14:44:47 -08001713func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1714 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001715}
1716
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001717func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1718 return ctx.mod.isOrderfileCompile()
1719}
1720
Yi Kongc702ebd2022-08-19 16:02:45 +08001721func (ctx *moduleContextImpl) isCfi() bool {
1722 return ctx.mod.isCfi()
1723}
1724
Yi Konged79fa32023-06-04 17:15:42 +09001725func (ctx *moduleContextImpl) isFuzzer() bool {
1726 return ctx.mod.isFuzzer()
1727}
1728
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001729func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1730 return ctx.mod.isNDKStubLibrary()
1731}
1732
Justin Yun8effde42017-06-23 19:24:43 +09001733func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001734 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001735}
1736
Ivan Lozanof9e21722020-12-02 09:00:51 -05001737func (ctx *moduleContextImpl) IsVndkExt() bool {
1738 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001739}
1740
Colin Cross5271fea2021-04-27 13:06:04 -07001741func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1742 return ctx.mod.IsVendorPublicLibrary()
1743}
1744
Vic Yangefd249e2018-11-12 20:19:56 -08001745func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001746 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001747}
1748
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001749func (ctx *moduleContextImpl) selectedStl() string {
1750 if stl := ctx.mod.stl; stl != nil {
1751 return stl.Properties.SelectedStl
1752 }
1753 return ""
1754}
1755
Ivan Lozanobd721262018-11-27 14:33:03 -08001756func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1757 return ctx.mod.linker.useClangLld(actx)
1758}
1759
Colin Crossce75d2c2016-10-06 16:12:58 -07001760func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001761 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001762}
1763
Logan Chienf3511742017-10-31 18:04:35 +08001764func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1765 return ctx.mod.getVndkExtendsModuleName()
1766}
1767
Logan Chiene274fc92019-12-03 11:18:32 -08001768func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001769 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1770 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001771}
1772
Colin Crosse07f2312020-08-13 11:24:56 -07001773func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001774 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1775 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001776}
1777
Dan Albertc8060532020-07-22 22:32:17 -07001778func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001779 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001780}
1781
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001782func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001783 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001784}
1785
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001786func (ctx *moduleContextImpl) nativeCoverage() bool {
1787 return ctx.mod.nativeCoverage()
1788}
1789
Colin Cross56a83212020-09-15 18:30:11 -07001790func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1791 return ctx.mod.DirectlyInAnyApex()
1792}
1793
Colin Cross95b07f22020-12-16 11:06:50 -08001794func (ctx *moduleContextImpl) isPreventInstall() bool {
1795 return ctx.mod.Properties.PreventInstall
1796}
1797
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001798func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1799 shared := &ctx.mod.sharedFlags
1800 if shared.flagsMap == nil {
1801 shared.numSharedFlags = 0
1802 shared.flagsMap = make(map[string]string)
1803 }
1804 return shared
1805}
1806
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001807func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1808 return ctx.mod.isCfiAssemblySupportEnabled()
1809}
1810
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001811func (ctx *moduleContextImpl) notInPlatform() bool {
1812 return ctx.mod.NotInPlatform()
1813}
1814
Colin Cross635c3b02016-05-18 15:37:25 -07001815func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001816 return &Module{
1817 hod: hod,
1818 multilib: multilib,
1819 }
1820}
1821
Colin Cross635c3b02016-05-18 15:37:25 -07001822func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001823 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001824 module.features = []feature{
1825 &tidyFeature{},
1826 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001827 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001828 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001829 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001830 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001831 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001832 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001833 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001834 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001835 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001836 return module
1837}
1838
Colin Crossce75d2c2016-10-06 16:12:58 -07001839func (c *Module) Prebuilt() *android.Prebuilt {
1840 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1841 return p.prebuilt()
1842 }
1843 return nil
1844}
1845
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001846func (c *Module) IsPrebuilt() bool {
1847 return c.Prebuilt() != nil
1848}
1849
Colin Crossce75d2c2016-10-06 16:12:58 -07001850func (c *Module) Name() string {
1851 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001852 if p, ok := c.linker.(interface {
1853 Name(string) string
1854 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001855 name = p.Name(name)
1856 }
1857 return name
1858}
1859
Alex Light3d673592019-01-18 14:37:31 -08001860func (c *Module) Symlinks() []string {
1861 if p, ok := c.installer.(interface {
1862 symlinkList() []string
1863 }); ok {
1864 return p.symlinkList()
1865 }
1866 return nil
1867}
1868
Roland Levillainf89cd092019-07-29 16:22:59 +01001869func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1870 test, ok := c.linker.(testPerSrc)
1871 return ok && test.isAllTestsVariation()
1872}
1873
Chris Parsons216e10a2020-07-09 17:12:52 -04001874func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001875 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001876 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001877 }); ok {
1878 return p.dataPaths()
1879 }
1880 return nil
1881}
1882
Ivan Lozanof1868af2022-04-12 13:08:36 -04001883func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001884 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1885 // "current", it will append the VNDK version to the name suffix.
1886 var vndkVersion string
1887 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001888 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001889 if c.ProductSpecific() {
1890 // If the module is product specific with 'product_specific: true',
1891 // do not add a name suffix because it is a base module.
1892 return ""
1893 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001894 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001895 } else {
1896 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001897 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001898 }
1899 if vndkVersion == "current" {
1900 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1901 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001902 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001903 // add version suffix only if the module is using different vndk version than the
1904 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001905 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001906 }
1907 return nameSuffix
1908}
1909
Ivan Lozanof1868af2022-04-12 13:08:36 -04001910func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1911 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001912
1913 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001914 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001915 }
1916
Colin Cross127bb8b2020-12-16 16:46:01 -08001917 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001918 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001919 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1920 // added for product variant only when we have vendor and product variants with core
1921 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001922 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001923 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001924 subName += vendorPublicLibrarySuffix
1925 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001926 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1927 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001928 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001929 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001930 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001931 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001932 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001933 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001934 subName += RecoverySuffix
1935 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1936 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001937 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001938 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001939 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001940 } else if c.IsStubs() && c.IsSdkVariant() {
1941 // Public API surface (NDK)
1942 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1943 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001944 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001945
1946 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001947}
1948
Sam Delmerico75dbca22023-04-20 13:13:25 +00001949func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1950 ctx := &moduleContext{
1951 ModuleContext: actx,
1952 moduleContextImpl: moduleContextImpl{
1953 mod: c,
1954 },
1955 }
1956 ctx.ctx = ctx
1957 return ctx
1958}
1959
Spandan Das20fce2d2023-04-12 17:21:39 +00001960// TODO (b/277651159): Remove this allowlist
1961var (
1962 skipStubLibraryMultipleApexViolation = map[string]bool{
1963 "libclang_rt.asan": true,
1964 "libclang_rt.hwasan": true,
1965 // runtime apex
1966 "libc": true,
1967 "libc_hwasan": true,
1968 "libdl_android": true,
1969 "libm": true,
1970 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001971 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001972 // art apex
1973 "libandroidio": true,
1974 "libdexfile": true,
1975 "libnativebridge": true,
1976 "libnativehelper": true,
1977 "libnativeloader": true,
1978 "libsigchain": true,
1979 }
1980)
1981
1982// Returns true if a stub library could be installed in multiple apexes
1983func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1984 // If this is not an apex variant, no check necessary
1985 if !c.InAnyApex() {
1986 return false
1987 }
1988 // If this is not a stub library, no check necessary
1989 if !c.HasStubsVariants() {
1990 return false
1991 }
1992 // Skip the allowlist
1993 // Use BaseModuleName so that this matches prebuilts.
1994 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1995 return false
1996 }
1997
1998 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1999 // Stub libraries should not have more than one apex_available
2000 if len(aaWithoutTestApexes) > 1 {
2001 return true
2002 }
2003 // Stub libraries should not use the wildcard
2004 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2005 return true
2006 }
2007 // Default: no violation
2008 return false
2009}
2010
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002011func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2012 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2013}
2014
Chris Parsons8d6e4332021-02-22 16:13:50 -05002015func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002016 // Handle the case of a test module split by `test_per_src` mutator.
2017 //
2018 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2019 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2020 // module and return early, as this module does not produce an output file per se.
2021 if c.IsTestPerSrcAllTestsVariation() {
2022 c.outputFile = android.OptionalPath{}
2023 return
2024 }
2025
Ivan Lozanof1868af2022-04-12 13:08:36 -04002026 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002027 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002028 if !apexInfo.IsForPlatform() {
2029 c.hideApexVariantFromMake = true
2030 }
2031
Chris Parsonseefc9e62021-04-02 17:36:47 -04002032 c.makeLinkType = GetMakeLinkType(actx, c)
2033
Sam Delmerico75dbca22023-04-20 13:13:25 +00002034 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002035
Colin Crossf18e1102017-11-16 14:33:08 -08002036 deps := c.depsToPaths(ctx)
2037 if ctx.Failed() {
2038 return
2039 }
2040
Joe Onorato37f900c2023-07-18 16:58:16 -07002041 for _, generator := range c.generators {
2042 gen := generator.GeneratorSources(ctx)
2043 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2044 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2045 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2046 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2047 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2048 if len(deps.Objs.objFiles) == 0 {
2049 // If we are reusuing object files (which happens when we're a shared library and we're
2050 // reusing our static variant's object files), then skip adding the actual source files,
2051 // because we already have the object for it.
2052 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2053 }
2054 }
2055
2056 if ctx.Failed() {
2057 return
2058 }
2059
Spandan Das20fce2d2023-04-12 17:21:39 +00002060 if c.stubLibraryMultipleApexViolation(actx) {
2061 actx.PropertyErrorf("apex_available",
2062 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2063 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002064 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2065 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002066 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2067 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002068 }
2069
Colin Crossca860ac2016-01-04 14:34:37 -08002070 flags := Flags{
2071 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002072 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002073 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002074 for _, generator := range c.generators {
2075 flags = generator.GeneratorFlags(ctx, flags, deps)
2076 }
Colin Crossca860ac2016-01-04 14:34:37 -08002077 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002078 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002079 }
2080 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002081 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002082 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002083 if c.stl != nil {
2084 flags = c.stl.flags(ctx, flags)
2085 }
Colin Cross16b23492016-01-06 14:41:07 -08002086 if c.sanitize != nil {
2087 flags = c.sanitize.flags(ctx, flags)
2088 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002089 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002090 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002091 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002092 if c.fuzzer != nil {
2093 flags = c.fuzzer.flags(ctx, flags)
2094 }
Stephen Craneba090d12017-05-09 15:44:35 -07002095 if c.lto != nil {
2096 flags = c.lto.flags(ctx, flags)
2097 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002098 if c.afdo != nil {
2099 flags = c.afdo.flags(ctx, flags)
2100 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002101 if c.orderfile != nil {
2102 flags = c.orderfile.flags(ctx, flags)
2103 }
Colin Crossca860ac2016-01-04 14:34:37 -08002104 for _, feature := range c.features {
2105 flags = feature.flags(ctx, flags)
2106 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002107 if ctx.Failed() {
2108 return
2109 }
2110
Colin Cross4af21ed2019-11-04 09:37:55 -08002111 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2112 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2113 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002114
Colin Cross4af21ed2019-11-04 09:37:55 -08002115 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002116
2117 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002118 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002119 }
2120 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002121 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002122 }
2123
Colin Cross3e5e7782022-06-17 22:17:05 +00002124 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2125
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002126 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002127 // We need access to all the flags seen by a source file.
2128 if c.sabi != nil {
2129 flags = c.sabi.flags(ctx, flags)
2130 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002131
Colin Cross4af21ed2019-11-04 09:37:55 -08002132 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002133
Joe Onorato37f900c2023-07-18 16:58:16 -07002134 for _, generator := range c.generators {
2135 generator.GeneratorBuildActions(ctx, flags, deps)
2136 }
2137
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002138 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002139 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002140 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002141 if ctx.Failed() {
2142 return
2143 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002144 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002145 c.objFiles = objs.objFiles
2146 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002147 }
2148
Colin Crossca860ac2016-01-04 14:34:37 -08002149 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002150 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002151 if ctx.Failed() {
2152 return
2153 }
Colin Cross635c3b02016-05-18 15:37:25 -07002154 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002155
Chris Parsons94a0bba2021-06-04 15:03:47 -04002156 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002157
Jose Galmes6f843bc2020-12-11 13:36:29 -08002158 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2159 // RECOVERY_SNAPSHOT_VERSION is current.
2160 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002161 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002162 i.collectHeadersForSnapshot(ctx)
2163 }
2164 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002165 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002166 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002167 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002168 }
Colin Cross40213022023-12-13 15:19:49 -08002169 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002170
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002171 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002172
Chris Parsons94a0bba2021-06-04 15:03:47 -04002173 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002174
2175 if c.linker != nil {
2176 moduleInfoJSON := ctx.ModuleInfoJSON()
2177 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2178 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2179 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2180 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2181 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2182
2183 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2184 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2185 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2186 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2187
2188 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2189 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2190 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2191 moduleInfoJSON.SubName += ".cfi"
2192 }
2193 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2194 moduleInfoJSON.SubName += ".hwasan"
2195 }
2196 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2197 moduleInfoJSON.SubName += ".scs"
2198 }
2199 }
2200 moduleInfoJSON.SubName += c.Properties.SubName
2201
2202 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2203 moduleInfoJSON.Uninstallable = true
2204 }
2205
2206 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002207}
2208
2209func (c *Module) maybeUnhideFromMake() {
2210 // If a lib is directly included in any of the APEXes or is not available to the
2211 // platform (which is often the case when the stub is provided as a prebuilt),
2212 // unhide the stubs variant having the latest version gets visible to make. In
2213 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2214 // force anything in the make world to link against the stubs library. (unless it
2215 // is explicitly referenced via .bootstrap suffix or the module is marked with
2216 // 'bootstrap: true').
2217 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002218 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002219 c.IsStubs() && !c.InVendorRamdisk() {
2220 c.Properties.HideFromMake = false // unhide
2221 // Note: this is still non-installable
2222 }
2223}
2224
Colin Cross8ff10582023-12-07 13:10:56 -08002225// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2226// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002227func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002228 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002229 // If the module has been specifically configure to not be installed then
2230 // hide from make as otherwise it will break when running inside make
2231 // as the output path to install will not be specified. Not all uninstallable
2232 // modules can be hidden from make as some are needed for resolving make side
2233 // dependencies.
2234 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002235 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002236 c.SkipInstall()
2237 }
2238
2239 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2240 // to allow using the outputs in a genrule.
2241 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002242 c.installer.install(ctx, c.outputFile.Path())
2243 if ctx.Failed() {
2244 return
Colin Crossca860ac2016-01-04 14:34:37 -08002245 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002246 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002247}
2248
Colin Cross0ea8ba82019-06-06 14:33:29 -07002249func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002250 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002251 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002252 }
Colin Crossca860ac2016-01-04 14:34:37 -08002253 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002254}
2255
Colin Crossca860ac2016-01-04 14:34:37 -08002256func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002257 for _, generator := range c.generators {
2258 generator.GeneratorInit(ctx)
2259 }
Colin Crossca860ac2016-01-04 14:34:37 -08002260 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002261 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002262 }
Colin Crossca860ac2016-01-04 14:34:37 -08002263 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002264 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002265 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002266 if c.stl != nil {
2267 c.stl.begin(ctx)
2268 }
Colin Cross16b23492016-01-06 14:41:07 -08002269 if c.sanitize != nil {
2270 c.sanitize.begin(ctx)
2271 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002272 if c.coverage != nil {
2273 c.coverage.begin(ctx)
2274 }
Yi Kong9723e332023-12-04 14:52:53 +09002275 if c.afdo != nil {
2276 c.afdo.begin(ctx)
2277 }
Stephen Craneba090d12017-05-09 15:44:35 -07002278 if c.lto != nil {
2279 c.lto.begin(ctx)
2280 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002281 if c.orderfile != nil {
2282 c.orderfile.begin(ctx)
2283 }
Dan Albert92fe7402020-07-15 13:33:30 -07002284 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002285 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002286 if err != nil {
2287 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002288 c.Properties.Sdk_version = nil
2289 } else {
2290 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002291 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002292 }
Colin Crossca860ac2016-01-04 14:34:37 -08002293}
2294
Colin Cross37047f12016-12-13 17:06:13 -08002295func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002296 deps := Deps{}
2297
Joe Onorato37f900c2023-07-18 16:58:16 -07002298 for _, generator := range c.generators {
2299 deps = generator.GeneratorDeps(ctx, deps)
2300 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002301 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002302 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002303 }
2304 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002305 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002306 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002307 if c.stl != nil {
2308 deps = c.stl.deps(ctx, deps)
2309 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002310 if c.coverage != nil {
2311 deps = c.coverage.deps(ctx, deps)
2312 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002313
Colin Crossb6715442017-10-24 11:13:31 -07002314 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2315 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2316 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2317 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2318 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2319 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002320 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002321
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002322 for _, lib := range deps.ReexportSharedLibHeaders {
2323 if !inList(lib, deps.SharedLibs) {
2324 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2325 }
2326 }
2327
2328 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002329 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2330 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 -07002331 }
2332 }
2333
Colin Cross5950f382016-12-13 12:50:57 -08002334 for _, lib := range deps.ReexportHeaderLibHeaders {
2335 if !inList(lib, deps.HeaderLibs) {
2336 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2337 }
2338 }
2339
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002340 for _, gen := range deps.ReexportGeneratedHeaders {
2341 if !inList(gen, deps.GeneratedHeaders) {
2342 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2343 }
2344 }
2345
Colin Crossc99deeb2016-04-11 15:06:20 -07002346 return deps
2347}
2348
Dan Albert7e9d2952016-08-04 13:02:36 -07002349func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002350 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002351 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002352 moduleContextImpl: moduleContextImpl{
2353 mod: c,
2354 },
2355 }
2356 ctx.ctx = ctx
2357
Colin Crossca860ac2016-01-04 14:34:37 -08002358 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002359}
2360
Jiyong Park7ed9de32018-10-15 22:25:07 +09002361// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002362func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002363 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2364 version := name[sharp+1:]
2365 libname := name[:sharp]
2366 return libname, version
2367 }
2368 return name, ""
2369}
2370
Dan Albert92fe7402020-07-15 13:33:30 -07002371func GetCrtVariations(ctx android.BottomUpMutatorContext,
2372 m LinkableInterface) []blueprint.Variation {
2373 if ctx.Os() != android.Android {
2374 return nil
2375 }
2376 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002377 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2378 minSdkVersion := m.MinSdkVersion()
2379 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2380 minSdkVersion = m.SdkVersion()
2381 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002382 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2383 if err != nil {
2384 ctx.PropertyErrorf("min_sdk_version", err.Error())
2385 }
Colin Cross363ec762023-01-13 13:45:14 -08002386
2387 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002388 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002389 if apiLevel.LessThan(minApiForArch) {
2390 apiLevel = minApiForArch
2391 }
2392
Dan Albert92fe7402020-07-15 13:33:30 -07002393 return []blueprint.Variation{
2394 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002395 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002396 }
2397 }
2398 return []blueprint.Variation{
2399 {Mutator: "sdk", Variation: ""},
2400 }
2401}
2402
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002403func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2404 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002405
2406 variations = append([]blueprint.Variation(nil), variations...)
2407
Liz Kammer23942242022-04-08 15:41:00 -04002408 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002409 // Version is explicitly specified. i.e. libFoo#30
2410 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002411 if tag, ok := depTag.(libraryDependencyTag); ok {
2412 tag.explicitlyVersioned = true
2413 } else {
2414 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2415 }
Colin Crosse7257d22020-09-24 09:56:18 -07002416 }
Colin Crosse7257d22020-09-24 09:56:18 -07002417
Colin Cross0de8a1e2020-09-18 14:15:30 -07002418 if far {
2419 ctx.AddFarVariationDependencies(variations, depTag, name)
2420 } else {
2421 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002422 }
2423}
2424
Kiyoung Kim487689e2022-07-26 09:48:22 +09002425func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2426 apiImportInfo := multitree.ApiImportInfo{}
2427
2428 if c.Device() {
2429 var apiImportModule []blueprint.Module
2430 if actx.OtherModuleExists("api_imports") {
2431 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2432 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002433 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002434 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002435 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002436 }
2437 }
2438 }
2439
2440 return apiImportInfo
2441}
2442
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002443func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002444 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002445 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002446 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002447 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2448 // between the modules in the snapshot and the snapshot itself.
2449 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002450 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002451 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002452 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002453 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2454 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002455 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002456 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002457 *snapshotInfo = &snapshot
2458 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002459 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002460 }
2461 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002462 if *snapshotInfo == nil {
2463 *snapshotInfo = &SnapshotInfo{}
2464 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002465 return **snapshotInfo
2466}
2467
Kiyoung Kim487689e2022-07-26 09:48:22 +09002468func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2469 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002470 return snapshot
2471 }
2472
2473 return lib
2474}
2475
2476// RewriteLibs takes a list of names of shared libraries and scans it for three types
2477// of names:
2478//
2479// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002480//
2481// For each of these, it adds the name of the prebuilt module (which will be in
2482// prebuilts/ndk) to the list of nonvariant libs.
2483//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002484// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002485//
2486// For each of these, it adds the name of the ndk_library module to the list of
2487// variant libs.
2488//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002489// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002490//
2491// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002492//
2493// The caller can then know to add the variantLibs dependencies differently from the
2494// nonvariantLibs
2495func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2496 variantLibs = []string{}
2497
2498 nonvariantLibs = []string{}
2499 for _, entry := range list {
2500 // strip #version suffix out
2501 name, _ := StubsLibNameAndVersion(entry)
2502 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002503 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002504 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2505 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2506 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002507 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002508 } else {
2509 // put name#version back
2510 nonvariantLibs = append(nonvariantLibs, entry)
2511 }
2512 }
2513 return nonvariantLibs, variantLibs
2514}
2515
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002516func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2517 nonVariantLibs := []string{}
2518 variantLibs := []string{}
2519
2520 for _, lib := range libs {
2521 replaceLibName := GetReplaceModuleName(lib, replaceList)
2522 if replaceLibName == lib {
2523 // Do not handle any libs which are not in API imports
2524 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2525 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2526 variantLibs = append(variantLibs, replaceLibName)
2527 } else {
2528 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2529 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002530 }
2531
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002532 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002533}
2534
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002535func (c *Module) shouldUseApiSurface() bool {
2536 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2537 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2538 // LLNDK Variant
2539 return true
2540 }
2541
2542 if c.Properties.IsSdkVariant {
2543 // NDK Variant
2544 return true
2545 }
2546
2547 if c.isImportedApiLibrary() {
2548 // API Library should depend on API headers
2549 return true
2550 }
2551 }
2552
2553 return false
2554}
2555
Colin Cross1e676be2016-10-12 14:38:15 -07002556func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002557 if !c.Enabled() {
2558 return
2559 }
2560
Colin Cross37047f12016-12-13 17:06:13 -08002561 ctx := &depsContext{
2562 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002563 moduleContextImpl: moduleContextImpl{
2564 mod: c,
2565 },
2566 }
2567 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002568
Colin Crossc99deeb2016-04-11 15:06:20 -07002569 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002570 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002571
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002572 apiNdkLibs := []string{}
2573 apiLateNdkLibs := []string{}
2574
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002575 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002576 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2577 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2578 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2579 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2580 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002581 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002582
Yo Chiang219968c2020-09-22 18:45:04 +08002583 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2584
Colin Crosse0edaf92021-01-11 17:31:17 -08002585 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002586
Dan Albert914449f2016-06-17 16:45:24 -07002587 variantNdkLibs := []string{}
2588 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002589 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002590 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2591 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2592 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002593
2594 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002595 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002596 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002597 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002598
Colin Cross32ec36c2016-12-15 07:39:51 -08002599 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002600 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002601 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002602 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002603 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002604
Kiyoung Kim51279d32022-08-24 14:10:46 +09002605 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002606 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002607 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2608 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002609 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002610
Spandan Das73bcafc2022-08-18 23:26:00 +00002611 if c.isNDKStubLibrary() {
2612 // ndk_headers do not have any variations
2613 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002614 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002615 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002616 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002617 } else {
2618 actx.AddVariationDependencies(nil, depTag, lib)
2619 }
2620 }
2621
Dan Albertf1d14c72020-07-30 14:32:55 -07002622 if c.isNDKStubLibrary() {
2623 // NDK stubs depend on their implementation because the ABI dumps are
2624 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002625
Spandan Das8b08aea2023-03-14 19:29:34 +00002626 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2627 c.ImageVariation(),
2628 blueprint.Variation{Mutator: "link", Variation: "shared"},
2629 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002630 }
2631
Jiyong Park5d1598f2019-02-25 22:14:17 +09002632 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002633 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002634
Kiyoung Kim487689e2022-07-26 09:48:22 +09002635 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002636
Jiyong Park5d1598f2019-02-25 22:14:17 +09002637 actx.AddVariationDependencies([]blueprint.Variation{
2638 {Mutator: "link", Variation: "static"},
2639 }, depTag, lib)
2640 }
2641
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002642 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002643 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002644 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002645 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002646 }
Jiyong Parke3867542020-12-03 17:28:25 +09002647 if inList(lib, deps.ExcludeLibsForApex) {
2648 depTag.excludeInApex = true
2649 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002650
Kiyoung Kim487689e2022-07-26 09:48:22 +09002651 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002652
Dan Willemsen59339a22018-07-22 21:18:45 -07002653 actx.AddVariationDependencies([]blueprint.Variation{
2654 {Mutator: "link", Variation: "static"},
2655 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002656 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002657
Jooyung Han75568392020-03-20 04:29:24 +09002658 // staticUnwinderDep is treated as staticDep for Q apexes
2659 // so that native libraries/binaries are linked with static unwinder
2660 // because Q libc doesn't have unwinder APIs
2661 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002662 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002663 actx.AddVariationDependencies([]blueprint.Variation{
2664 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002665 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002666 }
2667
Jiyong Park7ed9de32018-10-15 22:25:07 +09002668 // shared lib names without the #version suffix
2669 var sharedLibNames []string
2670
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002671 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002672 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002673 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002674 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002675 }
Jiyong Parke3867542020-12-03 17:28:25 +09002676 if inList(lib, deps.ExcludeLibsForApex) {
2677 depTag.excludeInApex = true
2678 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002679 if inList(lib, deps.ExcludeLibsForNonApex) {
2680 depTag.excludeInNonApex = true
2681 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002682
Jiyong Park73c54ee2019-10-22 20:31:18 +09002683 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002684 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2685 name = apiLibraryName
2686 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002687 sharedLibNames = append(sharedLibNames, name)
2688
Colin Crosse7257d22020-09-24 09:56:18 -07002689 variations := []blueprint.Variation{
2690 {Mutator: "link", Variation: "shared"},
2691 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002692
2693 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2694 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2695 }
2696
2697 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2698 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2699 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002700 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002701
Colin Crossfe9acfe2021-06-14 16:13:03 -07002702 for _, lib := range deps.LateStaticLibs {
2703 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2704 actx.AddVariationDependencies([]blueprint.Variation{
2705 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002706 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002707 }
2708
Colin Cross3e5e7782022-06-17 22:17:05 +00002709 for _, lib := range deps.UnexportedStaticLibs {
2710 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2711 actx.AddVariationDependencies([]blueprint.Variation{
2712 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002713 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002714 }
2715
Jiyong Park7ed9de32018-10-15 22:25:07 +09002716 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002717 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002718 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2719 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2720 // linking against both the stubs lib and the non-stubs lib at the same time.
2721 continue
2722 }
Colin Cross6e511a92020-07-27 21:26:48 -07002723 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002724 variations := []blueprint.Variation{
2725 {Mutator: "link", Variation: "shared"},
2726 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002727 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002728 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002729
Dan Willemsen59339a22018-07-22 21:18:45 -07002730 actx.AddVariationDependencies([]blueprint.Variation{
2731 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002732 }, dataLibDepTag, deps.DataLibs...)
2733
Colin Crossc8caa062021-09-24 16:50:14 -07002734 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2735
Chris Parsons79d66a52020-06-05 17:26:16 -04002736 actx.AddVariationDependencies([]blueprint.Variation{
2737 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002738 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002739
Colin Cross68861832016-07-08 10:41:41 -07002740 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002741
2742 for _, gen := range deps.GeneratedHeaders {
2743 depTag := genHeaderDepTag
2744 if inList(gen, deps.ReexportGeneratedHeaders) {
2745 depTag = genHeaderExportDepTag
2746 }
2747 actx.AddDependency(c, depTag, gen)
2748 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002749
Dan Albert92fe7402020-07-15 13:33:30 -07002750 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002751 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002752 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002753 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002754 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002755 }
Colin Crossc465efd2021-06-11 18:00:04 -07002756 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002757 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002758 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002759 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002760 if deps.DynamicLinker != "" {
2761 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002762 }
Dan Albert914449f2016-06-17 16:45:24 -07002763
2764 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002765
2766 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002767 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002768 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002769 {Mutator: "link", Variation: "shared"},
2770 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002771 actx.AddVariationDependencies([]blueprint.Variation{
2772 {Mutator: "version", Variation: version},
2773 {Mutator: "link", Variation: "shared"},
2774 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002775
2776 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002777 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002778 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002779 {Mutator: "link", Variation: "shared"},
2780 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002781 actx.AddVariationDependencies([]blueprint.Variation{
2782 {Mutator: "version", Variation: version},
2783 {Mutator: "link", Variation: "shared"},
2784 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002785
2786 if vndkdep := c.vndkdep; vndkdep != nil {
2787 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002788 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002789 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002790 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002791 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002792 }
2793 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002794
Vinh Tran367d89d2023-04-28 11:21:25 -04002795 if len(deps.AidlLibs) > 0 {
2796 actx.AddDependency(
2797 c,
2798 aidlLibraryTag,
2799 deps.AidlLibs...,
2800 )
2801 }
2802
Kiyoung Kimee58c932022-10-25 22:59:41 +09002803 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002804}
Colin Cross21b9a242015-03-24 14:15:58 -07002805
Colin Crosse40b4ea2018-10-02 22:25:58 -07002806func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002807 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2808 c.beginMutator(ctx)
2809 }
2810}
2811
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002812// Whether a module can link to another module, taking into
2813// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002814func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002815 tag blueprint.DependencyTag) {
2816
2817 switch t := tag.(type) {
2818 case dependencyTag:
2819 if t != vndkExtDepTag {
2820 return
2821 }
2822 case libraryDependencyTag:
2823 default:
2824 return
2825 }
2826
Ivan Lozanof9e21722020-12-02 09:00:51 -05002827 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002828 // Host code is not restricted
2829 return
2830 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002831
2832 // VNDK is cc.Module supported only for now.
2833 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002834 // Though allowed dependency is limited by the image mutator,
2835 // each vendor and product module needs to check link-type
2836 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002837 if ccTo, ok := to.(*Module); ok {
2838 if ccFrom.vndkdep != nil {
2839 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2840 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002841 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002842 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002843 }
2844 return
2845 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002846 // TODO(b/244244438) : Remove this once all variants are implemented
2847 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2848 return
2849 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002850 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002851 // Platform code can link to anything
2852 return
2853 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002854 if from.InRamdisk() {
2855 // Ramdisk code is not NDK
2856 return
2857 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002858 if from.InVendorRamdisk() {
2859 // Vendor ramdisk code is not NDK
2860 return
2861 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002862 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002863 // Recovery code is not NDK
2864 return
2865 }
Colin Cross31076b32020-10-23 17:22:06 -07002866 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002867 if c.NdkPrebuiltStl() {
2868 // These are allowed, but they don't set sdk_version
2869 return
2870 }
2871 if c.StubDecorator() {
2872 // These aren't real libraries, but are the stub shared libraries that are included in
2873 // the NDK.
2874 return
2875 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002876 if c.isImportedApiLibrary() {
2877 // Imported library from the API surface is a stub library built against interface definition.
2878 return
2879 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002880 }
Logan Chien834b9a62019-01-14 15:39:03 +08002881
Ivan Lozano52767be2019-10-18 14:49:46 -07002882 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002883 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2884 // to link to libc++ (non-NDK and without sdk_version).
2885 return
2886 }
2887
Ivan Lozano52767be2019-10-18 14:49:46 -07002888 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002889 // NDK code linking to platform code is never okay.
2890 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002891 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002892 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002893 }
2894
2895 // At this point we know we have two NDK libraries, but we need to
2896 // check that we're not linking against anything built against a higher
2897 // API level, as it is only valid to link against older or equivalent
2898 // APIs.
2899
Inseob Kim01a28722018-04-11 09:48:45 +09002900 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002901 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002902 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002903 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002904 // Current can't be linked against by anything else.
2905 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002906 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002907 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002908 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002909 if err != nil {
2910 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002911 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002912 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002913 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002914 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002915 if err != nil {
2916 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002917 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002918 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002919 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002920
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002921 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002922 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002923 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002924 }
2925 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002926 }
Dan Albert202fe492017-12-15 13:56:59 -08002927
2928 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002929 fromStl := from.SelectedStl()
2930 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002931 if fromStl == "" || toStl == "" {
2932 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002933 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002934 // We can be permissive with the system "STL" since it is only the C++
2935 // ABI layer, but in the future we should make sure that everyone is
2936 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002937 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002938 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002939 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2940 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002941 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002942}
2943
Jooyung Han479ca172020-10-19 18:51:07 +09002944func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2945 if c, ok := ctx.Module().(*Module); ok {
2946 ctx.VisitDirectDeps(func(dep android.Module) {
2947 depTag := ctx.OtherModuleDependencyTag(dep)
2948 ccDep, ok := dep.(LinkableInterface)
2949 if ok {
2950 checkLinkType(ctx, c, ccDep, depTag)
2951 }
2952 })
2953 }
2954}
2955
Jiyong Park5fb8c102018-04-09 12:03:06 +09002956// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002957// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2958// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002959// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002960func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2961 check := func(child, parent android.Module) bool {
2962 to, ok := child.(*Module)
2963 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002964 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002965 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002966
Jooyung Hana70f0672019-01-18 15:20:43 +09002967 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2968 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002969 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002970
Jiyong Park0474e1f2021-01-14 14:26:06 +09002971 // These dependencies are not excercised at runtime. Tracking these will give us
2972 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002973 depTag := ctx.OtherModuleDependencyTag(child)
2974 if IsHeaderDepTag(depTag) {
2975 return false
2976 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002977 if depTag == staticVariantTag {
2978 return false
2979 }
2980 if depTag == stubImplDepTag {
2981 return false
2982 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002983
Justin Yun63e9ec72020-10-29 16:49:43 +09002984 // Even if target lib has no vendor variant, keep checking dependency
2985 // graph in case it depends on vendor_available or product_available
2986 // but not double_loadable transtively.
2987 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002988 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002989 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002990
Jiyong Park0474e1f2021-01-14 14:26:06 +09002991 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2992 // one.
2993 if Bool(to.VendorProperties.Double_loadable) {
2994 return true
2995 }
2996
Ivan Lozanod7586b62021-04-01 09:49:36 -04002997 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002998 return false
2999 }
3000
Jooyung Hana70f0672019-01-18 15:20:43 +09003001 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3002 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003003 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003004 return false
3005 }
3006 if module, ok := ctx.Module().(*Module); ok {
3007 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003008 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003009 ctx.WalkDeps(check)
3010 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003011 }
3012 }
3013}
3014
Yu Liue4312402023-01-18 09:15:31 -08003015func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3016 // For the dependency from platform to apex, use the latest stubs
3017 apexSdkVersion := android.FutureApiLevel
3018 if !apexInfo.IsForPlatform() {
3019 apexSdkVersion = apexInfo.MinSdkVersion
3020 }
3021
3022 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3023 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3024 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3025 // (b/144430859)
3026 apexSdkVersion = android.FutureApiLevel
3027 }
3028
3029 return apexSdkVersion
3030}
3031
Colin Crossc99deeb2016-04-11 15:06:20 -07003032// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003033func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003034 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003035
Colin Cross0de8a1e2020-09-18 14:15:30 -07003036 var directStaticDeps []StaticLibraryInfo
3037 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003038
Colin Cross0de8a1e2020-09-18 14:15:30 -07003039 reexportExporter := func(exporter FlagExporterInfo) {
3040 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3041 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3042 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3043 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3044 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003045 }
3046
Colin Crossff694a82023-12-13 15:54:49 -08003047 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003048 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003049
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003050 skipModuleList := map[string]bool{}
3051
3052 var apiImportInfo multitree.ApiImportInfo
3053 hasApiImportInfo := false
3054
3055 ctx.VisitDirectDeps(func(dep android.Module) {
3056 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003057 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003058 hasApiImportInfo = true
3059 }
3060 })
3061
3062 if hasApiImportInfo {
3063 targetStubModuleList := map[string]string{}
3064 targetOrigModuleList := map[string]string{}
3065
3066 // Search for dependency which both original module and API imported library with APEX stub exists
3067 ctx.VisitDirectDeps(func(dep android.Module) {
3068 depName := ctx.OtherModuleName(dep)
3069 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3070 targetStubModuleList[apiLibrary] = depName
3071 }
3072 })
3073 ctx.VisitDirectDeps(func(dep android.Module) {
3074 depName := ctx.OtherModuleName(dep)
3075 if origLibrary, ok := targetStubModuleList[depName]; ok {
3076 targetOrigModuleList[origLibrary] = depName
3077 }
3078 })
3079
3080 // Decide which library should be used between original and API imported library
3081 ctx.VisitDirectDeps(func(dep android.Module) {
3082 depName := ctx.OtherModuleName(dep)
3083 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003084 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003085 skipModuleList[depName] = true
3086 } else {
3087 skipModuleList[apiLibrary] = true
3088 }
3089 }
3090 })
3091 }
3092
Colin Crossd11fcda2017-10-23 17:59:01 -07003093 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003094 depName := ctx.OtherModuleName(dep)
3095 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003096
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003097 if _, ok := skipModuleList[depName]; ok {
3098 // skip this module because original module or API imported module matching with this should be used instead.
3099 return
3100 }
3101
Dan Willemsen47450072021-10-19 20:24:49 -07003102 if depTag == android.DarwinUniversalVariantTag {
3103 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3104 return
3105 }
3106
Vinh Tran367d89d2023-04-28 11:21:25 -04003107 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003108 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003109 depPaths.AidlLibraryInfos = append(
3110 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003111 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003112 )
3113 }
3114 }
3115
Ivan Lozano52767be2019-10-18 14:49:46 -07003116 ccDep, ok := dep.(LinkableInterface)
3117 if !ok {
3118
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003119 // handling for a few module types that aren't cc Module but that are also supported
3120 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003121 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003122 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003123 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3124 genRule.GeneratedSourceFiles()...)
3125 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003126 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003127 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003128 // Support exported headers from a generated_sources dependency
3129 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003130 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003131 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003132 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003133 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003134 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003135 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003136 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003137 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003138 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3139 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003140 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003141 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
Jiyong Park74955042019-10-22 20:19:51 +09003142 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003143
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003144 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003145 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003146 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003147 }
Colin Crosscef792e2021-06-11 18:01:26 -07003148 case CrtBeginDepTag:
3149 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3150 case CrtEndDepTag:
3151 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003152 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003153 return
3154 }
3155
Colin Crossfe17f6f2019-03-28 19:30:56 -07003156 if depTag == android.ProtoPluginDepTag {
3157 return
3158 }
3159
Colin Crossd11fcda2017-10-23 17:59:01 -07003160 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003161 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3162 return
3163 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003164 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003165 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3166 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003167 return
3168 }
3169
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003170 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003171 // Skip reused objects for stub libraries, they use their own stub object file instead.
3172 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3173 // version mutator, so the stubs variant is created from the shared variant that
3174 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003175 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003176 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003177 objs := staticAnalogue.ReuseObjects
3178 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003179 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003180 reexportExporter(depExporterInfo)
3181 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003182 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003183 }
3184
Colin Cross6e511a92020-07-27 21:26:48 -07003185 linkFile := ccDep.OutputFile()
3186
3187 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3188 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003189 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003190 return
3191 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003192
Jiyong Parke3867542020-12-03 17:28:25 +09003193 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3194 return
3195 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003196 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3197 return
3198 }
Jiyong Parke3867542020-12-03 17:28:25 +09003199
Colin Cross313aa542023-12-13 13:47:44 -08003200 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003201
Colin Cross6e511a92020-07-27 21:26:48 -07003202 var ptr *android.Paths
3203 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003204
Colin Cross6e511a92020-07-27 21:26:48 -07003205 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003206
Colin Cross6e511a92020-07-27 21:26:48 -07003207 switch {
3208 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003209 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003210 if !ctx.Config().AllowMissingDependencies() {
3211 ctx.ModuleErrorf("module %q is not a header library", depName)
3212 } else {
3213 ctx.AddMissingDependencies([]string{depName})
3214 }
3215 return
3216 }
Colin Cross6e511a92020-07-27 21:26:48 -07003217 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003218 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003219 if !ctx.Config().AllowMissingDependencies() {
3220 ctx.ModuleErrorf("module %q is not a shared library", depName)
3221 } else {
3222 ctx.AddMissingDependencies([]string{depName})
3223 }
3224 return
3225 }
Jiyong Parke3867542020-12-03 17:28:25 +09003226
Jiyong Park7d55b612021-06-11 17:22:09 +09003227 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3228 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003229
Jiyong Park1ad8e162020-12-01 23:40:09 +09003230 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3231 // linkFile, depFile, and ptr.
3232 if c.IsStubs() {
3233 break
3234 }
3235
Colin Cross0de8a1e2020-09-18 14:15:30 -07003236 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3237 depFile = sharedLibraryInfo.TableOfContents
3238
Colin Cross6e511a92020-07-27 21:26:48 -07003239 ptr = &depPaths.SharedLibs
3240 switch libDepTag.Order {
3241 case earlyLibraryDependency:
3242 ptr = &depPaths.EarlySharedLibs
3243 depPtr = &depPaths.EarlySharedLibsDeps
3244 case normalLibraryDependency:
3245 ptr = &depPaths.SharedLibs
3246 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003247 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003248 case lateLibraryDependency:
3249 ptr = &depPaths.LateSharedLibs
3250 depPtr = &depPaths.LateSharedLibsDeps
3251 default:
3252 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003253 }
Colin Cross6e511a92020-07-27 21:26:48 -07003254 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003255 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3256 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003257 if !ctx.Config().AllowMissingDependencies() {
3258 ctx.ModuleErrorf("module %q is not a static library", depName)
3259 } else {
3260 ctx.AddMissingDependencies([]string{depName})
3261 }
3262 return
3263 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003264
3265 // Stubs lib doesn't link to the static lib dependencies. Don't set
3266 // linkFile, depFile, and ptr.
3267 if c.IsStubs() {
3268 break
3269 }
3270
Colin Cross0de8a1e2020-09-18 14:15:30 -07003271 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003272 if libDepTag.wholeStatic {
3273 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003274 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3275 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003276 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003277 // This case normally catches prebuilt static
3278 // libraries, but it can also occur when
3279 // AllowMissingDependencies is on and the
3280 // dependencies has no sources of its own
3281 // but has a whole_static_libs dependency
3282 // on a missing library. We want to depend
3283 // on the .a file so that there is something
3284 // in the dependency tree that contains the
3285 // error rule for the missing transitive
3286 // dependency.
3287 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003288 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003289 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3290 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003291 } else {
3292 switch libDepTag.Order {
3293 case earlyLibraryDependency:
3294 panic(fmt.Errorf("early static libs not suppported"))
3295 case normalLibraryDependency:
3296 // static dependencies will be handled separately so they can be ordered
3297 // using transitive dependencies.
3298 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003299 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003300 case lateLibraryDependency:
3301 ptr = &depPaths.LateStaticLibs
3302 default:
3303 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003304 }
3305 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003306 if libDepTag.unexportedSymbols {
3307 depPaths.LdFlags = append(depPaths.LdFlags,
3308 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3309 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003310 }
3311
Colin Cross6e511a92020-07-27 21:26:48 -07003312 if libDepTag.static() && !libDepTag.wholeStatic {
3313 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3314 ctx.ModuleErrorf("module %q not a static library", depName)
3315 return
3316 }
Logan Chien43d34c32017-12-20 01:17:32 +08003317
Colin Cross6e511a92020-07-27 21:26:48 -07003318 // When combining coverage files for shared libraries and executables, coverage files
3319 // in static libraries act as if they were whole static libraries. The same goes for
3320 // source based Abi dump files.
3321 if c, ok := ccDep.(*Module); ok {
3322 staticLib := c.linker.(libraryInterface)
3323 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3324 staticLib.objs().coverageFiles...)
3325 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3326 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003327 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003328 // Handle non-CC modules here
3329 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003330 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003331 }
3332 }
3333
Colin Cross6e511a92020-07-27 21:26:48 -07003334 if ptr != nil {
3335 if !linkFile.Valid() {
3336 if !ctx.Config().AllowMissingDependencies() {
3337 ctx.ModuleErrorf("module %q missing output file", depName)
3338 } else {
3339 ctx.AddMissingDependencies([]string{depName})
3340 }
3341 return
3342 }
3343 *ptr = append(*ptr, linkFile.Path())
3344 }
3345
3346 if depPtr != nil {
3347 dep := depFile
3348 if !dep.Valid() {
3349 dep = linkFile
3350 }
3351 *depPtr = append(*depPtr, dep.Path())
3352 }
3353
Colin Cross0de8a1e2020-09-18 14:15:30 -07003354 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3355 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3356 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3357 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3358
3359 if libDepTag.reexportFlags {
3360 reexportExporter(depExporterInfo)
3361 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3362 // Re-exported shared library headers must be included as well since they can help us with type information
3363 // about template instantiations (instantiated from their headers).
3364 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3365 // scripts.
3366 c.sabi.Properties.ReexportedIncludes = append(
3367 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3368 }
3369
Spandan Das3faa7922024-02-26 19:42:32 +00003370 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003371 switch {
3372 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003373 c.Properties.AndroidMkHeaderLibs = append(
3374 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003375 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003376 if lib := moduleLibraryInterface(dep); lib != nil {
3377 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003378 // Add the dependency to the APEX(es) providing the library so that
3379 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003380 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003381 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003382 c.Properties.ApexesProvidingSharedLibs = append(
3383 c.Properties.ApexesProvidingSharedLibs, an)
3384 }
3385 }
3386 }
3387
3388 // Note: the order of libs in this list is not important because
3389 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003390 c.Properties.AndroidMkSharedLibs = append(
3391 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003392 // Record BaseLibName for snapshots.
3393 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003394 case libDepTag.static():
3395 if libDepTag.wholeStatic {
3396 c.Properties.AndroidMkWholeStaticLibs = append(
3397 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3398 } else {
3399 c.Properties.AndroidMkStaticLibs = append(
3400 c.Properties.AndroidMkStaticLibs, makeLibName)
3401 }
Justin Yun5e035862021-06-29 20:50:37 +09003402 // Record BaseLibName for snapshots.
3403 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003404 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003405 } else if !c.IsStubs() {
3406 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3407
Colin Cross6e511a92020-07-27 21:26:48 -07003408 switch depTag {
3409 case runtimeDepTag:
3410 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003411 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003412 // Record BaseLibName for snapshots.
3413 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003414 case objDepTag:
3415 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3416 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003417 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003418 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003419 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003420 case dynamicLinkerDepTag:
3421 depPaths.DynamicLinker = linkFile
3422 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003423 }
Colin Crossca860ac2016-01-04 14:34:37 -08003424 })
3425
Jeff Gaston294356f2017-09-27 17:05:30 -07003426 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003427 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3428 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3429 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003430
Colin Crossdd84e052017-05-17 13:44:16 -07003431 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003432 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003433 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3434 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003435 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003436 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3437 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003438 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003439 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003440 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003441
3442 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003443 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003444 }
Colin Crossdd84e052017-05-17 13:44:16 -07003445
Colin Crossca860ac2016-01-04 14:34:37 -08003446 return depPaths
3447}
3448
Spandan Das604f3762023-03-16 22:51:40 +00003449func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003450 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003451 thisModule, ok := ctx.Module().(android.ApexModule)
3452 if !ok {
3453 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3454 }
3455
Kiyoung Kimaa394802024-01-08 12:55:45 +09003456 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003457 bootstrap := false
3458 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3459 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3460 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003461 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003462 bootstrap = linkable.Bootstrap()
3463 }
3464
Colin Crossff694a82023-12-13 15:54:49 -08003465 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003466
3467 useStubs := false
3468
Kiyoung Kimaa394802024-01-08 12:55:45 +09003469 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003470 if !apexInfo.IsForPlatform() {
3471 // For platform libraries, use current version of LLNDK
3472 // If this is for use_vendor apex we will apply the same rules
3473 // of apex sdk enforcement below to choose right version.
3474 useStubs = true
3475 }
3476 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3477 // If not building for APEX or the containing APEX allows the use of
3478 // platform APIs, use stubs only when it is from an APEX (and not from
3479 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3480 // bootstrap modules, always link to non-stub variant
3481 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3482
3483 isApexImportedApiLibrary := false
3484
3485 if cc, ok := dep.(*Module); ok {
3486 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3487 if apiLibrary.hasApexStubs() {
3488 isApexImportedApiLibrary = true
3489 }
3490 }
3491 }
3492
3493 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3494
3495 if useStubs {
3496 // Another exception: if this module is a test for an APEX, then
3497 // it is linked with the non-stub variant of a module in the APEX
3498 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003499 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003500 for _, apexContents := range testFor.ApexContents {
3501 if apexContents.DirectlyInApex(depName) {
3502 useStubs = false
3503 break
3504 }
3505 }
3506 }
3507 if useStubs {
3508 // Yet another exception: If this module and the dependency are
3509 // available to the same APEXes then skip stubs between their
3510 // platform variants. This complements the test_for case above,
3511 // which avoids the stubs on a direct APEX library dependency, by
3512 // avoiding stubs for indirect test dependencies as well.
3513 //
3514 // TODO(b/183882457): This doesn't work if the two libraries have
3515 // only partially overlapping apex_available. For that test_for
3516 // modules would need to be split into APEX variants and resolved
3517 // separately for each APEX they have access to.
3518 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3519 useStubs = false
3520 }
3521 }
3522 } else {
3523 // If building for APEX, use stubs when the parent is in any APEX that
3524 // the child is not in.
3525 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3526 }
3527
3528 return useStubs
3529}
3530
3531// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3532// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3533// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3534// has different level of updatability. For example, if a library foo in an APEX depends on a
3535// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3536// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3537// same APEX as foo, the non-stub variant of bar is used.
3538func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3539 depTag := ctx.OtherModuleDependencyTag(dep)
3540 libDepTag, ok := depTag.(libraryDependencyTag)
3541 if !ok || !libDepTag.shared() {
3542 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3543 }
3544
Colin Cross313aa542023-12-13 13:47:44 -08003545 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3546 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3547 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003548
3549 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003550 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003551 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003552 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3553 toUse := stubs[len(stubs)-1]
3554 sharedLibraryInfo = toUse.SharedLibraryInfo
3555 depExporterInfo = toUse.FlagExporterInfo
3556 }
3557 }
3558 return sharedLibraryInfo, depExporterInfo
3559}
3560
Colin Cross0de8a1e2020-09-18 14:15:30 -07003561// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3562// to match the topological order of the dependency tree, including any static analogues of
3563// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3564// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003565func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3566 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003567 var staticPaths android.Paths
3568 for _, staticDep := range staticDeps {
3569 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3570 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3571 }
3572 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003573 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3574 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003575 }
3576 }
3577 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3578
3579 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3580
3581 // reorder the dependencies based on transitive dependencies
3582 staticPaths = android.FirstUniquePaths(staticPaths)
3583 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3584
3585 if len(orderedStaticPaths) != len(staticPaths) {
3586 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3587 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3588 }
3589
3590 return orderedStaticPaths, transitiveStaticLibs
3591}
3592
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003593// BaseLibName trims known prefixes and suffixes
3594func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003595 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3596 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003597 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003598 return libName
3599}
3600
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003601func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003602 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003603 ccDepModule, _ := ccDep.(*Module)
3604 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003605 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003606
Justin Yuncbca3732021-02-03 19:24:13 +09003607 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003608 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003609 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003610 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003611
Ivan Lozanod1dec542021-05-26 15:33:11 -04003612 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003613 }
3614 }
3615
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003616 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3617 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003618 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3619 // core module instead.
3620 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003621 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003622 // The vendor and product modules in Make will have been renamed to not conflict with the
3623 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003624 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003625 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003626 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003627 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003628 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003629 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003630 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003631 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003632 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003633 } else {
3634 return libName
3635 }
3636}
3637
Colin Crossca860ac2016-01-04 14:34:37 -08003638func (c *Module) InstallInData() bool {
3639 if c.installer == nil {
3640 return false
3641 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003642 return c.installer.inData()
3643}
3644
3645func (c *Module) InstallInSanitizerDir() bool {
3646 if c.installer == nil {
3647 return false
3648 }
3649 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003650 return true
3651 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003652 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003653}
3654
Yifan Hong1b3348d2020-01-21 15:53:22 -08003655func (c *Module) InstallInRamdisk() bool {
3656 return c.InRamdisk()
3657}
3658
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003659func (c *Module) InstallInVendorRamdisk() bool {
3660 return c.InVendorRamdisk()
3661}
3662
Jiyong Parkf9332f12018-02-01 00:54:12 +09003663func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003664 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003665}
3666
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003667func (c *Module) MakeUninstallable() {
3668 if c.installer == nil {
3669 c.ModuleBase.MakeUninstallable()
3670 return
3671 }
3672 c.installer.makeUninstallable(c)
3673}
3674
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003675func (c *Module) HostToolPath() android.OptionalPath {
3676 if c.installer == nil {
3677 return android.OptionalPath{}
3678 }
3679 return c.installer.hostToolPath()
3680}
3681
Nan Zhangd4e641b2017-07-12 12:55:28 -07003682func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3683 return c.outputFile
3684}
3685
Colin Cross41955e82019-05-29 14:40:35 -07003686func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3687 switch tag {
3688 case "":
3689 if c.outputFile.Valid() {
3690 return android.Paths{c.outputFile.Path()}, nil
3691 }
3692 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003693 case "unstripped":
3694 if c.linker != nil {
3695 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3696 }
3697 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003698 case "stripped_all":
3699 if c.linker != nil {
3700 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3701 }
3702 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003703 default:
3704 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003705 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003706}
3707
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003708func (c *Module) static() bool {
3709 if static, ok := c.linker.(interface {
3710 static() bool
3711 }); ok {
3712 return static.static()
3713 }
3714 return false
3715}
3716
Jiyong Park379de2f2018-12-19 02:47:14 +09003717func (c *Module) staticBinary() bool {
3718 if static, ok := c.linker.(interface {
3719 staticBinary() bool
3720 }); ok {
3721 return static.staticBinary()
3722 }
3723 return false
3724}
3725
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003726func (c *Module) testBinary() bool {
3727 if test, ok := c.linker.(interface {
3728 testBinary() bool
3729 }); ok {
3730 return test.testBinary()
3731 }
3732 return false
3733}
3734
Jingwen Chen537242c2022-08-24 11:53:27 +00003735func (c *Module) testLibrary() bool {
3736 if test, ok := c.linker.(interface {
3737 testLibrary() bool
3738 }); ok {
3739 return test.testLibrary()
3740 }
3741 return false
3742}
3743
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003744func (c *Module) benchmarkBinary() bool {
3745 if b, ok := c.linker.(interface {
3746 benchmarkBinary() bool
3747 }); ok {
3748 return b.benchmarkBinary()
3749 }
3750 return false
3751}
3752
3753func (c *Module) fuzzBinary() bool {
3754 if f, ok := c.linker.(interface {
3755 fuzzBinary() bool
3756 }); ok {
3757 return f.fuzzBinary()
3758 }
3759 return false
3760}
3761
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003762// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3763func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003764 if h, ok := c.linker.(interface {
3765 header() bool
3766 }); ok {
3767 return h.header()
3768 }
3769 return false
3770}
3771
Ivan Lozanod7586b62021-04-01 09:49:36 -04003772func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003773 if b, ok := c.linker.(interface {
3774 binary() bool
3775 }); ok {
3776 return b.binary()
3777 }
3778 return false
3779}
3780
Justin Yun5e035862021-06-29 20:50:37 +09003781func (c *Module) StaticExecutable() bool {
3782 if b, ok := c.linker.(*binaryDecorator); ok {
3783 return b.static()
3784 }
3785 return false
3786}
3787
Ivan Lozanod7586b62021-04-01 09:49:36 -04003788func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003789 if o, ok := c.linker.(interface {
3790 object() bool
3791 }); ok {
3792 return o.object()
3793 }
3794 return false
3795}
3796
Ivan Lozanof9e21722020-12-02 09:00:51 -05003797func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003798 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003799 if c.IsLlndk() {
3800 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003801 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003802 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003803 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003804 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003805 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003806 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003807 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003808 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003809 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003810 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003811 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003812 return "native:product"
3813 }
Jooyung Han38002912019-05-16 04:01:54 +09003814 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003815 } else if c.InRamdisk() {
3816 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003817 } else if c.InVendorRamdisk() {
3818 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003819 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003820 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003821 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003822 return "native:ndk:none:none"
3823 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3824 //family, link := getNdkStlFamilyAndLinkType(c)
3825 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003826 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003827 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003828 } else {
3829 return "native:platform"
3830 }
3831}
3832
Jiyong Park9d452992018-10-03 00:38:19 +09003833// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003834// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003835func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003836 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003837 // Stub libs and prebuilt libs in a versioned SDK are not
3838 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003839 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003840 } else if _, ok := c.linker.(testPerSrc); ok {
3841 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003842 }
3843 return false
3844}
3845
Jiyong Parka90ca002019-10-07 15:47:24 +09003846func (c *Module) AvailableFor(what string) bool {
3847 if linker, ok := c.linker.(interface {
3848 availableFor(string) bool
3849 }); ok {
3850 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3851 } else {
3852 return c.ApexModuleBase.AvailableFor(what)
3853 }
3854}
3855
Jiyong Park62304bb2020-04-13 16:19:48 +09003856func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003857 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003858}
3859
Paul Duffin0cb37b92020-03-04 14:52:46 +00003860func (c *Module) EverInstallable() bool {
3861 return c.installer != nil &&
3862 // Check to see whether the module is actually ever installable.
3863 c.installer.everInstallable()
3864}
3865
Ivan Lozanod7586b62021-04-01 09:49:36 -04003866func (c *Module) PreventInstall() bool {
3867 return c.Properties.PreventInstall
3868}
3869
3870func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003871 if c.library != nil {
3872 if i := c.library.installable(); i != nil {
3873 return i
3874 }
3875 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003876 return c.Properties.Installable
3877}
3878
3879func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003880 ret := c.EverInstallable() &&
3881 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003882 proptools.BoolDefault(c.Installable(), true) &&
3883 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003884
3885 // The platform variant doesn't need further condition. Apex variants however might not
3886 // be installable because it will likely to be included in the APEX and won't appear
3887 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003888 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003889 return ret
3890 }
3891
3892 // Special case for modules that are configured to be installed to /data, which includes
3893 // test modules. For these modules, both APEX and non-APEX variants are considered as
3894 // installable. This is because even the APEX variants won't be included in the APEX, but
3895 // will anyway be installed to /data/*.
3896 // See b/146995717
3897 if c.InstallInData() {
3898 return ret
3899 }
3900
3901 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003902}
3903
Logan Chien41eabe62019-04-10 13:33:58 +08003904func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3905 if c.linker != nil {
3906 if library, ok := c.linker.(*libraryDecorator); ok {
3907 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3908 }
3909 }
3910}
3911
Jiyong Park45bf82e2020-12-15 22:29:02 +09003912var _ android.ApexModule = (*Module)(nil)
3913
3914// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003915func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003916 depTag := ctx.OtherModuleDependencyTag(dep)
3917 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3918
3919 if cc, ok := dep.(*Module); ok {
3920 if cc.HasStubsVariants() {
3921 if isLibDepTag && libDepTag.shared() {
3922 // dynamic dep to a stubs lib crosses APEX boundary
3923 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003924 }
Colin Cross6e511a92020-07-27 21:26:48 -07003925 if IsRuntimeDepTag(depTag) {
3926 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003927 return false
3928 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003929 }
Zhijun Heec285872021-04-24 10:47:08 -07003930 if cc.IsLlndk() {
3931 return false
3932 }
Colin Crossaac32222020-07-29 12:51:56 -07003933 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003934 // shared_lib dependency from a static lib is considered as crossing
3935 // the APEX boundary because the dependency doesn't actually is
3936 // linked; the dependency is used only during the compilation phase.
3937 return false
3938 }
Jiyong Parke3867542020-12-03 17:28:25 +09003939
3940 if isLibDepTag && libDepTag.excludeInApex {
3941 return false
3942 }
Colin Cross6e511a92020-07-27 21:26:48 -07003943 }
Colin Crossc1b36442021-05-06 13:42:48 -07003944 if depTag == stubImplDepTag {
3945 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003946 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003947 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003948 if depTag == staticVariantTag {
3949 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3950 // actually mean that the static lib (and its dependencies) are copied into the
3951 // APEX.
3952 return false
3953 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003954 return true
3955}
3956
Jiyong Park45bf82e2020-12-15 22:29:02 +09003957// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003958func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3959 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003960 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3961 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3962 return nil
3963 }
Jooyung Han749dc692020-04-15 11:03:39 +09003964 // We don't check for prebuilt modules
3965 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3966 return nil
3967 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003968
Jooyung Han749dc692020-04-15 11:03:39 +09003969 minSdkVersion := c.MinSdkVersion()
3970 if minSdkVersion == "apex_inherit" {
3971 return nil
3972 }
3973 if minSdkVersion == "" {
3974 // JNI libs within APK-in-APEX fall into here
3975 // Those are okay to set sdk_version instead
3976 // We don't have to check if this is a SDK variant because
3977 // non-SDK variant resets sdk_version, which works too.
3978 minSdkVersion = c.SdkVersion()
3979 }
Dan Albertc8060532020-07-22 22:32:17 -07003980 if minSdkVersion == "" {
3981 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3982 }
3983 // Not using nativeApiLevelFromUser because the context here is not
3984 // necessarily a native context.
3985 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003986 if err != nil {
3987 return err
3988 }
Dan Albertc8060532020-07-22 22:32:17 -07003989
Colin Cross8ca61c12022-10-06 21:00:14 -07003990 // A dependency only needs to support a min_sdk_version at least
3991 // as high as the api level that the architecture was introduced in.
3992 // This allows introducing new architectures in the platform that
3993 // need to be included in apexes that normally require an older
3994 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003995 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003996 if sdkVersion.LessThan(minApiForArch) {
3997 sdkVersion = minApiForArch
3998 }
3999
Dan Albertc8060532020-07-22 22:32:17 -07004000 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004001 return fmt.Errorf("newer SDK(%v)", ver)
4002 }
4003 return nil
4004}
4005
Paul Duffinb5769c12021-05-12 16:16:51 +01004006// Implements android.ApexModule
4007func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4008 // stub libraries and native bridge libraries are always available to platform
4009 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4010}
4011
Jooyung Han91f92032022-02-04 12:36:33 +09004012// Overrides android.ApexModuleBase.UniqueApexVariations
4013func (c *Module) UniqueApexVariations() bool {
4014 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4015 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4016 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004017 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004018 return c.UseVndk() && c.IsVndk()
4019}
4020
Inseob Kima1888ce2022-10-04 14:42:02 +09004021func (c *Module) overriddenModules() []string {
4022 if o, ok := c.linker.(overridable); ok {
4023 return o.overriddenModules()
4024 }
4025 return nil
4026}
4027
Rob Seymour925aa092021-08-10 20:42:03 +00004028var _ snapshot.RelativeInstallPath = (*Module)(nil)
4029
Liz Kammer35ca77e2021-12-22 15:31:40 -05004030type moduleType int
4031
4032const (
4033 unknownType moduleType = iota
4034 binary
4035 object
4036 fullLibrary
4037 staticLibrary
4038 sharedLibrary
4039 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004040 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004041 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004042 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004043)
4044
4045func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004046 if c.testBinary() {
4047 // testBinary is also a binary, so this comes before the c.Binary()
4048 // conditional. A testBinary has additional implicit dependencies and
4049 // other test-only semantics.
4050 return testBin
4051 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004052 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004053 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004054 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004055 } else if c.testLibrary() {
4056 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4057 // will let them add implicit compile deps on gtest, for example.
4058 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004059 // For now, treat them as regular libraries.
4060 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004061 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004062 static := false
4063 shared := false
4064 if library, ok := c.linker.(*libraryDecorator); ok {
4065 static = library.MutatedProperties.BuildStatic
4066 shared = library.MutatedProperties.BuildShared
4067 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4068 static = library.MutatedProperties.BuildStatic
4069 shared = library.MutatedProperties.BuildShared
4070 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004071 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004072 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004073 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004074 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004075 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004076 return staticLibrary
4077 }
4078 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004079 } else if c.isNDKStubLibrary() {
4080 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004081 } else if c.IsNdkPrebuiltStl() {
4082 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004083 }
4084 return unknownType
4085}
4086
Colin Crosscfad1192015-11-02 16:43:11 -08004087// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004088type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004089 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004090 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004091 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004092
4093 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4094 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004095}
4096
Patrice Arrudac249c712019-03-19 17:00:29 -07004097// cc_defaults provides a set of properties that can be inherited by other cc
4098// modules. A module can use the properties from a cc_defaults using
4099// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4100// merged (when possible) by prepending the default module's values to the
4101// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004102func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004103 return DefaultsFactory()
4104}
4105
Colin Cross36242852017-06-23 15:06:31 -07004106func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004107 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004108
Colin Cross36242852017-06-23 15:06:31 -07004109 module.AddProperties(props...)
4110 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004111 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004112 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004113 &BaseCompilerProperties{},
4114 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004115 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004116 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004117 &StaticProperties{},
4118 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004119 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004120 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004121 &TestLinkerProperties{},
4122 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004123 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004124 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004125 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004126 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004127 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004128 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004129 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004130 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004131 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004132 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004133 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004134 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004135 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004136 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004137 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004138 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4139 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004140 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004141 )
Colin Crosscfad1192015-11-02 16:43:11 -08004142
Jooyung Hancc372c52019-09-25 15:18:44 +09004143 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004144
4145 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004146}
4147
Jiyong Park2286afd2020-06-16 21:58:53 +09004148func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004149 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004150}
4151
Kiyoung Kim51279d32022-08-24 14:10:46 +09004152func (c *Module) isImportedApiLibrary() bool {
4153 _, ok := c.linker.(*apiLibraryDecorator)
4154 return ok
4155}
4156
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004157func kytheExtractAllFactory() android.Singleton {
4158 return &kytheExtractAllSingleton{}
4159}
4160
4161type kytheExtractAllSingleton struct {
4162}
4163
4164func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4165 var xrefTargets android.Paths
4166 ctx.VisitAllModules(func(module android.Module) {
4167 if ccModule, ok := module.(xref); ok {
4168 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4169 }
4170 })
4171 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4172 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004173 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004174 }
4175}
4176
Jihoon Kangf78a8902022-09-01 22:47:07 +00004177func (c *Module) Partition() string {
4178 if p, ok := c.installer.(interface {
4179 getPartition() string
4180 }); ok {
4181 return p.getPartition()
4182 }
4183 return ""
4184}
4185
Spandan Das2b6dfb52024-01-19 00:22:22 +00004186type sourceModuleName interface {
4187 sourceModuleName() string
4188}
4189
4190func (c *Module) BaseModuleName() string {
4191 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4192 // if the prebuilt module sets a source_module_name in Android.bp, use that
4193 return smn.sourceModuleName()
4194 }
4195 return c.ModuleBase.BaseModuleName()
4196}
4197
Colin Cross06a931b2015-10-28 17:23:31 -07004198var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004199var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004200var BoolPtr = proptools.BoolPtr
4201var String = proptools.String
4202var StringPtr = proptools.StringPtr