blob: 31fa4fdcd50b75ee96abd39db28072fb10759b2f [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()
Vinh Tran44cb78c2023-03-09 22:07:19 -050058 ctx.BottomUp("fdo_profile", fdoProfileMutator)
Colin Cross1e676be2016-10-12 14:38:15 -070059 })
Colin Cross16b23492016-01-06 14:41:07 -080060
Paul Duffin036e7002019-12-19 19:16:28 +000061 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040062 for _, san := range Sanitizers {
63 san.registerMutators(ctx)
64 }
Dan Willemsen581341d2017-02-09 16:16:31 -080065
Colin Cross0b908332019-06-19 23:00:20 -070066 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090067 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080068
Cory Barkera1da26f2022-06-07 20:12:06 +000069 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000070
Colin Crossf5f4ad32024-01-19 15:41:48 -080071 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070072
Yi Kongeb8efc92021-12-09 18:06:29 +080073 ctx.TopDown("afdo_deps", afdoDepsMutator)
74 ctx.BottomUp("afdo", afdoMutator).Parallel()
75
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000076 ctx.TopDown("orderfile_deps", orderfileDepsMutator)
77 ctx.BottomUp("orderfile", orderfileMutator).Parallel()
78
Colin Cross6ac83a82024-01-23 11:23:10 -080079 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090080
Jooyung Han479ca172020-10-19 18:51:07 +090081 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090082 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070083 })
Colin Crossb98c8b02016-07-29 13:44:28 -070084
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080085 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
86 // sabi mutator needs to be run after apex mutator finishes.
87 ctx.TopDown("sabi_deps", sabiDepsMutator)
88 })
89
LaMont Jones0c10e4d2023-05-16 00:58:37 +000090 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070091}
92
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050093// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
94// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
95// edges to these modules.
96// This object is constructed in DepsMutator, by calling to various module delegates to set
97// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
98// dependencies.
99// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
100// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800101type Deps struct {
102 SharedLibs, LateSharedLibs []string
103 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800104 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800105 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700106
Colin Cross3e5e7782022-06-17 22:17:05 +0000107 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
108 // prevent automatically exporting symbols.
109 UnexportedStaticLibs []string
110
Chris Parsons79d66a52020-06-05 17:26:16 -0400111 // Used for data dependencies adjacent to tests
112 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700113 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400114
Yo Chiang219968c2020-09-22 18:45:04 +0800115 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
116 SystemSharedLibs []string
117
Vinh Tran367d89d2023-04-28 11:21:25 -0400118 // Used by DepMutator to pass aidl_library modules to aidl compiler
119 AidlLibs []string
120
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500121 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800122 StaticUnwinderIfLegacy bool
123
Colin Cross5950f382016-12-13 12:50:57 -0800124 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700125
Colin Cross81413472016-04-11 14:37:39 -0700126 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700127
Dan Willemsenb40aab62016-04-20 14:21:14 -0700128 GeneratedSources []string
129 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900130 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700131
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700132 ReexportGeneratedHeaders []string
133
Colin Crossc465efd2021-06-11 18:00:04 -0700134 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700135
136 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700137 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900138
139 // List of libs that need to be excluded for APEX variant
140 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900141 // List of libs that need to be excluded for non-APEX variant
142 ExcludeLibsForNonApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700143}
144
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500145// PathDeps is a struct containing file paths to dependencies of a module.
146// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
147// It's used to construct flags for various build statements (such as for compiling and linking).
148// It is then passed to module decorator functions responsible for registering build statements
149// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800150type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700151 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900152 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700153 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900154 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700155 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700156 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700157
Colin Cross0de8a1e2020-09-18 14:15:30 -0700158 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700159 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700160
Colin Cross26c34ed2016-09-30 17:10:16 -0700161 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100162 Objs Objects
163 // Paths to .o files in dependencies that provide them. Note that these lists
164 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800165 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700166 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700167
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100168 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
169 // the libs from all whole_static_lib dependencies.
170 WholeStaticLibsFromPrebuilts android.Paths
171
Colin Cross26c34ed2016-09-30 17:10:16 -0700172 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700173 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900174 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700175
Inseob Kimd110f872019-12-06 13:15:38 +0900176 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000177 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900178 IncludeDirs android.Paths
179 SystemIncludeDirs android.Paths
180 ReexportedDirs android.Paths
181 ReexportedSystemDirs android.Paths
182 ReexportedFlags []string
183 ReexportedGeneratedHeaders android.Paths
184 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700185
Colin Cross26c34ed2016-09-30 17:10:16 -0700186 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700187 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700188
Dan Willemsena0790e32018-10-12 00:24:23 -0700189 // Path to the dynamic linker binary
190 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700191
192 // For Darwin builds, the path to the second architecture's output that should
193 // be combined with this architectures's output into a FAT MachO file.
194 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400195
196 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
197 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700198}
199
Colin Cross4af21ed2019-11-04 09:37:55 -0800200// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
201// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
202// command line so they can be overridden by the local module flags).
203type LocalOrGlobalFlags struct {
204 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700205 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800206 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700207 CFlags []string // Flags that apply to C and C++ source files
208 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
209 ConlyFlags []string // Flags that apply to C source files
210 CppFlags []string // Flags that apply to C++ source files
211 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700212 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800213}
214
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500215// Flags contains various types of command line flags (and settings) for use in building build
216// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800217type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500218 // Local flags (which individual modules are responsible for). These may override global flags.
219 Local LocalOrGlobalFlags
220 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800221 Global LocalOrGlobalFlags
222
223 aidlFlags []string // Flags that apply to aidl source files
224 rsFlags []string // Flags that apply to renderscript source files
225 libFlags []string // Flags to add libraries early to the link order
226 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
227 TidyFlags []string // Flags that apply to clang-tidy
228 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700229
Colin Crossc3199482017-03-30 15:03:04 -0700230 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800231 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700232 SystemIncludeFlags []string
233
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800234 Toolchain config.Toolchain
235 Tidy bool // True if ninja .tidy rules should be generated.
236 NeedTidyFiles bool // True if module link should depend on .tidy files
237 GcovCoverage bool // True if coverage files should be generated.
238 SAbiDump bool // True if header abi dumps should be generated.
239 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800240
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500241 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800242 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500243 // The target-device system path to the dynamic linker.
244 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800245
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700246 CFlagsDeps android.Paths // Files depended on by compiler flags
247 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800248
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500249 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700250 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800251
Colin Cross19878da2019-03-28 14:45:07 -0700252 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700253 protoC bool // Whether to use C instead of C++
254 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700255
256 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200257 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700258}
259
Colin Crossca860ac2016-01-04 14:34:37 -0800260// Properties used to compile all C or C++ modules
261type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700262 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800263 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700264
Jiyong Parkb35a8192020-08-10 15:59:36 +0900265 // The API level that this module is built against. The APIs of this API level will be
266 // visible at build time, but use of any APIs newer than min_sdk_version will render the
267 // module unloadable on older devices. In the future it will be possible to weakly-link new
268 // APIs, making the behavior match Java: such modules will load on older devices, but
269 // calling new APIs on devices that do not support them will result in a crash.
270 //
271 // This property has the same behavior as sdk_version does for Java modules. For those
272 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
273 // does for Java code.
274 //
275 // In addition, setting this property causes two variants to be built, one for the platform
276 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800277 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700278
Jiyong Parkb35a8192020-08-10 15:59:36 +0900279 // Minimum OS API level supported by this C or C++ module. This property becomes the value
280 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
281 // this property is also used to ensure that the min_sdk_version of the containing module is
282 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
283 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
284 // min_sdk_version of the containing APEX. When the module
285 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900286 Min_sdk_version *string
287
Colin Crossc511bc52020-04-07 16:50:32 +0000288 // If true, always create an sdk variant and don't create a platform variant.
289 Sdk_variant_only *bool
290
Jiyong Parkde866cb2018-12-07 23:08:36 +0900291 AndroidMkSharedLibs []string `blueprint:"mutated"`
292 AndroidMkStaticLibs []string `blueprint:"mutated"`
293 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
294 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700295 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900296 HideFromMake bool `blueprint:"mutated"`
297 PreventInstall bool `blueprint:"mutated"`
298 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700299
Yo Chiang219968c2020-09-22 18:45:04 +0800300 // Set by DepsMutator.
301 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
302
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900303 // The name of the image this module is built for
304 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200305
306 // The VNDK version this module is built against. If empty, the module is not
307 // build against the VNDK.
308 VndkVersion string `blueprint:"mutated"`
309
310 // Suffix for the name of Android.mk entries generated by this module
311 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800312
313 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
314 // file
315 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900316
Yifan Hong39143a92020-10-26 12:43:12 -0700317 // Make this module available when building for ramdisk.
318 // On device without a dedicated recovery partition, the module is only
319 // available after switching root into
320 // /first_stage_ramdisk. To expose the module before switching root, install
321 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800322 Ramdisk_available *bool
323
Yifan Hong39143a92020-10-26 12:43:12 -0700324 // Make this module available when building for vendor ramdisk.
325 // On device without a dedicated recovery partition, the module is only
326 // available after switching root into
327 // /first_stage_ramdisk. To expose the module before switching root, install
328 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700329 Vendor_ramdisk_available *bool
330
Jiyong Parkf9332f12018-02-01 00:54:12 +0900331 // Make this module available when building for recovery
332 Recovery_available *bool
333
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200334 // Used by imageMutator, set by ImageMutatorBegin()
335 CoreVariantNeeded bool `blueprint:"mutated"`
336 RamdiskVariantNeeded bool `blueprint:"mutated"`
337 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
338 RecoveryVariantNeeded bool `blueprint:"mutated"`
339
340 // A list of variations for the "image" mutator of the form
341 //<image name> '.' <version char>, for example, 'vendor.S'
342 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900343
344 // Allows this module to use non-APEX version of libraries. Useful
345 // for building binaries that are started before APEXes are activated.
346 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900347
348 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
349 // see soong/cc/config/vndk.go
350 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900351
352 // Used by vendor snapshot to record dependencies from snapshot modules.
353 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900354 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900355 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000356
Colin Cross1bc94122021-10-28 13:25:54 -0700357 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000358
359 // Set by factories of module types that can only be referenced from variants compiled against
360 // the SDK.
361 AlwaysSdk bool `blueprint:"mutated"`
362
363 // Variant is an SDK variant created by sdkMutator
364 IsSdkVariant bool `blueprint:"mutated"`
365 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
366 // variant to have a ".sdk" suffix.
367 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700368
369 // Normally Soong uses the directory structure to decide which modules
370 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800371 // different snapshots (vendor, recovery, etc.), but this property
372 // allows a partner to exclude a module normally thought of as a
373 // framework module from the vendor snapshot.
374 Exclude_from_vendor_snapshot *bool
375
376 // Normally Soong uses the directory structure to decide which modules
377 // should be included (framework) or excluded (non-framework) from the
378 // different snapshots (vendor, recovery, etc.), but this property
379 // allows a partner to exclude a module normally thought of as a
380 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800381 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900382
383 // List of APEXes that this module has private access to for testing purpose. The module
384 // can depend on libraries that are not exported by the APEXes and use private symbols
385 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000386 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800387
388 Target struct {
389 Platform struct {
390 // List of modules required by the core variant.
391 Required []string `android:"arch_variant"`
392
393 // List of modules not required by the core variant.
394 Exclude_required []string `android:"arch_variant"`
395 } `android:"arch_variant"`
396
397 Recovery struct {
398 // List of modules required by the recovery variant.
399 Required []string `android:"arch_variant"`
400
401 // List of modules not required by the recovery variant.
402 Exclude_required []string `android:"arch_variant"`
403 } `android:"arch_variant"`
404 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700405}
406
407type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900408 // whether this module should be allowed to be directly depended by other
409 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900410 // If set to true, two variants will be built separately, one like
411 // normal, and the other limited to the set of libraries and headers
412 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700413 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900414 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700415 // so it shouldn't have any unversioned runtime dependencies, or
416 // make assumptions about the system that may not be true in the
417 // future.
418 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900419 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900420 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900421 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900422 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900423 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700424 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
425 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900426
Justin Yunebcf0c52021-01-08 18:00:19 +0900427 // This is the same as the "vendor_available" except that the install path
428 // of the vendor variant is /odm or /vendor/odm.
429 // By replacing "vendor_available: true" with "odm_available: true", the
430 // module will install its vendor variant to the /odm partition or /vendor/odm.
431 // As the modules with "odm_available: true" still create the vendor variants,
432 // they can link to the other vendor modules as the vendor_available modules do.
433 // Also, the vendor modules can link to odm_available modules.
434 //
435 // It may not be used for VNDK modules.
436 Odm_available *bool
437
Justin Yun63e9ec72020-10-29 16:49:43 +0900438 // whether this module should be allowed to be directly depended by other
439 // modules with `product_specific: true` or `product_available: true`.
440 // If set to true, an additional product variant will be built separately
441 // that is limited to the set of libraries and headers that are exposed to
442 // /product modules.
443 //
444 // The product variant may be used with a different (newer) /system,
445 // so it shouldn't have any unversioned runtime dependencies, or
446 // make assumptions about the system that may not be true in the
447 // future.
448 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900449 // If set to false, this module becomes inaccessible from /product modules.
450 //
451 // Different from the 'vendor_available' property, the modules with
452 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
453 // library without 'product_available' may not be depended on by any other
454 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900455 //
456 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
457 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
458 Product_available *bool
459
Jiyong Park5fb8c102018-04-09 12:03:06 +0900460 // whether this module is capable of being loaded with other instance
461 // (possibly an older version) of the same module in the same process.
462 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
463 // can be double loaded in a vendor process if the library is also a
464 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
465 // explicitly marked as `double_loadable: true` by the owner, or the dependency
466 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
467 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800468
469 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
470 IsLLNDK bool `blueprint:"mutated"`
471
Colin Cross78212242021-01-06 14:51:30 -0800472 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
473 // set and the module is not listed in VndkMustUseVendorVariantList.
474 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
475
476 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
477 IsVNDKCore bool `blueprint:"mutated"`
478
479 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
480 IsVNDKSP bool `blueprint:"mutated"`
481
482 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
483 // module sets the llndk.private property.
484 IsVNDKPrivate bool `blueprint:"mutated"`
485
486 // IsVNDKProduct is set if a VNDK module sets the product_available property.
487 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700488
489 // IsVendorPublicLibrary is set for the core and product variants of a library that has
490 // vendor_public_library stubs.
491 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800492}
493
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500494// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
495// to understanding details about the type of the current module.
496// For example, one might call these functions to determine whether the current module is a static
497// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800498type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800499 static() bool
500 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700501 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800502 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900503 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900504 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900505 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700506 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900507 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700508 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800509 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900510 minSdkVersion() string
511 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700512 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700513 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800514 IsLlndk() bool
515 IsLlndkPublic() bool
516 isImplementationForLLNDKPublic() bool
517 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900518 isVndk() bool
519 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500520 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700521 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900522 inProduct() bool
523 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800524 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700525 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900526 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900527 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700528 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700529 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800530 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800531 isAfdoCompile() bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000532 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800533 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900534 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800535 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800536 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800537 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700538 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700539 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900540 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800541 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700542 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700543 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800544 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800545 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800546 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800547 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800548}
549
550type SharedFlags struct {
551 numSharedFlags int
552 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800553}
554
555type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700556 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800557 ModuleContextIntf
558}
559
560type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700561 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800562 ModuleContextIntf
563}
564
Colin Cross37047f12016-12-13 17:06:13 -0800565type DepsContext interface {
566 android.BottomUpMutatorContext
567 ModuleContextIntf
568}
569
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500570// feature represents additional (optional) steps to building cc-related modules, such as invocation
571// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800572type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800573 flags(ctx ModuleContext, flags Flags) Flags
574 props() []interface{}
575}
576
Joe Onorato37f900c2023-07-18 16:58:16 -0700577// Information returned from Generator about the source code it's generating
578type GeneratedSource struct {
579 IncludeDirs android.Paths
580 Sources android.Paths
581 Headers android.Paths
582 ReexportedDirs android.Paths
583}
584
585// generator allows injection of generated code
586type Generator interface {
587 GeneratorProps() []interface{}
588 GeneratorInit(ctx BaseModuleContext)
589 GeneratorDeps(ctx DepsContext, deps Deps) Deps
590 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
591 GeneratorSources(ctx ModuleContext) GeneratedSource
592 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
593}
594
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500595// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500596// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800597type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700598 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800599 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800600 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700601 compilerProps() []interface{}
602
Colin Cross76fada02016-07-27 10:31:13 -0700603 appendCflags([]string)
604 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700605 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800606}
607
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500608// linker is the interface for a linker decorator object. Individual module types can provide
609// their own implementation for this decorator, and thus specify custom logic regarding build
610// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800611type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700612 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800613 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700614 linkerFlags(ctx ModuleContext, flags Flags) Flags
615 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800616 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700617
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700618 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700619 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900620 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800621 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700622
623 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900624 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000625
626 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000627 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800628
629 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000630}
631
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500632// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000633type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500634 sharedLibs []string
635 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
636 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700637 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800638}
639
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500640// installer is the interface for an installer helper object. This helper is responsible for
641// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800642type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700643 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700644 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000645 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800646 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700647 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700648 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900649 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000650 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900651 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800652}
653
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800654type xref interface {
655 XrefCcFiles() android.Paths
656}
657
Inseob Kima1888ce2022-10-04 14:42:02 +0900658type overridable interface {
659 overriddenModules() []string
660}
661
Colin Cross6e511a92020-07-27 21:26:48 -0700662type libraryDependencyKind int
663
664const (
665 headerLibraryDependency = iota
666 sharedLibraryDependency
667 staticLibraryDependency
668)
669
670func (k libraryDependencyKind) String() string {
671 switch k {
672 case headerLibraryDependency:
673 return "headerLibraryDependency"
674 case sharedLibraryDependency:
675 return "sharedLibraryDependency"
676 case staticLibraryDependency:
677 return "staticLibraryDependency"
678 default:
679 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
680 }
681}
682
683type libraryDependencyOrder int
684
685const (
686 earlyLibraryDependency = -1
687 normalLibraryDependency = 0
688 lateLibraryDependency = 1
689)
690
691func (o libraryDependencyOrder) String() string {
692 switch o {
693 case earlyLibraryDependency:
694 return "earlyLibraryDependency"
695 case normalLibraryDependency:
696 return "normalLibraryDependency"
697 case lateLibraryDependency:
698 return "lateLibraryDependency"
699 default:
700 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
701 }
702}
703
704// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
705// tags that have a set of predefined tag objects that are reused for each dependency, a
706// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
707// That means that comparing a libraryDependencyTag for equality will only be equal if all
708// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
709// then check individual metadata fields instead.
710type libraryDependencyTag struct {
711 blueprint.BaseDependencyTag
712
713 // These are exported so that fmt.Printf("%#v") can call their String methods.
714 Kind libraryDependencyKind
715 Order libraryDependencyOrder
716
717 wholeStatic bool
718
719 reexportFlags bool
720 explicitlyVersioned bool
721 dataLib bool
722 ndk bool
723
724 staticUnwinder bool
725
726 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900727
Cindy Zhou18417cb2020-12-10 07:12:38 -0800728 // Whether or not this dependency should skip the apex dependency check
729 skipApexAllowedDependenciesCheck bool
730
Jiyong Parke3867542020-12-03 17:28:25 +0900731 // Whether or not this dependency has to be followed for the apex variants
732 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900733 // Whether or not this dependency has to be followed for the non-apex variants
734 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000735
736 // If true, don't automatically export symbols from the static library into a shared library.
737 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700738}
739
740// header returns true if the libraryDependencyTag is tagging a header lib dependency.
741func (d libraryDependencyTag) header() bool {
742 return d.Kind == headerLibraryDependency
743}
744
745// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
746func (d libraryDependencyTag) shared() bool {
747 return d.Kind == sharedLibraryDependency
748}
749
750// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
751func (d libraryDependencyTag) static() bool {
752 return d.Kind == staticLibraryDependency
753}
754
Colin Cross65cb3142021-12-10 23:05:02 +0000755func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
756 if d.shared() {
757 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
758 }
759 return nil
760}
761
762var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
763
Colin Crosse9fe2942020-11-10 18:12:15 -0800764// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
765// binaries or other shared libraries are installed as dependencies.
766func (d libraryDependencyTag) InstallDepNeeded() bool {
767 return d.shared()
768}
769
770var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
771
772// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700773// libraryDependencyTag. Each tag object is created globally and reused for multiple
774// dependencies (although since the object contains no references, assigning a tag to a
775// variable and modifying it will not modify the original). Users can compare the tag
776// returned by ctx.OtherModuleDependencyTag against the global original
777type dependencyTag struct {
778 blueprint.BaseDependencyTag
779 name string
780}
781
Colin Crosse9fe2942020-11-10 18:12:15 -0800782// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
783// libraryDependencyTag, but where the dependency needs to be installed when the parent is
784// installed.
785type installDependencyTag struct {
786 blueprint.BaseDependencyTag
787 android.InstallAlwaysNeededDependencyTag
788 name string
789}
790
Colin Crossc99deeb2016-04-11 15:06:20 -0700791var (
Colin Cross6e511a92020-07-27 21:26:48 -0700792 genSourceDepTag = dependencyTag{name: "gen source"}
793 genHeaderDepTag = dependencyTag{name: "gen header"}
794 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
795 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900796 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700797 reuseObjTag = dependencyTag{name: "reuse objects"}
798 staticVariantTag = dependencyTag{name: "static variant"}
799 vndkExtDepTag = dependencyTag{name: "vndk extends"}
800 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700801 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800802 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700803 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700804 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000805 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500806 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400807 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700808)
809
Roland Levillainf89cd092019-07-29 16:22:59 +0100810func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700811 ccLibDepTag, ok := depTag.(libraryDependencyTag)
812 return ok && ccLibDepTag.shared()
813}
814
815func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
816 ccLibDepTag, ok := depTag.(libraryDependencyTag)
817 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100818}
819
Zach Johnson3df4e632020-11-06 11:56:27 -0800820func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
821 ccLibDepTag, ok := depTag.(libraryDependencyTag)
822 return ok && ccLibDepTag.header()
823}
824
Roland Levillainf89cd092019-07-29 16:22:59 +0100825func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800826 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100827}
828
829func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700830 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100831 return ok && ccDepTag == testPerSrcDepTag
832}
833
Colin Crossca860ac2016-01-04 14:34:37 -0800834// Module contains the properties and members used by all C/C++ module types, and implements
835// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500836// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
837// interface.
838//
839// To define a C/C++ related module, construct a new Module object and point its delegates to
840// type-specific structs. These delegates will be invoked to register module-specific build
841// statements which may be unique to the module type. For example, module.compiler.compile() should
842// be defined so as to register build statements which are responsible for compiling the module.
843//
844// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
845// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
846// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
847// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800848type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700849 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700850
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700851 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700852 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700853
Colin Crossca860ac2016-01-04 14:34:37 -0800854 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000855 hod android.HostOrDeviceSupported
856 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000857 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700858
Paul Duffina0843f62019-12-13 19:50:38 +0000859 // Allowable SdkMemberTypes of this module type.
860 sdkMemberTypes []android.SdkMemberType
861
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500862 // decorator delegates, initialize before calling Init
863 // these may contain module-specific implementations, and effectively allow for custom
864 // type-specific logic. These members may reference different objects or the same object.
865 // Functions of these decorators will be invoked to initialize and register type-specific
866 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800867 generators []Generator
868 compiler compiler
869 linker linker
870 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500871
Spandan Dase12d2522023-09-12 21:42:31 +0000872 features []feature
873 stl *stl
874 sanitize *sanitize
875 coverage *coverage
876 fuzzer *fuzzer
877 sabi *sabi
878 vndkdep *vndkdep
879 lto *lto
880 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000881 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800882
Colin Cross31076b32020-10-23 17:22:06 -0700883 library libraryInterface
884
Colin Cross635c3b02016-05-18 15:37:25 -0700885 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800886
Colin Crossb98c8b02016-07-29 13:44:28 -0700887 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700888
889 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800890
891 // Flags used to compile this module
892 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700893
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800894 // Shared flags among build rules of this module
895 sharedFlags SharedFlags
896
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800897 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700898 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900899
900 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800901 // Kythe (source file indexer) paths for this compilation module
902 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700903 // Object .o file output paths for this compilation module
904 objFiles android.Paths
905 // Tidy .tidy file output paths for this compilation module
906 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900907
908 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700909 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700910
911 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800912
913 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800914 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700915}
916
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200917func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400918 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
919 if b, ok := c.compiler.(*baseCompiler); ok {
920 hasAidl = b.hasSrcExt(".aidl")
921 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
922 hasProto = b.hasSrcExt(".proto")
923 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
924 hasSysprop = b.hasSrcExt(".sysprop")
925 hasWinMsg = b.hasSrcExt(".mc")
926 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
927 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200928 c.AndroidModuleBase().AddJSONData(d)
929 (*d)["Cc"] = map[string]interface{}{
930 "SdkVersion": c.SdkVersion(),
931 "MinSdkVersion": c.MinSdkVersion(),
932 "VndkVersion": c.VndkVersion(),
933 "ProductSpecific": c.ProductSpecific(),
934 "SocSpecific": c.SocSpecific(),
935 "DeviceSpecific": c.DeviceSpecific(),
936 "InProduct": c.InProduct(),
937 "InVendor": c.InVendor(),
938 "InRamdisk": c.InRamdisk(),
939 "InVendorRamdisk": c.InVendorRamdisk(),
940 "InRecovery": c.InRecovery(),
941 "VendorAvailable": c.VendorAvailable(),
942 "ProductAvailable": c.ProductAvailable(),
943 "RamdiskAvailable": c.RamdiskAvailable(),
944 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
945 "RecoveryAvailable": c.RecoveryAvailable(),
946 "OdmAvailable": c.OdmAvailable(),
947 "InstallInData": c.InstallInData(),
948 "InstallInRamdisk": c.InstallInRamdisk(),
949 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
950 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
951 "InstallInRecovery": c.InstallInRecovery(),
952 "InstallInRoot": c.InstallInRoot(),
953 "IsVndk": c.IsVndk(),
954 "IsVndkExt": c.IsVndkExt(),
955 "IsVndkPrivate": c.IsVndkPrivate(),
956 "IsVndkSp": c.IsVndkSp(),
957 "IsLlndk": c.IsLlndk(),
958 "IsLlndkPublic": c.IsLlndkPublic(),
959 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
960 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
961 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
962 "ApexSdkVersion": c.apexSdkVersion,
963 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400964 "AidlSrcs": hasAidl,
965 "LexSrcs": hasLex,
966 "ProtoSrcs": hasProto,
967 "RenderscriptSrcs": hasRenderscript,
968 "SyspropSrcs": hasSysprop,
969 "WinMsgSrcs": hasWinMsg,
970 "YaccSrsc": hasYacc,
971 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200972 }
973}
974
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500975func (c *Module) SetPreventInstall() {
976 c.Properties.PreventInstall = true
977}
978
979func (c *Module) SetHideFromMake() {
980 c.Properties.HideFromMake = true
981}
982
Ivan Lozanod7586b62021-04-01 09:49:36 -0400983func (c *Module) HiddenFromMake() bool {
984 return c.Properties.HideFromMake
985}
986
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800987func (c *Module) RequiredModuleNames() []string {
988 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
989 if c.ImageVariation().Variation == android.CoreVariation {
990 required = append(required, c.Properties.Target.Platform.Required...)
991 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
992 } else if c.InRecovery() {
993 required = append(required, c.Properties.Target.Recovery.Required...)
994 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
995 }
996 return android.FirstUniqueStrings(required)
997}
998
Ivan Lozano52767be2019-10-18 14:49:46 -0700999func (c *Module) Toc() android.OptionalPath {
1000 if c.linker != nil {
1001 if library, ok := c.linker.(libraryInterface); ok {
1002 return library.toc()
1003 }
1004 }
1005 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1006}
1007
1008func (c *Module) ApiLevel() string {
1009 if c.linker != nil {
1010 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001011 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001012 }
1013 }
1014 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1015}
1016
1017func (c *Module) Static() bool {
1018 if c.linker != nil {
1019 if library, ok := c.linker.(libraryInterface); ok {
1020 return library.static()
1021 }
1022 }
1023 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1024}
1025
1026func (c *Module) Shared() bool {
1027 if c.linker != nil {
1028 if library, ok := c.linker.(libraryInterface); ok {
1029 return library.shared()
1030 }
1031 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001032
Ivan Lozano52767be2019-10-18 14:49:46 -07001033 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1034}
1035
1036func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001037 if c.stl != nil {
1038 return c.stl.Properties.SelectedStl
1039 }
1040 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001041}
1042
Ivan Lozano52767be2019-10-18 14:49:46 -07001043func (c *Module) NdkPrebuiltStl() bool {
1044 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1045 return true
1046 }
1047 return false
1048}
1049
1050func (c *Module) StubDecorator() bool {
1051 if _, ok := c.linker.(*stubDecorator); ok {
1052 return true
1053 }
1054 return false
1055}
1056
1057func (c *Module) SdkVersion() string {
1058 return String(c.Properties.Sdk_version)
1059}
1060
Artur Satayev480e25b2020-04-27 18:53:18 +01001061func (c *Module) MinSdkVersion() string {
1062 return String(c.Properties.Min_sdk_version)
1063}
1064
Jiyong Park5df7bd32021-08-25 16:18:46 +09001065func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001066 if linker, ok := c.linker.(*objectLinker); ok {
1067 return linker.isCrt()
1068 }
1069 return false
1070}
1071
Jiyong Park5df7bd32021-08-25 16:18:46 +09001072func (c *Module) SplitPerApiLevel() bool {
1073 return c.canUseSdk() && c.isCrt()
1074}
1075
Colin Crossc511bc52020-04-07 16:50:32 +00001076func (c *Module) AlwaysSdk() bool {
1077 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1078}
1079
Ivan Lozano183a3212019-10-18 14:18:45 -07001080func (c *Module) CcLibrary() bool {
1081 if c.linker != nil {
1082 if _, ok := c.linker.(*libraryDecorator); ok {
1083 return true
1084 }
Colin Crossd48fe732020-09-23 20:37:24 -07001085 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1086 return true
1087 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001088 }
1089 return false
1090}
1091
1092func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001093 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001094 return true
1095 }
1096 return false
1097}
1098
Spandan Dase12d2522023-09-12 21:42:31 +00001099func (c *Module) IsNdkPrebuiltStl() bool {
1100 if c.linker == nil {
1101 return false
1102 }
1103 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1104 return true
1105 }
1106 return false
1107}
1108
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001109func (c *Module) RlibStd() bool {
1110 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1111}
1112
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001113func (c *Module) RustLibraryInterface() bool {
1114 return false
1115}
1116
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001117func (c *Module) IsFuzzModule() bool {
1118 if _, ok := c.compiler.(*fuzzBinary); ok {
1119 return true
1120 }
1121 return false
1122}
1123
1124func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1125 return c.FuzzModule
1126}
1127
1128func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1129 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1130 return fuzzer.fuzzPackagedModule
1131 }
1132 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1133}
1134
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001135func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001136 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1137 return fuzzer.sharedLibraries
1138 }
1139 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1140}
1141
Ivan Lozano2b262972019-11-21 12:30:50 -08001142func (c *Module) NonCcVariants() bool {
1143 return false
1144}
1145
Ivan Lozano183a3212019-10-18 14:18:45 -07001146func (c *Module) SetStatic() {
1147 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001148 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001149 library.setStatic()
1150 return
1151 }
1152 }
1153 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1154}
1155
1156func (c *Module) SetShared() {
1157 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001158 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001159 library.setShared()
1160 return
1161 }
1162 }
1163 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1164}
1165
1166func (c *Module) BuildStaticVariant() bool {
1167 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001168 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001169 return library.buildStatic()
1170 }
1171 }
1172 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1173}
1174
1175func (c *Module) BuildSharedVariant() bool {
1176 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001177 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001178 return library.buildShared()
1179 }
1180 }
1181 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1182}
1183
1184func (c *Module) Module() android.Module {
1185 return c
1186}
1187
Jiyong Parkc20eee32018-09-05 22:36:17 +09001188func (c *Module) OutputFile() android.OptionalPath {
1189 return c.outputFile
1190}
1191
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001192func (c *Module) CoverageFiles() android.Paths {
1193 if c.linker != nil {
1194 if library, ok := c.linker.(libraryInterface); ok {
1195 return library.objs().coverageFiles
1196 }
1197 }
1198 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1199}
1200
Ivan Lozano183a3212019-10-18 14:18:45 -07001201var _ LinkableInterface = (*Module)(nil)
1202
Jiyong Park719b4462019-01-13 00:39:51 +09001203func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001204 if c.linker != nil {
1205 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001206 }
1207 return nil
1208}
1209
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001210func (c *Module) CoverageOutputFile() android.OptionalPath {
1211 if c.linker != nil {
1212 return c.linker.coverageOutputFilePath()
1213 }
1214 return android.OptionalPath{}
1215}
1216
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001217func (c *Module) RelativeInstallPath() string {
1218 if c.installer != nil {
1219 return c.installer.relativeInstallPath()
1220 }
1221 return ""
1222}
1223
Jooyung Han344d5432019-08-23 11:17:39 +09001224func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001225 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001226}
1227
Colin Cross36242852017-06-23 15:06:31 -07001228func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001229 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001230 for _, generator := range c.generators {
1231 c.AddProperties(generator.GeneratorProps()...)
1232 }
Colin Crossca860ac2016-01-04 14:34:37 -08001233 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001234 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001235 }
1236 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001237 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001238 }
1239 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001240 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001241 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001242 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001243 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001244 }
Colin Cross16b23492016-01-06 14:41:07 -08001245 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001246 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001247 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001248 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001249 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001250 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001251 if c.fuzzer != nil {
1252 c.AddProperties(c.fuzzer.props()...)
1253 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001254 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001255 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001256 }
Justin Yun8effde42017-06-23 19:24:43 +09001257 if c.vndkdep != nil {
1258 c.AddProperties(c.vndkdep.props()...)
1259 }
Stephen Craneba090d12017-05-09 15:44:35 -07001260 if c.lto != nil {
1261 c.AddProperties(c.lto.props()...)
1262 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001263 if c.afdo != nil {
1264 c.AddProperties(c.afdo.props()...)
1265 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001266 if c.orderfile != nil {
1267 c.AddProperties(c.orderfile.props()...)
1268 }
Colin Crossca860ac2016-01-04 14:34:37 -08001269 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001270 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001271 }
Colin Crossc472d572015-03-17 15:06:21 -07001272
Colin Cross36242852017-06-23 15:06:31 -07001273 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001274 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001275 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001276
Colin Cross36242852017-06-23 15:06:31 -07001277 return c
Colin Crossc472d572015-03-17 15:06:21 -07001278}
1279
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001280// UseVndk() returns true if this module is built against VNDK.
1281// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001282func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001283 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001284}
1285
Colin Crossc511bc52020-04-07 16:50:32 +00001286func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001287 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001288 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001289}
1290
1291func (c *Module) UseSdk() bool {
1292 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001293 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001294 }
1295 return false
1296}
1297
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001298func (c *Module) isCoverageVariant() bool {
1299 return c.coverage.Properties.IsCoverageVariant
1300}
1301
Colin Cross95f1ca02020-10-29 20:47:22 -07001302func (c *Module) IsNdk(config android.Config) bool {
1303 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001304}
1305
Colin Cross127bb8b2020-12-16 16:46:01 -08001306func (c *Module) IsLlndk() bool {
1307 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001308}
1309
Colin Cross127bb8b2020-12-16 16:46:01 -08001310func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001311 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001312}
1313
Colin Cross1f3f1302021-04-26 18:37:44 -07001314func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001315 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001316 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001317}
1318
Colin Cross5271fea2021-04-27 13:06:04 -07001319func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1320 lib := moduleLibraryInterface(m)
1321 return lib != nil && (lib.hasVendorPublicLibrary())
1322}
1323
1324// IsVendorPublicLibrary returns true for vendor public libraries.
1325func (c *Module) IsVendorPublicLibrary() bool {
1326 return c.VendorProperties.IsVendorPublicLibrary
1327}
1328
Ivan Lozanof1868af2022-04-12 13:08:36 -04001329func (c *Module) IsVndkPrebuiltLibrary() bool {
1330 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1331 return true
1332 }
1333 return false
1334}
1335
1336func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1337 return c.Properties.SdkAndPlatformVariantVisibleToMake
1338}
1339
Ivan Lozanod7586b62021-04-01 09:49:36 -04001340func (c *Module) HasLlndkStubs() bool {
1341 lib := moduleLibraryInterface(c)
1342 return lib != nil && lib.hasLLNDKStubs()
1343}
1344
1345func (c *Module) StubsVersion() string {
1346 if lib, ok := c.linker.(versionedInterface); ok {
1347 return lib.stubsVersion()
1348 }
1349 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1350}
1351
Colin Cross127bb8b2020-12-16 16:46:01 -08001352// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1353// and does not set llndk.vendor_available: false.
1354func (c *Module) isImplementationForLLNDKPublic() bool {
1355 library, _ := c.library.(*libraryDecorator)
1356 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001357 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001358}
1359
Justin Yunfd9e8042020-12-23 18:23:14 +09001360// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001361func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001362 // Check if VNDK-core-private or VNDK-SP-private
1363 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001364 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001365 }
1366
1367 // Check if LLNDK-private
1368 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001369 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001370 }
1371
1372 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001373}
1374
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001375// IsVndk() returns true if this module has a vndk variant.
1376// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1377// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001378func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001379 if vndkdep := c.vndkdep; vndkdep != nil {
1380 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001381 }
1382 return false
1383}
1384
Yi Kong4ef54592022-02-14 20:00:10 +08001385func (c *Module) isAfdoCompile() bool {
1386 if afdo := c.afdo; afdo != nil {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001387 return afdo.Properties.FdoProfilePath != nil
Yi Kong4ef54592022-02-14 20:00:10 +08001388 }
1389 return false
1390}
1391
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001392func (c *Module) isOrderfileCompile() bool {
1393 if orderfile := c.orderfile; orderfile != nil {
1394 return orderfile.Properties.OrderfileLoad
1395 }
1396 return false
1397}
1398
Yi Kongc702ebd2022-08-19 16:02:45 +08001399func (c *Module) isCfi() bool {
1400 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001401 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001402 }
1403 return false
1404}
1405
Yi Konged79fa32023-06-04 17:15:42 +09001406func (c *Module) isFuzzer() bool {
1407 if sanitize := c.sanitize; sanitize != nil {
1408 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1409 }
1410 return false
1411}
1412
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001413func (c *Module) isNDKStubLibrary() bool {
1414 if _, ok := c.compiler.(*stubDecorator); ok {
1415 return true
1416 }
1417 return false
1418}
1419
Ivan Lozanod7586b62021-04-01 09:49:36 -04001420func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001421 if vndkdep := c.vndkdep; vndkdep != nil {
1422 return vndkdep.isVndkSp()
1423 }
1424 return false
1425}
1426
Ivan Lozanof9e21722020-12-02 09:00:51 -05001427func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001428 if vndkdep := c.vndkdep; vndkdep != nil {
1429 return vndkdep.isVndkExt()
1430 }
1431 return false
1432}
1433
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001434func (c *Module) SubName() string {
1435 return c.Properties.SubName
1436}
1437
Ivan Lozano52767be2019-10-18 14:49:46 -07001438func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001439 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001440}
1441
Logan Chienf3511742017-10-31 18:04:35 +08001442func (c *Module) getVndkExtendsModuleName() string {
1443 if vndkdep := c.vndkdep; vndkdep != nil {
1444 return vndkdep.getVndkExtendsModuleName()
1445 }
1446 return ""
1447}
1448
Jiyong Park25fc6a92018-11-18 18:02:45 +09001449func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001450 if lib := c.library; lib != nil {
1451 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001452 }
1453 return false
1454}
1455
1456func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001457 if lib := c.library; lib != nil {
1458 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001459 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001460 return false
1461}
1462
Alan Stokes73feba32022-11-14 12:21:24 +00001463func (c *Module) IsStubsImplementationRequired() bool {
1464 if lib := c.library; lib != nil {
1465 return lib.isStubsImplementationRequired()
1466 }
1467 return false
1468}
1469
Colin Cross0477b422020-10-13 18:43:54 -07001470// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1471// the implementation. If it is an implementation library it returns its own name.
1472func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1473 name := ctx.OtherModuleName(c)
1474 if versioned, ok := c.linker.(versionedInterface); ok {
1475 name = versioned.implementationModuleName(name)
1476 }
1477 return name
1478}
1479
Martin Stjernholm2856c662020-12-02 15:03:42 +00001480// Similar to ImplementationModuleName, but uses the Make variant of the module
1481// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1482// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1483// under the premise that the prebuilt module overrides its source counterpart
1484// if it is exposed to Make).
1485func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1486 name := c.BaseModuleName()
1487 if versioned, ok := c.linker.(versionedInterface); ok {
1488 name = versioned.implementationModuleName(name)
1489 }
1490 return name
1491}
1492
Jiyong Park7d55b612021-06-11 17:22:09 +09001493func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001494 return Bool(c.Properties.Bootstrap)
1495}
1496
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001497func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001498 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1499 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1500 return false
1501 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001502 return c.linker != nil && c.linker.nativeCoverage()
1503}
1504
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001505func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001506 if p, ok := c.linker.(SnapshotInterface); ok {
1507 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001508 }
1509 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001510}
1511
Bill Peckham945441c2020-08-31 16:07:58 -07001512func (c *Module) ExcludeFromVendorSnapshot() bool {
1513 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1514}
1515
Jose Galmesf7294582020-11-13 12:07:36 -08001516func (c *Module) ExcludeFromRecoverySnapshot() bool {
1517 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1518}
1519
Jiyong Parkf1194352019-02-25 11:05:47 +09001520func isBionic(name string) bool {
1521 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001522 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001523 return true
1524 }
1525 return false
1526}
1527
Martin Stjernholm279de572019-09-10 23:18:20 +01001528func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001529 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001530 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001531 }
1532 return isBionic(name)
1533}
1534
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001535func (c *Module) XrefCcFiles() android.Paths {
1536 return c.kytheFiles
1537}
1538
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001539func (c *Module) isCfiAssemblySupportEnabled() bool {
1540 return c.sanitize != nil &&
1541 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1542}
1543
Inseob Kim800d1142021-06-14 12:03:51 +09001544func (c *Module) InstallInRoot() bool {
1545 return c.installer != nil && c.installer.installInRoot()
1546}
1547
Colin Crossca860ac2016-01-04 14:34:37 -08001548type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001549 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001550 moduleContextImpl
1551}
1552
Colin Cross37047f12016-12-13 17:06:13 -08001553type depsContext struct {
1554 android.BottomUpMutatorContext
1555 moduleContextImpl
1556}
1557
Colin Crossca860ac2016-01-04 14:34:37 -08001558type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001559 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001560 moduleContextImpl
1561}
1562
1563type moduleContextImpl struct {
1564 mod *Module
1565 ctx BaseModuleContext
1566}
1567
Colin Crossb98c8b02016-07-29 13:44:28 -07001568func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001569 return ctx.mod.toolchain(ctx.ctx)
1570}
1571
1572func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001573 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001574}
1575
1576func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001577 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001578}
1579
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001580func (ctx *moduleContextImpl) testBinary() bool {
1581 return ctx.mod.testBinary()
1582}
1583
Yi Kong56fc1b62022-09-06 16:24:00 +08001584func (ctx *moduleContextImpl) testLibrary() bool {
1585 return ctx.mod.testLibrary()
1586}
1587
Jiyong Park1d1119f2019-07-29 21:27:18 +09001588func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001589 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001590}
1591
Inseob Kim7f283f42020-06-01 21:53:49 +09001592func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001593 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001594}
1595
Inseob Kim1042d292020-06-01 23:23:05 +09001596func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001597 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001598}
1599
Jooyung Hanccce2f22020-03-07 03:45:53 +09001600func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001601 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001602}
1603
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001604func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001605 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001606}
1607
1608func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001609 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001610 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001611 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001612 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001613 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001614 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001615 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001616 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001617 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001618 }
1619 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001620}
1621
Jiyong Parkb35a8192020-08-10 15:59:36 +09001622func (ctx *moduleContextImpl) minSdkVersion() string {
1623 ver := ctx.mod.MinSdkVersion()
1624 if ver == "apex_inherit" && !ctx.isForPlatform() {
1625 ver = ctx.apexSdkVersion().String()
1626 }
1627 if ver == "apex_inherit" || ver == "" {
1628 ver = ctx.sdkVersion()
1629 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001630 // For crt objects, the meaning of min_sdk_version is very different from other types of
1631 // module. For them, min_sdk_version defines the oldest version that the build system will
1632 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1633 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1634 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001635 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1636 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1637 // support such an old version. The version is set to the later version in case when the
1638 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1639 // it's for an APEX.
1640 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1641 if ctx.isForPlatform() {
1642 ver = strconv.Itoa(android.FutureApiLevelInt)
1643 } else { // for apex
1644 ver = ctx.apexSdkVersion().String()
1645 if ver == "" { // in case when min_sdk_version was not set by the APEX
1646 ver = ctx.sdkVersion()
1647 }
1648 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001649 }
1650
Jiyong Parkb35a8192020-08-10 15:59:36 +09001651 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1652 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1653 minSdkVersionInt, err2 := strconv.Atoi(ver)
1654 if err == nil && err2 == nil {
1655 if sdkVersionInt < minSdkVersionInt {
1656 return strconv.Itoa(sdkVersionInt)
1657 }
1658 }
1659 return ver
1660}
1661
1662func (ctx *moduleContextImpl) isSdkVariant() bool {
1663 return ctx.mod.IsSdkVariant()
1664}
1665
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001666func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001667 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001668}
Justin Yun8effde42017-06-23 19:24:43 +09001669
Kiyoung Kimaa394802024-01-08 12:55:45 +09001670func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1671 return ctx.mod.InVendorOrProduct()
1672}
1673
Colin Cross95f1ca02020-10-29 20:47:22 -07001674func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1675 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001676}
1677
Colin Cross127bb8b2020-12-16 16:46:01 -08001678func (ctx *moduleContextImpl) IsLlndk() bool {
1679 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001680}
1681
Colin Cross127bb8b2020-12-16 16:46:01 -08001682func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1683 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001684}
1685
Colin Cross127bb8b2020-12-16 16:46:01 -08001686func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1687 return ctx.mod.isImplementationForLLNDKPublic()
1688}
1689
1690func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1691 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001692}
1693
Logan Chienf3511742017-10-31 18:04:35 +08001694func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001695 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001696}
1697
Yi Kong4ef54592022-02-14 20:00:10 +08001698func (ctx *moduleContextImpl) isAfdoCompile() bool {
1699 return ctx.mod.isAfdoCompile()
1700}
1701
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001702func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1703 return ctx.mod.isOrderfileCompile()
1704}
1705
Yi Kongc702ebd2022-08-19 16:02:45 +08001706func (ctx *moduleContextImpl) isCfi() bool {
1707 return ctx.mod.isCfi()
1708}
1709
Yi Konged79fa32023-06-04 17:15:42 +09001710func (ctx *moduleContextImpl) isFuzzer() bool {
1711 return ctx.mod.isFuzzer()
1712}
1713
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001714func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1715 return ctx.mod.isNDKStubLibrary()
1716}
1717
Justin Yun8effde42017-06-23 19:24:43 +09001718func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001719 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001720}
1721
Ivan Lozanof9e21722020-12-02 09:00:51 -05001722func (ctx *moduleContextImpl) IsVndkExt() bool {
1723 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001724}
1725
Colin Cross5271fea2021-04-27 13:06:04 -07001726func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1727 return ctx.mod.IsVendorPublicLibrary()
1728}
1729
Vic Yangefd249e2018-11-12 20:19:56 -08001730func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001731 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001732}
1733
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001734func (ctx *moduleContextImpl) selectedStl() string {
1735 if stl := ctx.mod.stl; stl != nil {
1736 return stl.Properties.SelectedStl
1737 }
1738 return ""
1739}
1740
Ivan Lozanobd721262018-11-27 14:33:03 -08001741func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1742 return ctx.mod.linker.useClangLld(actx)
1743}
1744
Colin Crossce75d2c2016-10-06 16:12:58 -07001745func (ctx *moduleContextImpl) baseModuleName() string {
1746 return ctx.mod.ModuleBase.BaseModuleName()
1747}
1748
Logan Chienf3511742017-10-31 18:04:35 +08001749func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1750 return ctx.mod.getVndkExtendsModuleName()
1751}
1752
Logan Chiene274fc92019-12-03 11:18:32 -08001753func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001754 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1755 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001756}
1757
Colin Crosse07f2312020-08-13 11:24:56 -07001758func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001759 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1760 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001761}
1762
Dan Albertc8060532020-07-22 22:32:17 -07001763func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001764 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001765}
1766
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001767func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001768 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001769}
1770
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001771func (ctx *moduleContextImpl) nativeCoverage() bool {
1772 return ctx.mod.nativeCoverage()
1773}
1774
Colin Cross56a83212020-09-15 18:30:11 -07001775func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1776 return ctx.mod.DirectlyInAnyApex()
1777}
1778
Colin Cross95b07f22020-12-16 11:06:50 -08001779func (ctx *moduleContextImpl) isPreventInstall() bool {
1780 return ctx.mod.Properties.PreventInstall
1781}
1782
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001783func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1784 shared := &ctx.mod.sharedFlags
1785 if shared.flagsMap == nil {
1786 shared.numSharedFlags = 0
1787 shared.flagsMap = make(map[string]string)
1788 }
1789 return shared
1790}
1791
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001792func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1793 return ctx.mod.isCfiAssemblySupportEnabled()
1794}
1795
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001796func (ctx *moduleContextImpl) notInPlatform() bool {
1797 return ctx.mod.NotInPlatform()
1798}
1799
Colin Cross635c3b02016-05-18 15:37:25 -07001800func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001801 return &Module{
1802 hod: hod,
1803 multilib: multilib,
1804 }
1805}
1806
Colin Cross635c3b02016-05-18 15:37:25 -07001807func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001808 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001809 module.features = []feature{
1810 &tidyFeature{},
1811 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001812 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001813 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001814 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001815 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001816 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001817 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001818 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001819 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001820 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001821 return module
1822}
1823
Colin Crossce75d2c2016-10-06 16:12:58 -07001824func (c *Module) Prebuilt() *android.Prebuilt {
1825 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1826 return p.prebuilt()
1827 }
1828 return nil
1829}
1830
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001831func (c *Module) IsPrebuilt() bool {
1832 return c.Prebuilt() != nil
1833}
1834
Colin Crossce75d2c2016-10-06 16:12:58 -07001835func (c *Module) Name() string {
1836 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001837 if p, ok := c.linker.(interface {
1838 Name(string) string
1839 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001840 name = p.Name(name)
1841 }
1842 return name
1843}
1844
Alex Light3d673592019-01-18 14:37:31 -08001845func (c *Module) Symlinks() []string {
1846 if p, ok := c.installer.(interface {
1847 symlinkList() []string
1848 }); ok {
1849 return p.symlinkList()
1850 }
1851 return nil
1852}
1853
Roland Levillainf89cd092019-07-29 16:22:59 +01001854func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1855 test, ok := c.linker.(testPerSrc)
1856 return ok && test.isAllTestsVariation()
1857}
1858
Chris Parsons216e10a2020-07-09 17:12:52 -04001859func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001860 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001861 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001862 }); ok {
1863 return p.dataPaths()
1864 }
1865 return nil
1866}
1867
Ivan Lozanof1868af2022-04-12 13:08:36 -04001868func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001869 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1870 // "current", it will append the VNDK version to the name suffix.
1871 var vndkVersion string
1872 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001873 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001874 if c.ProductSpecific() {
1875 // If the module is product specific with 'product_specific: true',
1876 // do not add a name suffix because it is a base module.
1877 return ""
1878 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001879 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001880 } else {
1881 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001882 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001883 }
1884 if vndkVersion == "current" {
1885 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1886 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001887 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001888 // add version suffix only if the module is using different vndk version than the
1889 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001890 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001891 }
1892 return nameSuffix
1893}
1894
Ivan Lozanof1868af2022-04-12 13:08:36 -04001895func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1896 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001897
1898 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001899 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001900 }
1901
Colin Cross127bb8b2020-12-16 16:46:01 -08001902 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001903 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001904 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1905 // added for product variant only when we have vendor and product variants with core
1906 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001907 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001908 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001909 subName += vendorPublicLibrarySuffix
1910 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001911 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1912 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001913 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001914 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001915 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001916 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001917 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001918 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001919 subName += RecoverySuffix
1920 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1921 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001922 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001923 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001924 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001925 } else if c.IsStubs() && c.IsSdkVariant() {
1926 // Public API surface (NDK)
1927 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1928 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001929 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001930
1931 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001932}
1933
Sam Delmerico75dbca22023-04-20 13:13:25 +00001934func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1935 ctx := &moduleContext{
1936 ModuleContext: actx,
1937 moduleContextImpl: moduleContextImpl{
1938 mod: c,
1939 },
1940 }
1941 ctx.ctx = ctx
1942 return ctx
1943}
1944
Spandan Das20fce2d2023-04-12 17:21:39 +00001945// TODO (b/277651159): Remove this allowlist
1946var (
1947 skipStubLibraryMultipleApexViolation = map[string]bool{
1948 "libclang_rt.asan": true,
1949 "libclang_rt.hwasan": true,
1950 // runtime apex
1951 "libc": true,
1952 "libc_hwasan": true,
1953 "libdl_android": true,
1954 "libm": true,
1955 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001956 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001957 // art apex
1958 "libandroidio": true,
1959 "libdexfile": true,
1960 "libnativebridge": true,
1961 "libnativehelper": true,
1962 "libnativeloader": true,
1963 "libsigchain": true,
1964 }
1965)
1966
1967// Returns true if a stub library could be installed in multiple apexes
1968func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1969 // If this is not an apex variant, no check necessary
1970 if !c.InAnyApex() {
1971 return false
1972 }
1973 // If this is not a stub library, no check necessary
1974 if !c.HasStubsVariants() {
1975 return false
1976 }
1977 // Skip the allowlist
1978 // Use BaseModuleName so that this matches prebuilts.
1979 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1980 return false
1981 }
1982
1983 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1984 // Stub libraries should not have more than one apex_available
1985 if len(aaWithoutTestApexes) > 1 {
1986 return true
1987 }
1988 // Stub libraries should not use the wildcard
1989 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
1990 return true
1991 }
1992 // Default: no violation
1993 return false
1994}
1995
LaMont Jonesafe7baf2024-01-09 22:47:39 +00001996func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1997 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
1998}
1999
Chris Parsons8d6e4332021-02-22 16:13:50 -05002000func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002001 // Handle the case of a test module split by `test_per_src` mutator.
2002 //
2003 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2004 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2005 // module and return early, as this module does not produce an output file per se.
2006 if c.IsTestPerSrcAllTestsVariation() {
2007 c.outputFile = android.OptionalPath{}
2008 return
2009 }
2010
Ivan Lozanof1868af2022-04-12 13:08:36 -04002011 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002012 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002013 if !apexInfo.IsForPlatform() {
2014 c.hideApexVariantFromMake = true
2015 }
2016
Chris Parsonseefc9e62021-04-02 17:36:47 -04002017 c.makeLinkType = GetMakeLinkType(actx, c)
2018
Sam Delmerico75dbca22023-04-20 13:13:25 +00002019 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002020
Colin Crossf18e1102017-11-16 14:33:08 -08002021 deps := c.depsToPaths(ctx)
2022 if ctx.Failed() {
2023 return
2024 }
2025
Joe Onorato37f900c2023-07-18 16:58:16 -07002026 for _, generator := range c.generators {
2027 gen := generator.GeneratorSources(ctx)
2028 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2029 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2030 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2031 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2032 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2033 if len(deps.Objs.objFiles) == 0 {
2034 // If we are reusuing object files (which happens when we're a shared library and we're
2035 // reusing our static variant's object files), then skip adding the actual source files,
2036 // because we already have the object for it.
2037 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2038 }
2039 }
2040
2041 if ctx.Failed() {
2042 return
2043 }
2044
Spandan Das20fce2d2023-04-12 17:21:39 +00002045 if c.stubLibraryMultipleApexViolation(actx) {
2046 actx.PropertyErrorf("apex_available",
2047 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2048 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002049 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2050 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002051 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2052 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002053 }
2054
Colin Crossca860ac2016-01-04 14:34:37 -08002055 flags := Flags{
2056 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002057 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002058 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002059 for _, generator := range c.generators {
2060 flags = generator.GeneratorFlags(ctx, flags, deps)
2061 }
Colin Crossca860ac2016-01-04 14:34:37 -08002062 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002063 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002064 }
2065 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002066 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002067 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002068 if c.stl != nil {
2069 flags = c.stl.flags(ctx, flags)
2070 }
Colin Cross16b23492016-01-06 14:41:07 -08002071 if c.sanitize != nil {
2072 flags = c.sanitize.flags(ctx, flags)
2073 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002074 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002075 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002076 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002077 if c.fuzzer != nil {
2078 flags = c.fuzzer.flags(ctx, flags)
2079 }
Stephen Craneba090d12017-05-09 15:44:35 -07002080 if c.lto != nil {
2081 flags = c.lto.flags(ctx, flags)
2082 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002083 if c.afdo != nil {
2084 flags = c.afdo.flags(ctx, flags)
2085 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002086 if c.orderfile != nil {
2087 flags = c.orderfile.flags(ctx, flags)
2088 }
Colin Crossca860ac2016-01-04 14:34:37 -08002089 for _, feature := range c.features {
2090 flags = feature.flags(ctx, flags)
2091 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002092 if ctx.Failed() {
2093 return
2094 }
2095
Colin Cross4af21ed2019-11-04 09:37:55 -08002096 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2097 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2098 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002099
Colin Cross4af21ed2019-11-04 09:37:55 -08002100 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002101
2102 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002103 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002104 }
2105 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002106 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002107 }
2108
Colin Cross3e5e7782022-06-17 22:17:05 +00002109 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2110
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002111 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002112 // We need access to all the flags seen by a source file.
2113 if c.sabi != nil {
2114 flags = c.sabi.flags(ctx, flags)
2115 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002116
Colin Cross4af21ed2019-11-04 09:37:55 -08002117 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002118
Joe Onorato37f900c2023-07-18 16:58:16 -07002119 for _, generator := range c.generators {
2120 generator.GeneratorBuildActions(ctx, flags, deps)
2121 }
2122
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002123 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002124 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002125 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002126 if ctx.Failed() {
2127 return
2128 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002129 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002130 c.objFiles = objs.objFiles
2131 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002132 }
2133
Colin Crossca860ac2016-01-04 14:34:37 -08002134 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002135 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002136 if ctx.Failed() {
2137 return
2138 }
Colin Cross635c3b02016-05-18 15:37:25 -07002139 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002140
Chris Parsons94a0bba2021-06-04 15:03:47 -04002141 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002142
Jose Galmes6f843bc2020-12-11 13:36:29 -08002143 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2144 // RECOVERY_SNAPSHOT_VERSION is current.
2145 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002146 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002147 i.collectHeadersForSnapshot(ctx)
2148 }
2149 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002150 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002151 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002152 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002153 }
Colin Cross40213022023-12-13 15:19:49 -08002154 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002155
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002156 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002157
Chris Parsons94a0bba2021-06-04 15:03:47 -04002158 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002159
2160 if c.linker != nil {
2161 moduleInfoJSON := ctx.ModuleInfoJSON()
2162 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2163 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2164 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2165 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2166 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2167
2168 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2169 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2170 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2171 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2172
2173 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2174 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2175 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2176 moduleInfoJSON.SubName += ".cfi"
2177 }
2178 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2179 moduleInfoJSON.SubName += ".hwasan"
2180 }
2181 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2182 moduleInfoJSON.SubName += ".scs"
2183 }
2184 }
2185 moduleInfoJSON.SubName += c.Properties.SubName
2186
2187 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2188 moduleInfoJSON.Uninstallable = true
2189 }
2190
2191 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002192}
2193
2194func (c *Module) maybeUnhideFromMake() {
2195 // If a lib is directly included in any of the APEXes or is not available to the
2196 // platform (which is often the case when the stub is provided as a prebuilt),
2197 // unhide the stubs variant having the latest version gets visible to make. In
2198 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2199 // force anything in the make world to link against the stubs library. (unless it
2200 // is explicitly referenced via .bootstrap suffix or the module is marked with
2201 // 'bootstrap: true').
2202 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002203 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002204 c.IsStubs() && !c.InVendorRamdisk() {
2205 c.Properties.HideFromMake = false // unhide
2206 // Note: this is still non-installable
2207 }
2208}
2209
Colin Cross8ff10582023-12-07 13:10:56 -08002210// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2211// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002212func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002213 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002214 // If the module has been specifically configure to not be installed then
2215 // hide from make as otherwise it will break when running inside make
2216 // as the output path to install will not be specified. Not all uninstallable
2217 // modules can be hidden from make as some are needed for resolving make side
2218 // dependencies.
2219 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002220 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002221 c.SkipInstall()
2222 }
2223
2224 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2225 // to allow using the outputs in a genrule.
2226 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002227 c.installer.install(ctx, c.outputFile.Path())
2228 if ctx.Failed() {
2229 return
Colin Crossca860ac2016-01-04 14:34:37 -08002230 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002231 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002232}
2233
Colin Cross0ea8ba82019-06-06 14:33:29 -07002234func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002235 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002236 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002237 }
Colin Crossca860ac2016-01-04 14:34:37 -08002238 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002239}
2240
Colin Crossca860ac2016-01-04 14:34:37 -08002241func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002242 for _, generator := range c.generators {
2243 generator.GeneratorInit(ctx)
2244 }
Colin Crossca860ac2016-01-04 14:34:37 -08002245 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002246 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002247 }
Colin Crossca860ac2016-01-04 14:34:37 -08002248 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002249 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002250 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002251 if c.stl != nil {
2252 c.stl.begin(ctx)
2253 }
Colin Cross16b23492016-01-06 14:41:07 -08002254 if c.sanitize != nil {
2255 c.sanitize.begin(ctx)
2256 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002257 if c.coverage != nil {
2258 c.coverage.begin(ctx)
2259 }
Yi Kong9723e332023-12-04 14:52:53 +09002260 if c.afdo != nil {
2261 c.afdo.begin(ctx)
2262 }
Stephen Craneba090d12017-05-09 15:44:35 -07002263 if c.lto != nil {
2264 c.lto.begin(ctx)
2265 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002266 if c.orderfile != nil {
2267 c.orderfile.begin(ctx)
2268 }
Dan Albert92fe7402020-07-15 13:33:30 -07002269 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002270 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002271 if err != nil {
2272 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002273 c.Properties.Sdk_version = nil
2274 } else {
2275 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002276 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002277 }
Colin Crossca860ac2016-01-04 14:34:37 -08002278}
2279
Colin Cross37047f12016-12-13 17:06:13 -08002280func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002281 deps := Deps{}
2282
Joe Onorato37f900c2023-07-18 16:58:16 -07002283 for _, generator := range c.generators {
2284 deps = generator.GeneratorDeps(ctx, deps)
2285 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002286 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002287 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002288 }
2289 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002290 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002291 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002292 if c.stl != nil {
2293 deps = c.stl.deps(ctx, deps)
2294 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002295 if c.coverage != nil {
2296 deps = c.coverage.deps(ctx, deps)
2297 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002298
Colin Crossb6715442017-10-24 11:13:31 -07002299 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2300 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2301 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2302 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2303 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2304 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002305 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002306
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002307 for _, lib := range deps.ReexportSharedLibHeaders {
2308 if !inList(lib, deps.SharedLibs) {
2309 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2310 }
2311 }
2312
2313 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002314 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2315 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 -07002316 }
2317 }
2318
Colin Cross5950f382016-12-13 12:50:57 -08002319 for _, lib := range deps.ReexportHeaderLibHeaders {
2320 if !inList(lib, deps.HeaderLibs) {
2321 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2322 }
2323 }
2324
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002325 for _, gen := range deps.ReexportGeneratedHeaders {
2326 if !inList(gen, deps.GeneratedHeaders) {
2327 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2328 }
2329 }
2330
Colin Crossc99deeb2016-04-11 15:06:20 -07002331 return deps
2332}
2333
Dan Albert7e9d2952016-08-04 13:02:36 -07002334func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002335 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002336 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002337 moduleContextImpl: moduleContextImpl{
2338 mod: c,
2339 },
2340 }
2341 ctx.ctx = ctx
2342
Vinh Tran44cb78c2023-03-09 22:07:19 -05002343 if !actx.Host() || !ctx.static() || ctx.staticBinary() {
2344 c.afdo.addDep(ctx, actx)
2345 }
2346
Colin Crossca860ac2016-01-04 14:34:37 -08002347 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002348}
2349
Jiyong Park7ed9de32018-10-15 22:25:07 +09002350// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002351func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002352 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2353 version := name[sharp+1:]
2354 libname := name[:sharp]
2355 return libname, version
2356 }
2357 return name, ""
2358}
2359
Dan Albert92fe7402020-07-15 13:33:30 -07002360func GetCrtVariations(ctx android.BottomUpMutatorContext,
2361 m LinkableInterface) []blueprint.Variation {
2362 if ctx.Os() != android.Android {
2363 return nil
2364 }
2365 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002366 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2367 minSdkVersion := m.MinSdkVersion()
2368 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2369 minSdkVersion = m.SdkVersion()
2370 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002371 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2372 if err != nil {
2373 ctx.PropertyErrorf("min_sdk_version", err.Error())
2374 }
Colin Cross363ec762023-01-13 13:45:14 -08002375
2376 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002377 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002378 if apiLevel.LessThan(minApiForArch) {
2379 apiLevel = minApiForArch
2380 }
2381
Dan Albert92fe7402020-07-15 13:33:30 -07002382 return []blueprint.Variation{
2383 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002384 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002385 }
2386 }
2387 return []blueprint.Variation{
2388 {Mutator: "sdk", Variation: ""},
2389 }
2390}
2391
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002392func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2393 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002394
2395 variations = append([]blueprint.Variation(nil), variations...)
2396
Liz Kammer23942242022-04-08 15:41:00 -04002397 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002398 // Version is explicitly specified. i.e. libFoo#30
2399 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002400 if tag, ok := depTag.(libraryDependencyTag); ok {
2401 tag.explicitlyVersioned = true
2402 } else {
2403 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2404 }
Colin Crosse7257d22020-09-24 09:56:18 -07002405 }
Colin Crosse7257d22020-09-24 09:56:18 -07002406
Colin Cross0de8a1e2020-09-18 14:15:30 -07002407 if far {
2408 ctx.AddFarVariationDependencies(variations, depTag, name)
2409 } else {
2410 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002411 }
2412}
2413
Kiyoung Kim487689e2022-07-26 09:48:22 +09002414func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2415 apiImportInfo := multitree.ApiImportInfo{}
2416
2417 if c.Device() {
2418 var apiImportModule []blueprint.Module
2419 if actx.OtherModuleExists("api_imports") {
2420 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2421 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002422 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002423 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002424 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002425 }
2426 }
2427 }
2428
2429 return apiImportInfo
2430}
2431
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002432func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002433 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002434 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002435 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002436 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2437 // between the modules in the snapshot and the snapshot itself.
2438 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002439 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002440 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002441 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002442 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2443 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002444 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002445 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002446 *snapshotInfo = &snapshot
2447 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002448 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002449 }
2450 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002451 if *snapshotInfo == nil {
2452 *snapshotInfo = &SnapshotInfo{}
2453 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002454 return **snapshotInfo
2455}
2456
Kiyoung Kim487689e2022-07-26 09:48:22 +09002457func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2458 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002459 return snapshot
2460 }
2461
2462 return lib
2463}
2464
2465// RewriteLibs takes a list of names of shared libraries and scans it for three types
2466// of names:
2467//
2468// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002469//
2470// For each of these, it adds the name of the prebuilt module (which will be in
2471// prebuilts/ndk) to the list of nonvariant libs.
2472//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002473// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002474//
2475// For each of these, it adds the name of the ndk_library module to the list of
2476// variant libs.
2477//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002478// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002479//
2480// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002481//
2482// The caller can then know to add the variantLibs dependencies differently from the
2483// nonvariantLibs
2484func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2485 variantLibs = []string{}
2486
2487 nonvariantLibs = []string{}
2488 for _, entry := range list {
2489 // strip #version suffix out
2490 name, _ := StubsLibNameAndVersion(entry)
2491 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002492 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002493 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2494 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2495 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002496 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002497 } else {
2498 // put name#version back
2499 nonvariantLibs = append(nonvariantLibs, entry)
2500 }
2501 }
2502 return nonvariantLibs, variantLibs
2503}
2504
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002505func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2506 nonVariantLibs := []string{}
2507 variantLibs := []string{}
2508
2509 for _, lib := range libs {
2510 replaceLibName := GetReplaceModuleName(lib, replaceList)
2511 if replaceLibName == lib {
2512 // Do not handle any libs which are not in API imports
2513 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2514 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2515 variantLibs = append(variantLibs, replaceLibName)
2516 } else {
2517 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2518 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002519 }
2520
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002521 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002522}
2523
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002524func (c *Module) shouldUseApiSurface() bool {
2525 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2526 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2527 // LLNDK Variant
2528 return true
2529 }
2530
2531 if c.Properties.IsSdkVariant {
2532 // NDK Variant
2533 return true
2534 }
2535
2536 if c.isImportedApiLibrary() {
2537 // API Library should depend on API headers
2538 return true
2539 }
2540 }
2541
2542 return false
2543}
2544
Colin Cross1e676be2016-10-12 14:38:15 -07002545func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002546 if !c.Enabled() {
2547 return
2548 }
2549
Colin Cross37047f12016-12-13 17:06:13 -08002550 ctx := &depsContext{
2551 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002552 moduleContextImpl: moduleContextImpl{
2553 mod: c,
2554 },
2555 }
2556 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002557
Colin Crossc99deeb2016-04-11 15:06:20 -07002558 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002559 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002560
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002561 apiNdkLibs := []string{}
2562 apiLateNdkLibs := []string{}
2563
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002564 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002565 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2566 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2567 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2568 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2569 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002570 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002571
Yo Chiang219968c2020-09-22 18:45:04 +08002572 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2573
Colin Crosse0edaf92021-01-11 17:31:17 -08002574 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002575
Dan Albert914449f2016-06-17 16:45:24 -07002576 variantNdkLibs := []string{}
2577 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002578 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002579 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2580 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2581 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002582
2583 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002584 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002585 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002586 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002587
Colin Cross32ec36c2016-12-15 07:39:51 -08002588 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002589 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002590 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002591 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002592 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002593
Kiyoung Kim51279d32022-08-24 14:10:46 +09002594 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002595 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002596 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2597 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002598 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002599
Spandan Das73bcafc2022-08-18 23:26:00 +00002600 if c.isNDKStubLibrary() {
2601 // ndk_headers do not have any variations
2602 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002603 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002604 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002605 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002606 } else {
2607 actx.AddVariationDependencies(nil, depTag, lib)
2608 }
2609 }
2610
Dan Albertf1d14c72020-07-30 14:32:55 -07002611 if c.isNDKStubLibrary() {
2612 // NDK stubs depend on their implementation because the ABI dumps are
2613 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002614
Spandan Das8b08aea2023-03-14 19:29:34 +00002615 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2616 c.ImageVariation(),
2617 blueprint.Variation{Mutator: "link", Variation: "shared"},
2618 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002619 }
2620
Jiyong Park5d1598f2019-02-25 22:14:17 +09002621 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002622 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002623
Kiyoung Kim487689e2022-07-26 09:48:22 +09002624 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002625
Jiyong Park5d1598f2019-02-25 22:14:17 +09002626 actx.AddVariationDependencies([]blueprint.Variation{
2627 {Mutator: "link", Variation: "static"},
2628 }, depTag, lib)
2629 }
2630
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002631 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002632 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002633 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002634 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002635 }
Jiyong Parke3867542020-12-03 17:28:25 +09002636 if inList(lib, deps.ExcludeLibsForApex) {
2637 depTag.excludeInApex = true
2638 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002639
Kiyoung Kim487689e2022-07-26 09:48:22 +09002640 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002641
Dan Willemsen59339a22018-07-22 21:18:45 -07002642 actx.AddVariationDependencies([]blueprint.Variation{
2643 {Mutator: "link", Variation: "static"},
2644 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002645 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002646
Jooyung Han75568392020-03-20 04:29:24 +09002647 // staticUnwinderDep is treated as staticDep for Q apexes
2648 // so that native libraries/binaries are linked with static unwinder
2649 // because Q libc doesn't have unwinder APIs
2650 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002651 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002652 actx.AddVariationDependencies([]blueprint.Variation{
2653 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002654 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002655 }
2656
Jiyong Park7ed9de32018-10-15 22:25:07 +09002657 // shared lib names without the #version suffix
2658 var sharedLibNames []string
2659
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002660 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002661 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002662 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002663 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002664 }
Jiyong Parke3867542020-12-03 17:28:25 +09002665 if inList(lib, deps.ExcludeLibsForApex) {
2666 depTag.excludeInApex = true
2667 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002668 if inList(lib, deps.ExcludeLibsForNonApex) {
2669 depTag.excludeInNonApex = true
2670 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002671
Jiyong Park73c54ee2019-10-22 20:31:18 +09002672 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002673 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2674 name = apiLibraryName
2675 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002676 sharedLibNames = append(sharedLibNames, name)
2677
Colin Crosse7257d22020-09-24 09:56:18 -07002678 variations := []blueprint.Variation{
2679 {Mutator: "link", Variation: "shared"},
2680 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002681
2682 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2683 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2684 }
2685
2686 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2687 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2688 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002689 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002690
Colin Crossfe9acfe2021-06-14 16:13:03 -07002691 for _, lib := range deps.LateStaticLibs {
2692 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2693 actx.AddVariationDependencies([]blueprint.Variation{
2694 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002695 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002696 }
2697
Colin Cross3e5e7782022-06-17 22:17:05 +00002698 for _, lib := range deps.UnexportedStaticLibs {
2699 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2700 actx.AddVariationDependencies([]blueprint.Variation{
2701 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002702 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002703 }
2704
Jiyong Park7ed9de32018-10-15 22:25:07 +09002705 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002706 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002707 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2708 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2709 // linking against both the stubs lib and the non-stubs lib at the same time.
2710 continue
2711 }
Colin Cross6e511a92020-07-27 21:26:48 -07002712 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002713 variations := []blueprint.Variation{
2714 {Mutator: "link", Variation: "shared"},
2715 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002716 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002717 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002718
Dan Willemsen59339a22018-07-22 21:18:45 -07002719 actx.AddVariationDependencies([]blueprint.Variation{
2720 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002721 }, dataLibDepTag, deps.DataLibs...)
2722
Colin Crossc8caa062021-09-24 16:50:14 -07002723 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2724
Chris Parsons79d66a52020-06-05 17:26:16 -04002725 actx.AddVariationDependencies([]blueprint.Variation{
2726 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002727 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002728
Colin Cross68861832016-07-08 10:41:41 -07002729 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002730
2731 for _, gen := range deps.GeneratedHeaders {
2732 depTag := genHeaderDepTag
2733 if inList(gen, deps.ReexportGeneratedHeaders) {
2734 depTag = genHeaderExportDepTag
2735 }
2736 actx.AddDependency(c, depTag, gen)
2737 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002738
Dan Albert92fe7402020-07-15 13:33:30 -07002739 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002740 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002741 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002742 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002743 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002744 }
Colin Crossc465efd2021-06-11 18:00:04 -07002745 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002746 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002747 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002748 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002749 if deps.DynamicLinker != "" {
2750 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002751 }
Dan Albert914449f2016-06-17 16:45:24 -07002752
2753 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002754
2755 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002756 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002757 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002758 {Mutator: "link", Variation: "shared"},
2759 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002760 actx.AddVariationDependencies([]blueprint.Variation{
2761 {Mutator: "version", Variation: version},
2762 {Mutator: "link", Variation: "shared"},
2763 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002764
2765 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002766 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002767 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002768 {Mutator: "link", Variation: "shared"},
2769 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002770 actx.AddVariationDependencies([]blueprint.Variation{
2771 {Mutator: "version", Variation: version},
2772 {Mutator: "link", Variation: "shared"},
2773 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002774
2775 if vndkdep := c.vndkdep; vndkdep != nil {
2776 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002777 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002778 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002779 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002780 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002781 }
2782 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002783
Vinh Tran367d89d2023-04-28 11:21:25 -04002784 if len(deps.AidlLibs) > 0 {
2785 actx.AddDependency(
2786 c,
2787 aidlLibraryTag,
2788 deps.AidlLibs...,
2789 )
2790 }
2791
Kiyoung Kimee58c932022-10-25 22:59:41 +09002792 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002793}
Colin Cross21b9a242015-03-24 14:15:58 -07002794
Colin Crosse40b4ea2018-10-02 22:25:58 -07002795func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002796 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2797 c.beginMutator(ctx)
2798 }
2799}
2800
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002801// Whether a module can link to another module, taking into
2802// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002803func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002804 tag blueprint.DependencyTag) {
2805
2806 switch t := tag.(type) {
2807 case dependencyTag:
2808 if t != vndkExtDepTag {
2809 return
2810 }
2811 case libraryDependencyTag:
2812 default:
2813 return
2814 }
2815
Ivan Lozanof9e21722020-12-02 09:00:51 -05002816 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002817 // Host code is not restricted
2818 return
2819 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002820
2821 // VNDK is cc.Module supported only for now.
2822 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002823 // Though allowed dependency is limited by the image mutator,
2824 // each vendor and product module needs to check link-type
2825 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002826 if ccTo, ok := to.(*Module); ok {
2827 if ccFrom.vndkdep != nil {
2828 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2829 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002830 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002831 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002832 }
2833 return
2834 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002835 // TODO(b/244244438) : Remove this once all variants are implemented
2836 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2837 return
2838 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002839 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002840 // Platform code can link to anything
2841 return
2842 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002843 if from.InRamdisk() {
2844 // Ramdisk code is not NDK
2845 return
2846 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002847 if from.InVendorRamdisk() {
2848 // Vendor ramdisk code is not NDK
2849 return
2850 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002851 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002852 // Recovery code is not NDK
2853 return
2854 }
Colin Cross31076b32020-10-23 17:22:06 -07002855 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002856 if c.NdkPrebuiltStl() {
2857 // These are allowed, but they don't set sdk_version
2858 return
2859 }
2860 if c.StubDecorator() {
2861 // These aren't real libraries, but are the stub shared libraries that are included in
2862 // the NDK.
2863 return
2864 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002865 if c.isImportedApiLibrary() {
2866 // Imported library from the API surface is a stub library built against interface definition.
2867 return
2868 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002869 }
Logan Chien834b9a62019-01-14 15:39:03 +08002870
Ivan Lozano52767be2019-10-18 14:49:46 -07002871 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002872 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2873 // to link to libc++ (non-NDK and without sdk_version).
2874 return
2875 }
2876
Ivan Lozano52767be2019-10-18 14:49:46 -07002877 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002878 // NDK code linking to platform code is never okay.
2879 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002880 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002881 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002882 }
2883
2884 // At this point we know we have two NDK libraries, but we need to
2885 // check that we're not linking against anything built against a higher
2886 // API level, as it is only valid to link against older or equivalent
2887 // APIs.
2888
Inseob Kim01a28722018-04-11 09:48:45 +09002889 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002890 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002891 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002892 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002893 // Current can't be linked against by anything else.
2894 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002895 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002896 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002897 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002898 if err != nil {
2899 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002900 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002901 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002902 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002903 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002904 if err != nil {
2905 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002906 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002907 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002908 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002909
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002910 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002911 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002912 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002913 }
2914 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002915 }
Dan Albert202fe492017-12-15 13:56:59 -08002916
2917 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002918 fromStl := from.SelectedStl()
2919 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002920 if fromStl == "" || toStl == "" {
2921 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002922 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002923 // We can be permissive with the system "STL" since it is only the C++
2924 // ABI layer, but in the future we should make sure that everyone is
2925 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002926 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002927 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002928 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2929 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002930 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002931}
2932
Jooyung Han479ca172020-10-19 18:51:07 +09002933func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2934 if c, ok := ctx.Module().(*Module); ok {
2935 ctx.VisitDirectDeps(func(dep android.Module) {
2936 depTag := ctx.OtherModuleDependencyTag(dep)
2937 ccDep, ok := dep.(LinkableInterface)
2938 if ok {
2939 checkLinkType(ctx, c, ccDep, depTag)
2940 }
2941 })
2942 }
2943}
2944
Jiyong Park5fb8c102018-04-09 12:03:06 +09002945// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002946// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2947// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002948// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002949func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2950 check := func(child, parent android.Module) bool {
2951 to, ok := child.(*Module)
2952 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002953 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002954 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002955
Jooyung Hana70f0672019-01-18 15:20:43 +09002956 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2957 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002958 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002959
Jiyong Park0474e1f2021-01-14 14:26:06 +09002960 // These dependencies are not excercised at runtime. Tracking these will give us
2961 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002962 depTag := ctx.OtherModuleDependencyTag(child)
2963 if IsHeaderDepTag(depTag) {
2964 return false
2965 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002966 if depTag == staticVariantTag {
2967 return false
2968 }
2969 if depTag == stubImplDepTag {
2970 return false
2971 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002972
Justin Yun63e9ec72020-10-29 16:49:43 +09002973 // Even if target lib has no vendor variant, keep checking dependency
2974 // graph in case it depends on vendor_available or product_available
2975 // but not double_loadable transtively.
2976 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002977 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002978 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002979
Jiyong Park0474e1f2021-01-14 14:26:06 +09002980 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2981 // one.
2982 if Bool(to.VendorProperties.Double_loadable) {
2983 return true
2984 }
2985
Ivan Lozanod7586b62021-04-01 09:49:36 -04002986 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002987 return false
2988 }
2989
Jooyung Hana70f0672019-01-18 15:20:43 +09002990 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2991 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002992 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002993 return false
2994 }
2995 if module, ok := ctx.Module().(*Module); ok {
2996 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002997 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002998 ctx.WalkDeps(check)
2999 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003000 }
3001 }
3002}
3003
Yu Liue4312402023-01-18 09:15:31 -08003004func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3005 // For the dependency from platform to apex, use the latest stubs
3006 apexSdkVersion := android.FutureApiLevel
3007 if !apexInfo.IsForPlatform() {
3008 apexSdkVersion = apexInfo.MinSdkVersion
3009 }
3010
3011 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3012 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3013 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3014 // (b/144430859)
3015 apexSdkVersion = android.FutureApiLevel
3016 }
3017
3018 return apexSdkVersion
3019}
3020
Colin Crossc99deeb2016-04-11 15:06:20 -07003021// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003022func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003023 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003024
Colin Cross0de8a1e2020-09-18 14:15:30 -07003025 var directStaticDeps []StaticLibraryInfo
3026 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003027
Colin Cross0de8a1e2020-09-18 14:15:30 -07003028 reexportExporter := func(exporter FlagExporterInfo) {
3029 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3030 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3031 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3032 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3033 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003034 }
3035
Colin Crossff694a82023-12-13 15:54:49 -08003036 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003037 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003038
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003039 skipModuleList := map[string]bool{}
3040
3041 var apiImportInfo multitree.ApiImportInfo
3042 hasApiImportInfo := false
3043
3044 ctx.VisitDirectDeps(func(dep android.Module) {
3045 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003046 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003047 hasApiImportInfo = true
3048 }
3049 })
3050
3051 if hasApiImportInfo {
3052 targetStubModuleList := map[string]string{}
3053 targetOrigModuleList := map[string]string{}
3054
3055 // Search for dependency which both original module and API imported library with APEX stub exists
3056 ctx.VisitDirectDeps(func(dep android.Module) {
3057 depName := ctx.OtherModuleName(dep)
3058 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3059 targetStubModuleList[apiLibrary] = depName
3060 }
3061 })
3062 ctx.VisitDirectDeps(func(dep android.Module) {
3063 depName := ctx.OtherModuleName(dep)
3064 if origLibrary, ok := targetStubModuleList[depName]; ok {
3065 targetOrigModuleList[origLibrary] = depName
3066 }
3067 })
3068
3069 // Decide which library should be used between original and API imported library
3070 ctx.VisitDirectDeps(func(dep android.Module) {
3071 depName := ctx.OtherModuleName(dep)
3072 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003073 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003074 skipModuleList[depName] = true
3075 } else {
3076 skipModuleList[apiLibrary] = true
3077 }
3078 }
3079 })
3080 }
3081
Colin Crossd11fcda2017-10-23 17:59:01 -07003082 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003083 depName := ctx.OtherModuleName(dep)
3084 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003085
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003086 if _, ok := skipModuleList[depName]; ok {
3087 // skip this module because original module or API imported module matching with this should be used instead.
3088 return
3089 }
3090
Dan Willemsen47450072021-10-19 20:24:49 -07003091 if depTag == android.DarwinUniversalVariantTag {
3092 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3093 return
3094 }
3095
Vinh Tran367d89d2023-04-28 11:21:25 -04003096 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003097 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003098 depPaths.AidlLibraryInfos = append(
3099 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003100 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003101 )
3102 }
3103 }
3104
Ivan Lozano52767be2019-10-18 14:49:46 -07003105 ccDep, ok := dep.(LinkableInterface)
3106 if !ok {
3107
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003108 // handling for a few module types that aren't cc Module but that are also supported
3109 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003110 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003111 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003112 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3113 genRule.GeneratedSourceFiles()...)
3114 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003115 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003116 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003117 // Support exported headers from a generated_sources dependency
3118 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003119 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003120 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003121 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003122 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003123 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003124 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003125 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003126 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003127 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3128 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003129 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003130 // 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 +09003131 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003132
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003133 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003134 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003135 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003136 }
Colin Crosscef792e2021-06-11 18:01:26 -07003137 case CrtBeginDepTag:
3138 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3139 case CrtEndDepTag:
3140 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003141 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003142 return
3143 }
3144
Colin Crossfe17f6f2019-03-28 19:30:56 -07003145 if depTag == android.ProtoPluginDepTag {
3146 return
3147 }
3148
Colin Crossd11fcda2017-10-23 17:59:01 -07003149 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003150 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3151 return
3152 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003153 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003154 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3155 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003156 return
3157 }
3158
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003159 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003160 // Skip reused objects for stub libraries, they use their own stub object file instead.
3161 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3162 // version mutator, so the stubs variant is created from the shared variant that
3163 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003164 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003165 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003166 objs := staticAnalogue.ReuseObjects
3167 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003168 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003169 reexportExporter(depExporterInfo)
3170 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003171 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003172 }
3173
Colin Cross6e511a92020-07-27 21:26:48 -07003174 linkFile := ccDep.OutputFile()
3175
3176 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3177 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003178 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003179 return
3180 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003181
Jiyong Parke3867542020-12-03 17:28:25 +09003182 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3183 return
3184 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003185 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3186 return
3187 }
Jiyong Parke3867542020-12-03 17:28:25 +09003188
Colin Cross313aa542023-12-13 13:47:44 -08003189 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003190
Colin Cross6e511a92020-07-27 21:26:48 -07003191 var ptr *android.Paths
3192 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003193
Colin Cross6e511a92020-07-27 21:26:48 -07003194 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003195
Colin Cross6e511a92020-07-27 21:26:48 -07003196 switch {
3197 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003198 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003199 if !ctx.Config().AllowMissingDependencies() {
3200 ctx.ModuleErrorf("module %q is not a header library", depName)
3201 } else {
3202 ctx.AddMissingDependencies([]string{depName})
3203 }
3204 return
3205 }
Colin Cross6e511a92020-07-27 21:26:48 -07003206 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003207 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003208 if !ctx.Config().AllowMissingDependencies() {
3209 ctx.ModuleErrorf("module %q is not a shared library", depName)
3210 } else {
3211 ctx.AddMissingDependencies([]string{depName})
3212 }
3213 return
3214 }
Jiyong Parke3867542020-12-03 17:28:25 +09003215
Jiyong Park7d55b612021-06-11 17:22:09 +09003216 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3217 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003218
Jiyong Park1ad8e162020-12-01 23:40:09 +09003219 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3220 // linkFile, depFile, and ptr.
3221 if c.IsStubs() {
3222 break
3223 }
3224
Colin Cross0de8a1e2020-09-18 14:15:30 -07003225 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3226 depFile = sharedLibraryInfo.TableOfContents
3227
Colin Cross6e511a92020-07-27 21:26:48 -07003228 ptr = &depPaths.SharedLibs
3229 switch libDepTag.Order {
3230 case earlyLibraryDependency:
3231 ptr = &depPaths.EarlySharedLibs
3232 depPtr = &depPaths.EarlySharedLibsDeps
3233 case normalLibraryDependency:
3234 ptr = &depPaths.SharedLibs
3235 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003236 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003237 case lateLibraryDependency:
3238 ptr = &depPaths.LateSharedLibs
3239 depPtr = &depPaths.LateSharedLibsDeps
3240 default:
3241 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003242 }
Colin Cross6e511a92020-07-27 21:26:48 -07003243 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003244 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3245 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003246 if !ctx.Config().AllowMissingDependencies() {
3247 ctx.ModuleErrorf("module %q is not a static library", depName)
3248 } else {
3249 ctx.AddMissingDependencies([]string{depName})
3250 }
3251 return
3252 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003253
3254 // Stubs lib doesn't link to the static lib dependencies. Don't set
3255 // linkFile, depFile, and ptr.
3256 if c.IsStubs() {
3257 break
3258 }
3259
Colin Cross0de8a1e2020-09-18 14:15:30 -07003260 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003261 if libDepTag.wholeStatic {
3262 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003263 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3264 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003265 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003266 // This case normally catches prebuilt static
3267 // libraries, but it can also occur when
3268 // AllowMissingDependencies is on and the
3269 // dependencies has no sources of its own
3270 // but has a whole_static_libs dependency
3271 // on a missing library. We want to depend
3272 // on the .a file so that there is something
3273 // in the dependency tree that contains the
3274 // error rule for the missing transitive
3275 // dependency.
3276 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003277 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003278 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3279 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003280 } else {
3281 switch libDepTag.Order {
3282 case earlyLibraryDependency:
3283 panic(fmt.Errorf("early static libs not suppported"))
3284 case normalLibraryDependency:
3285 // static dependencies will be handled separately so they can be ordered
3286 // using transitive dependencies.
3287 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003288 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003289 case lateLibraryDependency:
3290 ptr = &depPaths.LateStaticLibs
3291 default:
3292 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003293 }
3294 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003295 if libDepTag.unexportedSymbols {
3296 depPaths.LdFlags = append(depPaths.LdFlags,
3297 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3298 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003299 }
3300
Colin Cross6e511a92020-07-27 21:26:48 -07003301 if libDepTag.static() && !libDepTag.wholeStatic {
3302 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3303 ctx.ModuleErrorf("module %q not a static library", depName)
3304 return
3305 }
Logan Chien43d34c32017-12-20 01:17:32 +08003306
Colin Cross6e511a92020-07-27 21:26:48 -07003307 // When combining coverage files for shared libraries and executables, coverage files
3308 // in static libraries act as if they were whole static libraries. The same goes for
3309 // source based Abi dump files.
3310 if c, ok := ccDep.(*Module); ok {
3311 staticLib := c.linker.(libraryInterface)
3312 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3313 staticLib.objs().coverageFiles...)
3314 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3315 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003316 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003317 // Handle non-CC modules here
3318 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003319 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003320 }
3321 }
3322
Colin Cross6e511a92020-07-27 21:26:48 -07003323 if ptr != nil {
3324 if !linkFile.Valid() {
3325 if !ctx.Config().AllowMissingDependencies() {
3326 ctx.ModuleErrorf("module %q missing output file", depName)
3327 } else {
3328 ctx.AddMissingDependencies([]string{depName})
3329 }
3330 return
3331 }
3332 *ptr = append(*ptr, linkFile.Path())
3333 }
3334
3335 if depPtr != nil {
3336 dep := depFile
3337 if !dep.Valid() {
3338 dep = linkFile
3339 }
3340 *depPtr = append(*depPtr, dep.Path())
3341 }
3342
Colin Cross0de8a1e2020-09-18 14:15:30 -07003343 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3344 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3345 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3346 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3347
3348 if libDepTag.reexportFlags {
3349 reexportExporter(depExporterInfo)
3350 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3351 // Re-exported shared library headers must be included as well since they can help us with type information
3352 // about template instantiations (instantiated from their headers).
3353 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3354 // scripts.
3355 c.sabi.Properties.ReexportedIncludes = append(
3356 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3357 }
3358
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003359 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003360 switch {
3361 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003362 c.Properties.AndroidMkHeaderLibs = append(
3363 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003364 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003365 if lib := moduleLibraryInterface(dep); lib != nil {
3366 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003367 // Add the dependency to the APEX(es) providing the library so that
3368 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003369 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003370 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003371 c.Properties.ApexesProvidingSharedLibs = append(
3372 c.Properties.ApexesProvidingSharedLibs, an)
3373 }
3374 }
3375 }
3376
3377 // Note: the order of libs in this list is not important because
3378 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003379 c.Properties.AndroidMkSharedLibs = append(
3380 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003381 // Record BaseLibName for snapshots.
3382 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003383 case libDepTag.static():
3384 if libDepTag.wholeStatic {
3385 c.Properties.AndroidMkWholeStaticLibs = append(
3386 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3387 } else {
3388 c.Properties.AndroidMkStaticLibs = append(
3389 c.Properties.AndroidMkStaticLibs, makeLibName)
3390 }
Justin Yun5e035862021-06-29 20:50:37 +09003391 // Record BaseLibName for snapshots.
3392 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003393 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003394 } else if !c.IsStubs() {
3395 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3396
Colin Cross6e511a92020-07-27 21:26:48 -07003397 switch depTag {
3398 case runtimeDepTag:
3399 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003400 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003401 // Record BaseLibName for snapshots.
3402 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003403 case objDepTag:
3404 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3405 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003406 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003407 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003408 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003409 case dynamicLinkerDepTag:
3410 depPaths.DynamicLinker = linkFile
3411 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003412 }
Colin Crossca860ac2016-01-04 14:34:37 -08003413 })
3414
Jeff Gaston294356f2017-09-27 17:05:30 -07003415 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003416 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3417 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3418 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003419
Colin Crossdd84e052017-05-17 13:44:16 -07003420 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003421 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003422 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3423 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003424 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003425 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3426 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003427 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003428 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003429 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003430
3431 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003432 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003433 }
Colin Crossdd84e052017-05-17 13:44:16 -07003434
Colin Crossca860ac2016-01-04 14:34:37 -08003435 return depPaths
3436}
3437
Spandan Das604f3762023-03-16 22:51:40 +00003438func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003439 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003440 thisModule, ok := ctx.Module().(android.ApexModule)
3441 if !ok {
3442 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3443 }
3444
Kiyoung Kimaa394802024-01-08 12:55:45 +09003445 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003446 bootstrap := false
3447 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3448 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3449 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003450 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003451 bootstrap = linkable.Bootstrap()
3452 }
3453
Colin Crossff694a82023-12-13 15:54:49 -08003454 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003455
3456 useStubs := false
3457
Kiyoung Kimaa394802024-01-08 12:55:45 +09003458 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003459 if !apexInfo.IsForPlatform() {
3460 // For platform libraries, use current version of LLNDK
3461 // If this is for use_vendor apex we will apply the same rules
3462 // of apex sdk enforcement below to choose right version.
3463 useStubs = true
3464 }
3465 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3466 // If not building for APEX or the containing APEX allows the use of
3467 // platform APIs, use stubs only when it is from an APEX (and not from
3468 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3469 // bootstrap modules, always link to non-stub variant
3470 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3471
3472 isApexImportedApiLibrary := false
3473
3474 if cc, ok := dep.(*Module); ok {
3475 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3476 if apiLibrary.hasApexStubs() {
3477 isApexImportedApiLibrary = true
3478 }
3479 }
3480 }
3481
3482 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3483
3484 if useStubs {
3485 // Another exception: if this module is a test for an APEX, then
3486 // it is linked with the non-stub variant of a module in the APEX
3487 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003488 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003489 for _, apexContents := range testFor.ApexContents {
3490 if apexContents.DirectlyInApex(depName) {
3491 useStubs = false
3492 break
3493 }
3494 }
3495 }
3496 if useStubs {
3497 // Yet another exception: If this module and the dependency are
3498 // available to the same APEXes then skip stubs between their
3499 // platform variants. This complements the test_for case above,
3500 // which avoids the stubs on a direct APEX library dependency, by
3501 // avoiding stubs for indirect test dependencies as well.
3502 //
3503 // TODO(b/183882457): This doesn't work if the two libraries have
3504 // only partially overlapping apex_available. For that test_for
3505 // modules would need to be split into APEX variants and resolved
3506 // separately for each APEX they have access to.
3507 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3508 useStubs = false
3509 }
3510 }
3511 } else {
3512 // If building for APEX, use stubs when the parent is in any APEX that
3513 // the child is not in.
3514 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3515 }
3516
3517 return useStubs
3518}
3519
3520// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3521// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3522// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3523// has different level of updatability. For example, if a library foo in an APEX depends on a
3524// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3525// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3526// same APEX as foo, the non-stub variant of bar is used.
3527func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3528 depTag := ctx.OtherModuleDependencyTag(dep)
3529 libDepTag, ok := depTag.(libraryDependencyTag)
3530 if !ok || !libDepTag.shared() {
3531 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3532 }
3533
Colin Cross313aa542023-12-13 13:47:44 -08003534 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3535 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3536 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003537
3538 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003539 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003540 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003541 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3542 toUse := stubs[len(stubs)-1]
3543 sharedLibraryInfo = toUse.SharedLibraryInfo
3544 depExporterInfo = toUse.FlagExporterInfo
3545 }
3546 }
3547 return sharedLibraryInfo, depExporterInfo
3548}
3549
Colin Cross0de8a1e2020-09-18 14:15:30 -07003550// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3551// to match the topological order of the dependency tree, including any static analogues of
3552// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3553// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003554func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3555 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003556 var staticPaths android.Paths
3557 for _, staticDep := range staticDeps {
3558 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3559 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3560 }
3561 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003562 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3563 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003564 }
3565 }
3566 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3567
3568 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3569
3570 // reorder the dependencies based on transitive dependencies
3571 staticPaths = android.FirstUniquePaths(staticPaths)
3572 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3573
3574 if len(orderedStaticPaths) != len(staticPaths) {
3575 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3576 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3577 }
3578
3579 return orderedStaticPaths, transitiveStaticLibs
3580}
3581
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003582// BaseLibName trims known prefixes and suffixes
3583func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003584 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3585 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003586 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003587 return libName
3588}
3589
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003590func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003591 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003592 ccDepModule, _ := ccDep.(*Module)
3593 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003594 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003595
Justin Yuncbca3732021-02-03 19:24:13 +09003596 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003597 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003598 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003599 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003600
Ivan Lozanod1dec542021-05-26 15:33:11 -04003601 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003602 }
3603 }
3604
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003605 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3606 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003607 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3608 // core module instead.
3609 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003610 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003611 // The vendor and product modules in Make will have been renamed to not conflict with the
3612 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003613 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003614 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003615 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003616 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003617 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003618 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003619 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003620 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003621 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003622 } else {
3623 return libName
3624 }
3625}
3626
Colin Crossca860ac2016-01-04 14:34:37 -08003627func (c *Module) InstallInData() bool {
3628 if c.installer == nil {
3629 return false
3630 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003631 return c.installer.inData()
3632}
3633
3634func (c *Module) InstallInSanitizerDir() bool {
3635 if c.installer == nil {
3636 return false
3637 }
3638 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003639 return true
3640 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003641 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003642}
3643
Yifan Hong1b3348d2020-01-21 15:53:22 -08003644func (c *Module) InstallInRamdisk() bool {
3645 return c.InRamdisk()
3646}
3647
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003648func (c *Module) InstallInVendorRamdisk() bool {
3649 return c.InVendorRamdisk()
3650}
3651
Jiyong Parkf9332f12018-02-01 00:54:12 +09003652func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003653 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003654}
3655
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003656func (c *Module) MakeUninstallable() {
3657 if c.installer == nil {
3658 c.ModuleBase.MakeUninstallable()
3659 return
3660 }
3661 c.installer.makeUninstallable(c)
3662}
3663
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003664func (c *Module) HostToolPath() android.OptionalPath {
3665 if c.installer == nil {
3666 return android.OptionalPath{}
3667 }
3668 return c.installer.hostToolPath()
3669}
3670
Nan Zhangd4e641b2017-07-12 12:55:28 -07003671func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3672 return c.outputFile
3673}
3674
Colin Cross41955e82019-05-29 14:40:35 -07003675func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3676 switch tag {
3677 case "":
3678 if c.outputFile.Valid() {
3679 return android.Paths{c.outputFile.Path()}, nil
3680 }
3681 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003682 case "unstripped":
3683 if c.linker != nil {
3684 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3685 }
3686 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003687 case "stripped_all":
3688 if c.linker != nil {
3689 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3690 }
3691 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003692 default:
3693 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003694 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003695}
3696
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003697func (c *Module) static() bool {
3698 if static, ok := c.linker.(interface {
3699 static() bool
3700 }); ok {
3701 return static.static()
3702 }
3703 return false
3704}
3705
Jiyong Park379de2f2018-12-19 02:47:14 +09003706func (c *Module) staticBinary() bool {
3707 if static, ok := c.linker.(interface {
3708 staticBinary() bool
3709 }); ok {
3710 return static.staticBinary()
3711 }
3712 return false
3713}
3714
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003715func (c *Module) testBinary() bool {
3716 if test, ok := c.linker.(interface {
3717 testBinary() bool
3718 }); ok {
3719 return test.testBinary()
3720 }
3721 return false
3722}
3723
Jingwen Chen537242c2022-08-24 11:53:27 +00003724func (c *Module) testLibrary() bool {
3725 if test, ok := c.linker.(interface {
3726 testLibrary() bool
3727 }); ok {
3728 return test.testLibrary()
3729 }
3730 return false
3731}
3732
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003733func (c *Module) benchmarkBinary() bool {
3734 if b, ok := c.linker.(interface {
3735 benchmarkBinary() bool
3736 }); ok {
3737 return b.benchmarkBinary()
3738 }
3739 return false
3740}
3741
3742func (c *Module) fuzzBinary() bool {
3743 if f, ok := c.linker.(interface {
3744 fuzzBinary() bool
3745 }); ok {
3746 return f.fuzzBinary()
3747 }
3748 return false
3749}
3750
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003751// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3752func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003753 if h, ok := c.linker.(interface {
3754 header() bool
3755 }); ok {
3756 return h.header()
3757 }
3758 return false
3759}
3760
Ivan Lozanod7586b62021-04-01 09:49:36 -04003761func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003762 if b, ok := c.linker.(interface {
3763 binary() bool
3764 }); ok {
3765 return b.binary()
3766 }
3767 return false
3768}
3769
Justin Yun5e035862021-06-29 20:50:37 +09003770func (c *Module) StaticExecutable() bool {
3771 if b, ok := c.linker.(*binaryDecorator); ok {
3772 return b.static()
3773 }
3774 return false
3775}
3776
Ivan Lozanod7586b62021-04-01 09:49:36 -04003777func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003778 if o, ok := c.linker.(interface {
3779 object() bool
3780 }); ok {
3781 return o.object()
3782 }
3783 return false
3784}
3785
Ivan Lozanof9e21722020-12-02 09:00:51 -05003786func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003787 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003788 if c.IsLlndk() {
3789 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003790 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003791 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003792 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003793 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003794 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003795 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003796 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003797 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003798 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003799 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003800 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003801 return "native:product"
3802 }
Jooyung Han38002912019-05-16 04:01:54 +09003803 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003804 } else if c.InRamdisk() {
3805 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003806 } else if c.InVendorRamdisk() {
3807 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003808 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003809 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003810 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003811 return "native:ndk:none:none"
3812 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3813 //family, link := getNdkStlFamilyAndLinkType(c)
3814 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003815 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003816 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003817 } else {
3818 return "native:platform"
3819 }
3820}
3821
Jiyong Park9d452992018-10-03 00:38:19 +09003822// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003823// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003824func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003825 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003826 // Stub libs and prebuilt libs in a versioned SDK are not
3827 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003828 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003829 } else if _, ok := c.linker.(testPerSrc); ok {
3830 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003831 }
3832 return false
3833}
3834
Jiyong Parka90ca002019-10-07 15:47:24 +09003835func (c *Module) AvailableFor(what string) bool {
3836 if linker, ok := c.linker.(interface {
3837 availableFor(string) bool
3838 }); ok {
3839 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3840 } else {
3841 return c.ApexModuleBase.AvailableFor(what)
3842 }
3843}
3844
Jiyong Park62304bb2020-04-13 16:19:48 +09003845func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003846 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003847}
3848
Paul Duffin0cb37b92020-03-04 14:52:46 +00003849func (c *Module) EverInstallable() bool {
3850 return c.installer != nil &&
3851 // Check to see whether the module is actually ever installable.
3852 c.installer.everInstallable()
3853}
3854
Ivan Lozanod7586b62021-04-01 09:49:36 -04003855func (c *Module) PreventInstall() bool {
3856 return c.Properties.PreventInstall
3857}
3858
3859func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003860 if c.library != nil {
3861 if i := c.library.installable(); i != nil {
3862 return i
3863 }
3864 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003865 return c.Properties.Installable
3866}
3867
3868func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003869 ret := c.EverInstallable() &&
3870 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003871 proptools.BoolDefault(c.Installable(), true) &&
3872 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003873
3874 // The platform variant doesn't need further condition. Apex variants however might not
3875 // be installable because it will likely to be included in the APEX and won't appear
3876 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003877 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003878 return ret
3879 }
3880
3881 // Special case for modules that are configured to be installed to /data, which includes
3882 // test modules. For these modules, both APEX and non-APEX variants are considered as
3883 // installable. This is because even the APEX variants won't be included in the APEX, but
3884 // will anyway be installed to /data/*.
3885 // See b/146995717
3886 if c.InstallInData() {
3887 return ret
3888 }
3889
3890 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003891}
3892
Logan Chien41eabe62019-04-10 13:33:58 +08003893func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3894 if c.linker != nil {
3895 if library, ok := c.linker.(*libraryDecorator); ok {
3896 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3897 }
3898 }
3899}
3900
Jiyong Park45bf82e2020-12-15 22:29:02 +09003901var _ android.ApexModule = (*Module)(nil)
3902
3903// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003904func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003905 depTag := ctx.OtherModuleDependencyTag(dep)
3906 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3907
3908 if cc, ok := dep.(*Module); ok {
3909 if cc.HasStubsVariants() {
3910 if isLibDepTag && libDepTag.shared() {
3911 // dynamic dep to a stubs lib crosses APEX boundary
3912 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003913 }
Colin Cross6e511a92020-07-27 21:26:48 -07003914 if IsRuntimeDepTag(depTag) {
3915 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003916 return false
3917 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003918 }
Zhijun Heec285872021-04-24 10:47:08 -07003919 if cc.IsLlndk() {
3920 return false
3921 }
Colin Crossaac32222020-07-29 12:51:56 -07003922 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003923 // shared_lib dependency from a static lib is considered as crossing
3924 // the APEX boundary because the dependency doesn't actually is
3925 // linked; the dependency is used only during the compilation phase.
3926 return false
3927 }
Jiyong Parke3867542020-12-03 17:28:25 +09003928
3929 if isLibDepTag && libDepTag.excludeInApex {
3930 return false
3931 }
Colin Cross6e511a92020-07-27 21:26:48 -07003932 }
Colin Crossc1b36442021-05-06 13:42:48 -07003933 if depTag == stubImplDepTag {
3934 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003935 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003936 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003937 if depTag == staticVariantTag {
3938 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3939 // actually mean that the static lib (and its dependencies) are copied into the
3940 // APEX.
3941 return false
3942 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003943 return true
3944}
3945
Jiyong Park45bf82e2020-12-15 22:29:02 +09003946// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003947func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3948 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003949 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3950 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3951 return nil
3952 }
Jooyung Han749dc692020-04-15 11:03:39 +09003953 // We don't check for prebuilt modules
3954 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3955 return nil
3956 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003957
Jooyung Han749dc692020-04-15 11:03:39 +09003958 minSdkVersion := c.MinSdkVersion()
3959 if minSdkVersion == "apex_inherit" {
3960 return nil
3961 }
3962 if minSdkVersion == "" {
3963 // JNI libs within APK-in-APEX fall into here
3964 // Those are okay to set sdk_version instead
3965 // We don't have to check if this is a SDK variant because
3966 // non-SDK variant resets sdk_version, which works too.
3967 minSdkVersion = c.SdkVersion()
3968 }
Dan Albertc8060532020-07-22 22:32:17 -07003969 if minSdkVersion == "" {
3970 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3971 }
3972 // Not using nativeApiLevelFromUser because the context here is not
3973 // necessarily a native context.
3974 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003975 if err != nil {
3976 return err
3977 }
Dan Albertc8060532020-07-22 22:32:17 -07003978
Colin Cross8ca61c12022-10-06 21:00:14 -07003979 // A dependency only needs to support a min_sdk_version at least
3980 // as high as the api level that the architecture was introduced in.
3981 // This allows introducing new architectures in the platform that
3982 // need to be included in apexes that normally require an older
3983 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003984 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003985 if sdkVersion.LessThan(minApiForArch) {
3986 sdkVersion = minApiForArch
3987 }
3988
Dan Albertc8060532020-07-22 22:32:17 -07003989 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003990 return fmt.Errorf("newer SDK(%v)", ver)
3991 }
3992 return nil
3993}
3994
Paul Duffinb5769c12021-05-12 16:16:51 +01003995// Implements android.ApexModule
3996func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3997 // stub libraries and native bridge libraries are always available to platform
3998 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3999}
4000
Jooyung Han91f92032022-02-04 12:36:33 +09004001// Overrides android.ApexModuleBase.UniqueApexVariations
4002func (c *Module) UniqueApexVariations() bool {
4003 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4004 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4005 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004006 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004007 return c.UseVndk() && c.IsVndk()
4008}
4009
Inseob Kima1888ce2022-10-04 14:42:02 +09004010func (c *Module) overriddenModules() []string {
4011 if o, ok := c.linker.(overridable); ok {
4012 return o.overriddenModules()
4013 }
4014 return nil
4015}
4016
Rob Seymour925aa092021-08-10 20:42:03 +00004017var _ snapshot.RelativeInstallPath = (*Module)(nil)
4018
Liz Kammer35ca77e2021-12-22 15:31:40 -05004019type moduleType int
4020
4021const (
4022 unknownType moduleType = iota
4023 binary
4024 object
4025 fullLibrary
4026 staticLibrary
4027 sharedLibrary
4028 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004029 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004030 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004031 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004032)
4033
4034func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004035 if c.testBinary() {
4036 // testBinary is also a binary, so this comes before the c.Binary()
4037 // conditional. A testBinary has additional implicit dependencies and
4038 // other test-only semantics.
4039 return testBin
4040 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004041 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004042 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004043 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004044 } else if c.testLibrary() {
4045 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4046 // will let them add implicit compile deps on gtest, for example.
4047 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004048 // For now, treat them as regular libraries.
4049 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004050 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004051 static := false
4052 shared := false
4053 if library, ok := c.linker.(*libraryDecorator); ok {
4054 static = library.MutatedProperties.BuildStatic
4055 shared = library.MutatedProperties.BuildShared
4056 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4057 static = library.MutatedProperties.BuildStatic
4058 shared = library.MutatedProperties.BuildShared
4059 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004060 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004061 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004062 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004063 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004064 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004065 return staticLibrary
4066 }
4067 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004068 } else if c.isNDKStubLibrary() {
4069 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004070 } else if c.IsNdkPrebuiltStl() {
4071 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004072 }
4073 return unknownType
4074}
4075
Colin Crosscfad1192015-11-02 16:43:11 -08004076// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004077type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004078 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004079 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004080 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004081
4082 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4083 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004084}
4085
Patrice Arrudac249c712019-03-19 17:00:29 -07004086// cc_defaults provides a set of properties that can be inherited by other cc
4087// modules. A module can use the properties from a cc_defaults using
4088// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4089// merged (when possible) by prepending the default module's values to the
4090// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004091func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004092 return DefaultsFactory()
4093}
4094
Colin Cross36242852017-06-23 15:06:31 -07004095func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004096 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004097
Colin Cross36242852017-06-23 15:06:31 -07004098 module.AddProperties(props...)
4099 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004100 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004101 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004102 &BaseCompilerProperties{},
4103 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004104 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004105 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004106 &StaticProperties{},
4107 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004108 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004109 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004110 &TestLinkerProperties{},
4111 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004112 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004113 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004114 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004115 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004116 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004117 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004118 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004119 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004120 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004121 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004122 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004123 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004124 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004125 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004126 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004127 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4128 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004129 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004130 )
Colin Crosscfad1192015-11-02 16:43:11 -08004131
Jooyung Hancc372c52019-09-25 15:18:44 +09004132 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004133
4134 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004135}
4136
Jiyong Park2286afd2020-06-16 21:58:53 +09004137func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004138 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004139}
4140
Kiyoung Kim51279d32022-08-24 14:10:46 +09004141func (c *Module) isImportedApiLibrary() bool {
4142 _, ok := c.linker.(*apiLibraryDecorator)
4143 return ok
4144}
4145
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004146func kytheExtractAllFactory() android.Singleton {
4147 return &kytheExtractAllSingleton{}
4148}
4149
4150type kytheExtractAllSingleton struct {
4151}
4152
4153func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4154 var xrefTargets android.Paths
4155 ctx.VisitAllModules(func(module android.Module) {
4156 if ccModule, ok := module.(xref); ok {
4157 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4158 }
4159 })
4160 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4161 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004162 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004163 }
4164}
4165
Jihoon Kangf78a8902022-09-01 22:47:07 +00004166func (c *Module) Partition() string {
4167 if p, ok := c.installer.(interface {
4168 getPartition() string
4169 }); ok {
4170 return p.getPartition()
4171 }
4172 return ""
4173}
4174
Colin Cross06a931b2015-10-28 17:23:31 -07004175var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004176var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004177var BoolPtr = proptools.BoolPtr
4178var String = proptools.String
4179var StringPtr = proptools.StringPtr