blob: 83b635b4a1434c3f8c1ab5b2ba3d81a57d8e6ca4 [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
Chris Parsons39a16972023-06-08 14:28:51 +000027 "android/soong/ui/metrics/bp2build_metrics_proto"
Liz Kammer1cec9d12023-06-22 10:09:47 -040028
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"
Sam Delmerico5fb794a2023-01-27 16:01:37 -050034 "android/soong/bazel/cquery"
Colin Crossb98c8b02016-07-29 13:44:28 -070035 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070036 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070037 "android/soong/genrule"
Kiyoung Kim487689e2022-07-26 09:48:22 +090038 "android/soong/multitree"
Rob Seymour925aa092021-08-10 20:42:03 +000039 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080040)
41
Colin Cross463a90e2015-06-17 14:20:06 -070042func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000043 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070044
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
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080071 ctx.BottomUp("coverage", coverageMutator).Parallel()
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
Stephen Craneba090d12017-05-09 15:44:35 -070076 ctx.TopDown("lto_deps", ltoDepsMutator)
77 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090078
Jooyung Han479ca172020-10-19 18:51:07 +090079 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090080 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070081 })
Colin Crossb98c8b02016-07-29 13:44:28 -070082
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080083 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
84 // sabi mutator needs to be run after apex mutator finishes.
85 ctx.TopDown("sabi_deps", sabiDepsMutator)
86 })
87
LaMont Jones0c10e4d2023-05-16 00:58:37 +000088 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070089}
90
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050091// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
92// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
93// edges to these modules.
94// This object is constructed in DepsMutator, by calling to various module delegates to set
95// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
96// dependencies.
97// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
98// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080099type Deps struct {
100 SharedLibs, LateSharedLibs []string
101 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800102 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800103 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700104
Colin Cross3e5e7782022-06-17 22:17:05 +0000105 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
106 // prevent automatically exporting symbols.
107 UnexportedStaticLibs []string
108
Chris Parsons79d66a52020-06-05 17:26:16 -0400109 // Used for data dependencies adjacent to tests
110 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700111 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400112
Yo Chiang219968c2020-09-22 18:45:04 +0800113 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
114 SystemSharedLibs []string
115
Vinh Tran367d89d2023-04-28 11:21:25 -0400116 // Used by DepMutator to pass aidl_library modules to aidl compiler
117 AidlLibs []string
118
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500119 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800120 StaticUnwinderIfLegacy bool
121
Colin Cross5950f382016-12-13 12:50:57 -0800122 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700123
Colin Cross81413472016-04-11 14:37:39 -0700124 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700125
Dan Willemsenb40aab62016-04-20 14:21:14 -0700126 GeneratedSources []string
127 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900128 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700129
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700130 ReexportGeneratedHeaders []string
131
Colin Crossc465efd2021-06-11 18:00:04 -0700132 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700133
134 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700135 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900136
137 // List of libs that need to be excluded for APEX variant
138 ExcludeLibsForApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700139}
140
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500141// PathDeps is a struct containing file paths to dependencies of a module.
142// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
143// It's used to construct flags for various build statements (such as for compiling and linking).
144// It is then passed to module decorator functions responsible for registering build statements
145// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800146type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700147 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900148 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700149 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900150 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700151 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700152 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700153
Colin Cross0de8a1e2020-09-18 14:15:30 -0700154 // Transitive static library dependencies of static libraries for use in ordering.
155 TranstiveStaticLibrariesForOrdering *android.DepSet
156
Colin Cross26c34ed2016-09-30 17:10:16 -0700157 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100158 Objs Objects
159 // Paths to .o files in dependencies that provide them. Note that these lists
160 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800161 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700162 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700163
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100164 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
165 // the libs from all whole_static_lib dependencies.
166 WholeStaticLibsFromPrebuilts android.Paths
167
Colin Cross26c34ed2016-09-30 17:10:16 -0700168 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700169 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900170 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700171
Inseob Kimd110f872019-12-06 13:15:38 +0900172 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000173 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900174 IncludeDirs android.Paths
175 SystemIncludeDirs android.Paths
176 ReexportedDirs android.Paths
177 ReexportedSystemDirs android.Paths
178 ReexportedFlags []string
179 ReexportedGeneratedHeaders android.Paths
180 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700181
Colin Cross26c34ed2016-09-30 17:10:16 -0700182 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700183 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700184
Dan Willemsena0790e32018-10-12 00:24:23 -0700185 // Path to the dynamic linker binary
186 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700187
188 // For Darwin builds, the path to the second architecture's output that should
189 // be combined with this architectures's output into a FAT MachO file.
190 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400191
192 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
193 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700194}
195
Colin Cross4af21ed2019-11-04 09:37:55 -0800196// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
197// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
198// command line so they can be overridden by the local module flags).
199type LocalOrGlobalFlags struct {
200 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700201 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800202 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700203 CFlags []string // Flags that apply to C and C++ source files
204 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
205 ConlyFlags []string // Flags that apply to C source files
206 CppFlags []string // Flags that apply to C++ source files
207 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700208 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800209}
210
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500211// Flags contains various types of command line flags (and settings) for use in building build
212// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800213type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500214 // Local flags (which individual modules are responsible for). These may override global flags.
215 Local LocalOrGlobalFlags
216 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800217 Global LocalOrGlobalFlags
218
219 aidlFlags []string // Flags that apply to aidl source files
220 rsFlags []string // Flags that apply to renderscript source files
221 libFlags []string // Flags to add libraries early to the link order
222 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
223 TidyFlags []string // Flags that apply to clang-tidy
224 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700225
Colin Crossc3199482017-03-30 15:03:04 -0700226 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800227 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700228 SystemIncludeFlags []string
229
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800230 Toolchain config.Toolchain
231 Tidy bool // True if ninja .tidy rules should be generated.
232 NeedTidyFiles bool // True if module link should depend on .tidy files
233 GcovCoverage bool // True if coverage files should be generated.
234 SAbiDump bool // True if header abi dumps should be generated.
235 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800236
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500237 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800238 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500239 // The target-device system path to the dynamic linker.
240 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800241
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700242 CFlagsDeps android.Paths // Files depended on by compiler flags
243 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800244
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500245 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700246 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800247
Colin Cross19878da2019-03-28 14:45:07 -0700248 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700249 protoC bool // Whether to use C instead of C++
250 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700251
252 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200253 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700254}
255
Colin Crossca860ac2016-01-04 14:34:37 -0800256// Properties used to compile all C or C++ modules
257type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700258 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800259 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700260
Jiyong Parkb35a8192020-08-10 15:59:36 +0900261 // The API level that this module is built against. The APIs of this API level will be
262 // visible at build time, but use of any APIs newer than min_sdk_version will render the
263 // module unloadable on older devices. In the future it will be possible to weakly-link new
264 // APIs, making the behavior match Java: such modules will load on older devices, but
265 // calling new APIs on devices that do not support them will result in a crash.
266 //
267 // This property has the same behavior as sdk_version does for Java modules. For those
268 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
269 // does for Java code.
270 //
271 // In addition, setting this property causes two variants to be built, one for the platform
272 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800273 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700274
Jiyong Parkb35a8192020-08-10 15:59:36 +0900275 // Minimum OS API level supported by this C or C++ module. This property becomes the value
276 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
277 // this property is also used to ensure that the min_sdk_version of the containing module is
278 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
279 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
280 // min_sdk_version of the containing APEX. When the module
281 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900282 Min_sdk_version *string
283
Colin Crossc511bc52020-04-07 16:50:32 +0000284 // If true, always create an sdk variant and don't create a platform variant.
285 Sdk_variant_only *bool
286
Jiyong Parkde866cb2018-12-07 23:08:36 +0900287 AndroidMkSharedLibs []string `blueprint:"mutated"`
288 AndroidMkStaticLibs []string `blueprint:"mutated"`
289 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
290 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700291 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900292 HideFromMake bool `blueprint:"mutated"`
293 PreventInstall bool `blueprint:"mutated"`
294 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700295
Yo Chiang219968c2020-09-22 18:45:04 +0800296 // Set by DepsMutator.
297 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
298
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200299 // The name of the image this module is built for, suffixed with a '.'
Justin Yun5f7f7e82019-11-18 19:52:14 +0900300 ImageVariationPrefix string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200301
302 // The VNDK version this module is built against. If empty, the module is not
303 // build against the VNDK.
304 VndkVersion string `blueprint:"mutated"`
305
306 // Suffix for the name of Android.mk entries generated by this module
307 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800308
309 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
310 // file
311 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900312
Yifan Hong39143a92020-10-26 12:43:12 -0700313 // Make this module available when building for ramdisk.
314 // On device without a dedicated recovery partition, the module is only
315 // available after switching root into
316 // /first_stage_ramdisk. To expose the module before switching root, install
317 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800318 Ramdisk_available *bool
319
Yifan Hong39143a92020-10-26 12:43:12 -0700320 // Make this module available when building for vendor ramdisk.
321 // On device without a dedicated recovery partition, the module is only
322 // available after switching root into
323 // /first_stage_ramdisk. To expose the module before switching root, install
324 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700325 Vendor_ramdisk_available *bool
326
Jiyong Parkf9332f12018-02-01 00:54:12 +0900327 // Make this module available when building for recovery
328 Recovery_available *bool
329
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200330 // Used by imageMutator, set by ImageMutatorBegin()
331 CoreVariantNeeded bool `blueprint:"mutated"`
332 RamdiskVariantNeeded bool `blueprint:"mutated"`
333 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
334 RecoveryVariantNeeded bool `blueprint:"mutated"`
335
336 // A list of variations for the "image" mutator of the form
337 //<image name> '.' <version char>, for example, 'vendor.S'
338 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900339
340 // Allows this module to use non-APEX version of libraries. Useful
341 // for building binaries that are started before APEXes are activated.
342 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900343
344 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
345 // see soong/cc/config/vndk.go
346 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900347
348 // Used by vendor snapshot to record dependencies from snapshot modules.
349 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900350 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900351 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000352
Colin Cross1bc94122021-10-28 13:25:54 -0700353 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000354
355 // Set by factories of module types that can only be referenced from variants compiled against
356 // the SDK.
357 AlwaysSdk bool `blueprint:"mutated"`
358
359 // Variant is an SDK variant created by sdkMutator
360 IsSdkVariant bool `blueprint:"mutated"`
361 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
362 // variant to have a ".sdk" suffix.
363 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700364
365 // Normally Soong uses the directory structure to decide which modules
366 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800367 // different snapshots (vendor, recovery, etc.), but this property
368 // allows a partner to exclude a module normally thought of as a
369 // framework module from the vendor snapshot.
370 Exclude_from_vendor_snapshot *bool
371
372 // Normally Soong uses the directory structure to decide which modules
373 // should be included (framework) or excluded (non-framework) from the
374 // different snapshots (vendor, recovery, etc.), but this property
375 // allows a partner to exclude a module normally thought of as a
376 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800377 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900378
379 // List of APEXes that this module has private access to for testing purpose. The module
380 // can depend on libraries that are not exported by the APEXes and use private symbols
381 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000382 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800383
384 Target struct {
385 Platform struct {
386 // List of modules required by the core variant.
387 Required []string `android:"arch_variant"`
388
389 // List of modules not required by the core variant.
390 Exclude_required []string `android:"arch_variant"`
391 } `android:"arch_variant"`
392
393 Recovery struct {
394 // List of modules required by the recovery variant.
395 Required []string `android:"arch_variant"`
396
397 // List of modules not required by the recovery variant.
398 Exclude_required []string `android:"arch_variant"`
399 } `android:"arch_variant"`
400 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700401}
402
403type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900404 // whether this module should be allowed to be directly depended by other
405 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900406 // If set to true, two variants will be built separately, one like
407 // normal, and the other limited to the set of libraries and headers
408 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700409 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900410 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700411 // so it shouldn't have any unversioned runtime dependencies, or
412 // make assumptions about the system that may not be true in the
413 // future.
414 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900415 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900416 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900417 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900418 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900419 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700420 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
421 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900422
Justin Yunebcf0c52021-01-08 18:00:19 +0900423 // This is the same as the "vendor_available" except that the install path
424 // of the vendor variant is /odm or /vendor/odm.
425 // By replacing "vendor_available: true" with "odm_available: true", the
426 // module will install its vendor variant to the /odm partition or /vendor/odm.
427 // As the modules with "odm_available: true" still create the vendor variants,
428 // they can link to the other vendor modules as the vendor_available modules do.
429 // Also, the vendor modules can link to odm_available modules.
430 //
431 // It may not be used for VNDK modules.
432 Odm_available *bool
433
Justin Yun63e9ec72020-10-29 16:49:43 +0900434 // whether this module should be allowed to be directly depended by other
435 // modules with `product_specific: true` or `product_available: true`.
436 // If set to true, an additional product variant will be built separately
437 // that is limited to the set of libraries and headers that are exposed to
438 // /product modules.
439 //
440 // The product variant may be used with a different (newer) /system,
441 // so it shouldn't have any unversioned runtime dependencies, or
442 // make assumptions about the system that may not be true in the
443 // future.
444 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900445 // If set to false, this module becomes inaccessible from /product modules.
446 //
447 // Different from the 'vendor_available' property, the modules with
448 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
449 // library without 'product_available' may not be depended on by any other
450 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900451 //
452 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
453 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
454 Product_available *bool
455
Jiyong Park5fb8c102018-04-09 12:03:06 +0900456 // whether this module is capable of being loaded with other instance
457 // (possibly an older version) of the same module in the same process.
458 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
459 // can be double loaded in a vendor process if the library is also a
460 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
461 // explicitly marked as `double_loadable: true` by the owner, or the dependency
462 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
463 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800464
465 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
466 IsLLNDK bool `blueprint:"mutated"`
467
Colin Cross78212242021-01-06 14:51:30 -0800468 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
469 // set and the module is not listed in VndkMustUseVendorVariantList.
470 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
471
472 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
473 IsVNDKCore bool `blueprint:"mutated"`
474
475 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
476 IsVNDKSP bool `blueprint:"mutated"`
477
478 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
479 // module sets the llndk.private property.
480 IsVNDKPrivate bool `blueprint:"mutated"`
481
482 // IsVNDKProduct is set if a VNDK module sets the product_available property.
483 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700484
485 // IsVendorPublicLibrary is set for the core and product variants of a library that has
486 // vendor_public_library stubs.
487 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800488}
489
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500490// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
491// to understanding details about the type of the current module.
492// For example, one might call these functions to determine whether the current module is a static
493// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800494type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800495 static() bool
496 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700497 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800498 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900499 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900500 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900501 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700502 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900503 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700504 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800505 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900506 minSdkVersion() string
507 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700508 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700509 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800510 IsLlndk() bool
511 IsLlndkPublic() bool
512 isImplementationForLLNDKPublic() bool
513 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900514 isVndk() bool
515 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500516 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700517 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900518 inProduct() bool
519 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800520 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700521 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900522 inRecovery() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700523 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700524 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800525 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800526 isAfdoCompile() bool
Yi Kong7e53c572018-02-14 18:16:12 +0800527 isPgoCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800528 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900529 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800530 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800531 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800532 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700533 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700534 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900535 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800536 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700537 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700538 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800539 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800540 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800541 getSharedFlags() *SharedFlags
542}
543
544type SharedFlags struct {
545 numSharedFlags int
546 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800547}
548
549type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700550 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800551 ModuleContextIntf
552}
553
554type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700555 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800556 ModuleContextIntf
557}
558
Colin Cross37047f12016-12-13 17:06:13 -0800559type DepsContext interface {
560 android.BottomUpMutatorContext
561 ModuleContextIntf
562}
563
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500564// feature represents additional (optional) steps to building cc-related modules, such as invocation
565// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800566type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800567 flags(ctx ModuleContext, flags Flags) Flags
568 props() []interface{}
569}
570
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500571// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500572// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800573type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700574 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800575 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800576 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700577 compilerProps() []interface{}
578
Colin Cross76fada02016-07-27 10:31:13 -0700579 appendCflags([]string)
580 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700581 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800582}
583
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500584// linker is the interface for a linker decorator object. Individual module types can provide
585// their own implementation for this decorator, and thus specify custom logic regarding build
586// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800587type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700588 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800589 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700590 linkerFlags(ctx ModuleContext, flags Flags) Flags
591 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800592 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700593
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700594 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700595 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900596 unstrippedOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700597
598 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900599 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000600
601 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000602 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
603}
604
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500605// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000606type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500607 sharedLibs []string
608 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
609 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700610 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800611}
612
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500613// installer is the interface for an installer helper object. This helper is responsible for
614// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800615type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700616 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700617 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000618 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800619 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700620 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700621 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900622 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000623 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900624 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800625}
626
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800627type xref interface {
628 XrefCcFiles() android.Paths
629}
630
Inseob Kima1888ce2022-10-04 14:42:02 +0900631type overridable interface {
632 overriddenModules() []string
633}
634
Colin Cross6e511a92020-07-27 21:26:48 -0700635type libraryDependencyKind int
636
637const (
638 headerLibraryDependency = iota
639 sharedLibraryDependency
640 staticLibraryDependency
641)
642
643func (k libraryDependencyKind) String() string {
644 switch k {
645 case headerLibraryDependency:
646 return "headerLibraryDependency"
647 case sharedLibraryDependency:
648 return "sharedLibraryDependency"
649 case staticLibraryDependency:
650 return "staticLibraryDependency"
651 default:
652 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
653 }
654}
655
656type libraryDependencyOrder int
657
658const (
659 earlyLibraryDependency = -1
660 normalLibraryDependency = 0
661 lateLibraryDependency = 1
662)
663
664func (o libraryDependencyOrder) String() string {
665 switch o {
666 case earlyLibraryDependency:
667 return "earlyLibraryDependency"
668 case normalLibraryDependency:
669 return "normalLibraryDependency"
670 case lateLibraryDependency:
671 return "lateLibraryDependency"
672 default:
673 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
674 }
675}
676
677// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
678// tags that have a set of predefined tag objects that are reused for each dependency, a
679// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
680// That means that comparing a libraryDependencyTag for equality will only be equal if all
681// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
682// then check individual metadata fields instead.
683type libraryDependencyTag struct {
684 blueprint.BaseDependencyTag
685
686 // These are exported so that fmt.Printf("%#v") can call their String methods.
687 Kind libraryDependencyKind
688 Order libraryDependencyOrder
689
690 wholeStatic bool
691
692 reexportFlags bool
693 explicitlyVersioned bool
694 dataLib bool
695 ndk bool
696
697 staticUnwinder bool
698
699 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900700
Cindy Zhou18417cb2020-12-10 07:12:38 -0800701 // Whether or not this dependency should skip the apex dependency check
702 skipApexAllowedDependenciesCheck bool
703
Jiyong Parke3867542020-12-03 17:28:25 +0900704 // Whether or not this dependency has to be followed for the apex variants
705 excludeInApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000706
707 // If true, don't automatically export symbols from the static library into a shared library.
708 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700709}
710
711// header returns true if the libraryDependencyTag is tagging a header lib dependency.
712func (d libraryDependencyTag) header() bool {
713 return d.Kind == headerLibraryDependency
714}
715
716// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
717func (d libraryDependencyTag) shared() bool {
718 return d.Kind == sharedLibraryDependency
719}
720
721// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
722func (d libraryDependencyTag) static() bool {
723 return d.Kind == staticLibraryDependency
724}
725
Colin Cross65cb3142021-12-10 23:05:02 +0000726func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
727 if d.shared() {
728 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
729 }
730 return nil
731}
732
733var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
734
Colin Crosse9fe2942020-11-10 18:12:15 -0800735// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
736// binaries or other shared libraries are installed as dependencies.
737func (d libraryDependencyTag) InstallDepNeeded() bool {
738 return d.shared()
739}
740
741var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
742
743// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700744// libraryDependencyTag. Each tag object is created globally and reused for multiple
745// dependencies (although since the object contains no references, assigning a tag to a
746// variable and modifying it will not modify the original). Users can compare the tag
747// returned by ctx.OtherModuleDependencyTag against the global original
748type dependencyTag struct {
749 blueprint.BaseDependencyTag
750 name string
751}
752
Colin Crosse9fe2942020-11-10 18:12:15 -0800753// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
754// libraryDependencyTag, but where the dependency needs to be installed when the parent is
755// installed.
756type installDependencyTag struct {
757 blueprint.BaseDependencyTag
758 android.InstallAlwaysNeededDependencyTag
759 name string
760}
761
Colin Crossc99deeb2016-04-11 15:06:20 -0700762var (
Colin Cross6e511a92020-07-27 21:26:48 -0700763 genSourceDepTag = dependencyTag{name: "gen source"}
764 genHeaderDepTag = dependencyTag{name: "gen header"}
765 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
766 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900767 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700768 reuseObjTag = dependencyTag{name: "reuse objects"}
769 staticVariantTag = dependencyTag{name: "static variant"}
770 vndkExtDepTag = dependencyTag{name: "vndk extends"}
771 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700772 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800773 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700774 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700775 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000776 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500777 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400778 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700779)
780
Roland Levillainf89cd092019-07-29 16:22:59 +0100781func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700782 ccLibDepTag, ok := depTag.(libraryDependencyTag)
783 return ok && ccLibDepTag.shared()
784}
785
786func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
787 ccLibDepTag, ok := depTag.(libraryDependencyTag)
788 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100789}
790
Zach Johnson3df4e632020-11-06 11:56:27 -0800791func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
792 ccLibDepTag, ok := depTag.(libraryDependencyTag)
793 return ok && ccLibDepTag.header()
794}
795
Roland Levillainf89cd092019-07-29 16:22:59 +0100796func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800797 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100798}
799
800func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700801 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100802 return ok && ccDepTag == testPerSrcDepTag
803}
804
Chris Parsonsf874e462022-05-10 13:50:12 -0400805// bazelHandler is the interface for a helper object related to deferring to Bazel for
806// processing a cc module (during Bazel mixed builds). Individual module types should define
807// their own bazel handler if they support being handled by Bazel.
808type BazelHandler interface {
809 // QueueBazelCall invokes request-queueing functions on the BazelContext
810 //so that these requests are handled when Bazel's cquery is invoked.
811 QueueBazelCall(ctx android.BaseModuleContext, label string)
812
813 // ProcessBazelQueryResponse uses information retrieved from Bazel to set properties
814 // on the current module with given label.
815 ProcessBazelQueryResponse(ctx android.ModuleContext, label string)
816}
817
Colin Crossca860ac2016-01-04 14:34:37 -0800818// Module contains the properties and members used by all C/C++ module types, and implements
819// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500820// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
821// interface.
822//
823// To define a C/C++ related module, construct a new Module object and point its delegates to
824// type-specific structs. These delegates will be invoked to register module-specific build
825// statements which may be unique to the module type. For example, module.compiler.compile() should
826// be defined so as to register build statements which are responsible for compiling the module.
827//
828// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
829// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
830// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
831// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800832type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700833 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700834
Liz Kammerea6666f2021-02-17 10:17:28 -0500835 android.BazelModuleBase
Colin Crossc472d572015-03-17 15:06:21 -0700836
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700837 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700838 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700839
Colin Crossca860ac2016-01-04 14:34:37 -0800840 // initialize before calling Init
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400841 hod android.HostOrDeviceSupported
842 multilib android.Multilib
843 bazelable bool
Colin Crossc472d572015-03-17 15:06:21 -0700844
Paul Duffina0843f62019-12-13 19:50:38 +0000845 // Allowable SdkMemberTypes of this module type.
846 sdkMemberTypes []android.SdkMemberType
847
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500848 // decorator delegates, initialize before calling Init
849 // these may contain module-specific implementations, and effectively allow for custom
850 // type-specific logic. These members may reference different objects or the same object.
851 // Functions of these decorators will be invoked to initialize and register type-specific
852 // build statements.
Chris Parsons8d6e4332021-02-22 16:13:50 -0500853 compiler compiler
854 linker linker
855 installer installer
Chris Parsonsf874e462022-05-10 13:50:12 -0400856 bazelHandler BazelHandler
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500857
858 features []feature
859 stl *stl
860 sanitize *sanitize
861 coverage *coverage
Cory Barkera1da26f2022-06-07 20:12:06 +0000862 fuzzer *fuzzer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500863 sabi *sabi
864 vndkdep *vndkdep
865 lto *lto
Yi Kongeb8efc92021-12-09 18:06:29 +0800866 afdo *afdo
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500867 pgo *pgo
Colin Cross16b23492016-01-06 14:41:07 -0800868
Colin Cross31076b32020-10-23 17:22:06 -0700869 library libraryInterface
870
Colin Cross635c3b02016-05-18 15:37:25 -0700871 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800872
Colin Crossb98c8b02016-07-29 13:44:28 -0700873 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700874
875 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800876
877 // Flags used to compile this module
878 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700879
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800880 // Shared flags among build rules of this module
881 sharedFlags SharedFlags
882
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800883 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700884 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900885
886 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800887 // Kythe (source file indexer) paths for this compilation module
888 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700889 // Object .o file output paths for this compilation module
890 objFiles android.Paths
891 // Tidy .tidy file output paths for this compilation module
892 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900893
894 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700895 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700896
897 hideApexVariantFromMake bool
Colin Crossc472d572015-03-17 15:06:21 -0700898}
899
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200900func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400901 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
902 if b, ok := c.compiler.(*baseCompiler); ok {
903 hasAidl = b.hasSrcExt(".aidl")
904 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
905 hasProto = b.hasSrcExt(".proto")
906 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
907 hasSysprop = b.hasSrcExt(".sysprop")
908 hasWinMsg = b.hasSrcExt(".mc")
909 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
910 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200911 c.AndroidModuleBase().AddJSONData(d)
912 (*d)["Cc"] = map[string]interface{}{
913 "SdkVersion": c.SdkVersion(),
914 "MinSdkVersion": c.MinSdkVersion(),
915 "VndkVersion": c.VndkVersion(),
916 "ProductSpecific": c.ProductSpecific(),
917 "SocSpecific": c.SocSpecific(),
918 "DeviceSpecific": c.DeviceSpecific(),
919 "InProduct": c.InProduct(),
920 "InVendor": c.InVendor(),
921 "InRamdisk": c.InRamdisk(),
922 "InVendorRamdisk": c.InVendorRamdisk(),
923 "InRecovery": c.InRecovery(),
924 "VendorAvailable": c.VendorAvailable(),
925 "ProductAvailable": c.ProductAvailable(),
926 "RamdiskAvailable": c.RamdiskAvailable(),
927 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
928 "RecoveryAvailable": c.RecoveryAvailable(),
929 "OdmAvailable": c.OdmAvailable(),
930 "InstallInData": c.InstallInData(),
931 "InstallInRamdisk": c.InstallInRamdisk(),
932 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
933 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
934 "InstallInRecovery": c.InstallInRecovery(),
935 "InstallInRoot": c.InstallInRoot(),
936 "IsVndk": c.IsVndk(),
937 "IsVndkExt": c.IsVndkExt(),
938 "IsVndkPrivate": c.IsVndkPrivate(),
939 "IsVndkSp": c.IsVndkSp(),
940 "IsLlndk": c.IsLlndk(),
941 "IsLlndkPublic": c.IsLlndkPublic(),
942 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
943 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
944 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
945 "ApexSdkVersion": c.apexSdkVersion,
946 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400947 "AidlSrcs": hasAidl,
948 "LexSrcs": hasLex,
949 "ProtoSrcs": hasProto,
950 "RenderscriptSrcs": hasRenderscript,
951 "SyspropSrcs": hasSysprop,
952 "WinMsgSrcs": hasWinMsg,
953 "YaccSrsc": hasYacc,
954 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200955 }
956}
957
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500958func (c *Module) SetPreventInstall() {
959 c.Properties.PreventInstall = true
960}
961
962func (c *Module) SetHideFromMake() {
963 c.Properties.HideFromMake = true
964}
965
Ivan Lozanod7586b62021-04-01 09:49:36 -0400966func (c *Module) HiddenFromMake() bool {
967 return c.Properties.HideFromMake
968}
969
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800970func (c *Module) RequiredModuleNames() []string {
971 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
972 if c.ImageVariation().Variation == android.CoreVariation {
973 required = append(required, c.Properties.Target.Platform.Required...)
974 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
975 } else if c.InRecovery() {
976 required = append(required, c.Properties.Target.Recovery.Required...)
977 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
978 }
979 return android.FirstUniqueStrings(required)
980}
981
Ivan Lozano52767be2019-10-18 14:49:46 -0700982func (c *Module) Toc() android.OptionalPath {
983 if c.linker != nil {
984 if library, ok := c.linker.(libraryInterface); ok {
985 return library.toc()
986 }
987 }
988 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
989}
990
991func (c *Module) ApiLevel() string {
992 if c.linker != nil {
993 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700994 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700995 }
996 }
997 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
998}
999
1000func (c *Module) Static() bool {
1001 if c.linker != nil {
1002 if library, ok := c.linker.(libraryInterface); ok {
1003 return library.static()
1004 }
1005 }
1006 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1007}
1008
1009func (c *Module) Shared() bool {
1010 if c.linker != nil {
1011 if library, ok := c.linker.(libraryInterface); ok {
1012 return library.shared()
1013 }
1014 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001015
Ivan Lozano52767be2019-10-18 14:49:46 -07001016 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1017}
1018
1019func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001020 if c.stl != nil {
1021 return c.stl.Properties.SelectedStl
1022 }
1023 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001024}
1025
Ivan Lozano52767be2019-10-18 14:49:46 -07001026func (c *Module) NdkPrebuiltStl() bool {
1027 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1028 return true
1029 }
1030 return false
1031}
1032
1033func (c *Module) StubDecorator() bool {
1034 if _, ok := c.linker.(*stubDecorator); ok {
1035 return true
1036 }
1037 return false
1038}
1039
1040func (c *Module) SdkVersion() string {
1041 return String(c.Properties.Sdk_version)
1042}
1043
Artur Satayev480e25b2020-04-27 18:53:18 +01001044func (c *Module) MinSdkVersion() string {
1045 return String(c.Properties.Min_sdk_version)
1046}
1047
Jiyong Park5df7bd32021-08-25 16:18:46 +09001048func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001049 if linker, ok := c.linker.(*objectLinker); ok {
1050 return linker.isCrt()
1051 }
1052 return false
1053}
1054
Jiyong Park5df7bd32021-08-25 16:18:46 +09001055func (c *Module) SplitPerApiLevel() bool {
1056 return c.canUseSdk() && c.isCrt()
1057}
1058
Colin Crossc511bc52020-04-07 16:50:32 +00001059func (c *Module) AlwaysSdk() bool {
1060 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1061}
1062
Ivan Lozano183a3212019-10-18 14:18:45 -07001063func (c *Module) CcLibrary() bool {
1064 if c.linker != nil {
1065 if _, ok := c.linker.(*libraryDecorator); ok {
1066 return true
1067 }
Colin Crossd48fe732020-09-23 20:37:24 -07001068 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1069 return true
1070 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001071 }
1072 return false
1073}
1074
1075func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001076 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001077 return true
1078 }
1079 return false
1080}
1081
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001082func (c *Module) RustLibraryInterface() bool {
1083 return false
1084}
1085
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001086func (c *Module) IsFuzzModule() bool {
1087 if _, ok := c.compiler.(*fuzzBinary); ok {
1088 return true
1089 }
1090 return false
1091}
1092
1093func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1094 return c.FuzzModule
1095}
1096
1097func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1098 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1099 return fuzzer.fuzzPackagedModule
1100 }
1101 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1102}
1103
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001104func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001105 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1106 return fuzzer.sharedLibraries
1107 }
1108 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1109}
1110
Ivan Lozano2b262972019-11-21 12:30:50 -08001111func (c *Module) NonCcVariants() bool {
1112 return false
1113}
1114
Ivan Lozano183a3212019-10-18 14:18:45 -07001115func (c *Module) SetStatic() {
1116 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001117 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001118 library.setStatic()
1119 return
1120 }
1121 }
1122 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1123}
1124
1125func (c *Module) SetShared() {
1126 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001127 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001128 library.setShared()
1129 return
1130 }
1131 }
1132 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1133}
1134
1135func (c *Module) BuildStaticVariant() bool {
1136 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001137 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001138 return library.buildStatic()
1139 }
1140 }
1141 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1142}
1143
1144func (c *Module) BuildSharedVariant() bool {
1145 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001146 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001147 return library.buildShared()
1148 }
1149 }
1150 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1151}
1152
1153func (c *Module) Module() android.Module {
1154 return c
1155}
1156
Jiyong Parkc20eee32018-09-05 22:36:17 +09001157func (c *Module) OutputFile() android.OptionalPath {
1158 return c.outputFile
1159}
1160
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001161func (c *Module) CoverageFiles() android.Paths {
1162 if c.linker != nil {
1163 if library, ok := c.linker.(libraryInterface); ok {
1164 return library.objs().coverageFiles
1165 }
1166 }
1167 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1168}
1169
Ivan Lozano183a3212019-10-18 14:18:45 -07001170var _ LinkableInterface = (*Module)(nil)
1171
Jiyong Park719b4462019-01-13 00:39:51 +09001172func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001173 if c.linker != nil {
1174 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001175 }
1176 return nil
1177}
1178
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001179func (c *Module) CoverageOutputFile() android.OptionalPath {
1180 if c.linker != nil {
1181 return c.linker.coverageOutputFilePath()
1182 }
1183 return android.OptionalPath{}
1184}
1185
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001186func (c *Module) RelativeInstallPath() string {
1187 if c.installer != nil {
1188 return c.installer.relativeInstallPath()
1189 }
1190 return ""
1191}
1192
Jooyung Han344d5432019-08-23 11:17:39 +09001193func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001194 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001195}
1196
Colin Cross36242852017-06-23 15:06:31 -07001197func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001198 c.AddProperties(&c.Properties, &c.VendorProperties)
Colin Crossca860ac2016-01-04 14:34:37 -08001199 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001200 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001201 }
1202 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001203 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001204 }
1205 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001206 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001207 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001208 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001209 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001210 }
Colin Cross16b23492016-01-06 14:41:07 -08001211 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001212 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001213 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001214 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001215 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001216 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001217 if c.fuzzer != nil {
1218 c.AddProperties(c.fuzzer.props()...)
1219 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001220 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001221 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001222 }
Justin Yun8effde42017-06-23 19:24:43 +09001223 if c.vndkdep != nil {
1224 c.AddProperties(c.vndkdep.props()...)
1225 }
Stephen Craneba090d12017-05-09 15:44:35 -07001226 if c.lto != nil {
1227 c.AddProperties(c.lto.props()...)
1228 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001229 if c.afdo != nil {
1230 c.AddProperties(c.afdo.props()...)
1231 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001232 if c.pgo != nil {
1233 c.AddProperties(c.pgo.props()...)
1234 }
Colin Crossca860ac2016-01-04 14:34:37 -08001235 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001236 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001237 }
Colin Crossc472d572015-03-17 15:06:21 -07001238
Colin Cross36242852017-06-23 15:06:31 -07001239 android.InitAndroidArchModule(c, c.hod, c.multilib)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04001240 if c.bazelable {
1241 android.InitBazelModule(c)
1242 }
Jiyong Park7916bfc2019-09-30 19:13:12 +09001243 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001244 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001245
Colin Cross36242852017-06-23 15:06:31 -07001246 return c
Colin Crossc472d572015-03-17 15:06:21 -07001247}
1248
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001249// UseVndk() returns true if this module is built against VNDK.
1250// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001251func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001252 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001253}
1254
Colin Crossc511bc52020-04-07 16:50:32 +00001255func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001256 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1257 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001258}
1259
1260func (c *Module) UseSdk() bool {
1261 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001262 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001263 }
1264 return false
1265}
1266
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001267func (c *Module) isCoverageVariant() bool {
1268 return c.coverage.Properties.IsCoverageVariant
1269}
1270
Colin Cross95f1ca02020-10-29 20:47:22 -07001271func (c *Module) IsNdk(config android.Config) bool {
1272 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001273}
1274
Colin Cross127bb8b2020-12-16 16:46:01 -08001275func (c *Module) IsLlndk() bool {
1276 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001277}
1278
Colin Cross127bb8b2020-12-16 16:46:01 -08001279func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001280 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001281}
1282
Colin Cross1f3f1302021-04-26 18:37:44 -07001283func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001284 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001285 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001286}
1287
Colin Cross5271fea2021-04-27 13:06:04 -07001288func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1289 lib := moduleLibraryInterface(m)
1290 return lib != nil && (lib.hasVendorPublicLibrary())
1291}
1292
1293// IsVendorPublicLibrary returns true for vendor public libraries.
1294func (c *Module) IsVendorPublicLibrary() bool {
1295 return c.VendorProperties.IsVendorPublicLibrary
1296}
1297
Ivan Lozanof1868af2022-04-12 13:08:36 -04001298func (c *Module) IsVndkPrebuiltLibrary() bool {
1299 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1300 return true
1301 }
1302 return false
1303}
1304
1305func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1306 return c.Properties.SdkAndPlatformVariantVisibleToMake
1307}
1308
Ivan Lozanod7586b62021-04-01 09:49:36 -04001309func (c *Module) HasLlndkStubs() bool {
1310 lib := moduleLibraryInterface(c)
1311 return lib != nil && lib.hasLLNDKStubs()
1312}
1313
1314func (c *Module) StubsVersion() string {
1315 if lib, ok := c.linker.(versionedInterface); ok {
1316 return lib.stubsVersion()
1317 }
1318 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1319}
1320
Colin Cross127bb8b2020-12-16 16:46:01 -08001321// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1322// and does not set llndk.vendor_available: false.
1323func (c *Module) isImplementationForLLNDKPublic() bool {
1324 library, _ := c.library.(*libraryDecorator)
1325 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001326 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001327}
1328
Justin Yunfd9e8042020-12-23 18:23:14 +09001329// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001330func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001331 // Check if VNDK-core-private or VNDK-SP-private
1332 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001333 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001334 }
1335
1336 // Check if LLNDK-private
1337 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001338 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001339 }
1340
1341 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001342}
1343
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001344// IsVndk() returns true if this module has a vndk variant.
1345// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1346// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001347func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001348 if vndkdep := c.vndkdep; vndkdep != nil {
1349 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001350 }
1351 return false
1352}
1353
Yi Kong4ef54592022-02-14 20:00:10 +08001354func (c *Module) isAfdoCompile() bool {
1355 if afdo := c.afdo; afdo != nil {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001356 return afdo.Properties.FdoProfilePath != nil
Yi Kong4ef54592022-02-14 20:00:10 +08001357 }
1358 return false
1359}
1360
Yi Kong7e53c572018-02-14 18:16:12 +08001361func (c *Module) isPgoCompile() bool {
1362 if pgo := c.pgo; pgo != nil {
1363 return pgo.Properties.PgoCompile
1364 }
1365 return false
1366}
1367
Yi Kongc702ebd2022-08-19 16:02:45 +08001368func (c *Module) isCfi() bool {
1369 if sanitize := c.sanitize; sanitize != nil {
1370 return Bool(sanitize.Properties.Sanitize.Cfi)
1371 }
1372 return false
1373}
1374
Yi Konged79fa32023-06-04 17:15:42 +09001375func (c *Module) isFuzzer() bool {
1376 if sanitize := c.sanitize; sanitize != nil {
1377 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1378 }
1379 return false
1380}
1381
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001382func (c *Module) isNDKStubLibrary() bool {
1383 if _, ok := c.compiler.(*stubDecorator); ok {
1384 return true
1385 }
1386 return false
1387}
1388
Ivan Lozanod7586b62021-04-01 09:49:36 -04001389func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001390 if vndkdep := c.vndkdep; vndkdep != nil {
1391 return vndkdep.isVndkSp()
1392 }
1393 return false
1394}
1395
Ivan Lozanof9e21722020-12-02 09:00:51 -05001396func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001397 if vndkdep := c.vndkdep; vndkdep != nil {
1398 return vndkdep.isVndkExt()
1399 }
1400 return false
1401}
1402
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001403func (c *Module) SubName() string {
1404 return c.Properties.SubName
1405}
1406
Ivan Lozano52767be2019-10-18 14:49:46 -07001407func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001408 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001409}
1410
Logan Chienf3511742017-10-31 18:04:35 +08001411func (c *Module) getVndkExtendsModuleName() string {
1412 if vndkdep := c.vndkdep; vndkdep != nil {
1413 return vndkdep.getVndkExtendsModuleName()
1414 }
1415 return ""
1416}
1417
Jiyong Park25fc6a92018-11-18 18:02:45 +09001418func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001419 if lib := c.library; lib != nil {
1420 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001421 }
1422 return false
1423}
1424
1425func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001426 if lib := c.library; lib != nil {
1427 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001428 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001429 return false
1430}
1431
Alan Stokes73feba32022-11-14 12:21:24 +00001432func (c *Module) IsStubsImplementationRequired() bool {
1433 if lib := c.library; lib != nil {
1434 return lib.isStubsImplementationRequired()
1435 }
1436 return false
1437}
1438
Colin Cross0477b422020-10-13 18:43:54 -07001439// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1440// the implementation. If it is an implementation library it returns its own name.
1441func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1442 name := ctx.OtherModuleName(c)
1443 if versioned, ok := c.linker.(versionedInterface); ok {
1444 name = versioned.implementationModuleName(name)
1445 }
1446 return name
1447}
1448
Martin Stjernholm2856c662020-12-02 15:03:42 +00001449// Similar to ImplementationModuleName, but uses the Make variant of the module
1450// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1451// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1452// under the premise that the prebuilt module overrides its source counterpart
1453// if it is exposed to Make).
1454func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1455 name := c.BaseModuleName()
1456 if versioned, ok := c.linker.(versionedInterface); ok {
1457 name = versioned.implementationModuleName(name)
1458 }
1459 return name
1460}
1461
Jiyong Park7d55b612021-06-11 17:22:09 +09001462func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001463 return Bool(c.Properties.Bootstrap)
1464}
1465
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001466func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001467 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1468 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1469 return false
1470 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001471 return c.linker != nil && c.linker.nativeCoverage()
1472}
1473
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001474func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001475 if p, ok := c.linker.(SnapshotInterface); ok {
1476 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001477 }
1478 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001479}
1480
Bill Peckham945441c2020-08-31 16:07:58 -07001481func (c *Module) ExcludeFromVendorSnapshot() bool {
1482 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1483}
1484
Jose Galmesf7294582020-11-13 12:07:36 -08001485func (c *Module) ExcludeFromRecoverySnapshot() bool {
1486 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1487}
1488
Jiyong Parkf1194352019-02-25 11:05:47 +09001489func isBionic(name string) bool {
1490 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001491 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001492 return true
1493 }
1494 return false
1495}
1496
Martin Stjernholm279de572019-09-10 23:18:20 +01001497func InstallToBootstrap(name string, config android.Config) bool {
Jingwen Chen29743c82023-01-25 17:49:46 +00001498 // NOTE: also update //build/bazel/rules/apex/cc.bzl#_installed_to_bootstrap
1499 // if this list is updated.
Florian Mayer95cd6db2023-03-23 17:48:07 -07001500 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001501 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001502 }
1503 return isBionic(name)
1504}
1505
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001506func (c *Module) XrefCcFiles() android.Paths {
1507 return c.kytheFiles
1508}
1509
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001510func (c *Module) isCfiAssemblySupportEnabled() bool {
1511 return c.sanitize != nil &&
1512 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1513}
1514
Inseob Kim800d1142021-06-14 12:03:51 +09001515func (c *Module) InstallInRoot() bool {
1516 return c.installer != nil && c.installer.installInRoot()
1517}
1518
Colin Crossca860ac2016-01-04 14:34:37 -08001519type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001520 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001521 moduleContextImpl
1522}
1523
Colin Cross37047f12016-12-13 17:06:13 -08001524type depsContext struct {
1525 android.BottomUpMutatorContext
1526 moduleContextImpl
1527}
1528
Colin Crossca860ac2016-01-04 14:34:37 -08001529type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001530 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001531 moduleContextImpl
1532}
1533
1534type moduleContextImpl struct {
1535 mod *Module
1536 ctx BaseModuleContext
1537}
1538
Colin Crossb98c8b02016-07-29 13:44:28 -07001539func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001540 return ctx.mod.toolchain(ctx.ctx)
1541}
1542
1543func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001544 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001545}
1546
1547func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001548 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001549}
1550
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001551func (ctx *moduleContextImpl) testBinary() bool {
1552 return ctx.mod.testBinary()
1553}
1554
Yi Kong56fc1b62022-09-06 16:24:00 +08001555func (ctx *moduleContextImpl) testLibrary() bool {
1556 return ctx.mod.testLibrary()
1557}
1558
Jiyong Park1d1119f2019-07-29 21:27:18 +09001559func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001560 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001561}
1562
Inseob Kim7f283f42020-06-01 21:53:49 +09001563func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001564 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001565}
1566
Inseob Kim1042d292020-06-01 23:23:05 +09001567func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001568 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001569}
1570
Jooyung Hanccce2f22020-03-07 03:45:53 +09001571func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001572 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001573}
1574
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001575func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001576 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001577}
1578
1579func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001580 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001581 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001582 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001583 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001584 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001585 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001586 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001587 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001588 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001589 }
1590 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001591}
1592
Jiyong Parkb35a8192020-08-10 15:59:36 +09001593func (ctx *moduleContextImpl) minSdkVersion() string {
1594 ver := ctx.mod.MinSdkVersion()
1595 if ver == "apex_inherit" && !ctx.isForPlatform() {
1596 ver = ctx.apexSdkVersion().String()
1597 }
1598 if ver == "apex_inherit" || ver == "" {
1599 ver = ctx.sdkVersion()
1600 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001601 // For crt objects, the meaning of min_sdk_version is very different from other types of
1602 // module. For them, min_sdk_version defines the oldest version that the build system will
1603 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1604 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1605 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001606 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1607 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1608 // support such an old version. The version is set to the later version in case when the
1609 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1610 // it's for an APEX.
1611 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1612 if ctx.isForPlatform() {
1613 ver = strconv.Itoa(android.FutureApiLevelInt)
1614 } else { // for apex
1615 ver = ctx.apexSdkVersion().String()
1616 if ver == "" { // in case when min_sdk_version was not set by the APEX
1617 ver = ctx.sdkVersion()
1618 }
1619 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001620 }
1621
Jiyong Parkb35a8192020-08-10 15:59:36 +09001622 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1623 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1624 minSdkVersionInt, err2 := strconv.Atoi(ver)
1625 if err == nil && err2 == nil {
1626 if sdkVersionInt < minSdkVersionInt {
1627 return strconv.Itoa(sdkVersionInt)
1628 }
1629 }
1630 return ver
1631}
1632
1633func (ctx *moduleContextImpl) isSdkVariant() bool {
1634 return ctx.mod.IsSdkVariant()
1635}
1636
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001637func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001638 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001639}
Justin Yun8effde42017-06-23 19:24:43 +09001640
Colin Cross95f1ca02020-10-29 20:47:22 -07001641func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1642 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001643}
1644
Colin Cross127bb8b2020-12-16 16:46:01 -08001645func (ctx *moduleContextImpl) IsLlndk() bool {
1646 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001647}
1648
Colin Cross127bb8b2020-12-16 16:46:01 -08001649func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1650 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001651}
1652
Colin Cross127bb8b2020-12-16 16:46:01 -08001653func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1654 return ctx.mod.isImplementationForLLNDKPublic()
1655}
1656
1657func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1658 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001659}
1660
Logan Chienf3511742017-10-31 18:04:35 +08001661func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001662 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001663}
1664
Yi Kong4ef54592022-02-14 20:00:10 +08001665func (ctx *moduleContextImpl) isAfdoCompile() bool {
1666 return ctx.mod.isAfdoCompile()
1667}
1668
Yi Kong7e53c572018-02-14 18:16:12 +08001669func (ctx *moduleContextImpl) isPgoCompile() bool {
1670 return ctx.mod.isPgoCompile()
1671}
1672
Yi Kongc702ebd2022-08-19 16:02:45 +08001673func (ctx *moduleContextImpl) isCfi() bool {
1674 return ctx.mod.isCfi()
1675}
1676
Yi Konged79fa32023-06-04 17:15:42 +09001677func (ctx *moduleContextImpl) isFuzzer() bool {
1678 return ctx.mod.isFuzzer()
1679}
1680
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001681func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1682 return ctx.mod.isNDKStubLibrary()
1683}
1684
Justin Yun8effde42017-06-23 19:24:43 +09001685func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001686 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001687}
1688
Ivan Lozanof9e21722020-12-02 09:00:51 -05001689func (ctx *moduleContextImpl) IsVndkExt() bool {
1690 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001691}
1692
Colin Cross5271fea2021-04-27 13:06:04 -07001693func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1694 return ctx.mod.IsVendorPublicLibrary()
1695}
1696
Vic Yangefd249e2018-11-12 20:19:56 -08001697func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001698 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001699}
1700
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001701func (ctx *moduleContextImpl) selectedStl() string {
1702 if stl := ctx.mod.stl; stl != nil {
1703 return stl.Properties.SelectedStl
1704 }
1705 return ""
1706}
1707
Ivan Lozanobd721262018-11-27 14:33:03 -08001708func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1709 return ctx.mod.linker.useClangLld(actx)
1710}
1711
Colin Crossce75d2c2016-10-06 16:12:58 -07001712func (ctx *moduleContextImpl) baseModuleName() string {
1713 return ctx.mod.ModuleBase.BaseModuleName()
1714}
1715
Logan Chienf3511742017-10-31 18:04:35 +08001716func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1717 return ctx.mod.getVndkExtendsModuleName()
1718}
1719
Logan Chiene274fc92019-12-03 11:18:32 -08001720func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Cross56a83212020-09-15 18:30:11 -07001721 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001722}
1723
Colin Crosse07f2312020-08-13 11:24:56 -07001724func (ctx *moduleContextImpl) apexVariationName() string {
Colin Cross56a83212020-09-15 18:30:11 -07001725 return ctx.ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001726}
1727
Dan Albertc8060532020-07-22 22:32:17 -07001728func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001729 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001730}
1731
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001732func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001733 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001734}
1735
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001736func (ctx *moduleContextImpl) nativeCoverage() bool {
1737 return ctx.mod.nativeCoverage()
1738}
1739
Colin Cross56a83212020-09-15 18:30:11 -07001740func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1741 return ctx.mod.DirectlyInAnyApex()
1742}
1743
Colin Cross95b07f22020-12-16 11:06:50 -08001744func (ctx *moduleContextImpl) isPreventInstall() bool {
1745 return ctx.mod.Properties.PreventInstall
1746}
1747
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001748func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1749 shared := &ctx.mod.sharedFlags
1750 if shared.flagsMap == nil {
1751 shared.numSharedFlags = 0
1752 shared.flagsMap = make(map[string]string)
1753 }
1754 return shared
1755}
1756
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001757func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1758 return ctx.mod.isCfiAssemblySupportEnabled()
1759}
1760
Colin Cross635c3b02016-05-18 15:37:25 -07001761func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001762 return &Module{
1763 hod: hod,
1764 multilib: multilib,
1765 }
1766}
1767
Colin Cross635c3b02016-05-18 15:37:25 -07001768func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001769 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001770 module.features = []feature{
1771 &tidyFeature{},
1772 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001773 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001774 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001775 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001776 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001777 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001778 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001779 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001780 module.afdo = &afdo{}
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001781 module.pgo = &pgo{}
Colin Crossca860ac2016-01-04 14:34:37 -08001782 return module
1783}
1784
Colin Crossce75d2c2016-10-06 16:12:58 -07001785func (c *Module) Prebuilt() *android.Prebuilt {
1786 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1787 return p.prebuilt()
1788 }
1789 return nil
1790}
1791
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001792func (c *Module) IsPrebuilt() bool {
1793 return c.Prebuilt() != nil
1794}
1795
Colin Crossce75d2c2016-10-06 16:12:58 -07001796func (c *Module) Name() string {
1797 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001798 if p, ok := c.linker.(interface {
1799 Name(string) string
1800 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001801 name = p.Name(name)
1802 }
1803 return name
1804}
1805
Alex Light3d673592019-01-18 14:37:31 -08001806func (c *Module) Symlinks() []string {
1807 if p, ok := c.installer.(interface {
1808 symlinkList() []string
1809 }); ok {
1810 return p.symlinkList()
1811 }
1812 return nil
1813}
1814
Roland Levillainf89cd092019-07-29 16:22:59 +01001815func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1816 test, ok := c.linker.(testPerSrc)
1817 return ok && test.isAllTestsVariation()
1818}
1819
Chris Parsons216e10a2020-07-09 17:12:52 -04001820func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001821 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001822 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001823 }); ok {
1824 return p.dataPaths()
1825 }
1826 return nil
1827}
1828
Ivan Lozanof1868af2022-04-12 13:08:36 -04001829func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001830 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1831 // "current", it will append the VNDK version to the name suffix.
1832 var vndkVersion string
1833 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001834 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001835 if c.ProductSpecific() {
1836 // If the module is product specific with 'product_specific: true',
1837 // do not add a name suffix because it is a base module.
1838 return ""
1839 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001840 vndkVersion = ctx.DeviceConfig().ProductVndkVersion()
Matthew Maurer52af5b02021-05-27 10:01:36 -07001841 nameSuffix = ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001842 } else {
1843 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001844 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001845 }
1846 if vndkVersion == "current" {
1847 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1848 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001849 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001850 // add version suffix only if the module is using different vndk version than the
1851 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001852 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001853 }
1854 return nameSuffix
1855}
1856
Ivan Lozanof1868af2022-04-12 13:08:36 -04001857func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1858 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001859
1860 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001861 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001862 }
1863
Colin Cross127bb8b2020-12-16 16:46:01 -08001864 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001865 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001866 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1867 // added for product variant only when we have vendor and product variants with core
1868 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001869 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001870 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001871 subName += vendorPublicLibrarySuffix
1872 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001873 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1874 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001875 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001876 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001877 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001878 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001879 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001880 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001881 subName += RecoverySuffix
1882 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1883 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001884 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001885 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001886 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001887 } else if c.IsStubs() && c.IsSdkVariant() {
1888 // Public API surface (NDK)
1889 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1890 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001891 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001892
1893 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001894}
1895
Chris Parsonsf874e462022-05-10 13:50:12 -04001896var _ android.MixedBuildBuildable = (*Module)(nil)
1897
1898func (c *Module) getBazelModuleLabel(ctx android.BaseModuleContext) string {
Trevor Radcliffe5d6fa4d2022-05-17 21:59:36 +00001899 var bazelModuleLabel string
Liz Kammer35ca77e2021-12-22 15:31:40 -05001900 if c.typ() == fullLibrary && c.static() {
Chris Parsons77acf2e2021-12-03 17:27:16 -05001901 // cc_library is a special case in bp2build; two targets are generated -- one for each
1902 // of the shared and static variants. The shared variant keeps the module name, but the
1903 // static variant uses a different suffixed name.
Trevor Radcliffe5d6fa4d2022-05-17 21:59:36 +00001904 bazelModuleLabel = bazelLabelForStaticModule(ctx, c)
1905 } else {
1906 bazelModuleLabel = c.GetBazelLabel(ctx, c)
Chris Parsonsf874e462022-05-10 13:50:12 -04001907 }
Trevor Radcliffe5d6fa4d2022-05-17 21:59:36 +00001908 labelNoPrebuilt := bazelModuleLabel
1909 if c.IsPrebuilt() {
1910 labelNoPrebuilt = android.RemoveOptionalPrebuiltPrefixFromBazelLabel(bazelModuleLabel)
1911 }
1912 return labelNoPrebuilt
Chris Parsonsf874e462022-05-10 13:50:12 -04001913}
1914
1915func (c *Module) QueueBazelCall(ctx android.BaseModuleContext) {
1916 c.bazelHandler.QueueBazelCall(ctx, c.getBazelModuleLabel(ctx))
1917}
1918
Jingwen Chen3952a902022-12-12 12:20:58 +00001919// IsMixedBuildSupported returns true if the module should be analyzed by Bazel
Jingwen Chena485d092023-04-20 12:34:08 +00001920// in any of the --bazel-mode(s).
Chris Parsonsf874e462022-05-10 13:50:12 -04001921func (c *Module) IsMixedBuildSupported(ctx android.BaseModuleContext) bool {
Yu Liu8860c6c2023-06-07 12:43:26 -07001922 if !allEnabledSanitizersSupportedByBazel(ctx, c) {
Sam Delmericoef69d472023-04-18 17:32:43 -04001923 //TODO(b/278772861) support sanitizers in Bazel rules
Yu Liue4312402023-01-18 09:15:31 -08001924 return false
1925 }
Liz Kammer1cec9d12023-06-22 10:09:47 -04001926 if !imageVariantSupportedByBazel(c) {
1927 return false
1928 }
1929 if c.IsSdkVariant() {
1930 return false
1931 }
Sam Delmericoef69d472023-04-18 17:32:43 -04001932 return c.bazelHandler != nil
1933}
1934
Liz Kammer1cec9d12023-06-22 10:09:47 -04001935func imageVariantSupportedByBazel(c *Module) bool {
1936 if c.IsLlndk() {
1937 return false
1938 }
1939 if c.InVendor() {
1940 return false
1941 }
1942 if c.InProduct() {
1943 return false
1944 }
1945 if c.InRamdisk() {
1946 return false
1947 }
1948 if c.InVendorRamdisk() {
1949 return false
1950 }
1951 if c.InRecovery() {
1952 return false
1953 }
1954 return true
1955}
1956
Yu Liu8860c6c2023-06-07 12:43:26 -07001957func allEnabledSanitizersSupportedByBazel(ctx android.BaseModuleContext, c *Module) bool {
Sam Delmericoef69d472023-04-18 17:32:43 -04001958 if c.sanitize == nil {
1959 return true
1960 }
Yu Liue4312402023-01-18 09:15:31 -08001961 sanitizeProps := &c.sanitize.Properties.SanitizeMutated
Sam Delmericoef69d472023-04-18 17:32:43 -04001962
1963 unsupportedSanitizers := []*bool{
1964 sanitizeProps.Safestack,
Sam Delmericoef69d472023-04-18 17:32:43 -04001965 sanitizeProps.Scudo,
1966 BoolPtr(len(c.sanitize.Properties.Sanitize.Recover) > 0),
Sam Delmericoef69d472023-04-18 17:32:43 -04001967 }
1968 for _, san := range unsupportedSanitizers {
1969 if Bool(san) {
1970 return false
1971 }
1972 }
1973
1974 for _, san := range Sanitizers {
1975 if san == intOverflow {
1976 // TODO(b/261058727): enable mixed builds for all modules with UBSan
1977 // Currently we can only support ubsan when minimum runtime is used.
1978 ubsanEnabled := Bool(sanitizeProps.Integer_overflow) || len(sanitizeProps.Misc_undefined) > 0
Yu Liu8860c6c2023-06-07 12:43:26 -07001979 if !ubsanEnabled || c.MinimalRuntimeNeeded() {
1980 continue
Sam Delmericoef69d472023-04-18 17:32:43 -04001981 }
Yu Liu95497dc2023-05-25 11:15:07 -07001982 } else if san == cfi {
Yu Liu8860c6c2023-06-07 12:43:26 -07001983 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1984 // Only allow cfi if this is an apex variant
1985 if !apexInfo.IsForPlatform() {
1986 continue
1987 }
1988 }
1989 if c.sanitize.isSanitizerEnabled(san) {
Sam Delmericoef69d472023-04-18 17:32:43 -04001990 return false
1991 }
1992 }
1993
1994 return true
Yu Liue4312402023-01-18 09:15:31 -08001995}
1996
1997func GetApexConfigKey(ctx android.BaseModuleContext) *android.ApexConfigKey {
1998 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1999 if !apexInfo.IsForPlatform() {
Yu Liubfb23622023-02-22 10:42:15 -08002000 if !ctx.Config().BazelContext.IsModuleDclaAllowed(ctx.Module().Name()) {
2001 return nil
2002 }
Yu Liue4312402023-01-18 09:15:31 -08002003 apexKey := android.ApexConfigKey{
2004 WithinApex: true,
2005 ApexSdkVersion: findApexSdkVersion(ctx, apexInfo).String(),
2006 }
2007 return &apexKey
2008 }
2009
2010 return nil
Chris Parsonsf874e462022-05-10 13:50:12 -04002011}
2012
2013func (c *Module) ProcessBazelQueryResponse(ctx android.ModuleContext) {
2014 bazelModuleLabel := c.getBazelModuleLabel(ctx)
Chris Parsonsf874e462022-05-10 13:50:12 -04002015 c.bazelHandler.ProcessBazelQueryResponse(ctx, bazelModuleLabel)
2016
2017 c.Properties.SubName = GetSubnameProperty(ctx, c)
2018 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2019 if !apexInfo.IsForPlatform() {
2020 c.hideApexVariantFromMake = true
Chris Parsons77acf2e2021-12-03 17:27:16 -05002021 }
Liz Kammer35ca77e2021-12-22 15:31:40 -05002022
Chris Parsonsf874e462022-05-10 13:50:12 -04002023 c.makeLinkType = GetMakeLinkType(ctx, c)
2024
2025 mctx := &moduleContext{
2026 ModuleContext: ctx,
2027 moduleContextImpl: moduleContextImpl{
2028 mod: c,
2029 },
Chris Parsons8d6e4332021-02-22 16:13:50 -05002030 }
Chris Parsonsf874e462022-05-10 13:50:12 -04002031 mctx.ctx = mctx
2032
Jingwen Chen3952a902022-12-12 12:20:58 +00002033 // TODO(b/244432500): Get the tradefed config from the bazel target instead
2034 // of generating it with Soong.
Chris Parsonsf874e462022-05-10 13:50:12 -04002035 c.maybeInstall(mctx, apexInfo)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002036}
2037
Sam Delmerico75dbca22023-04-20 13:13:25 +00002038func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
2039 ctx := &moduleContext{
2040 ModuleContext: actx,
2041 moduleContextImpl: moduleContextImpl{
2042 mod: c,
2043 },
2044 }
2045 ctx.ctx = ctx
2046 return ctx
2047}
2048
Spandan Das20fce2d2023-04-12 17:21:39 +00002049// TODO (b/277651159): Remove this allowlist
2050var (
2051 skipStubLibraryMultipleApexViolation = map[string]bool{
2052 "libclang_rt.asan": true,
2053 "libclang_rt.hwasan": true,
2054 // runtime apex
2055 "libc": true,
2056 "libc_hwasan": true,
2057 "libdl_android": true,
2058 "libm": true,
2059 "libdl": true,
2060 // art apex
2061 "libandroidio": true,
2062 "libdexfile": true,
2063 "libnativebridge": true,
2064 "libnativehelper": true,
2065 "libnativeloader": true,
2066 "libsigchain": true,
2067 }
2068)
2069
2070// Returns true if a stub library could be installed in multiple apexes
2071func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
2072 // If this is not an apex variant, no check necessary
2073 if !c.InAnyApex() {
2074 return false
2075 }
2076 // If this is not a stub library, no check necessary
2077 if !c.HasStubsVariants() {
2078 return false
2079 }
2080 // Skip the allowlist
2081 // Use BaseModuleName so that this matches prebuilts.
2082 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
2083 return false
2084 }
2085
2086 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
2087 // Stub libraries should not have more than one apex_available
2088 if len(aaWithoutTestApexes) > 1 {
2089 return true
2090 }
2091 // Stub libraries should not use the wildcard
2092 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2093 return true
2094 }
2095 // Default: no violation
2096 return false
2097}
2098
Chris Parsons8d6e4332021-02-22 16:13:50 -05002099func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002100 // Handle the case of a test module split by `test_per_src` mutator.
2101 //
2102 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2103 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2104 // module and return early, as this module does not produce an output file per se.
2105 if c.IsTestPerSrcAllTestsVariation() {
2106 c.outputFile = android.OptionalPath{}
2107 return
2108 }
2109
Ivan Lozanof1868af2022-04-12 13:08:36 -04002110 c.Properties.SubName = GetSubnameProperty(actx, c)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002111 apexInfo := actx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2112 if !apexInfo.IsForPlatform() {
2113 c.hideApexVariantFromMake = true
2114 }
2115
Chris Parsonseefc9e62021-04-02 17:36:47 -04002116 c.makeLinkType = GetMakeLinkType(actx, c)
2117
Sam Delmerico75dbca22023-04-20 13:13:25 +00002118 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002119
Colin Crossf18e1102017-11-16 14:33:08 -08002120 deps := c.depsToPaths(ctx)
2121 if ctx.Failed() {
2122 return
2123 }
2124
Spandan Das20fce2d2023-04-12 17:21:39 +00002125 if c.stubLibraryMultipleApexViolation(actx) {
2126 actx.PropertyErrorf("apex_available",
2127 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2128 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002129 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2130 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002131 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2132 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002133 }
2134
Colin Crossca860ac2016-01-04 14:34:37 -08002135 flags := Flags{
2136 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002137 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002138 }
Colin Crossca860ac2016-01-04 14:34:37 -08002139 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002140 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002141 }
2142 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002143 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002144 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002145 if c.stl != nil {
2146 flags = c.stl.flags(ctx, flags)
2147 }
Colin Cross16b23492016-01-06 14:41:07 -08002148 if c.sanitize != nil {
2149 flags = c.sanitize.flags(ctx, flags)
2150 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002151 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002152 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002153 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002154 if c.fuzzer != nil {
2155 flags = c.fuzzer.flags(ctx, flags)
2156 }
Stephen Craneba090d12017-05-09 15:44:35 -07002157 if c.lto != nil {
2158 flags = c.lto.flags(ctx, flags)
2159 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002160 if c.afdo != nil {
2161 flags = c.afdo.flags(ctx, flags)
2162 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07002163 if c.pgo != nil {
2164 flags = c.pgo.flags(ctx, flags)
2165 }
Colin Crossca860ac2016-01-04 14:34:37 -08002166 for _, feature := range c.features {
2167 flags = feature.flags(ctx, flags)
2168 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002169 if ctx.Failed() {
2170 return
2171 }
2172
Colin Cross4af21ed2019-11-04 09:37:55 -08002173 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2174 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2175 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002176
Colin Cross4af21ed2019-11-04 09:37:55 -08002177 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002178
2179 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002180 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002181 }
2182 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002183 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002184 }
2185
Colin Cross3e5e7782022-06-17 22:17:05 +00002186 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2187
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002188 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002189 // We need access to all the flags seen by a source file.
2190 if c.sabi != nil {
2191 flags = c.sabi.flags(ctx, flags)
2192 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002193
Colin Cross4af21ed2019-11-04 09:37:55 -08002194 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002195
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002196 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002197 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002198 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002199 if ctx.Failed() {
2200 return
2201 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002202 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002203 c.objFiles = objs.objFiles
2204 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002205 }
2206
Colin Crossca860ac2016-01-04 14:34:37 -08002207 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002208 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002209 if ctx.Failed() {
2210 return
2211 }
Colin Cross635c3b02016-05-18 15:37:25 -07002212 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002213
Chris Parsons94a0bba2021-06-04 15:03:47 -04002214 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002215
Jose Galmes6f843bc2020-12-11 13:36:29 -08002216 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2217 // RECOVERY_SNAPSHOT_VERSION is current.
2218 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002219 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002220 i.collectHeadersForSnapshot(ctx)
2221 }
2222 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002223 }
Colin Cross5049f022015-03-18 13:28:46 -07002224
Chris Parsons94a0bba2021-06-04 15:03:47 -04002225 c.maybeInstall(ctx, apexInfo)
2226}
2227
2228func (c *Module) maybeUnhideFromMake() {
2229 // If a lib is directly included in any of the APEXes or is not available to the
2230 // platform (which is often the case when the stub is provided as a prebuilt),
2231 // unhide the stubs variant having the latest version gets visible to make. In
2232 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2233 // force anything in the make world to link against the stubs library. (unless it
2234 // is explicitly referenced via .bootstrap suffix or the module is marked with
2235 // 'bootstrap: true').
2236 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
2237 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
2238 c.IsStubs() && !c.InVendorRamdisk() {
2239 c.Properties.HideFromMake = false // unhide
2240 // Note: this is still non-installable
2241 }
2242}
2243
Jingwen Chen3952a902022-12-12 12:20:58 +00002244// maybeInstall is called at the end of both GenerateAndroidBuildActions and
2245// ProcessBazelQueryResponse to run the install hooks for installable modules,
2246// like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002247func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002248 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002249 // If the module has been specifically configure to not be installed then
2250 // hide from make as otherwise it will break when running inside make
2251 // as the output path to install will not be specified. Not all uninstallable
2252 // modules can be hidden from make as some are needed for resolving make side
2253 // dependencies.
2254 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002255 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002256 c.SkipInstall()
2257 }
2258
2259 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2260 // to allow using the outputs in a genrule.
2261 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002262 c.installer.install(ctx, c.outputFile.Path())
2263 if ctx.Failed() {
2264 return
Colin Crossca860ac2016-01-04 14:34:37 -08002265 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002266 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002267}
2268
Sam Delmerico5fb794a2023-01-27 16:01:37 -05002269func (c *Module) setAndroidMkVariablesFromCquery(info cquery.CcAndroidMkInfo) {
2270 c.Properties.AndroidMkSharedLibs = info.LocalSharedLibs
2271 c.Properties.AndroidMkStaticLibs = info.LocalStaticLibs
2272 c.Properties.AndroidMkWholeStaticLibs = info.LocalWholeStaticLibs
2273}
2274
Colin Cross0ea8ba82019-06-06 14:33:29 -07002275func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002276 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002277 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002278 }
Colin Crossca860ac2016-01-04 14:34:37 -08002279 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002280}
2281
Colin Crossca860ac2016-01-04 14:34:37 -08002282func (c *Module) begin(ctx BaseModuleContext) {
2283 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002284 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002285 }
Colin Crossca860ac2016-01-04 14:34:37 -08002286 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002287 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002288 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002289 if c.stl != nil {
2290 c.stl.begin(ctx)
2291 }
Colin Cross16b23492016-01-06 14:41:07 -08002292 if c.sanitize != nil {
2293 c.sanitize.begin(ctx)
2294 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002295 if c.coverage != nil {
2296 c.coverage.begin(ctx)
2297 }
Stephen Craneba090d12017-05-09 15:44:35 -07002298 if c.lto != nil {
2299 c.lto.begin(ctx)
2300 }
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07002301 if c.pgo != nil {
2302 c.pgo.begin(ctx)
2303 }
Dan Albert92fe7402020-07-15 13:33:30 -07002304 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002305 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002306 if err != nil {
2307 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002308 c.Properties.Sdk_version = nil
2309 } else {
2310 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002311 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002312 }
Colin Crossca860ac2016-01-04 14:34:37 -08002313}
2314
Colin Cross37047f12016-12-13 17:06:13 -08002315func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002316 deps := Deps{}
2317
2318 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002319 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002320 }
2321 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002322 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002323 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002324 if c.stl != nil {
2325 deps = c.stl.deps(ctx, deps)
2326 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002327 if c.coverage != nil {
2328 deps = c.coverage.deps(ctx, deps)
2329 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002330
Colin Crossb6715442017-10-24 11:13:31 -07002331 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2332 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2333 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2334 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2335 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2336 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002337 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002338
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002339 for _, lib := range deps.ReexportSharedLibHeaders {
2340 if !inList(lib, deps.SharedLibs) {
2341 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2342 }
2343 }
2344
2345 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002346 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2347 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 -07002348 }
2349 }
2350
Colin Cross5950f382016-12-13 12:50:57 -08002351 for _, lib := range deps.ReexportHeaderLibHeaders {
2352 if !inList(lib, deps.HeaderLibs) {
2353 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2354 }
2355 }
2356
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002357 for _, gen := range deps.ReexportGeneratedHeaders {
2358 if !inList(gen, deps.GeneratedHeaders) {
2359 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2360 }
2361 }
2362
Colin Crossc99deeb2016-04-11 15:06:20 -07002363 return deps
2364}
2365
Dan Albert7e9d2952016-08-04 13:02:36 -07002366func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002367 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002368 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002369 moduleContextImpl: moduleContextImpl{
2370 mod: c,
2371 },
2372 }
2373 ctx.ctx = ctx
2374
Vinh Tran44cb78c2023-03-09 22:07:19 -05002375 if !actx.Host() || !ctx.static() || ctx.staticBinary() {
2376 c.afdo.addDep(ctx, actx)
2377 }
2378
Colin Crossca860ac2016-01-04 14:34:37 -08002379 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002380}
2381
Jiyong Park7ed9de32018-10-15 22:25:07 +09002382// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002383func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002384 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2385 version := name[sharp+1:]
2386 libname := name[:sharp]
2387 return libname, version
2388 }
2389 return name, ""
2390}
2391
Dan Albert92fe7402020-07-15 13:33:30 -07002392func GetCrtVariations(ctx android.BottomUpMutatorContext,
2393 m LinkableInterface) []blueprint.Variation {
2394 if ctx.Os() != android.Android {
2395 return nil
2396 }
2397 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002398 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2399 minSdkVersion := m.MinSdkVersion()
2400 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2401 minSdkVersion = m.SdkVersion()
2402 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002403 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2404 if err != nil {
2405 ctx.PropertyErrorf("min_sdk_version", err.Error())
2406 }
Colin Cross363ec762023-01-13 13:45:14 -08002407
2408 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002409 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002410 if apiLevel.LessThan(minApiForArch) {
2411 apiLevel = minApiForArch
2412 }
2413
Dan Albert92fe7402020-07-15 13:33:30 -07002414 return []blueprint.Variation{
2415 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002416 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002417 }
2418 }
2419 return []blueprint.Variation{
2420 {Mutator: "sdk", Variation: ""},
2421 }
2422}
2423
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002424func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2425 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002426
2427 variations = append([]blueprint.Variation(nil), variations...)
2428
Liz Kammer23942242022-04-08 15:41:00 -04002429 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002430 // Version is explicitly specified. i.e. libFoo#30
2431 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002432 if tag, ok := depTag.(libraryDependencyTag); ok {
2433 tag.explicitlyVersioned = true
2434 } else {
2435 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2436 }
Colin Crosse7257d22020-09-24 09:56:18 -07002437 }
Colin Crosse7257d22020-09-24 09:56:18 -07002438
Colin Cross0de8a1e2020-09-18 14:15:30 -07002439 if far {
2440 ctx.AddFarVariationDependencies(variations, depTag, name)
2441 } else {
2442 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002443 }
2444}
2445
Kiyoung Kim487689e2022-07-26 09:48:22 +09002446func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2447 apiImportInfo := multitree.ApiImportInfo{}
2448
2449 if c.Device() {
2450 var apiImportModule []blueprint.Module
2451 if actx.OtherModuleExists("api_imports") {
2452 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2453 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
2454 apiInfo := actx.OtherModuleProvider(apiImportModule[0], multitree.ApiImportsProvider).(multitree.ApiImportInfo)
2455 apiImportInfo = apiInfo
2456 actx.SetProvider(multitree.ApiImportsProvider, apiInfo)
2457 }
2458 }
2459 }
2460
2461 return apiImportInfo
2462}
2463
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002464func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002465 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002466 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002467 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002468 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2469 // between the modules in the snapshot and the snapshot itself.
2470 var snapshotModule []blueprint.Module
2471 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() {
2472 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
2473 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() {
2474 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2475 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002476 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002477 snapshot := actx.OtherModuleProvider(snapshotModule[0], SnapshotInfoProvider).(SnapshotInfo)
2478 *snapshotInfo = &snapshot
2479 // republish the snapshot for use in later mutators on this module
2480 actx.SetProvider(SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002481 }
2482 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002483 if *snapshotInfo == nil {
2484 *snapshotInfo = &SnapshotInfo{}
2485 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002486 return **snapshotInfo
2487}
2488
Kiyoung Kim487689e2022-07-26 09:48:22 +09002489func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2490 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002491 return snapshot
2492 }
2493
2494 return lib
2495}
2496
2497// RewriteLibs takes a list of names of shared libraries and scans it for three types
2498// of names:
2499//
2500// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002501//
2502// For each of these, it adds the name of the prebuilt module (which will be in
2503// prebuilts/ndk) to the list of nonvariant libs.
2504//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002505// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002506//
2507// For each of these, it adds the name of the ndk_library module to the list of
2508// variant libs.
2509//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002510// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002511//
2512// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002513//
2514// The caller can then know to add the variantLibs dependencies differently from the
2515// nonvariantLibs
2516func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2517 variantLibs = []string{}
2518
2519 nonvariantLibs = []string{}
2520 for _, entry := range list {
2521 // strip #version suffix out
2522 name, _ := StubsLibNameAndVersion(entry)
2523 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002524 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002525 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2526 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2527 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002528 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002529 } else {
2530 // put name#version back
2531 nonvariantLibs = append(nonvariantLibs, entry)
2532 }
2533 }
2534 return nonvariantLibs, variantLibs
2535}
2536
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002537func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2538 nonVariantLibs := []string{}
2539 variantLibs := []string{}
2540
2541 for _, lib := range libs {
2542 replaceLibName := GetReplaceModuleName(lib, replaceList)
2543 if replaceLibName == lib {
2544 // Do not handle any libs which are not in API imports
2545 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2546 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2547 variantLibs = append(variantLibs, replaceLibName)
2548 } else {
2549 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2550 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002551 }
2552
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002553 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002554}
2555
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002556func (c *Module) shouldUseApiSurface() bool {
2557 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2558 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2559 // LLNDK Variant
2560 return true
2561 }
2562
2563 if c.Properties.IsSdkVariant {
2564 // NDK Variant
2565 return true
2566 }
2567
2568 if c.isImportedApiLibrary() {
2569 // API Library should depend on API headers
2570 return true
2571 }
2572 }
2573
2574 return false
2575}
2576
Colin Cross1e676be2016-10-12 14:38:15 -07002577func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002578 if !c.Enabled() {
2579 return
2580 }
2581
Colin Cross37047f12016-12-13 17:06:13 -08002582 ctx := &depsContext{
2583 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002584 moduleContextImpl: moduleContextImpl{
2585 mod: c,
2586 },
2587 }
2588 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002589
Colin Crossc99deeb2016-04-11 15:06:20 -07002590 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002591 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002592
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002593 apiNdkLibs := []string{}
2594 apiLateNdkLibs := []string{}
2595
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002596 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002597 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2598 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2599 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2600 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2601 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002602 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002603
Yo Chiang219968c2020-09-22 18:45:04 +08002604 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2605
Colin Crosse0edaf92021-01-11 17:31:17 -08002606 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002607
Dan Albert914449f2016-06-17 16:45:24 -07002608 variantNdkLibs := []string{}
2609 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002610 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002611 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2612 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2613 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002614
2615 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002616 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002617 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002618 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002619
Colin Cross32ec36c2016-12-15 07:39:51 -08002620 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002621 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002622 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002623 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002624 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002625
Kiyoung Kim51279d32022-08-24 14:10:46 +09002626 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002627 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002628 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2629 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002630 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002631
Spandan Das73bcafc2022-08-18 23:26:00 +00002632 if c.isNDKStubLibrary() {
2633 // ndk_headers do not have any variations
2634 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002635 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002636 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002637 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002638 } else {
2639 actx.AddVariationDependencies(nil, depTag, lib)
2640 }
2641 }
2642
Dan Albertf1d14c72020-07-30 14:32:55 -07002643 if c.isNDKStubLibrary() {
2644 // NDK stubs depend on their implementation because the ABI dumps are
2645 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002646
Spandan Das8b08aea2023-03-14 19:29:34 +00002647 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2648 c.ImageVariation(),
2649 blueprint.Variation{Mutator: "link", Variation: "shared"},
2650 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002651 }
2652
Jiyong Park5d1598f2019-02-25 22:14:17 +09002653 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002654 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002655
Kiyoung Kim487689e2022-07-26 09:48:22 +09002656 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002657
Jiyong Park5d1598f2019-02-25 22:14:17 +09002658 actx.AddVariationDependencies([]blueprint.Variation{
2659 {Mutator: "link", Variation: "static"},
2660 }, depTag, lib)
2661 }
2662
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002663 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002664 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002665 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002666 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002667 }
Jiyong Parke3867542020-12-03 17:28:25 +09002668 if inList(lib, deps.ExcludeLibsForApex) {
2669 depTag.excludeInApex = true
2670 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002671
Kiyoung Kim487689e2022-07-26 09:48:22 +09002672 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002673
Dan Willemsen59339a22018-07-22 21:18:45 -07002674 actx.AddVariationDependencies([]blueprint.Variation{
2675 {Mutator: "link", Variation: "static"},
2676 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002677 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002678
Jooyung Han75568392020-03-20 04:29:24 +09002679 // staticUnwinderDep is treated as staticDep for Q apexes
2680 // so that native libraries/binaries are linked with static unwinder
2681 // because Q libc doesn't have unwinder APIs
2682 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002683 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002684 actx.AddVariationDependencies([]blueprint.Variation{
2685 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002686 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002687 }
2688
Jiyong Park7ed9de32018-10-15 22:25:07 +09002689 // shared lib names without the #version suffix
2690 var sharedLibNames []string
2691
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002692 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002693 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002694 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002695 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002696 }
Jiyong Parke3867542020-12-03 17:28:25 +09002697 if inList(lib, deps.ExcludeLibsForApex) {
2698 depTag.excludeInApex = true
2699 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002700
Jiyong Park73c54ee2019-10-22 20:31:18 +09002701 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002702 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2703 name = apiLibraryName
2704 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002705 sharedLibNames = append(sharedLibNames, name)
2706
Colin Crosse7257d22020-09-24 09:56:18 -07002707 variations := []blueprint.Variation{
2708 {Mutator: "link", Variation: "shared"},
2709 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002710
2711 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2712 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2713 }
2714
2715 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2716 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2717 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002718 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002719
Colin Crossfe9acfe2021-06-14 16:13:03 -07002720 for _, lib := range deps.LateStaticLibs {
2721 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2722 actx.AddVariationDependencies([]blueprint.Variation{
2723 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002724 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002725 }
2726
Colin Cross3e5e7782022-06-17 22:17:05 +00002727 for _, lib := range deps.UnexportedStaticLibs {
2728 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2729 actx.AddVariationDependencies([]blueprint.Variation{
2730 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002731 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002732 }
2733
Jiyong Park7ed9de32018-10-15 22:25:07 +09002734 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002735 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002736 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2737 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2738 // linking against both the stubs lib and the non-stubs lib at the same time.
2739 continue
2740 }
Colin Cross6e511a92020-07-27 21:26:48 -07002741 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002742 variations := []blueprint.Variation{
2743 {Mutator: "link", Variation: "shared"},
2744 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002745 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002746 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002747
Dan Willemsen59339a22018-07-22 21:18:45 -07002748 actx.AddVariationDependencies([]blueprint.Variation{
2749 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002750 }, dataLibDepTag, deps.DataLibs...)
2751
Colin Crossc8caa062021-09-24 16:50:14 -07002752 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2753
Chris Parsons79d66a52020-06-05 17:26:16 -04002754 actx.AddVariationDependencies([]blueprint.Variation{
2755 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002756 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002757
Colin Cross68861832016-07-08 10:41:41 -07002758 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002759
2760 for _, gen := range deps.GeneratedHeaders {
2761 depTag := genHeaderDepTag
2762 if inList(gen, deps.ReexportGeneratedHeaders) {
2763 depTag = genHeaderExportDepTag
2764 }
2765 actx.AddDependency(c, depTag, gen)
2766 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002767
Dan Albert92fe7402020-07-15 13:33:30 -07002768 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002769 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002770 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002771 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002772 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002773 }
Colin Crossc465efd2021-06-11 18:00:04 -07002774 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002775 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002776 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002777 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002778 if deps.DynamicLinker != "" {
2779 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002780 }
Dan Albert914449f2016-06-17 16:45:24 -07002781
2782 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002783
2784 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002785 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002786 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002787 {Mutator: "link", Variation: "shared"},
2788 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002789 actx.AddVariationDependencies([]blueprint.Variation{
2790 {Mutator: "version", Variation: version},
2791 {Mutator: "link", Variation: "shared"},
2792 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002793
2794 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002795 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002796 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002797 {Mutator: "link", Variation: "shared"},
2798 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002799 actx.AddVariationDependencies([]blueprint.Variation{
2800 {Mutator: "version", Variation: version},
2801 {Mutator: "link", Variation: "shared"},
2802 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002803
2804 if vndkdep := c.vndkdep; vndkdep != nil {
2805 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002806 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002807 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002808 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002809 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002810 }
2811 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002812
Vinh Tran367d89d2023-04-28 11:21:25 -04002813 if len(deps.AidlLibs) > 0 {
2814 actx.AddDependency(
2815 c,
2816 aidlLibraryTag,
2817 deps.AidlLibs...,
2818 )
2819 }
2820
Kiyoung Kimee58c932022-10-25 22:59:41 +09002821 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002822}
Colin Cross21b9a242015-03-24 14:15:58 -07002823
Colin Crosse40b4ea2018-10-02 22:25:58 -07002824func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002825 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2826 c.beginMutator(ctx)
2827 }
2828}
2829
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002830// Whether a module can link to another module, taking into
2831// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002832func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002833 tag blueprint.DependencyTag) {
2834
2835 switch t := tag.(type) {
2836 case dependencyTag:
2837 if t != vndkExtDepTag {
2838 return
2839 }
2840 case libraryDependencyTag:
2841 default:
2842 return
2843 }
2844
Ivan Lozanof9e21722020-12-02 09:00:51 -05002845 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002846 // Host code is not restricted
2847 return
2848 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002849
2850 // VNDK is cc.Module supported only for now.
2851 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002852 // Though allowed dependency is limited by the image mutator,
2853 // each vendor and product module needs to check link-type
2854 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002855 if ccTo, ok := to.(*Module); ok {
2856 if ccFrom.vndkdep != nil {
2857 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2858 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002859 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002860 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002861 }
2862 return
2863 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002864 // TODO(b/244244438) : Remove this once all variants are implemented
2865 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2866 return
2867 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002868 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002869 // Platform code can link to anything
2870 return
2871 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002872 if from.InRamdisk() {
2873 // Ramdisk code is not NDK
2874 return
2875 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002876 if from.InVendorRamdisk() {
2877 // Vendor ramdisk code is not NDK
2878 return
2879 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002880 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002881 // Recovery code is not NDK
2882 return
2883 }
Colin Cross31076b32020-10-23 17:22:06 -07002884 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002885 if c.NdkPrebuiltStl() {
2886 // These are allowed, but they don't set sdk_version
2887 return
2888 }
2889 if c.StubDecorator() {
2890 // These aren't real libraries, but are the stub shared libraries that are included in
2891 // the NDK.
2892 return
2893 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002894 if c.isImportedApiLibrary() {
2895 // Imported library from the API surface is a stub library built against interface definition.
2896 return
2897 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002898 }
Logan Chien834b9a62019-01-14 15:39:03 +08002899
Ivan Lozano52767be2019-10-18 14:49:46 -07002900 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002901 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2902 // to link to libc++ (non-NDK and without sdk_version).
2903 return
2904 }
2905
Ivan Lozano52767be2019-10-18 14:49:46 -07002906 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002907 // NDK code linking to platform code is never okay.
2908 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002909 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002910 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002911 }
2912
2913 // At this point we know we have two NDK libraries, but we need to
2914 // check that we're not linking against anything built against a higher
2915 // API level, as it is only valid to link against older or equivalent
2916 // APIs.
2917
Inseob Kim01a28722018-04-11 09:48:45 +09002918 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002919 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002920 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002921 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002922 // Current can't be linked against by anything else.
2923 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002924 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002925 } else {
Ivan Lozano52767be2019-10-18 14:49:46 -07002926 fromApi, err := strconv.Atoi(from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002927 if err != nil {
2928 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002929 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002930 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002931 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002932 toApi, err := strconv.Atoi(to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002933 if err != nil {
2934 ctx.PropertyErrorf("sdk_version",
Inseob Kim34b22832018-04-11 10:13:16 +09002935 "Invalid sdk_version value (must be int or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002936 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002937 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002938
Inseob Kim01a28722018-04-11 09:48:45 +09002939 if toApi > fromApi {
2940 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002941 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002942 }
2943 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002944 }
Dan Albert202fe492017-12-15 13:56:59 -08002945
2946 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002947 fromStl := from.SelectedStl()
2948 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002949 if fromStl == "" || toStl == "" {
2950 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002951 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002952 // We can be permissive with the system "STL" since it is only the C++
2953 // ABI layer, but in the future we should make sure that everyone is
2954 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002955 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002956 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002957 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2958 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002959 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002960}
2961
Jooyung Han479ca172020-10-19 18:51:07 +09002962func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2963 if c, ok := ctx.Module().(*Module); ok {
2964 ctx.VisitDirectDeps(func(dep android.Module) {
2965 depTag := ctx.OtherModuleDependencyTag(dep)
2966 ccDep, ok := dep.(LinkableInterface)
2967 if ok {
2968 checkLinkType(ctx, c, ccDep, depTag)
2969 }
2970 })
2971 }
2972}
2973
Jiyong Park5fb8c102018-04-09 12:03:06 +09002974// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002975// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2976// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002977// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002978func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2979 check := func(child, parent android.Module) bool {
2980 to, ok := child.(*Module)
2981 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002982 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002983 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002984
Jooyung Hana70f0672019-01-18 15:20:43 +09002985 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2986 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002987 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002988
Jiyong Park0474e1f2021-01-14 14:26:06 +09002989 // These dependencies are not excercised at runtime. Tracking these will give us
2990 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002991 depTag := ctx.OtherModuleDependencyTag(child)
2992 if IsHeaderDepTag(depTag) {
2993 return false
2994 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002995 if depTag == staticVariantTag {
2996 return false
2997 }
2998 if depTag == stubImplDepTag {
2999 return false
3000 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003001
Justin Yun63e9ec72020-10-29 16:49:43 +09003002 // Even if target lib has no vendor variant, keep checking dependency
3003 // graph in case it depends on vendor_available or product_available
3004 // but not double_loadable transtively.
3005 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003006 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003007 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003008
Jiyong Park0474e1f2021-01-14 14:26:06 +09003009 // The happy path. Keep tracking dependencies until we hit a non double-loadable
3010 // one.
3011 if Bool(to.VendorProperties.Double_loadable) {
3012 return true
3013 }
3014
Ivan Lozanod7586b62021-04-01 09:49:36 -04003015 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003016 return false
3017 }
3018
Jooyung Hana70f0672019-01-18 15:20:43 +09003019 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3020 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003021 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003022 return false
3023 }
3024 if module, ok := ctx.Module().(*Module); ok {
3025 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003026 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003027 ctx.WalkDeps(check)
3028 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003029 }
3030 }
3031}
3032
Yu Liue4312402023-01-18 09:15:31 -08003033func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3034 // For the dependency from platform to apex, use the latest stubs
3035 apexSdkVersion := android.FutureApiLevel
3036 if !apexInfo.IsForPlatform() {
3037 apexSdkVersion = apexInfo.MinSdkVersion
3038 }
3039
3040 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3041 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3042 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3043 // (b/144430859)
3044 apexSdkVersion = android.FutureApiLevel
3045 }
3046
3047 return apexSdkVersion
3048}
3049
Colin Crossc99deeb2016-04-11 15:06:20 -07003050// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003051func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003052 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003053
Colin Cross0de8a1e2020-09-18 14:15:30 -07003054 var directStaticDeps []StaticLibraryInfo
3055 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003056
Colin Cross0de8a1e2020-09-18 14:15:30 -07003057 reexportExporter := func(exporter FlagExporterInfo) {
3058 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3059 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3060 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3061 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3062 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003063 }
3064
Colin Cross56a83212020-09-15 18:30:11 -07003065 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Yu Liue4312402023-01-18 09:15:31 -08003066 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003067
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003068 skipModuleList := map[string]bool{}
3069
3070 var apiImportInfo multitree.ApiImportInfo
3071 hasApiImportInfo := false
3072
3073 ctx.VisitDirectDeps(func(dep android.Module) {
3074 if dep.Name() == "api_imports" {
3075 apiImportInfo = ctx.OtherModuleProvider(dep, multitree.ApiImportsProvider).(multitree.ApiImportInfo)
3076 hasApiImportInfo = true
3077 }
3078 })
3079
3080 if hasApiImportInfo {
3081 targetStubModuleList := map[string]string{}
3082 targetOrigModuleList := map[string]string{}
3083
3084 // Search for dependency which both original module and API imported library with APEX stub exists
3085 ctx.VisitDirectDeps(func(dep android.Module) {
3086 depName := ctx.OtherModuleName(dep)
3087 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3088 targetStubModuleList[apiLibrary] = depName
3089 }
3090 })
3091 ctx.VisitDirectDeps(func(dep android.Module) {
3092 depName := ctx.OtherModuleName(dep)
3093 if origLibrary, ok := targetStubModuleList[depName]; ok {
3094 targetOrigModuleList[origLibrary] = depName
3095 }
3096 })
3097
3098 // Decide which library should be used between original and API imported library
3099 ctx.VisitDirectDeps(func(dep android.Module) {
3100 depName := ctx.OtherModuleName(dep)
3101 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003102 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003103 skipModuleList[depName] = true
3104 } else {
3105 skipModuleList[apiLibrary] = true
3106 }
3107 }
3108 })
3109 }
3110
Colin Crossd11fcda2017-10-23 17:59:01 -07003111 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003112 depName := ctx.OtherModuleName(dep)
3113 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003114
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003115 if _, ok := skipModuleList[depName]; ok {
3116 // skip this module because original module or API imported module matching with this should be used instead.
3117 return
3118 }
3119
Dan Willemsen47450072021-10-19 20:24:49 -07003120 if depTag == android.DarwinUniversalVariantTag {
3121 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3122 return
3123 }
3124
Vinh Tran367d89d2023-04-28 11:21:25 -04003125 if depTag == aidlLibraryTag {
3126 if ctx.OtherModuleHasProvider(dep, aidl_library.AidlLibraryProvider) {
3127 depPaths.AidlLibraryInfos = append(
3128 depPaths.AidlLibraryInfos,
3129 ctx.OtherModuleProvider(
3130 dep,
3131 aidl_library.AidlLibraryProvider).(aidl_library.AidlLibraryInfo),
3132 )
3133 }
3134 }
3135
Ivan Lozano52767be2019-10-18 14:49:46 -07003136 ccDep, ok := dep.(LinkableInterface)
3137 if !ok {
3138
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003139 // handling for a few module types that aren't cc Module but that are also supported
3140 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003141 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003142 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003143 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3144 genRule.GeneratedSourceFiles()...)
3145 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003146 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003147 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003148 // Support exported headers from a generated_sources dependency
3149 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003150 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003151 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003152 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003153 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003154 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003155 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003156 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003157 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003158 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3159 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003160 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003161 // 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 +09003162 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003163
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003164 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003165 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003166 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003167 }
Colin Crosscef792e2021-06-11 18:01:26 -07003168 case CrtBeginDepTag:
3169 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3170 case CrtEndDepTag:
3171 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003172 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003173 return
3174 }
3175
Colin Crossfe17f6f2019-03-28 19:30:56 -07003176 if depTag == android.ProtoPluginDepTag {
3177 return
3178 }
3179
Colin Crossd11fcda2017-10-23 17:59:01 -07003180 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003181 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3182 return
3183 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003184 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003185 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3186 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003187 return
3188 }
3189
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003190 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003191 // Skip reused objects for stub libraries, they use their own stub object file instead.
3192 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3193 // version mutator, so the stubs variant is created from the shared variant that
3194 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003195 if !c.library.buildStubs() {
Colin Crossa717db72020-10-23 14:53:06 -07003196 staticAnalogue := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
3197 objs := staticAnalogue.ReuseObjects
3198 depPaths.Objs = depPaths.Objs.Append(objs)
3199 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
3200 reexportExporter(depExporterInfo)
3201 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003202 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003203 }
3204
Colin Cross6e511a92020-07-27 21:26:48 -07003205 linkFile := ccDep.OutputFile()
3206
3207 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3208 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003209 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003210 return
3211 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003212
Jiyong Parke3867542020-12-03 17:28:25 +09003213 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3214 return
3215 }
3216
Colin Cross0de8a1e2020-09-18 14:15:30 -07003217 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
Colin Crossc99deeb2016-04-11 15:06:20 -07003218
Colin Cross6e511a92020-07-27 21:26:48 -07003219 var ptr *android.Paths
3220 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003221
Colin Cross6e511a92020-07-27 21:26:48 -07003222 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003223
Colin Cross6e511a92020-07-27 21:26:48 -07003224 switch {
3225 case libDepTag.header():
Colin Cross649d8172020-12-10 12:30:21 -08003226 if !ctx.OtherModuleHasProvider(dep, HeaderLibraryInfoProvider) {
3227 if !ctx.Config().AllowMissingDependencies() {
3228 ctx.ModuleErrorf("module %q is not a header library", depName)
3229 } else {
3230 ctx.AddMissingDependencies([]string{depName})
3231 }
3232 return
3233 }
Colin Cross6e511a92020-07-27 21:26:48 -07003234 case libDepTag.shared():
Colin Cross0de8a1e2020-09-18 14:15:30 -07003235 if !ctx.OtherModuleHasProvider(dep, SharedLibraryInfoProvider) {
3236 if !ctx.Config().AllowMissingDependencies() {
3237 ctx.ModuleErrorf("module %q is not a shared library", depName)
3238 } else {
3239 ctx.AddMissingDependencies([]string{depName})
3240 }
3241 return
3242 }
Jiyong Parke3867542020-12-03 17:28:25 +09003243
Jiyong Park7d55b612021-06-11 17:22:09 +09003244 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3245 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003246
Jiyong Park1ad8e162020-12-01 23:40:09 +09003247 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3248 // linkFile, depFile, and ptr.
3249 if c.IsStubs() {
3250 break
3251 }
3252
Colin Cross0de8a1e2020-09-18 14:15:30 -07003253 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3254 depFile = sharedLibraryInfo.TableOfContents
3255
Colin Cross6e511a92020-07-27 21:26:48 -07003256 ptr = &depPaths.SharedLibs
3257 switch libDepTag.Order {
3258 case earlyLibraryDependency:
3259 ptr = &depPaths.EarlySharedLibs
3260 depPtr = &depPaths.EarlySharedLibsDeps
3261 case normalLibraryDependency:
3262 ptr = &depPaths.SharedLibs
3263 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003264 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003265 case lateLibraryDependency:
3266 ptr = &depPaths.LateSharedLibs
3267 depPtr = &depPaths.LateSharedLibsDeps
3268 default:
3269 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003270 }
Colin Cross6e511a92020-07-27 21:26:48 -07003271 case libDepTag.static():
Colin Cross0de8a1e2020-09-18 14:15:30 -07003272 if !ctx.OtherModuleHasProvider(dep, StaticLibraryInfoProvider) {
3273 if !ctx.Config().AllowMissingDependencies() {
3274 ctx.ModuleErrorf("module %q is not a static library", depName)
3275 } else {
3276 ctx.AddMissingDependencies([]string{depName})
3277 }
3278 return
3279 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003280
3281 // Stubs lib doesn't link to the static lib dependencies. Don't set
3282 // linkFile, depFile, and ptr.
3283 if c.IsStubs() {
3284 break
3285 }
3286
Colin Cross0de8a1e2020-09-18 14:15:30 -07003287 staticLibraryInfo := ctx.OtherModuleProvider(dep, StaticLibraryInfoProvider).(StaticLibraryInfo)
3288 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003289 if libDepTag.wholeStatic {
3290 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003291 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3292 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003293 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003294 // This case normally catches prebuilt static
3295 // libraries, but it can also occur when
3296 // AllowMissingDependencies is on and the
3297 // dependencies has no sources of its own
3298 // but has a whole_static_libs dependency
3299 // on a missing library. We want to depend
3300 // on the .a file so that there is something
3301 // in the dependency tree that contains the
3302 // error rule for the missing transitive
3303 // dependency.
3304 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003305 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003306 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3307 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003308 } else {
3309 switch libDepTag.Order {
3310 case earlyLibraryDependency:
3311 panic(fmt.Errorf("early static libs not suppported"))
3312 case normalLibraryDependency:
3313 // static dependencies will be handled separately so they can be ordered
3314 // using transitive dependencies.
3315 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003316 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003317 case lateLibraryDependency:
3318 ptr = &depPaths.LateStaticLibs
3319 default:
3320 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003321 }
3322 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003323 if libDepTag.unexportedSymbols {
3324 depPaths.LdFlags = append(depPaths.LdFlags,
3325 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3326 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003327 }
3328
Colin Cross6e511a92020-07-27 21:26:48 -07003329 if libDepTag.static() && !libDepTag.wholeStatic {
3330 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3331 ctx.ModuleErrorf("module %q not a static library", depName)
3332 return
3333 }
Logan Chien43d34c32017-12-20 01:17:32 +08003334
Colin Cross6e511a92020-07-27 21:26:48 -07003335 // When combining coverage files for shared libraries and executables, coverage files
3336 // in static libraries act as if they were whole static libraries. The same goes for
3337 // source based Abi dump files.
3338 if c, ok := ccDep.(*Module); ok {
3339 staticLib := c.linker.(libraryInterface)
3340 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3341 staticLib.objs().coverageFiles...)
3342 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3343 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003344 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003345 // Handle non-CC modules here
3346 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003347 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003348 }
3349 }
3350
Colin Cross6e511a92020-07-27 21:26:48 -07003351 if ptr != nil {
3352 if !linkFile.Valid() {
3353 if !ctx.Config().AllowMissingDependencies() {
3354 ctx.ModuleErrorf("module %q missing output file", depName)
3355 } else {
3356 ctx.AddMissingDependencies([]string{depName})
3357 }
3358 return
3359 }
3360 *ptr = append(*ptr, linkFile.Path())
3361 }
3362
3363 if depPtr != nil {
3364 dep := depFile
3365 if !dep.Valid() {
3366 dep = linkFile
3367 }
3368 *depPtr = append(*depPtr, dep.Path())
3369 }
3370
Colin Cross0de8a1e2020-09-18 14:15:30 -07003371 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3372 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3373 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3374 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3375
3376 if libDepTag.reexportFlags {
3377 reexportExporter(depExporterInfo)
3378 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3379 // Re-exported shared library headers must be included as well since they can help us with type information
3380 // about template instantiations (instantiated from their headers).
3381 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3382 // scripts.
3383 c.sabi.Properties.ReexportedIncludes = append(
3384 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3385 }
3386
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003387 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003388 switch {
3389 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003390 c.Properties.AndroidMkHeaderLibs = append(
3391 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003392 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003393 if lib := moduleLibraryInterface(dep); lib != nil {
3394 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003395 // Add the dependency to the APEX(es) providing the library so that
3396 // m <module> can trigger building the APEXes as well.
Colin Cross56a83212020-09-15 18:30:11 -07003397 depApexInfo := ctx.OtherModuleProvider(dep, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09003398 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003399 c.Properties.ApexesProvidingSharedLibs = append(
3400 c.Properties.ApexesProvidingSharedLibs, an)
3401 }
3402 }
3403 }
3404
3405 // Note: the order of libs in this list is not important because
3406 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003407 c.Properties.AndroidMkSharedLibs = append(
3408 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003409 // Record BaseLibName for snapshots.
3410 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003411 case libDepTag.static():
3412 if libDepTag.wholeStatic {
3413 c.Properties.AndroidMkWholeStaticLibs = append(
3414 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3415 } else {
3416 c.Properties.AndroidMkStaticLibs = append(
3417 c.Properties.AndroidMkStaticLibs, makeLibName)
3418 }
Justin Yun5e035862021-06-29 20:50:37 +09003419 // Record BaseLibName for snapshots.
3420 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003421 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003422 } else if !c.IsStubs() {
3423 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3424
Colin Cross6e511a92020-07-27 21:26:48 -07003425 switch depTag {
3426 case runtimeDepTag:
3427 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003428 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003429 // Record BaseLibName for snapshots.
3430 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003431 case objDepTag:
3432 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3433 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003434 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003435 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003436 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003437 case dynamicLinkerDepTag:
3438 depPaths.DynamicLinker = linkFile
3439 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003440 }
Colin Crossca860ac2016-01-04 14:34:37 -08003441 })
3442
Jeff Gaston294356f2017-09-27 17:05:30 -07003443 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003444 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3445 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3446 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003447
Colin Crossdd84e052017-05-17 13:44:16 -07003448 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003449 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003450 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3451 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003452 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003453 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3454 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003455 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003456 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003457 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003458
3459 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003460 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003461 }
Colin Crossdd84e052017-05-17 13:44:16 -07003462
Colin Crossca860ac2016-01-04 14:34:37 -08003463 return depPaths
3464}
3465
Spandan Das604f3762023-03-16 22:51:40 +00003466func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003467 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003468 thisModule, ok := ctx.Module().(android.ApexModule)
3469 if !ok {
3470 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3471 }
3472
3473 useVndk := false
3474 bootstrap := false
3475 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3476 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3477 } else {
3478 useVndk = linkable.UseVndk()
3479 bootstrap = linkable.Bootstrap()
3480 }
3481
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003482 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
3483
3484 useStubs := false
3485
3486 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
3487 if !apexInfo.IsForPlatform() {
3488 // For platform libraries, use current version of LLNDK
3489 // If this is for use_vendor apex we will apply the same rules
3490 // of apex sdk enforcement below to choose right version.
3491 useStubs = true
3492 }
3493 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3494 // If not building for APEX or the containing APEX allows the use of
3495 // platform APIs, use stubs only when it is from an APEX (and not from
3496 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3497 // bootstrap modules, always link to non-stub variant
3498 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3499
3500 isApexImportedApiLibrary := false
3501
3502 if cc, ok := dep.(*Module); ok {
3503 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3504 if apiLibrary.hasApexStubs() {
3505 isApexImportedApiLibrary = true
3506 }
3507 }
3508 }
3509
3510 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3511
3512 if useStubs {
3513 // Another exception: if this module is a test for an APEX, then
3514 // it is linked with the non-stub variant of a module in the APEX
3515 // as if this is part of the APEX.
3516 testFor := ctx.Provider(android.ApexTestForInfoProvider).(android.ApexTestForInfo)
3517 for _, apexContents := range testFor.ApexContents {
3518 if apexContents.DirectlyInApex(depName) {
3519 useStubs = false
3520 break
3521 }
3522 }
3523 }
3524 if useStubs {
3525 // Yet another exception: If this module and the dependency are
3526 // available to the same APEXes then skip stubs between their
3527 // platform variants. This complements the test_for case above,
3528 // which avoids the stubs on a direct APEX library dependency, by
3529 // avoiding stubs for indirect test dependencies as well.
3530 //
3531 // TODO(b/183882457): This doesn't work if the two libraries have
3532 // only partially overlapping apex_available. For that test_for
3533 // modules would need to be split into APEX variants and resolved
3534 // separately for each APEX they have access to.
3535 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3536 useStubs = false
3537 }
3538 }
3539 } else {
3540 // If building for APEX, use stubs when the parent is in any APEX that
3541 // the child is not in.
3542 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3543 }
3544
3545 return useStubs
3546}
3547
3548// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3549// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3550// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3551// has different level of updatability. For example, if a library foo in an APEX depends on a
3552// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3553// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3554// same APEX as foo, the non-stub variant of bar is used.
3555func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3556 depTag := ctx.OtherModuleDependencyTag(dep)
3557 libDepTag, ok := depTag.(libraryDependencyTag)
3558 if !ok || !libDepTag.shared() {
3559 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3560 }
3561
Jiyong Park7d55b612021-06-11 17:22:09 +09003562 sharedLibraryInfo := ctx.OtherModuleProvider(dep, SharedLibraryInfoProvider).(SharedLibraryInfo)
3563 depExporterInfo := ctx.OtherModuleProvider(dep, FlagExporterInfoProvider).(FlagExporterInfo)
3564 sharedLibraryStubsInfo := ctx.OtherModuleProvider(dep, SharedLibraryStubsProvider).(SharedLibraryStubsInfo)
Jiyong Park7d55b612021-06-11 17:22:09 +09003565
3566 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003567 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003568 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003569 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3570 toUse := stubs[len(stubs)-1]
3571 sharedLibraryInfo = toUse.SharedLibraryInfo
3572 depExporterInfo = toUse.FlagExporterInfo
3573 }
3574 }
3575 return sharedLibraryInfo, depExporterInfo
3576}
3577
Colin Cross0de8a1e2020-09-18 14:15:30 -07003578// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3579// to match the topological order of the dependency tree, including any static analogues of
3580// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3581// of the transitive dependencies.
3582func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet) {
3583 transitiveStaticLibsBuilder := android.NewDepSetBuilder(android.TOPOLOGICAL)
3584 var staticPaths android.Paths
3585 for _, staticDep := range staticDeps {
3586 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3587 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3588 }
3589 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003590 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3591 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003592 }
3593 }
3594 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3595
3596 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3597
3598 // reorder the dependencies based on transitive dependencies
3599 staticPaths = android.FirstUniquePaths(staticPaths)
3600 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3601
3602 if len(orderedStaticPaths) != len(staticPaths) {
3603 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3604 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3605 }
3606
3607 return orderedStaticPaths, transitiveStaticLibs
3608}
3609
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003610// BaseLibName trims known prefixes and suffixes
3611func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003612 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3613 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003614 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003615 return libName
3616}
3617
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003618func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003619 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003620 ccDepModule, _ := ccDep.(*Module)
3621 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003622 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003623
Justin Yuncbca3732021-02-03 19:24:13 +09003624 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003625 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003626 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003627 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003628
Ivan Lozanod1dec542021-05-26 15:33:11 -04003629 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003630 }
3631 }
3632
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003633 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3634 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003635 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3636 // core module instead.
3637 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003638 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003639 // The vendor and product modules in Make will have been renamed to not conflict with the
3640 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003641 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003642 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003643 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003644 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003645 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003646 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003647 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003648 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003649 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003650 } else {
3651 return libName
3652 }
3653}
3654
Colin Crossca860ac2016-01-04 14:34:37 -08003655func (c *Module) InstallInData() bool {
3656 if c.installer == nil {
3657 return false
3658 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003659 return c.installer.inData()
3660}
3661
3662func (c *Module) InstallInSanitizerDir() bool {
3663 if c.installer == nil {
3664 return false
3665 }
3666 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003667 return true
3668 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003669 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003670}
3671
Yifan Hong1b3348d2020-01-21 15:53:22 -08003672func (c *Module) InstallInRamdisk() bool {
3673 return c.InRamdisk()
3674}
3675
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003676func (c *Module) InstallInVendorRamdisk() bool {
3677 return c.InVendorRamdisk()
3678}
3679
Jiyong Parkf9332f12018-02-01 00:54:12 +09003680func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003681 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003682}
3683
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003684func (c *Module) MakeUninstallable() {
3685 if c.installer == nil {
3686 c.ModuleBase.MakeUninstallable()
3687 return
3688 }
3689 c.installer.makeUninstallable(c)
3690}
3691
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003692func (c *Module) HostToolPath() android.OptionalPath {
3693 if c.installer == nil {
3694 return android.OptionalPath{}
3695 }
3696 return c.installer.hostToolPath()
3697}
3698
Nan Zhangd4e641b2017-07-12 12:55:28 -07003699func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3700 return c.outputFile
3701}
3702
Colin Cross41955e82019-05-29 14:40:35 -07003703func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3704 switch tag {
3705 case "":
3706 if c.outputFile.Valid() {
3707 return android.Paths{c.outputFile.Path()}, nil
3708 }
3709 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003710 case "unstripped":
3711 if c.linker != nil {
3712 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3713 }
3714 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003715 default:
3716 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003717 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003718}
3719
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003720func (c *Module) static() bool {
3721 if static, ok := c.linker.(interface {
3722 static() bool
3723 }); ok {
3724 return static.static()
3725 }
3726 return false
3727}
3728
Jiyong Park379de2f2018-12-19 02:47:14 +09003729func (c *Module) staticBinary() bool {
3730 if static, ok := c.linker.(interface {
3731 staticBinary() bool
3732 }); ok {
3733 return static.staticBinary()
3734 }
3735 return false
3736}
3737
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003738func (c *Module) testBinary() bool {
3739 if test, ok := c.linker.(interface {
3740 testBinary() bool
3741 }); ok {
3742 return test.testBinary()
3743 }
3744 return false
3745}
3746
Jingwen Chen537242c2022-08-24 11:53:27 +00003747func (c *Module) testLibrary() bool {
3748 if test, ok := c.linker.(interface {
3749 testLibrary() bool
3750 }); ok {
3751 return test.testLibrary()
3752 }
3753 return false
3754}
3755
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003756func (c *Module) benchmarkBinary() bool {
3757 if b, ok := c.linker.(interface {
3758 benchmarkBinary() bool
3759 }); ok {
3760 return b.benchmarkBinary()
3761 }
3762 return false
3763}
3764
3765func (c *Module) fuzzBinary() bool {
3766 if f, ok := c.linker.(interface {
3767 fuzzBinary() bool
3768 }); ok {
3769 return f.fuzzBinary()
3770 }
3771 return false
3772}
3773
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003774// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3775func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003776 if h, ok := c.linker.(interface {
3777 header() bool
3778 }); ok {
3779 return h.header()
3780 }
3781 return false
3782}
3783
Ivan Lozanod7586b62021-04-01 09:49:36 -04003784func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003785 if b, ok := c.linker.(interface {
3786 binary() bool
3787 }); ok {
3788 return b.binary()
3789 }
3790 return false
3791}
3792
Justin Yun5e035862021-06-29 20:50:37 +09003793func (c *Module) StaticExecutable() bool {
3794 if b, ok := c.linker.(*binaryDecorator); ok {
3795 return b.static()
3796 }
3797 return false
3798}
3799
Ivan Lozanod7586b62021-04-01 09:49:36 -04003800func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003801 if o, ok := c.linker.(interface {
3802 object() bool
3803 }); ok {
3804 return o.object()
3805 }
3806 return false
3807}
3808
Ivan Lozanof9e21722020-12-02 09:00:51 -05003809func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003810 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003811 if c.IsLlndk() {
3812 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003813 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003814 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003815 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003816 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003817 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003818 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003819 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003820 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003821 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003822 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003823 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003824 return "native:product"
3825 }
Jooyung Han38002912019-05-16 04:01:54 +09003826 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003827 } else if c.InRamdisk() {
3828 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003829 } else if c.InVendorRamdisk() {
3830 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003831 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003832 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003833 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003834 return "native:ndk:none:none"
3835 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3836 //family, link := getNdkStlFamilyAndLinkType(c)
3837 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003838 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003839 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003840 } else {
3841 return "native:platform"
3842 }
3843}
3844
Jiyong Park9d452992018-10-03 00:38:19 +09003845// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003846// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003847func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003848 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003849 // Stub libs and prebuilt libs in a versioned SDK are not
3850 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003851 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003852 } else if _, ok := c.linker.(testPerSrc); ok {
3853 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003854 }
3855 return false
3856}
3857
Jiyong Parka90ca002019-10-07 15:47:24 +09003858func (c *Module) AvailableFor(what string) bool {
3859 if linker, ok := c.linker.(interface {
3860 availableFor(string) bool
3861 }); ok {
3862 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3863 } else {
3864 return c.ApexModuleBase.AvailableFor(what)
3865 }
3866}
3867
Jiyong Park62304bb2020-04-13 16:19:48 +09003868func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003869 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003870}
3871
Paul Duffin0cb37b92020-03-04 14:52:46 +00003872func (c *Module) EverInstallable() bool {
3873 return c.installer != nil &&
3874 // Check to see whether the module is actually ever installable.
3875 c.installer.everInstallable()
3876}
3877
Ivan Lozanod7586b62021-04-01 09:49:36 -04003878func (c *Module) PreventInstall() bool {
3879 return c.Properties.PreventInstall
3880}
3881
3882func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003883 if c.library != nil {
3884 if i := c.library.installable(); i != nil {
3885 return i
3886 }
3887 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003888 return c.Properties.Installable
3889}
3890
3891func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003892 ret := c.EverInstallable() &&
3893 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003894 proptools.BoolDefault(c.Installable(), true) &&
3895 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003896
3897 // The platform variant doesn't need further condition. Apex variants however might not
3898 // be installable because it will likely to be included in the APEX and won't appear
3899 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003900 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003901 return ret
3902 }
3903
3904 // Special case for modules that are configured to be installed to /data, which includes
3905 // test modules. For these modules, both APEX and non-APEX variants are considered as
3906 // installable. This is because even the APEX variants won't be included in the APEX, but
3907 // will anyway be installed to /data/*.
3908 // See b/146995717
3909 if c.InstallInData() {
3910 return ret
3911 }
3912
3913 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003914}
3915
Logan Chien41eabe62019-04-10 13:33:58 +08003916func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3917 if c.linker != nil {
3918 if library, ok := c.linker.(*libraryDecorator); ok {
3919 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3920 }
3921 }
3922}
3923
Jiyong Park45bf82e2020-12-15 22:29:02 +09003924var _ android.ApexModule = (*Module)(nil)
3925
3926// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003927func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003928 depTag := ctx.OtherModuleDependencyTag(dep)
3929 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3930
3931 if cc, ok := dep.(*Module); ok {
3932 if cc.HasStubsVariants() {
3933 if isLibDepTag && libDepTag.shared() {
3934 // dynamic dep to a stubs lib crosses APEX boundary
3935 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003936 }
Colin Cross6e511a92020-07-27 21:26:48 -07003937 if IsRuntimeDepTag(depTag) {
3938 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003939 return false
3940 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003941 }
Zhijun Heec285872021-04-24 10:47:08 -07003942 if cc.IsLlndk() {
3943 return false
3944 }
Colin Crossaac32222020-07-29 12:51:56 -07003945 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003946 // shared_lib dependency from a static lib is considered as crossing
3947 // the APEX boundary because the dependency doesn't actually is
3948 // linked; the dependency is used only during the compilation phase.
3949 return false
3950 }
Jiyong Parke3867542020-12-03 17:28:25 +09003951
3952 if isLibDepTag && libDepTag.excludeInApex {
3953 return false
3954 }
Colin Cross6e511a92020-07-27 21:26:48 -07003955 }
Colin Crossc1b36442021-05-06 13:42:48 -07003956 if depTag == stubImplDepTag {
3957 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003958 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003959 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003960 if depTag == staticVariantTag {
3961 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3962 // actually mean that the static lib (and its dependencies) are copied into the
3963 // APEX.
3964 return false
3965 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003966 return true
3967}
3968
Jiyong Park45bf82e2020-12-15 22:29:02 +09003969// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003970func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3971 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003972 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3973 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3974 return nil
3975 }
Jooyung Han749dc692020-04-15 11:03:39 +09003976 // We don't check for prebuilt modules
3977 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3978 return nil
3979 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003980
Jooyung Han749dc692020-04-15 11:03:39 +09003981 minSdkVersion := c.MinSdkVersion()
3982 if minSdkVersion == "apex_inherit" {
3983 return nil
3984 }
3985 if minSdkVersion == "" {
3986 // JNI libs within APK-in-APEX fall into here
3987 // Those are okay to set sdk_version instead
3988 // We don't have to check if this is a SDK variant because
3989 // non-SDK variant resets sdk_version, which works too.
3990 minSdkVersion = c.SdkVersion()
3991 }
Dan Albertc8060532020-07-22 22:32:17 -07003992 if minSdkVersion == "" {
3993 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3994 }
3995 // Not using nativeApiLevelFromUser because the context here is not
3996 // necessarily a native context.
3997 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003998 if err != nil {
3999 return err
4000 }
Dan Albertc8060532020-07-22 22:32:17 -07004001
Colin Cross8ca61c12022-10-06 21:00:14 -07004002 // A dependency only needs to support a min_sdk_version at least
4003 // as high as the api level that the architecture was introduced in.
4004 // This allows introducing new architectures in the platform that
4005 // need to be included in apexes that normally require an older
4006 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08004007 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07004008 if sdkVersion.LessThan(minApiForArch) {
4009 sdkVersion = minApiForArch
4010 }
4011
Dan Albertc8060532020-07-22 22:32:17 -07004012 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004013 return fmt.Errorf("newer SDK(%v)", ver)
4014 }
4015 return nil
4016}
4017
Paul Duffinb5769c12021-05-12 16:16:51 +01004018// Implements android.ApexModule
4019func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4020 // stub libraries and native bridge libraries are always available to platform
4021 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4022}
4023
Jooyung Han91f92032022-02-04 12:36:33 +09004024// Overrides android.ApexModuleBase.UniqueApexVariations
4025func (c *Module) UniqueApexVariations() bool {
4026 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4027 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4028 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004029 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004030 return c.UseVndk() && c.IsVndk()
4031}
4032
Inseob Kima1888ce2022-10-04 14:42:02 +09004033func (c *Module) overriddenModules() []string {
4034 if o, ok := c.linker.(overridable); ok {
4035 return o.overriddenModules()
4036 }
4037 return nil
4038}
4039
Rob Seymour925aa092021-08-10 20:42:03 +00004040var _ snapshot.RelativeInstallPath = (*Module)(nil)
4041
Liz Kammer35ca77e2021-12-22 15:31:40 -05004042type moduleType int
4043
4044const (
4045 unknownType moduleType = iota
4046 binary
4047 object
4048 fullLibrary
4049 staticLibrary
4050 sharedLibrary
4051 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004052 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004053 ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004054)
4055
4056func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004057 if c.testBinary() {
4058 // testBinary is also a binary, so this comes before the c.Binary()
4059 // conditional. A testBinary has additional implicit dependencies and
4060 // other test-only semantics.
4061 return testBin
4062 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004063 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004064 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004065 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004066 } else if c.testLibrary() {
4067 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4068 // will let them add implicit compile deps on gtest, for example.
4069 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004070 // For now, treat them as regular libraries.
4071 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004072 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004073 static := false
4074 shared := false
4075 if library, ok := c.linker.(*libraryDecorator); ok {
4076 static = library.MutatedProperties.BuildStatic
4077 shared = library.MutatedProperties.BuildShared
4078 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4079 static = library.MutatedProperties.BuildStatic
4080 shared = library.MutatedProperties.BuildShared
4081 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004082 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004083 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004084 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004085 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004086 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004087 return staticLibrary
4088 }
4089 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004090 } else if c.isNDKStubLibrary() {
4091 return ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004092 }
4093 return unknownType
4094}
4095
4096// ConvertWithBp2build converts Module to Bazel for bp2build.
4097func (c *Module) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
4098 prebuilt := c.IsPrebuilt()
4099 switch c.typ() {
4100 case binary:
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00004101 if prebuilt {
4102 prebuiltBinaryBp2Build(ctx, c)
4103 } else {
Jingwen Chen537242c2022-08-24 11:53:27 +00004104 binaryBp2build(ctx, c)
4105 }
4106 case testBin:
4107 if !prebuilt {
4108 testBinaryBp2build(ctx, c)
Liz Kammer35ca77e2021-12-22 15:31:40 -05004109 }
4110 case object:
Colin Crossc5075e92022-12-05 16:46:39 -08004111 if prebuilt {
4112 prebuiltObjectBp2Build(ctx, c)
4113 } else {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004114 objectBp2Build(ctx, c)
4115 }
4116 case fullLibrary:
4117 if !prebuilt {
4118 libraryBp2Build(ctx, c)
Trevor Radcliffe58ea4512022-04-07 20:36:39 +00004119 } else {
4120 prebuiltLibraryBp2Build(ctx, c)
Liz Kammer35ca77e2021-12-22 15:31:40 -05004121 }
4122 case headerLibrary:
4123 libraryHeadersBp2Build(ctx, c)
4124 case staticLibrary:
Liz Kammer35ca77e2021-12-22 15:31:40 -05004125 if prebuilt {
Trevor Radcliffe58ea4512022-04-07 20:36:39 +00004126 prebuiltLibraryStaticBp2Build(ctx, c, false)
Liz Kammer35ca77e2021-12-22 15:31:40 -05004127 } else {
4128 sharedOrStaticLibraryBp2Build(ctx, c, true)
4129 }
4130 case sharedLibrary:
4131 if prebuilt {
4132 prebuiltLibrarySharedBp2Build(ctx, c)
4133 } else {
4134 sharedOrStaticLibraryBp2Build(ctx, c, false)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004135 }
Chris Parsons39a16972023-06-08 14:28:51 +00004136 default:
4137 ctx.MarkBp2buildUnconvertible(bp2build_metrics_proto.UnconvertedReasonType_TYPE_UNSUPPORTED, "")
Spandan Das8b4a5f32022-09-29 00:28:24 +00004138 }
4139}
4140
4141var _ android.ApiProvider = (*Module)(nil)
4142
4143func (c *Module) ConvertWithApiBp2build(ctx android.TopDownMutatorContext) {
Spandan Das4238c652022-09-09 01:38:47 +00004144 if c.IsPrebuilt() {
4145 return
4146 }
Spandan Das8b4a5f32022-09-29 00:28:24 +00004147 switch c.typ() {
Spandan Das4238c652022-09-09 01:38:47 +00004148 case fullLibrary:
4149 apiContributionBp2Build(ctx, c)
4150 case sharedLibrary:
4151 apiContributionBp2Build(ctx, c)
4152 case headerLibrary:
4153 // Aggressively generate api targets for all header modules
4154 // This is necessary since the header module does not know if it is a dep of API surface stub library
4155 apiLibraryHeadersBp2Build(ctx, c)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004156 }
4157}
4158
Colin Crosscfad1192015-11-02 16:43:11 -08004159// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004160type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004161 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004162 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004163 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004164}
4165
Patrice Arrudac249c712019-03-19 17:00:29 -07004166// cc_defaults provides a set of properties that can be inherited by other cc
4167// modules. A module can use the properties from a cc_defaults using
4168// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4169// merged (when possible) by prepending the default module's values to the
4170// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004171func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004172 return DefaultsFactory()
4173}
4174
Colin Cross36242852017-06-23 15:06:31 -07004175func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004176 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004177
Colin Cross36242852017-06-23 15:06:31 -07004178 module.AddProperties(props...)
4179 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004180 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004181 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004182 &BaseCompilerProperties{},
4183 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004184 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004185 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004186 &StaticProperties{},
4187 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004188 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004189 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004190 &TestLinkerProperties{},
4191 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004192 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004193 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004194 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004195 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004196 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004197 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004198 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004199 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004200 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004201 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004202 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004203 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004204 &AfdoProperties{},
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07004205 &PgoProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004206 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004207 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4208 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004209 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004210 )
Colin Crosscfad1192015-11-02 16:43:11 -08004211
Jooyung Hancc372c52019-09-25 15:18:44 +09004212 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004213
4214 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004215}
4216
Jiyong Park2286afd2020-06-16 21:58:53 +09004217func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004218 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004219}
4220
Kiyoung Kim51279d32022-08-24 14:10:46 +09004221func (c *Module) isImportedApiLibrary() bool {
4222 _, ok := c.linker.(*apiLibraryDecorator)
4223 return ok
4224}
4225
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004226func kytheExtractAllFactory() android.Singleton {
4227 return &kytheExtractAllSingleton{}
4228}
4229
4230type kytheExtractAllSingleton struct {
4231}
4232
4233func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4234 var xrefTargets android.Paths
4235 ctx.VisitAllModules(func(module android.Module) {
4236 if ccModule, ok := module.(xref); ok {
4237 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4238 }
4239 })
4240 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4241 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004242 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004243 }
4244}
4245
Jihoon Kangf78a8902022-09-01 22:47:07 +00004246func (c *Module) Partition() string {
4247 if p, ok := c.installer.(interface {
4248 getPartition() string
4249 }); ok {
4250 return p.getPartition()
4251 }
4252 return ""
4253}
4254
Colin Cross06a931b2015-10-28 17:23:31 -07004255var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004256var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004257var BoolPtr = proptools.BoolPtr
4258var String = proptools.String
4259var StringPtr = proptools.StringPtr