blob: d34daec9ea9aacb4d1a8e8d4aa4e8ac835bc74d2 [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Aditya Choudhary87b2ab22023-11-17 15:27:06 +000027 "android/soong/testing"
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090028
Colin Cross97ba0732015-03-23 17:50:24 -070029 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070030 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070031
Vinh Tran367d89d2023-04-28 11:21:25 -040032 "android/soong/aidl_library"
Colin Cross635c3b02016-05-18 15:37:25 -070033 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070034 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070035 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070036 "android/soong/genrule"
Kiyoung Kim487689e2022-07-26 09:48:22 +090037 "android/soong/multitree"
Rob Seymour925aa092021-08-10 20:42:03 +000038 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080039)
40
Colin Cross463a90e2015-06-17 14:20:06 -070041func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000042 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070043
Inseob Kim3b244062023-07-11 13:31:36 +090044 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000045 pctx.Import("android/soong/cc/config")
46}
47
48func RegisterCCBuildComponents(ctx android.RegistrationContext) {
49 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
50
51 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000052 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090053 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070054 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010055 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070056 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070057 ctx.BottomUp("begin", BeginMutator).Parallel()
Vinh Tran44cb78c2023-03-09 22:07:19 -050058 ctx.BottomUp("fdo_profile", fdoProfileMutator)
Colin Cross1e676be2016-10-12 14:38:15 -070059 })
Colin Cross16b23492016-01-06 14:41:07 -080060
Paul Duffin036e7002019-12-19 19:16:28 +000061 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040062 for _, san := range Sanitizers {
63 san.registerMutators(ctx)
64 }
Dan Willemsen581341d2017-02-09 16:16:31 -080065
Colin Cross0b908332019-06-19 23:00:20 -070066 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090067 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080068
Cory Barkera1da26f2022-06-07 20:12:06 +000069 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000070
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
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000076 ctx.TopDown("orderfile_deps", orderfileDepsMutator)
77 ctx.BottomUp("orderfile", orderfileMutator).Parallel()
78
Stephen Craneba090d12017-05-09 15:44:35 -070079 ctx.TopDown("lto_deps", ltoDepsMutator)
80 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090081
Jooyung Han479ca172020-10-19 18:51:07 +090082 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090083 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070084 })
Colin Crossb98c8b02016-07-29 13:44:28 -070085
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080086 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
87 // sabi mutator needs to be run after apex mutator finishes.
88 ctx.TopDown("sabi_deps", sabiDepsMutator)
89 })
90
LaMont Jones0c10e4d2023-05-16 00:58:37 +000091 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070092}
93
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050094// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
95// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
96// edges to these modules.
97// This object is constructed in DepsMutator, by calling to various module delegates to set
98// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
99// dependencies.
100// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
101// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800102type Deps struct {
103 SharedLibs, LateSharedLibs []string
104 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800105 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800106 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700107
Colin Cross3e5e7782022-06-17 22:17:05 +0000108 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
109 // prevent automatically exporting symbols.
110 UnexportedStaticLibs []string
111
Chris Parsons79d66a52020-06-05 17:26:16 -0400112 // Used for data dependencies adjacent to tests
113 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700114 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400115
Yo Chiang219968c2020-09-22 18:45:04 +0800116 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
117 SystemSharedLibs []string
118
Vinh Tran367d89d2023-04-28 11:21:25 -0400119 // Used by DepMutator to pass aidl_library modules to aidl compiler
120 AidlLibs []string
121
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500122 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800123 StaticUnwinderIfLegacy bool
124
Colin Cross5950f382016-12-13 12:50:57 -0800125 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700126
Colin Cross81413472016-04-11 14:37:39 -0700127 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700128
Dan Willemsenb40aab62016-04-20 14:21:14 -0700129 GeneratedSources []string
130 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900131 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700132
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700133 ReexportGeneratedHeaders []string
134
Colin Crossc465efd2021-06-11 18:00:04 -0700135 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700136
137 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700138 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900139
140 // List of libs that need to be excluded for APEX variant
141 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900142 // List of libs that need to be excluded for non-APEX variant
143 ExcludeLibsForNonApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700144}
145
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500146// PathDeps is a struct containing file paths to dependencies of a module.
147// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
148// It's used to construct flags for various build statements (such as for compiling and linking).
149// It is then passed to module decorator functions responsible for registering build statements
150// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800151type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700152 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900153 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700154 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900155 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700156 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700157 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700158
Colin Cross0de8a1e2020-09-18 14:15:30 -0700159 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700160 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700161
Colin Cross26c34ed2016-09-30 17:10:16 -0700162 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100163 Objs Objects
164 // Paths to .o files in dependencies that provide them. Note that these lists
165 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800166 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700167 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700168
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100169 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
170 // the libs from all whole_static_lib dependencies.
171 WholeStaticLibsFromPrebuilts android.Paths
172
Colin Cross26c34ed2016-09-30 17:10:16 -0700173 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700174 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900175 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700176
Inseob Kimd110f872019-12-06 13:15:38 +0900177 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000178 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900179 IncludeDirs android.Paths
180 SystemIncludeDirs android.Paths
181 ReexportedDirs android.Paths
182 ReexportedSystemDirs android.Paths
183 ReexportedFlags []string
184 ReexportedGeneratedHeaders android.Paths
185 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700186
Colin Cross26c34ed2016-09-30 17:10:16 -0700187 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700188 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700189
Dan Willemsena0790e32018-10-12 00:24:23 -0700190 // Path to the dynamic linker binary
191 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700192
193 // For Darwin builds, the path to the second architecture's output that should
194 // be combined with this architectures's output into a FAT MachO file.
195 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400196
197 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
198 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700199}
200
Colin Cross4af21ed2019-11-04 09:37:55 -0800201// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
202// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
203// command line so they can be overridden by the local module flags).
204type LocalOrGlobalFlags struct {
205 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700206 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800207 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700208 CFlags []string // Flags that apply to C and C++ source files
209 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
210 ConlyFlags []string // Flags that apply to C source files
211 CppFlags []string // Flags that apply to C++ source files
212 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700213 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800214}
215
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500216// Flags contains various types of command line flags (and settings) for use in building build
217// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800218type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500219 // Local flags (which individual modules are responsible for). These may override global flags.
220 Local LocalOrGlobalFlags
221 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800222 Global LocalOrGlobalFlags
223
224 aidlFlags []string // Flags that apply to aidl source files
225 rsFlags []string // Flags that apply to renderscript source files
226 libFlags []string // Flags to add libraries early to the link order
227 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
228 TidyFlags []string // Flags that apply to clang-tidy
229 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700230
Colin Crossc3199482017-03-30 15:03:04 -0700231 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800232 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700233 SystemIncludeFlags []string
234
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800235 Toolchain config.Toolchain
236 Tidy bool // True if ninja .tidy rules should be generated.
237 NeedTidyFiles bool // True if module link should depend on .tidy files
238 GcovCoverage bool // True if coverage files should be generated.
239 SAbiDump bool // True if header abi dumps should be generated.
240 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800241
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500242 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800243 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500244 // The target-device system path to the dynamic linker.
245 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800246
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700247 CFlagsDeps android.Paths // Files depended on by compiler flags
248 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800249
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500250 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700251 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800252
Colin Cross19878da2019-03-28 14:45:07 -0700253 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700254 protoC bool // Whether to use C instead of C++
255 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700256
257 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200258 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700259}
260
Colin Crossca860ac2016-01-04 14:34:37 -0800261// Properties used to compile all C or C++ modules
262type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700263 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800264 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700265
Jiyong Parkb35a8192020-08-10 15:59:36 +0900266 // The API level that this module is built against. The APIs of this API level will be
267 // visible at build time, but use of any APIs newer than min_sdk_version will render the
268 // module unloadable on older devices. In the future it will be possible to weakly-link new
269 // APIs, making the behavior match Java: such modules will load on older devices, but
270 // calling new APIs on devices that do not support them will result in a crash.
271 //
272 // This property has the same behavior as sdk_version does for Java modules. For those
273 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
274 // does for Java code.
275 //
276 // In addition, setting this property causes two variants to be built, one for the platform
277 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800278 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700279
Jiyong Parkb35a8192020-08-10 15:59:36 +0900280 // Minimum OS API level supported by this C or C++ module. This property becomes the value
281 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
282 // this property is also used to ensure that the min_sdk_version of the containing module is
283 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
284 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
285 // min_sdk_version of the containing APEX. When the module
286 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900287 Min_sdk_version *string
288
Colin Crossc511bc52020-04-07 16:50:32 +0000289 // If true, always create an sdk variant and don't create a platform variant.
290 Sdk_variant_only *bool
291
Jiyong Parkde866cb2018-12-07 23:08:36 +0900292 AndroidMkSharedLibs []string `blueprint:"mutated"`
293 AndroidMkStaticLibs []string `blueprint:"mutated"`
294 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
295 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700296 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900297 HideFromMake bool `blueprint:"mutated"`
298 PreventInstall bool `blueprint:"mutated"`
299 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700300
Yo Chiang219968c2020-09-22 18:45:04 +0800301 // Set by DepsMutator.
302 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
303
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900304 // The name of the image this module is built for
305 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200306
307 // The VNDK version this module is built against. If empty, the module is not
308 // build against the VNDK.
309 VndkVersion string `blueprint:"mutated"`
310
311 // Suffix for the name of Android.mk entries generated by this module
312 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800313
314 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
315 // file
316 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900317
Yifan Hong39143a92020-10-26 12:43:12 -0700318 // Make this module available when building for ramdisk.
319 // On device without a dedicated recovery partition, the module is only
320 // available after switching root into
321 // /first_stage_ramdisk. To expose the module before switching root, install
322 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800323 Ramdisk_available *bool
324
Yifan Hong39143a92020-10-26 12:43:12 -0700325 // Make this module available when building for vendor ramdisk.
326 // On device without a dedicated recovery partition, the module is only
327 // available after switching root into
328 // /first_stage_ramdisk. To expose the module before switching root, install
329 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700330 Vendor_ramdisk_available *bool
331
Jiyong Parkf9332f12018-02-01 00:54:12 +0900332 // Make this module available when building for recovery
333 Recovery_available *bool
334
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200335 // Used by imageMutator, set by ImageMutatorBegin()
336 CoreVariantNeeded bool `blueprint:"mutated"`
337 RamdiskVariantNeeded bool `blueprint:"mutated"`
338 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
339 RecoveryVariantNeeded bool `blueprint:"mutated"`
340
341 // A list of variations for the "image" mutator of the form
342 //<image name> '.' <version char>, for example, 'vendor.S'
343 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900344
345 // Allows this module to use non-APEX version of libraries. Useful
346 // for building binaries that are started before APEXes are activated.
347 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900348
349 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
350 // see soong/cc/config/vndk.go
351 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900352
353 // Used by vendor snapshot to record dependencies from snapshot modules.
354 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900355 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900356 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000357
Colin Cross1bc94122021-10-28 13:25:54 -0700358 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000359
360 // Set by factories of module types that can only be referenced from variants compiled against
361 // the SDK.
362 AlwaysSdk bool `blueprint:"mutated"`
363
364 // Variant is an SDK variant created by sdkMutator
365 IsSdkVariant bool `blueprint:"mutated"`
366 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
367 // variant to have a ".sdk" suffix.
368 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700369
370 // Normally Soong uses the directory structure to decide which modules
371 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800372 // different snapshots (vendor, recovery, etc.), but this property
373 // allows a partner to exclude a module normally thought of as a
374 // framework module from the vendor snapshot.
375 Exclude_from_vendor_snapshot *bool
376
377 // Normally Soong uses the directory structure to decide which modules
378 // should be included (framework) or excluded (non-framework) from the
379 // different snapshots (vendor, recovery, etc.), but this property
380 // allows a partner to exclude a module normally thought of as a
381 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800382 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900383
384 // List of APEXes that this module has private access to for testing purpose. The module
385 // can depend on libraries that are not exported by the APEXes and use private symbols
386 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000387 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800388
389 Target struct {
390 Platform struct {
391 // List of modules required by the core variant.
392 Required []string `android:"arch_variant"`
393
394 // List of modules not required by the core variant.
395 Exclude_required []string `android:"arch_variant"`
396 } `android:"arch_variant"`
397
398 Recovery struct {
399 // List of modules required by the recovery variant.
400 Required []string `android:"arch_variant"`
401
402 // List of modules not required by the recovery variant.
403 Exclude_required []string `android:"arch_variant"`
404 } `android:"arch_variant"`
405 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700406}
407
408type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900409 // whether this module should be allowed to be directly depended by other
410 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900411 // If set to true, two variants will be built separately, one like
412 // normal, and the other limited to the set of libraries and headers
413 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700414 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900415 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700416 // so it shouldn't have any unversioned runtime dependencies, or
417 // make assumptions about the system that may not be true in the
418 // future.
419 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900420 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900421 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900422 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900423 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900424 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700425 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
426 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900427
Justin Yunebcf0c52021-01-08 18:00:19 +0900428 // This is the same as the "vendor_available" except that the install path
429 // of the vendor variant is /odm or /vendor/odm.
430 // By replacing "vendor_available: true" with "odm_available: true", the
431 // module will install its vendor variant to the /odm partition or /vendor/odm.
432 // As the modules with "odm_available: true" still create the vendor variants,
433 // they can link to the other vendor modules as the vendor_available modules do.
434 // Also, the vendor modules can link to odm_available modules.
435 //
436 // It may not be used for VNDK modules.
437 Odm_available *bool
438
Justin Yun63e9ec72020-10-29 16:49:43 +0900439 // whether this module should be allowed to be directly depended by other
440 // modules with `product_specific: true` or `product_available: true`.
441 // If set to true, an additional product variant will be built separately
442 // that is limited to the set of libraries and headers that are exposed to
443 // /product modules.
444 //
445 // The product variant may be used with a different (newer) /system,
446 // so it shouldn't have any unversioned runtime dependencies, or
447 // make assumptions about the system that may not be true in the
448 // future.
449 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900450 // If set to false, this module becomes inaccessible from /product modules.
451 //
452 // Different from the 'vendor_available' property, the modules with
453 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
454 // library without 'product_available' may not be depended on by any other
455 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900456 //
457 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
458 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
459 Product_available *bool
460
Jiyong Park5fb8c102018-04-09 12:03:06 +0900461 // whether this module is capable of being loaded with other instance
462 // (possibly an older version) of the same module in the same process.
463 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
464 // can be double loaded in a vendor process if the library is also a
465 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
466 // explicitly marked as `double_loadable: true` by the owner, or the dependency
467 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
468 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800469
470 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
471 IsLLNDK bool `blueprint:"mutated"`
472
Colin Cross78212242021-01-06 14:51:30 -0800473 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
474 // set and the module is not listed in VndkMustUseVendorVariantList.
475 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
476
477 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
478 IsVNDKCore bool `blueprint:"mutated"`
479
480 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
481 IsVNDKSP bool `blueprint:"mutated"`
482
483 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
484 // module sets the llndk.private property.
485 IsVNDKPrivate bool `blueprint:"mutated"`
486
487 // IsVNDKProduct is set if a VNDK module sets the product_available property.
488 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700489
490 // IsVendorPublicLibrary is set for the core and product variants of a library that has
491 // vendor_public_library stubs.
492 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800493}
494
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500495// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
496// to understanding details about the type of the current module.
497// For example, one might call these functions to determine whether the current module is a static
498// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800499type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800500 static() bool
501 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700502 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800503 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900504 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900505 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900506 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700507 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900508 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700509 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800510 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900511 minSdkVersion() string
512 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700513 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700514 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800515 IsLlndk() bool
516 IsLlndkPublic() bool
517 isImplementationForLLNDKPublic() bool
518 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900519 isVndk() bool
520 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500521 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700522 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900523 inProduct() bool
524 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800525 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700526 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900527 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900528 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700529 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700530 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800531 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800532 isAfdoCompile() bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000533 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800534 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900535 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800536 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800537 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800538 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700539 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700540 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900541 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800542 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700543 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700544 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800545 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800546 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800547 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800548 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800549}
550
551type SharedFlags struct {
552 numSharedFlags int
553 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800554}
555
556type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700557 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800558 ModuleContextIntf
559}
560
561type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700562 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800563 ModuleContextIntf
564}
565
Colin Cross37047f12016-12-13 17:06:13 -0800566type DepsContext interface {
567 android.BottomUpMutatorContext
568 ModuleContextIntf
569}
570
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500571// feature represents additional (optional) steps to building cc-related modules, such as invocation
572// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800573type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800574 flags(ctx ModuleContext, flags Flags) Flags
575 props() []interface{}
576}
577
Joe Onorato37f900c2023-07-18 16:58:16 -0700578// Information returned from Generator about the source code it's generating
579type GeneratedSource struct {
580 IncludeDirs android.Paths
581 Sources android.Paths
582 Headers android.Paths
583 ReexportedDirs android.Paths
584}
585
586// generator allows injection of generated code
587type Generator interface {
588 GeneratorProps() []interface{}
589 GeneratorInit(ctx BaseModuleContext)
590 GeneratorDeps(ctx DepsContext, deps Deps) Deps
591 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
592 GeneratorSources(ctx ModuleContext) GeneratedSource
593 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
594}
595
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500596// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500597// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800598type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700599 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800600 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800601 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700602 compilerProps() []interface{}
603
Colin Cross76fada02016-07-27 10:31:13 -0700604 appendCflags([]string)
605 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700606 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800607}
608
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500609// linker is the interface for a linker decorator object. Individual module types can provide
610// their own implementation for this decorator, and thus specify custom logic regarding build
611// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800612type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700613 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800614 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700615 linkerFlags(ctx ModuleContext, flags Flags) Flags
616 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800617 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700618
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700619 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700620 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900621 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800622 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700623
624 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900625 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000626
627 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000628 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800629
630 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000631}
632
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500633// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000634type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500635 sharedLibs []string
636 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
637 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700638 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800639}
640
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500641// installer is the interface for an installer helper object. This helper is responsible for
642// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800643type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700644 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700645 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000646 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800647 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700648 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700649 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900650 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000651 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900652 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800653}
654
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800655type xref interface {
656 XrefCcFiles() android.Paths
657}
658
Inseob Kima1888ce2022-10-04 14:42:02 +0900659type overridable interface {
660 overriddenModules() []string
661}
662
Colin Cross6e511a92020-07-27 21:26:48 -0700663type libraryDependencyKind int
664
665const (
666 headerLibraryDependency = iota
667 sharedLibraryDependency
668 staticLibraryDependency
669)
670
671func (k libraryDependencyKind) String() string {
672 switch k {
673 case headerLibraryDependency:
674 return "headerLibraryDependency"
675 case sharedLibraryDependency:
676 return "sharedLibraryDependency"
677 case staticLibraryDependency:
678 return "staticLibraryDependency"
679 default:
680 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
681 }
682}
683
684type libraryDependencyOrder int
685
686const (
687 earlyLibraryDependency = -1
688 normalLibraryDependency = 0
689 lateLibraryDependency = 1
690)
691
692func (o libraryDependencyOrder) String() string {
693 switch o {
694 case earlyLibraryDependency:
695 return "earlyLibraryDependency"
696 case normalLibraryDependency:
697 return "normalLibraryDependency"
698 case lateLibraryDependency:
699 return "lateLibraryDependency"
700 default:
701 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
702 }
703}
704
705// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
706// tags that have a set of predefined tag objects that are reused for each dependency, a
707// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
708// That means that comparing a libraryDependencyTag for equality will only be equal if all
709// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
710// then check individual metadata fields instead.
711type libraryDependencyTag struct {
712 blueprint.BaseDependencyTag
713
714 // These are exported so that fmt.Printf("%#v") can call their String methods.
715 Kind libraryDependencyKind
716 Order libraryDependencyOrder
717
718 wholeStatic bool
719
720 reexportFlags bool
721 explicitlyVersioned bool
722 dataLib bool
723 ndk bool
724
725 staticUnwinder bool
726
727 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900728
Cindy Zhou18417cb2020-12-10 07:12:38 -0800729 // Whether or not this dependency should skip the apex dependency check
730 skipApexAllowedDependenciesCheck bool
731
Jiyong Parke3867542020-12-03 17:28:25 +0900732 // Whether or not this dependency has to be followed for the apex variants
733 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900734 // Whether or not this dependency has to be followed for the non-apex variants
735 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000736
737 // If true, don't automatically export symbols from the static library into a shared library.
738 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700739}
740
741// header returns true if the libraryDependencyTag is tagging a header lib dependency.
742func (d libraryDependencyTag) header() bool {
743 return d.Kind == headerLibraryDependency
744}
745
746// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
747func (d libraryDependencyTag) shared() bool {
748 return d.Kind == sharedLibraryDependency
749}
750
751// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
752func (d libraryDependencyTag) static() bool {
753 return d.Kind == staticLibraryDependency
754}
755
Colin Cross65cb3142021-12-10 23:05:02 +0000756func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
757 if d.shared() {
758 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
759 }
760 return nil
761}
762
763var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
764
Colin Crosse9fe2942020-11-10 18:12:15 -0800765// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
766// binaries or other shared libraries are installed as dependencies.
767func (d libraryDependencyTag) InstallDepNeeded() bool {
768 return d.shared()
769}
770
771var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
772
773// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700774// libraryDependencyTag. Each tag object is created globally and reused for multiple
775// dependencies (although since the object contains no references, assigning a tag to a
776// variable and modifying it will not modify the original). Users can compare the tag
777// returned by ctx.OtherModuleDependencyTag against the global original
778type dependencyTag struct {
779 blueprint.BaseDependencyTag
780 name string
781}
782
Colin Crosse9fe2942020-11-10 18:12:15 -0800783// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
784// libraryDependencyTag, but where the dependency needs to be installed when the parent is
785// installed.
786type installDependencyTag struct {
787 blueprint.BaseDependencyTag
788 android.InstallAlwaysNeededDependencyTag
789 name string
790}
791
Colin Crossc99deeb2016-04-11 15:06:20 -0700792var (
Colin Cross6e511a92020-07-27 21:26:48 -0700793 genSourceDepTag = dependencyTag{name: "gen source"}
794 genHeaderDepTag = dependencyTag{name: "gen header"}
795 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
796 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900797 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700798 reuseObjTag = dependencyTag{name: "reuse objects"}
799 staticVariantTag = dependencyTag{name: "static variant"}
800 vndkExtDepTag = dependencyTag{name: "vndk extends"}
801 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700802 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800803 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700804 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700805 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000806 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500807 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400808 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700809)
810
Roland Levillainf89cd092019-07-29 16:22:59 +0100811func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700812 ccLibDepTag, ok := depTag.(libraryDependencyTag)
813 return ok && ccLibDepTag.shared()
814}
815
816func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
817 ccLibDepTag, ok := depTag.(libraryDependencyTag)
818 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100819}
820
Zach Johnson3df4e632020-11-06 11:56:27 -0800821func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
822 ccLibDepTag, ok := depTag.(libraryDependencyTag)
823 return ok && ccLibDepTag.header()
824}
825
Roland Levillainf89cd092019-07-29 16:22:59 +0100826func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800827 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100828}
829
830func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700831 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100832 return ok && ccDepTag == testPerSrcDepTag
833}
834
Colin Crossca860ac2016-01-04 14:34:37 -0800835// Module contains the properties and members used by all C/C++ module types, and implements
836// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500837// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
838// interface.
839//
840// To define a C/C++ related module, construct a new Module object and point its delegates to
841// type-specific structs. These delegates will be invoked to register module-specific build
842// statements which may be unique to the module type. For example, module.compiler.compile() should
843// be defined so as to register build statements which are responsible for compiling the module.
844//
845// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
846// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
847// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
848// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800849type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700850 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700851
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700852 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700853 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700854
Colin Crossca860ac2016-01-04 14:34:37 -0800855 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000856 hod android.HostOrDeviceSupported
857 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000858 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700859
Paul Duffina0843f62019-12-13 19:50:38 +0000860 // Allowable SdkMemberTypes of this module type.
861 sdkMemberTypes []android.SdkMemberType
862
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500863 // decorator delegates, initialize before calling Init
864 // these may contain module-specific implementations, and effectively allow for custom
865 // type-specific logic. These members may reference different objects or the same object.
866 // Functions of these decorators will be invoked to initialize and register type-specific
867 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800868 generators []Generator
869 compiler compiler
870 linker linker
871 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500872
Spandan Dase12d2522023-09-12 21:42:31 +0000873 features []feature
874 stl *stl
875 sanitize *sanitize
876 coverage *coverage
877 fuzzer *fuzzer
878 sabi *sabi
879 vndkdep *vndkdep
880 lto *lto
881 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000882 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800883
Colin Cross31076b32020-10-23 17:22:06 -0700884 library libraryInterface
885
Colin Cross635c3b02016-05-18 15:37:25 -0700886 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800887
Colin Crossb98c8b02016-07-29 13:44:28 -0700888 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700889
890 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800891
892 // Flags used to compile this module
893 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700894
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800895 // Shared flags among build rules of this module
896 sharedFlags SharedFlags
897
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800898 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700899 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900900
901 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800902 // Kythe (source file indexer) paths for this compilation module
903 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700904 // Object .o file output paths for this compilation module
905 objFiles android.Paths
906 // Tidy .tidy file output paths for this compilation module
907 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900908
909 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700910 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700911
912 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800913
914 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800915 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700916}
917
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200918func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400919 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
920 if b, ok := c.compiler.(*baseCompiler); ok {
921 hasAidl = b.hasSrcExt(".aidl")
922 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
923 hasProto = b.hasSrcExt(".proto")
924 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
925 hasSysprop = b.hasSrcExt(".sysprop")
926 hasWinMsg = b.hasSrcExt(".mc")
927 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
928 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200929 c.AndroidModuleBase().AddJSONData(d)
930 (*d)["Cc"] = map[string]interface{}{
931 "SdkVersion": c.SdkVersion(),
932 "MinSdkVersion": c.MinSdkVersion(),
933 "VndkVersion": c.VndkVersion(),
934 "ProductSpecific": c.ProductSpecific(),
935 "SocSpecific": c.SocSpecific(),
936 "DeviceSpecific": c.DeviceSpecific(),
937 "InProduct": c.InProduct(),
938 "InVendor": c.InVendor(),
939 "InRamdisk": c.InRamdisk(),
940 "InVendorRamdisk": c.InVendorRamdisk(),
941 "InRecovery": c.InRecovery(),
942 "VendorAvailable": c.VendorAvailable(),
943 "ProductAvailable": c.ProductAvailable(),
944 "RamdiskAvailable": c.RamdiskAvailable(),
945 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
946 "RecoveryAvailable": c.RecoveryAvailable(),
947 "OdmAvailable": c.OdmAvailable(),
948 "InstallInData": c.InstallInData(),
949 "InstallInRamdisk": c.InstallInRamdisk(),
950 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
951 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
952 "InstallInRecovery": c.InstallInRecovery(),
953 "InstallInRoot": c.InstallInRoot(),
954 "IsVndk": c.IsVndk(),
955 "IsVndkExt": c.IsVndkExt(),
956 "IsVndkPrivate": c.IsVndkPrivate(),
957 "IsVndkSp": c.IsVndkSp(),
958 "IsLlndk": c.IsLlndk(),
959 "IsLlndkPublic": c.IsLlndkPublic(),
960 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
961 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
962 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
963 "ApexSdkVersion": c.apexSdkVersion,
964 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400965 "AidlSrcs": hasAidl,
966 "LexSrcs": hasLex,
967 "ProtoSrcs": hasProto,
968 "RenderscriptSrcs": hasRenderscript,
969 "SyspropSrcs": hasSysprop,
970 "WinMsgSrcs": hasWinMsg,
971 "YaccSrsc": hasYacc,
972 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200973 }
974}
975
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500976func (c *Module) SetPreventInstall() {
977 c.Properties.PreventInstall = true
978}
979
980func (c *Module) SetHideFromMake() {
981 c.Properties.HideFromMake = true
982}
983
Ivan Lozanod7586b62021-04-01 09:49:36 -0400984func (c *Module) HiddenFromMake() bool {
985 return c.Properties.HideFromMake
986}
987
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800988func (c *Module) RequiredModuleNames() []string {
989 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
990 if c.ImageVariation().Variation == android.CoreVariation {
991 required = append(required, c.Properties.Target.Platform.Required...)
992 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
993 } else if c.InRecovery() {
994 required = append(required, c.Properties.Target.Recovery.Required...)
995 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
996 }
997 return android.FirstUniqueStrings(required)
998}
999
Ivan Lozano52767be2019-10-18 14:49:46 -07001000func (c *Module) Toc() android.OptionalPath {
1001 if c.linker != nil {
1002 if library, ok := c.linker.(libraryInterface); ok {
1003 return library.toc()
1004 }
1005 }
1006 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1007}
1008
1009func (c *Module) ApiLevel() string {
1010 if c.linker != nil {
1011 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001012 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001013 }
1014 }
1015 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1016}
1017
1018func (c *Module) Static() bool {
1019 if c.linker != nil {
1020 if library, ok := c.linker.(libraryInterface); ok {
1021 return library.static()
1022 }
1023 }
1024 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1025}
1026
1027func (c *Module) Shared() bool {
1028 if c.linker != nil {
1029 if library, ok := c.linker.(libraryInterface); ok {
1030 return library.shared()
1031 }
1032 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001033
Ivan Lozano52767be2019-10-18 14:49:46 -07001034 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1035}
1036
1037func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001038 if c.stl != nil {
1039 return c.stl.Properties.SelectedStl
1040 }
1041 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001042}
1043
Ivan Lozano52767be2019-10-18 14:49:46 -07001044func (c *Module) NdkPrebuiltStl() bool {
1045 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1046 return true
1047 }
1048 return false
1049}
1050
1051func (c *Module) StubDecorator() bool {
1052 if _, ok := c.linker.(*stubDecorator); ok {
1053 return true
1054 }
1055 return false
1056}
1057
1058func (c *Module) SdkVersion() string {
1059 return String(c.Properties.Sdk_version)
1060}
1061
Artur Satayev480e25b2020-04-27 18:53:18 +01001062func (c *Module) MinSdkVersion() string {
1063 return String(c.Properties.Min_sdk_version)
1064}
1065
Jiyong Park5df7bd32021-08-25 16:18:46 +09001066func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001067 if linker, ok := c.linker.(*objectLinker); ok {
1068 return linker.isCrt()
1069 }
1070 return false
1071}
1072
Jiyong Park5df7bd32021-08-25 16:18:46 +09001073func (c *Module) SplitPerApiLevel() bool {
1074 return c.canUseSdk() && c.isCrt()
1075}
1076
Colin Crossc511bc52020-04-07 16:50:32 +00001077func (c *Module) AlwaysSdk() bool {
1078 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1079}
1080
Ivan Lozano183a3212019-10-18 14:18:45 -07001081func (c *Module) CcLibrary() bool {
1082 if c.linker != nil {
1083 if _, ok := c.linker.(*libraryDecorator); ok {
1084 return true
1085 }
Colin Crossd48fe732020-09-23 20:37:24 -07001086 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1087 return true
1088 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001089 }
1090 return false
1091}
1092
1093func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001094 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001095 return true
1096 }
1097 return false
1098}
1099
Spandan Dase12d2522023-09-12 21:42:31 +00001100func (c *Module) IsNdkPrebuiltStl() bool {
1101 if c.linker == nil {
1102 return false
1103 }
1104 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1105 return true
1106 }
1107 return false
1108}
1109
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001110func (c *Module) RlibStd() bool {
1111 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1112}
1113
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001114func (c *Module) RustLibraryInterface() bool {
1115 return false
1116}
1117
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001118func (c *Module) IsFuzzModule() bool {
1119 if _, ok := c.compiler.(*fuzzBinary); ok {
1120 return true
1121 }
1122 return false
1123}
1124
1125func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1126 return c.FuzzModule
1127}
1128
1129func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1130 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1131 return fuzzer.fuzzPackagedModule
1132 }
1133 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1134}
1135
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001136func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001137 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1138 return fuzzer.sharedLibraries
1139 }
1140 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1141}
1142
Ivan Lozano2b262972019-11-21 12:30:50 -08001143func (c *Module) NonCcVariants() bool {
1144 return false
1145}
1146
Ivan Lozano183a3212019-10-18 14:18:45 -07001147func (c *Module) SetStatic() {
1148 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001149 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001150 library.setStatic()
1151 return
1152 }
1153 }
1154 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1155}
1156
1157func (c *Module) SetShared() {
1158 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001159 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001160 library.setShared()
1161 return
1162 }
1163 }
1164 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1165}
1166
1167func (c *Module) BuildStaticVariant() bool {
1168 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001169 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001170 return library.buildStatic()
1171 }
1172 }
1173 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1174}
1175
1176func (c *Module) BuildSharedVariant() bool {
1177 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001178 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001179 return library.buildShared()
1180 }
1181 }
1182 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1183}
1184
1185func (c *Module) Module() android.Module {
1186 return c
1187}
1188
Jiyong Parkc20eee32018-09-05 22:36:17 +09001189func (c *Module) OutputFile() android.OptionalPath {
1190 return c.outputFile
1191}
1192
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001193func (c *Module) CoverageFiles() android.Paths {
1194 if c.linker != nil {
1195 if library, ok := c.linker.(libraryInterface); ok {
1196 return library.objs().coverageFiles
1197 }
1198 }
1199 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1200}
1201
Ivan Lozano183a3212019-10-18 14:18:45 -07001202var _ LinkableInterface = (*Module)(nil)
1203
Jiyong Park719b4462019-01-13 00:39:51 +09001204func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001205 if c.linker != nil {
1206 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001207 }
1208 return nil
1209}
1210
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001211func (c *Module) CoverageOutputFile() android.OptionalPath {
1212 if c.linker != nil {
1213 return c.linker.coverageOutputFilePath()
1214 }
1215 return android.OptionalPath{}
1216}
1217
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001218func (c *Module) RelativeInstallPath() string {
1219 if c.installer != nil {
1220 return c.installer.relativeInstallPath()
1221 }
1222 return ""
1223}
1224
Jooyung Han344d5432019-08-23 11:17:39 +09001225func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001226 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001227}
1228
Colin Cross36242852017-06-23 15:06:31 -07001229func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001230 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001231 for _, generator := range c.generators {
1232 c.AddProperties(generator.GeneratorProps()...)
1233 }
Colin Crossca860ac2016-01-04 14:34:37 -08001234 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001235 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001236 }
1237 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001238 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001239 }
1240 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001241 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001242 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001243 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001244 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001245 }
Colin Cross16b23492016-01-06 14:41:07 -08001246 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001247 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001248 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001249 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001250 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001251 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001252 if c.fuzzer != nil {
1253 c.AddProperties(c.fuzzer.props()...)
1254 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001255 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001256 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001257 }
Justin Yun8effde42017-06-23 19:24:43 +09001258 if c.vndkdep != nil {
1259 c.AddProperties(c.vndkdep.props()...)
1260 }
Stephen Craneba090d12017-05-09 15:44:35 -07001261 if c.lto != nil {
1262 c.AddProperties(c.lto.props()...)
1263 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001264 if c.afdo != nil {
1265 c.AddProperties(c.afdo.props()...)
1266 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001267 if c.orderfile != nil {
1268 c.AddProperties(c.orderfile.props()...)
1269 }
Colin Crossca860ac2016-01-04 14:34:37 -08001270 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001271 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001272 }
Colin Crossc472d572015-03-17 15:06:21 -07001273
Colin Cross36242852017-06-23 15:06:31 -07001274 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001275 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001276 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001277
Colin Cross36242852017-06-23 15:06:31 -07001278 return c
Colin Crossc472d572015-03-17 15:06:21 -07001279}
1280
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001281// UseVndk() returns true if this module is built against VNDK.
1282// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001283func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001284 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001285}
1286
Colin Crossc511bc52020-04-07 16:50:32 +00001287func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001288 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001289 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001290}
1291
1292func (c *Module) UseSdk() bool {
1293 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001294 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001295 }
1296 return false
1297}
1298
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001299func (c *Module) isCoverageVariant() bool {
1300 return c.coverage.Properties.IsCoverageVariant
1301}
1302
Colin Cross95f1ca02020-10-29 20:47:22 -07001303func (c *Module) IsNdk(config android.Config) bool {
1304 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001305}
1306
Colin Cross127bb8b2020-12-16 16:46:01 -08001307func (c *Module) IsLlndk() bool {
1308 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001309}
1310
Colin Cross127bb8b2020-12-16 16:46:01 -08001311func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001312 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001313}
1314
Colin Cross1f3f1302021-04-26 18:37:44 -07001315func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001316 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001317 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001318}
1319
Colin Cross5271fea2021-04-27 13:06:04 -07001320func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1321 lib := moduleLibraryInterface(m)
1322 return lib != nil && (lib.hasVendorPublicLibrary())
1323}
1324
1325// IsVendorPublicLibrary returns true for vendor public libraries.
1326func (c *Module) IsVendorPublicLibrary() bool {
1327 return c.VendorProperties.IsVendorPublicLibrary
1328}
1329
Ivan Lozanof1868af2022-04-12 13:08:36 -04001330func (c *Module) IsVndkPrebuiltLibrary() bool {
1331 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1332 return true
1333 }
1334 return false
1335}
1336
1337func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1338 return c.Properties.SdkAndPlatformVariantVisibleToMake
1339}
1340
Ivan Lozanod7586b62021-04-01 09:49:36 -04001341func (c *Module) HasLlndkStubs() bool {
1342 lib := moduleLibraryInterface(c)
1343 return lib != nil && lib.hasLLNDKStubs()
1344}
1345
1346func (c *Module) StubsVersion() string {
1347 if lib, ok := c.linker.(versionedInterface); ok {
1348 return lib.stubsVersion()
1349 }
1350 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1351}
1352
Colin Cross127bb8b2020-12-16 16:46:01 -08001353// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1354// and does not set llndk.vendor_available: false.
1355func (c *Module) isImplementationForLLNDKPublic() bool {
1356 library, _ := c.library.(*libraryDecorator)
1357 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001358 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001359}
1360
Justin Yunfd9e8042020-12-23 18:23:14 +09001361// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001362func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001363 // Check if VNDK-core-private or VNDK-SP-private
1364 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001365 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001366 }
1367
1368 // Check if LLNDK-private
1369 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001370 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001371 }
1372
1373 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001374}
1375
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001376// IsVndk() returns true if this module has a vndk variant.
1377// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1378// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001379func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001380 if vndkdep := c.vndkdep; vndkdep != nil {
1381 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001382 }
1383 return false
1384}
1385
Yi Kong4ef54592022-02-14 20:00:10 +08001386func (c *Module) isAfdoCompile() bool {
1387 if afdo := c.afdo; afdo != nil {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001388 return afdo.Properties.FdoProfilePath != nil
Yi Kong4ef54592022-02-14 20:00:10 +08001389 }
1390 return false
1391}
1392
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001393func (c *Module) isOrderfileCompile() bool {
1394 if orderfile := c.orderfile; orderfile != nil {
1395 return orderfile.Properties.OrderfileLoad
1396 }
1397 return false
1398}
1399
Yi Kongc702ebd2022-08-19 16:02:45 +08001400func (c *Module) isCfi() bool {
1401 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001402 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001403 }
1404 return false
1405}
1406
Yi Konged79fa32023-06-04 17:15:42 +09001407func (c *Module) isFuzzer() bool {
1408 if sanitize := c.sanitize; sanitize != nil {
1409 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1410 }
1411 return false
1412}
1413
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001414func (c *Module) isNDKStubLibrary() bool {
1415 if _, ok := c.compiler.(*stubDecorator); ok {
1416 return true
1417 }
1418 return false
1419}
1420
Ivan Lozanod7586b62021-04-01 09:49:36 -04001421func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001422 if vndkdep := c.vndkdep; vndkdep != nil {
1423 return vndkdep.isVndkSp()
1424 }
1425 return false
1426}
1427
Ivan Lozanof9e21722020-12-02 09:00:51 -05001428func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001429 if vndkdep := c.vndkdep; vndkdep != nil {
1430 return vndkdep.isVndkExt()
1431 }
1432 return false
1433}
1434
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001435func (c *Module) SubName() string {
1436 return c.Properties.SubName
1437}
1438
Ivan Lozano52767be2019-10-18 14:49:46 -07001439func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001440 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001441}
1442
Logan Chienf3511742017-10-31 18:04:35 +08001443func (c *Module) getVndkExtendsModuleName() string {
1444 if vndkdep := c.vndkdep; vndkdep != nil {
1445 return vndkdep.getVndkExtendsModuleName()
1446 }
1447 return ""
1448}
1449
Jiyong Park25fc6a92018-11-18 18:02:45 +09001450func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001451 if lib := c.library; lib != nil {
1452 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001453 }
1454 return false
1455}
1456
1457func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001458 if lib := c.library; lib != nil {
1459 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001460 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001461 return false
1462}
1463
Alan Stokes73feba32022-11-14 12:21:24 +00001464func (c *Module) IsStubsImplementationRequired() bool {
1465 if lib := c.library; lib != nil {
1466 return lib.isStubsImplementationRequired()
1467 }
1468 return false
1469}
1470
Colin Cross0477b422020-10-13 18:43:54 -07001471// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1472// the implementation. If it is an implementation library it returns its own name.
1473func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1474 name := ctx.OtherModuleName(c)
1475 if versioned, ok := c.linker.(versionedInterface); ok {
1476 name = versioned.implementationModuleName(name)
1477 }
1478 return name
1479}
1480
Martin Stjernholm2856c662020-12-02 15:03:42 +00001481// Similar to ImplementationModuleName, but uses the Make variant of the module
1482// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1483// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1484// under the premise that the prebuilt module overrides its source counterpart
1485// if it is exposed to Make).
1486func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1487 name := c.BaseModuleName()
1488 if versioned, ok := c.linker.(versionedInterface); ok {
1489 name = versioned.implementationModuleName(name)
1490 }
1491 return name
1492}
1493
Jiyong Park7d55b612021-06-11 17:22:09 +09001494func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001495 return Bool(c.Properties.Bootstrap)
1496}
1497
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001498func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001499 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1500 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1501 return false
1502 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001503 return c.linker != nil && c.linker.nativeCoverage()
1504}
1505
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001506func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001507 if p, ok := c.linker.(SnapshotInterface); ok {
1508 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001509 }
1510 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001511}
1512
Bill Peckham945441c2020-08-31 16:07:58 -07001513func (c *Module) ExcludeFromVendorSnapshot() bool {
1514 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1515}
1516
Jose Galmesf7294582020-11-13 12:07:36 -08001517func (c *Module) ExcludeFromRecoverySnapshot() bool {
1518 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1519}
1520
Jiyong Parkf1194352019-02-25 11:05:47 +09001521func isBionic(name string) bool {
1522 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001523 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001524 return true
1525 }
1526 return false
1527}
1528
Martin Stjernholm279de572019-09-10 23:18:20 +01001529func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001530 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001531 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001532 }
1533 return isBionic(name)
1534}
1535
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001536func (c *Module) XrefCcFiles() android.Paths {
1537 return c.kytheFiles
1538}
1539
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001540func (c *Module) isCfiAssemblySupportEnabled() bool {
1541 return c.sanitize != nil &&
1542 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1543}
1544
Inseob Kim800d1142021-06-14 12:03:51 +09001545func (c *Module) InstallInRoot() bool {
1546 return c.installer != nil && c.installer.installInRoot()
1547}
1548
Colin Crossca860ac2016-01-04 14:34:37 -08001549type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001550 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001551 moduleContextImpl
1552}
1553
Colin Cross37047f12016-12-13 17:06:13 -08001554type depsContext struct {
1555 android.BottomUpMutatorContext
1556 moduleContextImpl
1557}
1558
Colin Crossca860ac2016-01-04 14:34:37 -08001559type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001560 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001561 moduleContextImpl
1562}
1563
1564type moduleContextImpl struct {
1565 mod *Module
1566 ctx BaseModuleContext
1567}
1568
Colin Crossb98c8b02016-07-29 13:44:28 -07001569func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001570 return ctx.mod.toolchain(ctx.ctx)
1571}
1572
1573func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001574 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001575}
1576
1577func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001578 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001579}
1580
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001581func (ctx *moduleContextImpl) testBinary() bool {
1582 return ctx.mod.testBinary()
1583}
1584
Yi Kong56fc1b62022-09-06 16:24:00 +08001585func (ctx *moduleContextImpl) testLibrary() bool {
1586 return ctx.mod.testLibrary()
1587}
1588
Jiyong Park1d1119f2019-07-29 21:27:18 +09001589func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001590 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001591}
1592
Inseob Kim7f283f42020-06-01 21:53:49 +09001593func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001594 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001595}
1596
Inseob Kim1042d292020-06-01 23:23:05 +09001597func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001598 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001599}
1600
Jooyung Hanccce2f22020-03-07 03:45:53 +09001601func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001602 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001603}
1604
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001605func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001606 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001607}
1608
1609func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001610 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001611 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001612 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001613 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001614 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001615 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001616 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001617 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001618 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001619 }
1620 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001621}
1622
Jiyong Parkb35a8192020-08-10 15:59:36 +09001623func (ctx *moduleContextImpl) minSdkVersion() string {
1624 ver := ctx.mod.MinSdkVersion()
1625 if ver == "apex_inherit" && !ctx.isForPlatform() {
1626 ver = ctx.apexSdkVersion().String()
1627 }
1628 if ver == "apex_inherit" || ver == "" {
1629 ver = ctx.sdkVersion()
1630 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001631 // For crt objects, the meaning of min_sdk_version is very different from other types of
1632 // module. For them, min_sdk_version defines the oldest version that the build system will
1633 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1634 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1635 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001636 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1637 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1638 // support such an old version. The version is set to the later version in case when the
1639 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1640 // it's for an APEX.
1641 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1642 if ctx.isForPlatform() {
1643 ver = strconv.Itoa(android.FutureApiLevelInt)
1644 } else { // for apex
1645 ver = ctx.apexSdkVersion().String()
1646 if ver == "" { // in case when min_sdk_version was not set by the APEX
1647 ver = ctx.sdkVersion()
1648 }
1649 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001650 }
1651
Jiyong Parkb35a8192020-08-10 15:59:36 +09001652 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1653 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1654 minSdkVersionInt, err2 := strconv.Atoi(ver)
1655 if err == nil && err2 == nil {
1656 if sdkVersionInt < minSdkVersionInt {
1657 return strconv.Itoa(sdkVersionInt)
1658 }
1659 }
1660 return ver
1661}
1662
1663func (ctx *moduleContextImpl) isSdkVariant() bool {
1664 return ctx.mod.IsSdkVariant()
1665}
1666
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001667func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001668 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001669}
Justin Yun8effde42017-06-23 19:24:43 +09001670
Kiyoung Kimaa394802024-01-08 12:55:45 +09001671func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1672 return ctx.mod.InVendorOrProduct()
1673}
1674
Colin Cross95f1ca02020-10-29 20:47:22 -07001675func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1676 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001677}
1678
Colin Cross127bb8b2020-12-16 16:46:01 -08001679func (ctx *moduleContextImpl) IsLlndk() bool {
1680 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001681}
1682
Colin Cross127bb8b2020-12-16 16:46:01 -08001683func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1684 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001685}
1686
Colin Cross127bb8b2020-12-16 16:46:01 -08001687func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1688 return ctx.mod.isImplementationForLLNDKPublic()
1689}
1690
1691func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1692 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001693}
1694
Logan Chienf3511742017-10-31 18:04:35 +08001695func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001696 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001697}
1698
Yi Kong4ef54592022-02-14 20:00:10 +08001699func (ctx *moduleContextImpl) isAfdoCompile() bool {
1700 return ctx.mod.isAfdoCompile()
1701}
1702
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001703func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1704 return ctx.mod.isOrderfileCompile()
1705}
1706
Yi Kongc702ebd2022-08-19 16:02:45 +08001707func (ctx *moduleContextImpl) isCfi() bool {
1708 return ctx.mod.isCfi()
1709}
1710
Yi Konged79fa32023-06-04 17:15:42 +09001711func (ctx *moduleContextImpl) isFuzzer() bool {
1712 return ctx.mod.isFuzzer()
1713}
1714
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001715func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1716 return ctx.mod.isNDKStubLibrary()
1717}
1718
Justin Yun8effde42017-06-23 19:24:43 +09001719func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001720 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001721}
1722
Ivan Lozanof9e21722020-12-02 09:00:51 -05001723func (ctx *moduleContextImpl) IsVndkExt() bool {
1724 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001725}
1726
Colin Cross5271fea2021-04-27 13:06:04 -07001727func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1728 return ctx.mod.IsVendorPublicLibrary()
1729}
1730
Vic Yangefd249e2018-11-12 20:19:56 -08001731func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001732 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001733}
1734
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001735func (ctx *moduleContextImpl) selectedStl() string {
1736 if stl := ctx.mod.stl; stl != nil {
1737 return stl.Properties.SelectedStl
1738 }
1739 return ""
1740}
1741
Ivan Lozanobd721262018-11-27 14:33:03 -08001742func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1743 return ctx.mod.linker.useClangLld(actx)
1744}
1745
Colin Crossce75d2c2016-10-06 16:12:58 -07001746func (ctx *moduleContextImpl) baseModuleName() string {
1747 return ctx.mod.ModuleBase.BaseModuleName()
1748}
1749
Logan Chienf3511742017-10-31 18:04:35 +08001750func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1751 return ctx.mod.getVndkExtendsModuleName()
1752}
1753
Logan Chiene274fc92019-12-03 11:18:32 -08001754func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001755 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1756 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001757}
1758
Colin Crosse07f2312020-08-13 11:24:56 -07001759func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001760 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1761 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001762}
1763
Dan Albertc8060532020-07-22 22:32:17 -07001764func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001765 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001766}
1767
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001768func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001769 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001770}
1771
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001772func (ctx *moduleContextImpl) nativeCoverage() bool {
1773 return ctx.mod.nativeCoverage()
1774}
1775
Colin Cross56a83212020-09-15 18:30:11 -07001776func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1777 return ctx.mod.DirectlyInAnyApex()
1778}
1779
Colin Cross95b07f22020-12-16 11:06:50 -08001780func (ctx *moduleContextImpl) isPreventInstall() bool {
1781 return ctx.mod.Properties.PreventInstall
1782}
1783
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001784func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1785 shared := &ctx.mod.sharedFlags
1786 if shared.flagsMap == nil {
1787 shared.numSharedFlags = 0
1788 shared.flagsMap = make(map[string]string)
1789 }
1790 return shared
1791}
1792
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001793func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1794 return ctx.mod.isCfiAssemblySupportEnabled()
1795}
1796
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001797func (ctx *moduleContextImpl) notInPlatform() bool {
1798 return ctx.mod.NotInPlatform()
1799}
1800
Colin Cross635c3b02016-05-18 15:37:25 -07001801func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001802 return &Module{
1803 hod: hod,
1804 multilib: multilib,
1805 }
1806}
1807
Colin Cross635c3b02016-05-18 15:37:25 -07001808func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001809 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001810 module.features = []feature{
1811 &tidyFeature{},
1812 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001813 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001814 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001815 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001816 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001817 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001818 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001819 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001820 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001821 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001822 return module
1823}
1824
Colin Crossce75d2c2016-10-06 16:12:58 -07001825func (c *Module) Prebuilt() *android.Prebuilt {
1826 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1827 return p.prebuilt()
1828 }
1829 return nil
1830}
1831
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001832func (c *Module) IsPrebuilt() bool {
1833 return c.Prebuilt() != nil
1834}
1835
Colin Crossce75d2c2016-10-06 16:12:58 -07001836func (c *Module) Name() string {
1837 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001838 if p, ok := c.linker.(interface {
1839 Name(string) string
1840 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001841 name = p.Name(name)
1842 }
1843 return name
1844}
1845
Alex Light3d673592019-01-18 14:37:31 -08001846func (c *Module) Symlinks() []string {
1847 if p, ok := c.installer.(interface {
1848 symlinkList() []string
1849 }); ok {
1850 return p.symlinkList()
1851 }
1852 return nil
1853}
1854
Roland Levillainf89cd092019-07-29 16:22:59 +01001855func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1856 test, ok := c.linker.(testPerSrc)
1857 return ok && test.isAllTestsVariation()
1858}
1859
Chris Parsons216e10a2020-07-09 17:12:52 -04001860func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001861 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001862 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001863 }); ok {
1864 return p.dataPaths()
1865 }
1866 return nil
1867}
1868
Ivan Lozanof1868af2022-04-12 13:08:36 -04001869func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001870 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1871 // "current", it will append the VNDK version to the name suffix.
1872 var vndkVersion string
1873 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001874 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001875 if c.ProductSpecific() {
1876 // If the module is product specific with 'product_specific: true',
1877 // do not add a name suffix because it is a base module.
1878 return ""
1879 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001880 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001881 } else {
1882 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001883 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001884 }
1885 if vndkVersion == "current" {
1886 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1887 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001888 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001889 // add version suffix only if the module is using different vndk version than the
1890 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001891 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001892 }
1893 return nameSuffix
1894}
1895
Ivan Lozanof1868af2022-04-12 13:08:36 -04001896func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1897 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001898
1899 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001900 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001901 }
1902
Colin Cross127bb8b2020-12-16 16:46:01 -08001903 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001904 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001905 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1906 // added for product variant only when we have vendor and product variants with core
1907 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001908 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001909 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001910 subName += vendorPublicLibrarySuffix
1911 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001912 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1913 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001914 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001915 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001916 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001917 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001918 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001919 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001920 subName += RecoverySuffix
1921 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1922 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001923 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001924 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001925 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001926 } else if c.IsStubs() && c.IsSdkVariant() {
1927 // Public API surface (NDK)
1928 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1929 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001930 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001931
1932 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001933}
1934
Sam Delmerico75dbca22023-04-20 13:13:25 +00001935func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1936 ctx := &moduleContext{
1937 ModuleContext: actx,
1938 moduleContextImpl: moduleContextImpl{
1939 mod: c,
1940 },
1941 }
1942 ctx.ctx = ctx
1943 return ctx
1944}
1945
Spandan Das20fce2d2023-04-12 17:21:39 +00001946// TODO (b/277651159): Remove this allowlist
1947var (
1948 skipStubLibraryMultipleApexViolation = map[string]bool{
1949 "libclang_rt.asan": true,
1950 "libclang_rt.hwasan": true,
1951 // runtime apex
1952 "libc": true,
1953 "libc_hwasan": true,
1954 "libdl_android": true,
1955 "libm": true,
1956 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001957 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001958 // art apex
1959 "libandroidio": true,
1960 "libdexfile": true,
1961 "libnativebridge": true,
1962 "libnativehelper": true,
1963 "libnativeloader": true,
1964 "libsigchain": true,
1965 }
1966)
1967
1968// Returns true if a stub library could be installed in multiple apexes
1969func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1970 // If this is not an apex variant, no check necessary
1971 if !c.InAnyApex() {
1972 return false
1973 }
1974 // If this is not a stub library, no check necessary
1975 if !c.HasStubsVariants() {
1976 return false
1977 }
1978 // Skip the allowlist
1979 // Use BaseModuleName so that this matches prebuilts.
1980 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1981 return false
1982 }
1983
1984 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1985 // Stub libraries should not have more than one apex_available
1986 if len(aaWithoutTestApexes) > 1 {
1987 return true
1988 }
1989 // Stub libraries should not use the wildcard
1990 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
1991 return true
1992 }
1993 // Default: no violation
1994 return false
1995}
1996
Chris Parsons8d6e4332021-02-22 16:13:50 -05001997func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05001998 // Handle the case of a test module split by `test_per_src` mutator.
1999 //
2000 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2001 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2002 // module and return early, as this module does not produce an output file per se.
2003 if c.IsTestPerSrcAllTestsVariation() {
2004 c.outputFile = android.OptionalPath{}
2005 return
2006 }
2007
Ivan Lozanof1868af2022-04-12 13:08:36 -04002008 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002009 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002010 if !apexInfo.IsForPlatform() {
2011 c.hideApexVariantFromMake = true
2012 }
2013
Chris Parsonseefc9e62021-04-02 17:36:47 -04002014 c.makeLinkType = GetMakeLinkType(actx, c)
2015
Sam Delmerico75dbca22023-04-20 13:13:25 +00002016 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002017
Colin Crossf18e1102017-11-16 14:33:08 -08002018 deps := c.depsToPaths(ctx)
2019 if ctx.Failed() {
2020 return
2021 }
2022
Joe Onorato37f900c2023-07-18 16:58:16 -07002023 for _, generator := range c.generators {
2024 gen := generator.GeneratorSources(ctx)
2025 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2026 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2027 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2028 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2029 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2030 if len(deps.Objs.objFiles) == 0 {
2031 // If we are reusuing object files (which happens when we're a shared library and we're
2032 // reusing our static variant's object files), then skip adding the actual source files,
2033 // because we already have the object for it.
2034 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2035 }
2036 }
2037
2038 if ctx.Failed() {
2039 return
2040 }
2041
Spandan Das20fce2d2023-04-12 17:21:39 +00002042 if c.stubLibraryMultipleApexViolation(actx) {
2043 actx.PropertyErrorf("apex_available",
2044 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2045 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002046 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2047 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002048 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2049 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002050 }
2051
Colin Crossca860ac2016-01-04 14:34:37 -08002052 flags := Flags{
2053 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002054 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002055 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002056 for _, generator := range c.generators {
2057 flags = generator.GeneratorFlags(ctx, flags, deps)
2058 }
Colin Crossca860ac2016-01-04 14:34:37 -08002059 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002060 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002061 }
2062 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002063 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002064 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002065 if c.stl != nil {
2066 flags = c.stl.flags(ctx, flags)
2067 }
Colin Cross16b23492016-01-06 14:41:07 -08002068 if c.sanitize != nil {
2069 flags = c.sanitize.flags(ctx, flags)
2070 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002071 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002072 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002073 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002074 if c.fuzzer != nil {
2075 flags = c.fuzzer.flags(ctx, flags)
2076 }
Stephen Craneba090d12017-05-09 15:44:35 -07002077 if c.lto != nil {
2078 flags = c.lto.flags(ctx, flags)
2079 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002080 if c.afdo != nil {
2081 flags = c.afdo.flags(ctx, flags)
2082 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002083 if c.orderfile != nil {
2084 flags = c.orderfile.flags(ctx, flags)
2085 }
Colin Crossca860ac2016-01-04 14:34:37 -08002086 for _, feature := range c.features {
2087 flags = feature.flags(ctx, flags)
2088 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002089 if ctx.Failed() {
2090 return
2091 }
2092
Colin Cross4af21ed2019-11-04 09:37:55 -08002093 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2094 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2095 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002096
Colin Cross4af21ed2019-11-04 09:37:55 -08002097 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002098
2099 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002100 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002101 }
2102 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002103 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002104 }
2105
Colin Cross3e5e7782022-06-17 22:17:05 +00002106 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2107
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002108 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002109 // We need access to all the flags seen by a source file.
2110 if c.sabi != nil {
2111 flags = c.sabi.flags(ctx, flags)
2112 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002113
Colin Cross4af21ed2019-11-04 09:37:55 -08002114 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002115
Joe Onorato37f900c2023-07-18 16:58:16 -07002116 for _, generator := range c.generators {
2117 generator.GeneratorBuildActions(ctx, flags, deps)
2118 }
2119
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002120 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002121 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002122 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002123 if ctx.Failed() {
2124 return
2125 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002126 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002127 c.objFiles = objs.objFiles
2128 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002129 }
2130
Colin Crossca860ac2016-01-04 14:34:37 -08002131 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002132 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002133 if ctx.Failed() {
2134 return
2135 }
Colin Cross635c3b02016-05-18 15:37:25 -07002136 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002137
Chris Parsons94a0bba2021-06-04 15:03:47 -04002138 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002139
Jose Galmes6f843bc2020-12-11 13:36:29 -08002140 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2141 // RECOVERY_SNAPSHOT_VERSION is current.
2142 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002143 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002144 i.collectHeadersForSnapshot(ctx)
2145 }
2146 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002147 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002148 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002149 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002150 }
Colin Cross40213022023-12-13 15:19:49 -08002151 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002152
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002153 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002154
Chris Parsons94a0bba2021-06-04 15:03:47 -04002155 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002156
2157 if c.linker != nil {
2158 moduleInfoJSON := ctx.ModuleInfoJSON()
2159 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2160 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2161 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2162 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2163 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2164
2165 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2166 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2167 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2168 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2169
2170 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2171 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2172 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2173 moduleInfoJSON.SubName += ".cfi"
2174 }
2175 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2176 moduleInfoJSON.SubName += ".hwasan"
2177 }
2178 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2179 moduleInfoJSON.SubName += ".scs"
2180 }
2181 }
2182 moduleInfoJSON.SubName += c.Properties.SubName
2183
2184 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2185 moduleInfoJSON.Uninstallable = true
2186 }
2187
2188 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002189}
2190
2191func (c *Module) maybeUnhideFromMake() {
2192 // If a lib is directly included in any of the APEXes or is not available to the
2193 // platform (which is often the case when the stub is provided as a prebuilt),
2194 // unhide the stubs variant having the latest version gets visible to make. In
2195 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2196 // force anything in the make world to link against the stubs library. (unless it
2197 // is explicitly referenced via .bootstrap suffix or the module is marked with
2198 // 'bootstrap: true').
2199 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002200 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002201 c.IsStubs() && !c.InVendorRamdisk() {
2202 c.Properties.HideFromMake = false // unhide
2203 // Note: this is still non-installable
2204 }
2205}
2206
Colin Cross8ff10582023-12-07 13:10:56 -08002207// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2208// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002209func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002210 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002211 // If the module has been specifically configure to not be installed then
2212 // hide from make as otherwise it will break when running inside make
2213 // as the output path to install will not be specified. Not all uninstallable
2214 // modules can be hidden from make as some are needed for resolving make side
2215 // dependencies.
2216 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002217 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002218 c.SkipInstall()
2219 }
2220
2221 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2222 // to allow using the outputs in a genrule.
2223 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002224 c.installer.install(ctx, c.outputFile.Path())
2225 if ctx.Failed() {
2226 return
Colin Crossca860ac2016-01-04 14:34:37 -08002227 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002228 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002229}
2230
Colin Cross0ea8ba82019-06-06 14:33:29 -07002231func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002232 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002233 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002234 }
Colin Crossca860ac2016-01-04 14:34:37 -08002235 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002236}
2237
Colin Crossca860ac2016-01-04 14:34:37 -08002238func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002239 for _, generator := range c.generators {
2240 generator.GeneratorInit(ctx)
2241 }
Colin Crossca860ac2016-01-04 14:34:37 -08002242 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002243 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002244 }
Colin Crossca860ac2016-01-04 14:34:37 -08002245 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002246 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002247 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002248 if c.stl != nil {
2249 c.stl.begin(ctx)
2250 }
Colin Cross16b23492016-01-06 14:41:07 -08002251 if c.sanitize != nil {
2252 c.sanitize.begin(ctx)
2253 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002254 if c.coverage != nil {
2255 c.coverage.begin(ctx)
2256 }
Yi Kong9723e332023-12-04 14:52:53 +09002257 if c.afdo != nil {
2258 c.afdo.begin(ctx)
2259 }
Stephen Craneba090d12017-05-09 15:44:35 -07002260 if c.lto != nil {
2261 c.lto.begin(ctx)
2262 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002263 if c.orderfile != nil {
2264 c.orderfile.begin(ctx)
2265 }
Dan Albert92fe7402020-07-15 13:33:30 -07002266 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002267 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002268 if err != nil {
2269 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002270 c.Properties.Sdk_version = nil
2271 } else {
2272 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002273 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002274 }
Colin Crossca860ac2016-01-04 14:34:37 -08002275}
2276
Colin Cross37047f12016-12-13 17:06:13 -08002277func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002278 deps := Deps{}
2279
Joe Onorato37f900c2023-07-18 16:58:16 -07002280 for _, generator := range c.generators {
2281 deps = generator.GeneratorDeps(ctx, deps)
2282 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002283 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002284 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002285 }
2286 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002287 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002288 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002289 if c.stl != nil {
2290 deps = c.stl.deps(ctx, deps)
2291 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002292 if c.coverage != nil {
2293 deps = c.coverage.deps(ctx, deps)
2294 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002295
Colin Crossb6715442017-10-24 11:13:31 -07002296 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2297 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2298 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2299 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2300 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2301 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002302 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002303
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002304 for _, lib := range deps.ReexportSharedLibHeaders {
2305 if !inList(lib, deps.SharedLibs) {
2306 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2307 }
2308 }
2309
2310 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002311 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2312 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 -07002313 }
2314 }
2315
Colin Cross5950f382016-12-13 12:50:57 -08002316 for _, lib := range deps.ReexportHeaderLibHeaders {
2317 if !inList(lib, deps.HeaderLibs) {
2318 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2319 }
2320 }
2321
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002322 for _, gen := range deps.ReexportGeneratedHeaders {
2323 if !inList(gen, deps.GeneratedHeaders) {
2324 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2325 }
2326 }
2327
Colin Crossc99deeb2016-04-11 15:06:20 -07002328 return deps
2329}
2330
Dan Albert7e9d2952016-08-04 13:02:36 -07002331func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002332 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002333 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002334 moduleContextImpl: moduleContextImpl{
2335 mod: c,
2336 },
2337 }
2338 ctx.ctx = ctx
2339
Vinh Tran44cb78c2023-03-09 22:07:19 -05002340 if !actx.Host() || !ctx.static() || ctx.staticBinary() {
2341 c.afdo.addDep(ctx, actx)
2342 }
2343
Colin Crossca860ac2016-01-04 14:34:37 -08002344 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002345}
2346
Jiyong Park7ed9de32018-10-15 22:25:07 +09002347// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002348func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002349 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2350 version := name[sharp+1:]
2351 libname := name[:sharp]
2352 return libname, version
2353 }
2354 return name, ""
2355}
2356
Dan Albert92fe7402020-07-15 13:33:30 -07002357func GetCrtVariations(ctx android.BottomUpMutatorContext,
2358 m LinkableInterface) []blueprint.Variation {
2359 if ctx.Os() != android.Android {
2360 return nil
2361 }
2362 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002363 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2364 minSdkVersion := m.MinSdkVersion()
2365 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2366 minSdkVersion = m.SdkVersion()
2367 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002368 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2369 if err != nil {
2370 ctx.PropertyErrorf("min_sdk_version", err.Error())
2371 }
Colin Cross363ec762023-01-13 13:45:14 -08002372
2373 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002374 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002375 if apiLevel.LessThan(minApiForArch) {
2376 apiLevel = minApiForArch
2377 }
2378
Dan Albert92fe7402020-07-15 13:33:30 -07002379 return []blueprint.Variation{
2380 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002381 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002382 }
2383 }
2384 return []blueprint.Variation{
2385 {Mutator: "sdk", Variation: ""},
2386 }
2387}
2388
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002389func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2390 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002391
2392 variations = append([]blueprint.Variation(nil), variations...)
2393
Liz Kammer23942242022-04-08 15:41:00 -04002394 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002395 // Version is explicitly specified. i.e. libFoo#30
2396 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002397 if tag, ok := depTag.(libraryDependencyTag); ok {
2398 tag.explicitlyVersioned = true
2399 } else {
2400 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2401 }
Colin Crosse7257d22020-09-24 09:56:18 -07002402 }
Colin Crosse7257d22020-09-24 09:56:18 -07002403
Colin Cross0de8a1e2020-09-18 14:15:30 -07002404 if far {
2405 ctx.AddFarVariationDependencies(variations, depTag, name)
2406 } else {
2407 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002408 }
2409}
2410
Kiyoung Kim487689e2022-07-26 09:48:22 +09002411func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2412 apiImportInfo := multitree.ApiImportInfo{}
2413
2414 if c.Device() {
2415 var apiImportModule []blueprint.Module
2416 if actx.OtherModuleExists("api_imports") {
2417 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2418 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002419 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002420 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002421 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002422 }
2423 }
2424 }
2425
2426 return apiImportInfo
2427}
2428
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002429func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002430 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002431 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002432 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002433 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2434 // between the modules in the snapshot and the snapshot itself.
2435 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002436 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002437 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002438 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002439 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2440 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002441 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002442 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002443 *snapshotInfo = &snapshot
2444 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002445 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002446 }
2447 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002448 if *snapshotInfo == nil {
2449 *snapshotInfo = &SnapshotInfo{}
2450 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002451 return **snapshotInfo
2452}
2453
Kiyoung Kim487689e2022-07-26 09:48:22 +09002454func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2455 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002456 return snapshot
2457 }
2458
2459 return lib
2460}
2461
2462// RewriteLibs takes a list of names of shared libraries and scans it for three types
2463// of names:
2464//
2465// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002466//
2467// For each of these, it adds the name of the prebuilt module (which will be in
2468// prebuilts/ndk) to the list of nonvariant libs.
2469//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002470// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002471//
2472// For each of these, it adds the name of the ndk_library module to the list of
2473// variant libs.
2474//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002475// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002476//
2477// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002478//
2479// The caller can then know to add the variantLibs dependencies differently from the
2480// nonvariantLibs
2481func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2482 variantLibs = []string{}
2483
2484 nonvariantLibs = []string{}
2485 for _, entry := range list {
2486 // strip #version suffix out
2487 name, _ := StubsLibNameAndVersion(entry)
2488 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002489 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002490 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2491 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2492 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002493 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002494 } else {
2495 // put name#version back
2496 nonvariantLibs = append(nonvariantLibs, entry)
2497 }
2498 }
2499 return nonvariantLibs, variantLibs
2500}
2501
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002502func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2503 nonVariantLibs := []string{}
2504 variantLibs := []string{}
2505
2506 for _, lib := range libs {
2507 replaceLibName := GetReplaceModuleName(lib, replaceList)
2508 if replaceLibName == lib {
2509 // Do not handle any libs which are not in API imports
2510 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2511 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2512 variantLibs = append(variantLibs, replaceLibName)
2513 } else {
2514 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2515 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002516 }
2517
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002518 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002519}
2520
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002521func (c *Module) shouldUseApiSurface() bool {
2522 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2523 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2524 // LLNDK Variant
2525 return true
2526 }
2527
2528 if c.Properties.IsSdkVariant {
2529 // NDK Variant
2530 return true
2531 }
2532
2533 if c.isImportedApiLibrary() {
2534 // API Library should depend on API headers
2535 return true
2536 }
2537 }
2538
2539 return false
2540}
2541
Colin Cross1e676be2016-10-12 14:38:15 -07002542func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002543 if !c.Enabled() {
2544 return
2545 }
2546
Colin Cross37047f12016-12-13 17:06:13 -08002547 ctx := &depsContext{
2548 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002549 moduleContextImpl: moduleContextImpl{
2550 mod: c,
2551 },
2552 }
2553 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002554
Colin Crossc99deeb2016-04-11 15:06:20 -07002555 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002556 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002557
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002558 apiNdkLibs := []string{}
2559 apiLateNdkLibs := []string{}
2560
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002561 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002562 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2563 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2564 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2565 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2566 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002567 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002568
Yo Chiang219968c2020-09-22 18:45:04 +08002569 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2570
Colin Crosse0edaf92021-01-11 17:31:17 -08002571 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002572
Dan Albert914449f2016-06-17 16:45:24 -07002573 variantNdkLibs := []string{}
2574 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002575 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002576 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2577 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2578 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002579
2580 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002581 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002582 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002583 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002584
Colin Cross32ec36c2016-12-15 07:39:51 -08002585 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002586 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002587 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002588 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002589 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002590
Kiyoung Kim51279d32022-08-24 14:10:46 +09002591 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002592 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002593 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2594 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002595 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002596
Spandan Das73bcafc2022-08-18 23:26:00 +00002597 if c.isNDKStubLibrary() {
2598 // ndk_headers do not have any variations
2599 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002600 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002601 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002602 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002603 } else {
2604 actx.AddVariationDependencies(nil, depTag, lib)
2605 }
2606 }
2607
Dan Albertf1d14c72020-07-30 14:32:55 -07002608 if c.isNDKStubLibrary() {
2609 // NDK stubs depend on their implementation because the ABI dumps are
2610 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002611
Spandan Das8b08aea2023-03-14 19:29:34 +00002612 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2613 c.ImageVariation(),
2614 blueprint.Variation{Mutator: "link", Variation: "shared"},
2615 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002616 }
2617
Jiyong Park5d1598f2019-02-25 22:14:17 +09002618 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002619 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002620
Kiyoung Kim487689e2022-07-26 09:48:22 +09002621 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002622
Jiyong Park5d1598f2019-02-25 22:14:17 +09002623 actx.AddVariationDependencies([]blueprint.Variation{
2624 {Mutator: "link", Variation: "static"},
2625 }, depTag, lib)
2626 }
2627
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002628 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002629 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002630 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002631 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002632 }
Jiyong Parke3867542020-12-03 17:28:25 +09002633 if inList(lib, deps.ExcludeLibsForApex) {
2634 depTag.excludeInApex = true
2635 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002636
Kiyoung Kim487689e2022-07-26 09:48:22 +09002637 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002638
Dan Willemsen59339a22018-07-22 21:18:45 -07002639 actx.AddVariationDependencies([]blueprint.Variation{
2640 {Mutator: "link", Variation: "static"},
2641 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002642 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002643
Jooyung Han75568392020-03-20 04:29:24 +09002644 // staticUnwinderDep is treated as staticDep for Q apexes
2645 // so that native libraries/binaries are linked with static unwinder
2646 // because Q libc doesn't have unwinder APIs
2647 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002648 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002649 actx.AddVariationDependencies([]blueprint.Variation{
2650 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002651 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002652 }
2653
Jiyong Park7ed9de32018-10-15 22:25:07 +09002654 // shared lib names without the #version suffix
2655 var sharedLibNames []string
2656
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002657 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002658 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002659 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002660 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002661 }
Jiyong Parke3867542020-12-03 17:28:25 +09002662 if inList(lib, deps.ExcludeLibsForApex) {
2663 depTag.excludeInApex = true
2664 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002665 if inList(lib, deps.ExcludeLibsForNonApex) {
2666 depTag.excludeInNonApex = true
2667 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002668
Jiyong Park73c54ee2019-10-22 20:31:18 +09002669 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002670 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2671 name = apiLibraryName
2672 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002673 sharedLibNames = append(sharedLibNames, name)
2674
Colin Crosse7257d22020-09-24 09:56:18 -07002675 variations := []blueprint.Variation{
2676 {Mutator: "link", Variation: "shared"},
2677 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002678
2679 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2680 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2681 }
2682
2683 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2684 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2685 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002686 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002687
Colin Crossfe9acfe2021-06-14 16:13:03 -07002688 for _, lib := range deps.LateStaticLibs {
2689 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2690 actx.AddVariationDependencies([]blueprint.Variation{
2691 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002692 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002693 }
2694
Colin Cross3e5e7782022-06-17 22:17:05 +00002695 for _, lib := range deps.UnexportedStaticLibs {
2696 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2697 actx.AddVariationDependencies([]blueprint.Variation{
2698 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002699 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002700 }
2701
Jiyong Park7ed9de32018-10-15 22:25:07 +09002702 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002703 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002704 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2705 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2706 // linking against both the stubs lib and the non-stubs lib at the same time.
2707 continue
2708 }
Colin Cross6e511a92020-07-27 21:26:48 -07002709 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002710 variations := []blueprint.Variation{
2711 {Mutator: "link", Variation: "shared"},
2712 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002713 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002714 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002715
Dan Willemsen59339a22018-07-22 21:18:45 -07002716 actx.AddVariationDependencies([]blueprint.Variation{
2717 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002718 }, dataLibDepTag, deps.DataLibs...)
2719
Colin Crossc8caa062021-09-24 16:50:14 -07002720 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2721
Chris Parsons79d66a52020-06-05 17:26:16 -04002722 actx.AddVariationDependencies([]blueprint.Variation{
2723 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002724 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002725
Colin Cross68861832016-07-08 10:41:41 -07002726 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002727
2728 for _, gen := range deps.GeneratedHeaders {
2729 depTag := genHeaderDepTag
2730 if inList(gen, deps.ReexportGeneratedHeaders) {
2731 depTag = genHeaderExportDepTag
2732 }
2733 actx.AddDependency(c, depTag, gen)
2734 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002735
Dan Albert92fe7402020-07-15 13:33:30 -07002736 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002737 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002738 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002739 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002740 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002741 }
Colin Crossc465efd2021-06-11 18:00:04 -07002742 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002743 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002744 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002745 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002746 if deps.DynamicLinker != "" {
2747 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002748 }
Dan Albert914449f2016-06-17 16:45:24 -07002749
2750 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002751
2752 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002753 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002754 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002755 {Mutator: "link", Variation: "shared"},
2756 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002757 actx.AddVariationDependencies([]blueprint.Variation{
2758 {Mutator: "version", Variation: version},
2759 {Mutator: "link", Variation: "shared"},
2760 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002761
2762 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002763 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002764 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002765 {Mutator: "link", Variation: "shared"},
2766 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002767 actx.AddVariationDependencies([]blueprint.Variation{
2768 {Mutator: "version", Variation: version},
2769 {Mutator: "link", Variation: "shared"},
2770 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002771
2772 if vndkdep := c.vndkdep; vndkdep != nil {
2773 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002774 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002775 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002776 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002777 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002778 }
2779 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002780
Vinh Tran367d89d2023-04-28 11:21:25 -04002781 if len(deps.AidlLibs) > 0 {
2782 actx.AddDependency(
2783 c,
2784 aidlLibraryTag,
2785 deps.AidlLibs...,
2786 )
2787 }
2788
Kiyoung Kimee58c932022-10-25 22:59:41 +09002789 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002790}
Colin Cross21b9a242015-03-24 14:15:58 -07002791
Colin Crosse40b4ea2018-10-02 22:25:58 -07002792func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002793 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2794 c.beginMutator(ctx)
2795 }
2796}
2797
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002798// Whether a module can link to another module, taking into
2799// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002800func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002801 tag blueprint.DependencyTag) {
2802
2803 switch t := tag.(type) {
2804 case dependencyTag:
2805 if t != vndkExtDepTag {
2806 return
2807 }
2808 case libraryDependencyTag:
2809 default:
2810 return
2811 }
2812
Ivan Lozanof9e21722020-12-02 09:00:51 -05002813 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002814 // Host code is not restricted
2815 return
2816 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002817
2818 // VNDK is cc.Module supported only for now.
2819 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002820 // Though allowed dependency is limited by the image mutator,
2821 // each vendor and product module needs to check link-type
2822 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002823 if ccTo, ok := to.(*Module); ok {
2824 if ccFrom.vndkdep != nil {
2825 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2826 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002827 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002828 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002829 }
2830 return
2831 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002832 // TODO(b/244244438) : Remove this once all variants are implemented
2833 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2834 return
2835 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002836 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002837 // Platform code can link to anything
2838 return
2839 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002840 if from.InRamdisk() {
2841 // Ramdisk code is not NDK
2842 return
2843 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002844 if from.InVendorRamdisk() {
2845 // Vendor ramdisk code is not NDK
2846 return
2847 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002848 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002849 // Recovery code is not NDK
2850 return
2851 }
Colin Cross31076b32020-10-23 17:22:06 -07002852 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002853 if c.NdkPrebuiltStl() {
2854 // These are allowed, but they don't set sdk_version
2855 return
2856 }
2857 if c.StubDecorator() {
2858 // These aren't real libraries, but are the stub shared libraries that are included in
2859 // the NDK.
2860 return
2861 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002862 if c.isImportedApiLibrary() {
2863 // Imported library from the API surface is a stub library built against interface definition.
2864 return
2865 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002866 }
Logan Chien834b9a62019-01-14 15:39:03 +08002867
Ivan Lozano52767be2019-10-18 14:49:46 -07002868 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002869 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2870 // to link to libc++ (non-NDK and without sdk_version).
2871 return
2872 }
2873
Ivan Lozano52767be2019-10-18 14:49:46 -07002874 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002875 // NDK code linking to platform code is never okay.
2876 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002877 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002878 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002879 }
2880
2881 // At this point we know we have two NDK libraries, but we need to
2882 // check that we're not linking against anything built against a higher
2883 // API level, as it is only valid to link against older or equivalent
2884 // APIs.
2885
Inseob Kim01a28722018-04-11 09:48:45 +09002886 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002887 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002888 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002889 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002890 // Current can't be linked against by anything else.
2891 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002892 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002893 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002894 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002895 if err != nil {
2896 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002897 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002898 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002899 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002900 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002901 if err != nil {
2902 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002903 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002904 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002905 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002906
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002907 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002908 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002909 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002910 }
2911 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002912 }
Dan Albert202fe492017-12-15 13:56:59 -08002913
2914 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002915 fromStl := from.SelectedStl()
2916 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002917 if fromStl == "" || toStl == "" {
2918 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002919 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002920 // We can be permissive with the system "STL" since it is only the C++
2921 // ABI layer, but in the future we should make sure that everyone is
2922 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002923 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002924 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002925 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2926 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002927 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002928}
2929
Jooyung Han479ca172020-10-19 18:51:07 +09002930func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2931 if c, ok := ctx.Module().(*Module); ok {
2932 ctx.VisitDirectDeps(func(dep android.Module) {
2933 depTag := ctx.OtherModuleDependencyTag(dep)
2934 ccDep, ok := dep.(LinkableInterface)
2935 if ok {
2936 checkLinkType(ctx, c, ccDep, depTag)
2937 }
2938 })
2939 }
2940}
2941
Jiyong Park5fb8c102018-04-09 12:03:06 +09002942// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002943// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2944// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002945// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002946func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2947 check := func(child, parent android.Module) bool {
2948 to, ok := child.(*Module)
2949 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002950 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002951 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002952
Jooyung Hana70f0672019-01-18 15:20:43 +09002953 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2954 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002955 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002956
Jiyong Park0474e1f2021-01-14 14:26:06 +09002957 // These dependencies are not excercised at runtime. Tracking these will give us
2958 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002959 depTag := ctx.OtherModuleDependencyTag(child)
2960 if IsHeaderDepTag(depTag) {
2961 return false
2962 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002963 if depTag == staticVariantTag {
2964 return false
2965 }
2966 if depTag == stubImplDepTag {
2967 return false
2968 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002969
Justin Yun63e9ec72020-10-29 16:49:43 +09002970 // Even if target lib has no vendor variant, keep checking dependency
2971 // graph in case it depends on vendor_available or product_available
2972 // but not double_loadable transtively.
2973 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002974 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002975 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002976
Jiyong Park0474e1f2021-01-14 14:26:06 +09002977 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2978 // one.
2979 if Bool(to.VendorProperties.Double_loadable) {
2980 return true
2981 }
2982
Ivan Lozanod7586b62021-04-01 09:49:36 -04002983 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002984 return false
2985 }
2986
Jooyung Hana70f0672019-01-18 15:20:43 +09002987 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2988 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002989 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002990 return false
2991 }
2992 if module, ok := ctx.Module().(*Module); ok {
2993 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002994 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002995 ctx.WalkDeps(check)
2996 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002997 }
2998 }
2999}
3000
Yu Liue4312402023-01-18 09:15:31 -08003001func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3002 // For the dependency from platform to apex, use the latest stubs
3003 apexSdkVersion := android.FutureApiLevel
3004 if !apexInfo.IsForPlatform() {
3005 apexSdkVersion = apexInfo.MinSdkVersion
3006 }
3007
3008 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3009 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3010 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3011 // (b/144430859)
3012 apexSdkVersion = android.FutureApiLevel
3013 }
3014
3015 return apexSdkVersion
3016}
3017
Colin Crossc99deeb2016-04-11 15:06:20 -07003018// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003019func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003020 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003021
Colin Cross0de8a1e2020-09-18 14:15:30 -07003022 var directStaticDeps []StaticLibraryInfo
3023 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003024
Colin Cross0de8a1e2020-09-18 14:15:30 -07003025 reexportExporter := func(exporter FlagExporterInfo) {
3026 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3027 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3028 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3029 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3030 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003031 }
3032
Colin Crossff694a82023-12-13 15:54:49 -08003033 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003034 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003035
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003036 skipModuleList := map[string]bool{}
3037
3038 var apiImportInfo multitree.ApiImportInfo
3039 hasApiImportInfo := false
3040
3041 ctx.VisitDirectDeps(func(dep android.Module) {
3042 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003043 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003044 hasApiImportInfo = true
3045 }
3046 })
3047
3048 if hasApiImportInfo {
3049 targetStubModuleList := map[string]string{}
3050 targetOrigModuleList := map[string]string{}
3051
3052 // Search for dependency which both original module and API imported library with APEX stub exists
3053 ctx.VisitDirectDeps(func(dep android.Module) {
3054 depName := ctx.OtherModuleName(dep)
3055 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3056 targetStubModuleList[apiLibrary] = depName
3057 }
3058 })
3059 ctx.VisitDirectDeps(func(dep android.Module) {
3060 depName := ctx.OtherModuleName(dep)
3061 if origLibrary, ok := targetStubModuleList[depName]; ok {
3062 targetOrigModuleList[origLibrary] = depName
3063 }
3064 })
3065
3066 // Decide which library should be used between original and API imported library
3067 ctx.VisitDirectDeps(func(dep android.Module) {
3068 depName := ctx.OtherModuleName(dep)
3069 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003070 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003071 skipModuleList[depName] = true
3072 } else {
3073 skipModuleList[apiLibrary] = true
3074 }
3075 }
3076 })
3077 }
3078
Colin Crossd11fcda2017-10-23 17:59:01 -07003079 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003080 depName := ctx.OtherModuleName(dep)
3081 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003082
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003083 if _, ok := skipModuleList[depName]; ok {
3084 // skip this module because original module or API imported module matching with this should be used instead.
3085 return
3086 }
3087
Dan Willemsen47450072021-10-19 20:24:49 -07003088 if depTag == android.DarwinUniversalVariantTag {
3089 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3090 return
3091 }
3092
Vinh Tran367d89d2023-04-28 11:21:25 -04003093 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003094 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003095 depPaths.AidlLibraryInfos = append(
3096 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003097 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003098 )
3099 }
3100 }
3101
Ivan Lozano52767be2019-10-18 14:49:46 -07003102 ccDep, ok := dep.(LinkableInterface)
3103 if !ok {
3104
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003105 // handling for a few module types that aren't cc Module but that are also supported
3106 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003107 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003108 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003109 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3110 genRule.GeneratedSourceFiles()...)
3111 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003112 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003113 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003114 // Support exported headers from a generated_sources dependency
3115 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003116 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003117 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003118 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003119 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003120 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003121 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003122 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003123 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003124 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3125 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003126 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003127 // 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 +09003128 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003129
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003130 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003131 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003132 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003133 }
Colin Crosscef792e2021-06-11 18:01:26 -07003134 case CrtBeginDepTag:
3135 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3136 case CrtEndDepTag:
3137 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003138 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003139 return
3140 }
3141
Colin Crossfe17f6f2019-03-28 19:30:56 -07003142 if depTag == android.ProtoPluginDepTag {
3143 return
3144 }
3145
Colin Crossd11fcda2017-10-23 17:59:01 -07003146 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003147 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3148 return
3149 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003150 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003151 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3152 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003153 return
3154 }
3155
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003156 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003157 // Skip reused objects for stub libraries, they use their own stub object file instead.
3158 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3159 // version mutator, so the stubs variant is created from the shared variant that
3160 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003161 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003162 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003163 objs := staticAnalogue.ReuseObjects
3164 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003165 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003166 reexportExporter(depExporterInfo)
3167 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003168 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003169 }
3170
Colin Cross6e511a92020-07-27 21:26:48 -07003171 linkFile := ccDep.OutputFile()
3172
3173 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3174 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003175 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003176 return
3177 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003178
Jiyong Parke3867542020-12-03 17:28:25 +09003179 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3180 return
3181 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003182 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3183 return
3184 }
Jiyong Parke3867542020-12-03 17:28:25 +09003185
Colin Cross313aa542023-12-13 13:47:44 -08003186 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003187
Colin Cross6e511a92020-07-27 21:26:48 -07003188 var ptr *android.Paths
3189 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003190
Colin Cross6e511a92020-07-27 21:26:48 -07003191 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003192
Colin Cross6e511a92020-07-27 21:26:48 -07003193 switch {
3194 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003195 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003196 if !ctx.Config().AllowMissingDependencies() {
3197 ctx.ModuleErrorf("module %q is not a header library", depName)
3198 } else {
3199 ctx.AddMissingDependencies([]string{depName})
3200 }
3201 return
3202 }
Colin Cross6e511a92020-07-27 21:26:48 -07003203 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003204 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003205 if !ctx.Config().AllowMissingDependencies() {
3206 ctx.ModuleErrorf("module %q is not a shared library", depName)
3207 } else {
3208 ctx.AddMissingDependencies([]string{depName})
3209 }
3210 return
3211 }
Jiyong Parke3867542020-12-03 17:28:25 +09003212
Jiyong Park7d55b612021-06-11 17:22:09 +09003213 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3214 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003215
Jiyong Park1ad8e162020-12-01 23:40:09 +09003216 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3217 // linkFile, depFile, and ptr.
3218 if c.IsStubs() {
3219 break
3220 }
3221
Colin Cross0de8a1e2020-09-18 14:15:30 -07003222 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3223 depFile = sharedLibraryInfo.TableOfContents
3224
Colin Cross6e511a92020-07-27 21:26:48 -07003225 ptr = &depPaths.SharedLibs
3226 switch libDepTag.Order {
3227 case earlyLibraryDependency:
3228 ptr = &depPaths.EarlySharedLibs
3229 depPtr = &depPaths.EarlySharedLibsDeps
3230 case normalLibraryDependency:
3231 ptr = &depPaths.SharedLibs
3232 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003233 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003234 case lateLibraryDependency:
3235 ptr = &depPaths.LateSharedLibs
3236 depPtr = &depPaths.LateSharedLibsDeps
3237 default:
3238 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003239 }
Colin Cross6e511a92020-07-27 21:26:48 -07003240 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003241 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3242 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003243 if !ctx.Config().AllowMissingDependencies() {
3244 ctx.ModuleErrorf("module %q is not a static library", depName)
3245 } else {
3246 ctx.AddMissingDependencies([]string{depName})
3247 }
3248 return
3249 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003250
3251 // Stubs lib doesn't link to the static lib dependencies. Don't set
3252 // linkFile, depFile, and ptr.
3253 if c.IsStubs() {
3254 break
3255 }
3256
Colin Cross0de8a1e2020-09-18 14:15:30 -07003257 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003258 if libDepTag.wholeStatic {
3259 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003260 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3261 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003262 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003263 // This case normally catches prebuilt static
3264 // libraries, but it can also occur when
3265 // AllowMissingDependencies is on and the
3266 // dependencies has no sources of its own
3267 // but has a whole_static_libs dependency
3268 // on a missing library. We want to depend
3269 // on the .a file so that there is something
3270 // in the dependency tree that contains the
3271 // error rule for the missing transitive
3272 // dependency.
3273 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003274 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003275 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3276 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003277 } else {
3278 switch libDepTag.Order {
3279 case earlyLibraryDependency:
3280 panic(fmt.Errorf("early static libs not suppported"))
3281 case normalLibraryDependency:
3282 // static dependencies will be handled separately so they can be ordered
3283 // using transitive dependencies.
3284 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003285 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003286 case lateLibraryDependency:
3287 ptr = &depPaths.LateStaticLibs
3288 default:
3289 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003290 }
3291 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003292 if libDepTag.unexportedSymbols {
3293 depPaths.LdFlags = append(depPaths.LdFlags,
3294 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3295 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003296 }
3297
Colin Cross6e511a92020-07-27 21:26:48 -07003298 if libDepTag.static() && !libDepTag.wholeStatic {
3299 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3300 ctx.ModuleErrorf("module %q not a static library", depName)
3301 return
3302 }
Logan Chien43d34c32017-12-20 01:17:32 +08003303
Colin Cross6e511a92020-07-27 21:26:48 -07003304 // When combining coverage files for shared libraries and executables, coverage files
3305 // in static libraries act as if they were whole static libraries. The same goes for
3306 // source based Abi dump files.
3307 if c, ok := ccDep.(*Module); ok {
3308 staticLib := c.linker.(libraryInterface)
3309 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3310 staticLib.objs().coverageFiles...)
3311 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3312 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003313 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003314 // Handle non-CC modules here
3315 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003316 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003317 }
3318 }
3319
Colin Cross6e511a92020-07-27 21:26:48 -07003320 if ptr != nil {
3321 if !linkFile.Valid() {
3322 if !ctx.Config().AllowMissingDependencies() {
3323 ctx.ModuleErrorf("module %q missing output file", depName)
3324 } else {
3325 ctx.AddMissingDependencies([]string{depName})
3326 }
3327 return
3328 }
3329 *ptr = append(*ptr, linkFile.Path())
3330 }
3331
3332 if depPtr != nil {
3333 dep := depFile
3334 if !dep.Valid() {
3335 dep = linkFile
3336 }
3337 *depPtr = append(*depPtr, dep.Path())
3338 }
3339
Colin Cross0de8a1e2020-09-18 14:15:30 -07003340 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3341 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3342 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3343 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3344
3345 if libDepTag.reexportFlags {
3346 reexportExporter(depExporterInfo)
3347 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3348 // Re-exported shared library headers must be included as well since they can help us with type information
3349 // about template instantiations (instantiated from their headers).
3350 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3351 // scripts.
3352 c.sabi.Properties.ReexportedIncludes = append(
3353 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3354 }
3355
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003356 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003357 switch {
3358 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003359 c.Properties.AndroidMkHeaderLibs = append(
3360 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003361 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003362 if lib := moduleLibraryInterface(dep); lib != nil {
3363 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003364 // Add the dependency to the APEX(es) providing the library so that
3365 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003366 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003367 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003368 c.Properties.ApexesProvidingSharedLibs = append(
3369 c.Properties.ApexesProvidingSharedLibs, an)
3370 }
3371 }
3372 }
3373
3374 // Note: the order of libs in this list is not important because
3375 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003376 c.Properties.AndroidMkSharedLibs = append(
3377 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003378 // Record BaseLibName for snapshots.
3379 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003380 case libDepTag.static():
3381 if libDepTag.wholeStatic {
3382 c.Properties.AndroidMkWholeStaticLibs = append(
3383 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3384 } else {
3385 c.Properties.AndroidMkStaticLibs = append(
3386 c.Properties.AndroidMkStaticLibs, makeLibName)
3387 }
Justin Yun5e035862021-06-29 20:50:37 +09003388 // Record BaseLibName for snapshots.
3389 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003390 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003391 } else if !c.IsStubs() {
3392 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3393
Colin Cross6e511a92020-07-27 21:26:48 -07003394 switch depTag {
3395 case runtimeDepTag:
3396 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003397 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003398 // Record BaseLibName for snapshots.
3399 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003400 case objDepTag:
3401 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3402 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003403 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003404 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003405 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003406 case dynamicLinkerDepTag:
3407 depPaths.DynamicLinker = linkFile
3408 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003409 }
Colin Crossca860ac2016-01-04 14:34:37 -08003410 })
3411
Jeff Gaston294356f2017-09-27 17:05:30 -07003412 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003413 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3414 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3415 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003416
Colin Crossdd84e052017-05-17 13:44:16 -07003417 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003418 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003419 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3420 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003421 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003422 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3423 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003424 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003425 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003426 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003427
3428 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003429 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003430 }
Colin Crossdd84e052017-05-17 13:44:16 -07003431
Colin Crossca860ac2016-01-04 14:34:37 -08003432 return depPaths
3433}
3434
Spandan Das604f3762023-03-16 22:51:40 +00003435func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003436 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003437 thisModule, ok := ctx.Module().(android.ApexModule)
3438 if !ok {
3439 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3440 }
3441
Kiyoung Kimaa394802024-01-08 12:55:45 +09003442 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003443 bootstrap := false
3444 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3445 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3446 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003447 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003448 bootstrap = linkable.Bootstrap()
3449 }
3450
Colin Crossff694a82023-12-13 15:54:49 -08003451 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003452
3453 useStubs := false
3454
Kiyoung Kimaa394802024-01-08 12:55:45 +09003455 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003456 if !apexInfo.IsForPlatform() {
3457 // For platform libraries, use current version of LLNDK
3458 // If this is for use_vendor apex we will apply the same rules
3459 // of apex sdk enforcement below to choose right version.
3460 useStubs = true
3461 }
3462 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3463 // If not building for APEX or the containing APEX allows the use of
3464 // platform APIs, use stubs only when it is from an APEX (and not from
3465 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3466 // bootstrap modules, always link to non-stub variant
3467 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3468
3469 isApexImportedApiLibrary := false
3470
3471 if cc, ok := dep.(*Module); ok {
3472 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3473 if apiLibrary.hasApexStubs() {
3474 isApexImportedApiLibrary = true
3475 }
3476 }
3477 }
3478
3479 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3480
3481 if useStubs {
3482 // Another exception: if this module is a test for an APEX, then
3483 // it is linked with the non-stub variant of a module in the APEX
3484 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003485 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003486 for _, apexContents := range testFor.ApexContents {
3487 if apexContents.DirectlyInApex(depName) {
3488 useStubs = false
3489 break
3490 }
3491 }
3492 }
3493 if useStubs {
3494 // Yet another exception: If this module and the dependency are
3495 // available to the same APEXes then skip stubs between their
3496 // platform variants. This complements the test_for case above,
3497 // which avoids the stubs on a direct APEX library dependency, by
3498 // avoiding stubs for indirect test dependencies as well.
3499 //
3500 // TODO(b/183882457): This doesn't work if the two libraries have
3501 // only partially overlapping apex_available. For that test_for
3502 // modules would need to be split into APEX variants and resolved
3503 // separately for each APEX they have access to.
3504 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3505 useStubs = false
3506 }
3507 }
3508 } else {
3509 // If building for APEX, use stubs when the parent is in any APEX that
3510 // the child is not in.
3511 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3512 }
3513
3514 return useStubs
3515}
3516
3517// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3518// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3519// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3520// has different level of updatability. For example, if a library foo in an APEX depends on a
3521// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3522// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3523// same APEX as foo, the non-stub variant of bar is used.
3524func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3525 depTag := ctx.OtherModuleDependencyTag(dep)
3526 libDepTag, ok := depTag.(libraryDependencyTag)
3527 if !ok || !libDepTag.shared() {
3528 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3529 }
3530
Colin Cross313aa542023-12-13 13:47:44 -08003531 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3532 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3533 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003534
3535 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003536 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003537 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003538 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3539 toUse := stubs[len(stubs)-1]
3540 sharedLibraryInfo = toUse.SharedLibraryInfo
3541 depExporterInfo = toUse.FlagExporterInfo
3542 }
3543 }
3544 return sharedLibraryInfo, depExporterInfo
3545}
3546
Colin Cross0de8a1e2020-09-18 14:15:30 -07003547// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3548// to match the topological order of the dependency tree, including any static analogues of
3549// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3550// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003551func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3552 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003553 var staticPaths android.Paths
3554 for _, staticDep := range staticDeps {
3555 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3556 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3557 }
3558 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003559 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3560 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003561 }
3562 }
3563 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3564
3565 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3566
3567 // reorder the dependencies based on transitive dependencies
3568 staticPaths = android.FirstUniquePaths(staticPaths)
3569 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3570
3571 if len(orderedStaticPaths) != len(staticPaths) {
3572 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3573 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3574 }
3575
3576 return orderedStaticPaths, transitiveStaticLibs
3577}
3578
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003579// BaseLibName trims known prefixes and suffixes
3580func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003581 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3582 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003583 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003584 return libName
3585}
3586
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003587func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003588 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003589 ccDepModule, _ := ccDep.(*Module)
3590 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003591 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003592
Justin Yuncbca3732021-02-03 19:24:13 +09003593 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003594 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003595 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003596 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003597
Ivan Lozanod1dec542021-05-26 15:33:11 -04003598 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003599 }
3600 }
3601
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003602 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3603 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003604 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3605 // core module instead.
3606 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003607 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003608 // The vendor and product modules in Make will have been renamed to not conflict with the
3609 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003610 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003611 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003612 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003613 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003614 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003615 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003616 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003617 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003618 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003619 } else {
3620 return libName
3621 }
3622}
3623
Colin Crossca860ac2016-01-04 14:34:37 -08003624func (c *Module) InstallInData() bool {
3625 if c.installer == nil {
3626 return false
3627 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003628 return c.installer.inData()
3629}
3630
3631func (c *Module) InstallInSanitizerDir() bool {
3632 if c.installer == nil {
3633 return false
3634 }
3635 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003636 return true
3637 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003638 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003639}
3640
Yifan Hong1b3348d2020-01-21 15:53:22 -08003641func (c *Module) InstallInRamdisk() bool {
3642 return c.InRamdisk()
3643}
3644
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003645func (c *Module) InstallInVendorRamdisk() bool {
3646 return c.InVendorRamdisk()
3647}
3648
Jiyong Parkf9332f12018-02-01 00:54:12 +09003649func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003650 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003651}
3652
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003653func (c *Module) MakeUninstallable() {
3654 if c.installer == nil {
3655 c.ModuleBase.MakeUninstallable()
3656 return
3657 }
3658 c.installer.makeUninstallable(c)
3659}
3660
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003661func (c *Module) HostToolPath() android.OptionalPath {
3662 if c.installer == nil {
3663 return android.OptionalPath{}
3664 }
3665 return c.installer.hostToolPath()
3666}
3667
Nan Zhangd4e641b2017-07-12 12:55:28 -07003668func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3669 return c.outputFile
3670}
3671
Colin Cross41955e82019-05-29 14:40:35 -07003672func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3673 switch tag {
3674 case "":
3675 if c.outputFile.Valid() {
3676 return android.Paths{c.outputFile.Path()}, nil
3677 }
3678 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003679 case "unstripped":
3680 if c.linker != nil {
3681 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3682 }
3683 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003684 case "stripped_all":
3685 if c.linker != nil {
3686 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3687 }
3688 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003689 default:
3690 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003691 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003692}
3693
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003694func (c *Module) static() bool {
3695 if static, ok := c.linker.(interface {
3696 static() bool
3697 }); ok {
3698 return static.static()
3699 }
3700 return false
3701}
3702
Jiyong Park379de2f2018-12-19 02:47:14 +09003703func (c *Module) staticBinary() bool {
3704 if static, ok := c.linker.(interface {
3705 staticBinary() bool
3706 }); ok {
3707 return static.staticBinary()
3708 }
3709 return false
3710}
3711
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003712func (c *Module) testBinary() bool {
3713 if test, ok := c.linker.(interface {
3714 testBinary() bool
3715 }); ok {
3716 return test.testBinary()
3717 }
3718 return false
3719}
3720
Jingwen Chen537242c2022-08-24 11:53:27 +00003721func (c *Module) testLibrary() bool {
3722 if test, ok := c.linker.(interface {
3723 testLibrary() bool
3724 }); ok {
3725 return test.testLibrary()
3726 }
3727 return false
3728}
3729
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003730func (c *Module) benchmarkBinary() bool {
3731 if b, ok := c.linker.(interface {
3732 benchmarkBinary() bool
3733 }); ok {
3734 return b.benchmarkBinary()
3735 }
3736 return false
3737}
3738
3739func (c *Module) fuzzBinary() bool {
3740 if f, ok := c.linker.(interface {
3741 fuzzBinary() bool
3742 }); ok {
3743 return f.fuzzBinary()
3744 }
3745 return false
3746}
3747
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003748// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3749func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003750 if h, ok := c.linker.(interface {
3751 header() bool
3752 }); ok {
3753 return h.header()
3754 }
3755 return false
3756}
3757
Ivan Lozanod7586b62021-04-01 09:49:36 -04003758func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003759 if b, ok := c.linker.(interface {
3760 binary() bool
3761 }); ok {
3762 return b.binary()
3763 }
3764 return false
3765}
3766
Justin Yun5e035862021-06-29 20:50:37 +09003767func (c *Module) StaticExecutable() bool {
3768 if b, ok := c.linker.(*binaryDecorator); ok {
3769 return b.static()
3770 }
3771 return false
3772}
3773
Ivan Lozanod7586b62021-04-01 09:49:36 -04003774func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003775 if o, ok := c.linker.(interface {
3776 object() bool
3777 }); ok {
3778 return o.object()
3779 }
3780 return false
3781}
3782
Ivan Lozanof9e21722020-12-02 09:00:51 -05003783func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003784 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003785 if c.IsLlndk() {
3786 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003787 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003788 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003789 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003790 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003791 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003792 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003793 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003794 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003795 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003796 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003797 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003798 return "native:product"
3799 }
Jooyung Han38002912019-05-16 04:01:54 +09003800 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003801 } else if c.InRamdisk() {
3802 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003803 } else if c.InVendorRamdisk() {
3804 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003805 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003806 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003807 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003808 return "native:ndk:none:none"
3809 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3810 //family, link := getNdkStlFamilyAndLinkType(c)
3811 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003812 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003813 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003814 } else {
3815 return "native:platform"
3816 }
3817}
3818
Jiyong Park9d452992018-10-03 00:38:19 +09003819// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003820// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003821func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003822 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003823 // Stub libs and prebuilt libs in a versioned SDK are not
3824 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003825 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003826 } else if _, ok := c.linker.(testPerSrc); ok {
3827 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003828 }
3829 return false
3830}
3831
Jiyong Parka90ca002019-10-07 15:47:24 +09003832func (c *Module) AvailableFor(what string) bool {
3833 if linker, ok := c.linker.(interface {
3834 availableFor(string) bool
3835 }); ok {
3836 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3837 } else {
3838 return c.ApexModuleBase.AvailableFor(what)
3839 }
3840}
3841
Jiyong Park62304bb2020-04-13 16:19:48 +09003842func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003843 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003844}
3845
Paul Duffin0cb37b92020-03-04 14:52:46 +00003846func (c *Module) EverInstallable() bool {
3847 return c.installer != nil &&
3848 // Check to see whether the module is actually ever installable.
3849 c.installer.everInstallable()
3850}
3851
Ivan Lozanod7586b62021-04-01 09:49:36 -04003852func (c *Module) PreventInstall() bool {
3853 return c.Properties.PreventInstall
3854}
3855
3856func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003857 if c.library != nil {
3858 if i := c.library.installable(); i != nil {
3859 return i
3860 }
3861 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003862 return c.Properties.Installable
3863}
3864
3865func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003866 ret := c.EverInstallable() &&
3867 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003868 proptools.BoolDefault(c.Installable(), true) &&
3869 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003870
3871 // The platform variant doesn't need further condition. Apex variants however might not
3872 // be installable because it will likely to be included in the APEX and won't appear
3873 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003874 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003875 return ret
3876 }
3877
3878 // Special case for modules that are configured to be installed to /data, which includes
3879 // test modules. For these modules, both APEX and non-APEX variants are considered as
3880 // installable. This is because even the APEX variants won't be included in the APEX, but
3881 // will anyway be installed to /data/*.
3882 // See b/146995717
3883 if c.InstallInData() {
3884 return ret
3885 }
3886
3887 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003888}
3889
Logan Chien41eabe62019-04-10 13:33:58 +08003890func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3891 if c.linker != nil {
3892 if library, ok := c.linker.(*libraryDecorator); ok {
3893 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3894 }
3895 }
3896}
3897
Jiyong Park45bf82e2020-12-15 22:29:02 +09003898var _ android.ApexModule = (*Module)(nil)
3899
3900// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003901func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003902 depTag := ctx.OtherModuleDependencyTag(dep)
3903 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3904
3905 if cc, ok := dep.(*Module); ok {
3906 if cc.HasStubsVariants() {
3907 if isLibDepTag && libDepTag.shared() {
3908 // dynamic dep to a stubs lib crosses APEX boundary
3909 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003910 }
Colin Cross6e511a92020-07-27 21:26:48 -07003911 if IsRuntimeDepTag(depTag) {
3912 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003913 return false
3914 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003915 }
Zhijun Heec285872021-04-24 10:47:08 -07003916 if cc.IsLlndk() {
3917 return false
3918 }
Colin Crossaac32222020-07-29 12:51:56 -07003919 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003920 // shared_lib dependency from a static lib is considered as crossing
3921 // the APEX boundary because the dependency doesn't actually is
3922 // linked; the dependency is used only during the compilation phase.
3923 return false
3924 }
Jiyong Parke3867542020-12-03 17:28:25 +09003925
3926 if isLibDepTag && libDepTag.excludeInApex {
3927 return false
3928 }
Colin Cross6e511a92020-07-27 21:26:48 -07003929 }
Colin Crossc1b36442021-05-06 13:42:48 -07003930 if depTag == stubImplDepTag {
3931 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003932 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003933 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003934 if depTag == staticVariantTag {
3935 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3936 // actually mean that the static lib (and its dependencies) are copied into the
3937 // APEX.
3938 return false
3939 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003940 return true
3941}
3942
Jiyong Park45bf82e2020-12-15 22:29:02 +09003943// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003944func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3945 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003946 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3947 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3948 return nil
3949 }
Jooyung Han749dc692020-04-15 11:03:39 +09003950 // We don't check for prebuilt modules
3951 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3952 return nil
3953 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003954
Jooyung Han749dc692020-04-15 11:03:39 +09003955 minSdkVersion := c.MinSdkVersion()
3956 if minSdkVersion == "apex_inherit" {
3957 return nil
3958 }
3959 if minSdkVersion == "" {
3960 // JNI libs within APK-in-APEX fall into here
3961 // Those are okay to set sdk_version instead
3962 // We don't have to check if this is a SDK variant because
3963 // non-SDK variant resets sdk_version, which works too.
3964 minSdkVersion = c.SdkVersion()
3965 }
Dan Albertc8060532020-07-22 22:32:17 -07003966 if minSdkVersion == "" {
3967 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3968 }
3969 // Not using nativeApiLevelFromUser because the context here is not
3970 // necessarily a native context.
3971 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003972 if err != nil {
3973 return err
3974 }
Dan Albertc8060532020-07-22 22:32:17 -07003975
Colin Cross8ca61c12022-10-06 21:00:14 -07003976 // A dependency only needs to support a min_sdk_version at least
3977 // as high as the api level that the architecture was introduced in.
3978 // This allows introducing new architectures in the platform that
3979 // need to be included in apexes that normally require an older
3980 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003981 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003982 if sdkVersion.LessThan(minApiForArch) {
3983 sdkVersion = minApiForArch
3984 }
3985
Dan Albertc8060532020-07-22 22:32:17 -07003986 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003987 return fmt.Errorf("newer SDK(%v)", ver)
3988 }
3989 return nil
3990}
3991
Paul Duffinb5769c12021-05-12 16:16:51 +01003992// Implements android.ApexModule
3993func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3994 // stub libraries and native bridge libraries are always available to platform
3995 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3996}
3997
Jooyung Han91f92032022-02-04 12:36:33 +09003998// Overrides android.ApexModuleBase.UniqueApexVariations
3999func (c *Module) UniqueApexVariations() bool {
4000 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4001 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4002 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004003 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004004 return c.UseVndk() && c.IsVndk()
4005}
4006
Inseob Kima1888ce2022-10-04 14:42:02 +09004007func (c *Module) overriddenModules() []string {
4008 if o, ok := c.linker.(overridable); ok {
4009 return o.overriddenModules()
4010 }
4011 return nil
4012}
4013
Rob Seymour925aa092021-08-10 20:42:03 +00004014var _ snapshot.RelativeInstallPath = (*Module)(nil)
4015
Liz Kammer35ca77e2021-12-22 15:31:40 -05004016type moduleType int
4017
4018const (
4019 unknownType moduleType = iota
4020 binary
4021 object
4022 fullLibrary
4023 staticLibrary
4024 sharedLibrary
4025 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004026 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004027 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004028 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004029)
4030
4031func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004032 if c.testBinary() {
4033 // testBinary is also a binary, so this comes before the c.Binary()
4034 // conditional. A testBinary has additional implicit dependencies and
4035 // other test-only semantics.
4036 return testBin
4037 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004038 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004039 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004040 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004041 } else if c.testLibrary() {
4042 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4043 // will let them add implicit compile deps on gtest, for example.
4044 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004045 // For now, treat them as regular libraries.
4046 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004047 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004048 static := false
4049 shared := false
4050 if library, ok := c.linker.(*libraryDecorator); ok {
4051 static = library.MutatedProperties.BuildStatic
4052 shared = library.MutatedProperties.BuildShared
4053 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4054 static = library.MutatedProperties.BuildStatic
4055 shared = library.MutatedProperties.BuildShared
4056 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004057 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004058 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004059 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004060 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004061 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004062 return staticLibrary
4063 }
4064 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004065 } else if c.isNDKStubLibrary() {
4066 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004067 } else if c.IsNdkPrebuiltStl() {
4068 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004069 }
4070 return unknownType
4071}
4072
Colin Crosscfad1192015-11-02 16:43:11 -08004073// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004074type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004075 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004076 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004077 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004078}
4079
Patrice Arrudac249c712019-03-19 17:00:29 -07004080// cc_defaults provides a set of properties that can be inherited by other cc
4081// modules. A module can use the properties from a cc_defaults using
4082// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4083// merged (when possible) by prepending the default module's values to the
4084// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004085func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004086 return DefaultsFactory()
4087}
4088
Colin Cross36242852017-06-23 15:06:31 -07004089func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004090 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004091
Colin Cross36242852017-06-23 15:06:31 -07004092 module.AddProperties(props...)
4093 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004094 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004095 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004096 &BaseCompilerProperties{},
4097 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004098 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004099 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004100 &StaticProperties{},
4101 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004102 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004103 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004104 &TestLinkerProperties{},
4105 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004106 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004107 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004108 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004109 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004110 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004111 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004112 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004113 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004114 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004115 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004116 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004117 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004118 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004119 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004120 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004121 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4122 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004123 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004124 )
Colin Crosscfad1192015-11-02 16:43:11 -08004125
Jooyung Hancc372c52019-09-25 15:18:44 +09004126 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004127
4128 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004129}
4130
Jiyong Park2286afd2020-06-16 21:58:53 +09004131func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004132 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004133}
4134
Kiyoung Kim51279d32022-08-24 14:10:46 +09004135func (c *Module) isImportedApiLibrary() bool {
4136 _, ok := c.linker.(*apiLibraryDecorator)
4137 return ok
4138}
4139
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004140func kytheExtractAllFactory() android.Singleton {
4141 return &kytheExtractAllSingleton{}
4142}
4143
4144type kytheExtractAllSingleton struct {
4145}
4146
4147func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4148 var xrefTargets android.Paths
4149 ctx.VisitAllModules(func(module android.Module) {
4150 if ccModule, ok := module.(xref); ok {
4151 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4152 }
4153 })
4154 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4155 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004156 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004157 }
4158}
4159
Jihoon Kangf78a8902022-09-01 22:47:07 +00004160func (c *Module) Partition() string {
4161 if p, ok := c.installer.(interface {
4162 getPartition() string
4163 }); ok {
4164 return p.getPartition()
4165 }
4166 return ""
4167}
4168
Colin Cross06a931b2015-10-28 17:23:31 -07004169var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004170var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004171var BoolPtr = proptools.BoolPtr
4172var String = proptools.String
4173var StringPtr = proptools.StringPtr