blob: c6e21c24b87810e3200ddce3b4e5eb177c99dea3 [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
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700528 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700529 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800530 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800531 isAfdoCompile() bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000532 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800533 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900534 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800535 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800536 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800537 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700538 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700539 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900540 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800541 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700542 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700543 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800544 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800545 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800546 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800547 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800548}
549
550type SharedFlags struct {
551 numSharedFlags int
552 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800553}
554
555type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700556 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800557 ModuleContextIntf
558}
559
560type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700561 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800562 ModuleContextIntf
563}
564
Colin Cross37047f12016-12-13 17:06:13 -0800565type DepsContext interface {
566 android.BottomUpMutatorContext
567 ModuleContextIntf
568}
569
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500570// feature represents additional (optional) steps to building cc-related modules, such as invocation
571// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800572type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800573 flags(ctx ModuleContext, flags Flags) Flags
574 props() []interface{}
575}
576
Joe Onorato37f900c2023-07-18 16:58:16 -0700577// Information returned from Generator about the source code it's generating
578type GeneratedSource struct {
579 IncludeDirs android.Paths
580 Sources android.Paths
581 Headers android.Paths
582 ReexportedDirs android.Paths
583}
584
585// generator allows injection of generated code
586type Generator interface {
587 GeneratorProps() []interface{}
588 GeneratorInit(ctx BaseModuleContext)
589 GeneratorDeps(ctx DepsContext, deps Deps) Deps
590 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
591 GeneratorSources(ctx ModuleContext) GeneratedSource
592 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
593}
594
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500595// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500596// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800597type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700598 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800599 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800600 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700601 compilerProps() []interface{}
602
Colin Cross76fada02016-07-27 10:31:13 -0700603 appendCflags([]string)
604 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700605 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800606}
607
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500608// linker is the interface for a linker decorator object. Individual module types can provide
609// their own implementation for this decorator, and thus specify custom logic regarding build
610// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800611type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700612 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800613 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700614 linkerFlags(ctx ModuleContext, flags Flags) Flags
615 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800616 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700617
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700618 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700619 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900620 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800621 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700622
623 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900624 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000625
626 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000627 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800628
629 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000630}
631
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500632// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000633type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500634 sharedLibs []string
635 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
636 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700637 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800638}
639
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500640// installer is the interface for an installer helper object. This helper is responsible for
641// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800642type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700643 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700644 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000645 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800646 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700647 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700648 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900649 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000650 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900651 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800652}
653
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800654type xref interface {
655 XrefCcFiles() android.Paths
656}
657
Inseob Kima1888ce2022-10-04 14:42:02 +0900658type overridable interface {
659 overriddenModules() []string
660}
661
Colin Cross6e511a92020-07-27 21:26:48 -0700662type libraryDependencyKind int
663
664const (
665 headerLibraryDependency = iota
666 sharedLibraryDependency
667 staticLibraryDependency
668)
669
670func (k libraryDependencyKind) String() string {
671 switch k {
672 case headerLibraryDependency:
673 return "headerLibraryDependency"
674 case sharedLibraryDependency:
675 return "sharedLibraryDependency"
676 case staticLibraryDependency:
677 return "staticLibraryDependency"
678 default:
679 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
680 }
681}
682
683type libraryDependencyOrder int
684
685const (
686 earlyLibraryDependency = -1
687 normalLibraryDependency = 0
688 lateLibraryDependency = 1
689)
690
691func (o libraryDependencyOrder) String() string {
692 switch o {
693 case earlyLibraryDependency:
694 return "earlyLibraryDependency"
695 case normalLibraryDependency:
696 return "normalLibraryDependency"
697 case lateLibraryDependency:
698 return "lateLibraryDependency"
699 default:
700 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
701 }
702}
703
704// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
705// tags that have a set of predefined tag objects that are reused for each dependency, a
706// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
707// That means that comparing a libraryDependencyTag for equality will only be equal if all
708// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
709// then check individual metadata fields instead.
710type libraryDependencyTag struct {
711 blueprint.BaseDependencyTag
712
713 // These are exported so that fmt.Printf("%#v") can call their String methods.
714 Kind libraryDependencyKind
715 Order libraryDependencyOrder
716
717 wholeStatic bool
718
719 reexportFlags bool
720 explicitlyVersioned bool
721 dataLib bool
722 ndk bool
723
724 staticUnwinder bool
725
726 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900727
Cindy Zhou18417cb2020-12-10 07:12:38 -0800728 // Whether or not this dependency should skip the apex dependency check
729 skipApexAllowedDependenciesCheck bool
730
Jiyong Parke3867542020-12-03 17:28:25 +0900731 // Whether or not this dependency has to be followed for the apex variants
732 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900733 // Whether or not this dependency has to be followed for the non-apex variants
734 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000735
736 // If true, don't automatically export symbols from the static library into a shared library.
737 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700738}
739
740// header returns true if the libraryDependencyTag is tagging a header lib dependency.
741func (d libraryDependencyTag) header() bool {
742 return d.Kind == headerLibraryDependency
743}
744
745// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
746func (d libraryDependencyTag) shared() bool {
747 return d.Kind == sharedLibraryDependency
748}
749
750// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
751func (d libraryDependencyTag) static() bool {
752 return d.Kind == staticLibraryDependency
753}
754
Colin Cross65cb3142021-12-10 23:05:02 +0000755func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
756 if d.shared() {
757 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
758 }
759 return nil
760}
761
762var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
763
Colin Crosse9fe2942020-11-10 18:12:15 -0800764// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
765// binaries or other shared libraries are installed as dependencies.
766func (d libraryDependencyTag) InstallDepNeeded() bool {
767 return d.shared()
768}
769
770var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
771
772// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700773// libraryDependencyTag. Each tag object is created globally and reused for multiple
774// dependencies (although since the object contains no references, assigning a tag to a
775// variable and modifying it will not modify the original). Users can compare the tag
776// returned by ctx.OtherModuleDependencyTag against the global original
777type dependencyTag struct {
778 blueprint.BaseDependencyTag
779 name string
780}
781
Colin Crosse9fe2942020-11-10 18:12:15 -0800782// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
783// libraryDependencyTag, but where the dependency needs to be installed when the parent is
784// installed.
785type installDependencyTag struct {
786 blueprint.BaseDependencyTag
787 android.InstallAlwaysNeededDependencyTag
788 name string
789}
790
Colin Crossc99deeb2016-04-11 15:06:20 -0700791var (
Colin Cross6e511a92020-07-27 21:26:48 -0700792 genSourceDepTag = dependencyTag{name: "gen source"}
793 genHeaderDepTag = dependencyTag{name: "gen header"}
794 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
795 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900796 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700797 reuseObjTag = dependencyTag{name: "reuse objects"}
798 staticVariantTag = dependencyTag{name: "static variant"}
799 vndkExtDepTag = dependencyTag{name: "vndk extends"}
800 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700801 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800802 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700803 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700804 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000805 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500806 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400807 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700808)
809
Roland Levillainf89cd092019-07-29 16:22:59 +0100810func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700811 ccLibDepTag, ok := depTag.(libraryDependencyTag)
812 return ok && ccLibDepTag.shared()
813}
814
815func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
816 ccLibDepTag, ok := depTag.(libraryDependencyTag)
817 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100818}
819
Zach Johnson3df4e632020-11-06 11:56:27 -0800820func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
821 ccLibDepTag, ok := depTag.(libraryDependencyTag)
822 return ok && ccLibDepTag.header()
823}
824
Roland Levillainf89cd092019-07-29 16:22:59 +0100825func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800826 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100827}
828
829func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700830 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100831 return ok && ccDepTag == testPerSrcDepTag
832}
833
Colin Crossca860ac2016-01-04 14:34:37 -0800834// Module contains the properties and members used by all C/C++ module types, and implements
835// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500836// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
837// interface.
838//
839// To define a C/C++ related module, construct a new Module object and point its delegates to
840// type-specific structs. These delegates will be invoked to register module-specific build
841// statements which may be unique to the module type. For example, module.compiler.compile() should
842// be defined so as to register build statements which are responsible for compiling the module.
843//
844// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
845// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
846// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
847// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800848type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700849 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700850
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700851 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700852 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700853
Colin Crossca860ac2016-01-04 14:34:37 -0800854 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000855 hod android.HostOrDeviceSupported
856 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000857 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700858
Paul Duffina0843f62019-12-13 19:50:38 +0000859 // Allowable SdkMemberTypes of this module type.
860 sdkMemberTypes []android.SdkMemberType
861
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500862 // decorator delegates, initialize before calling Init
863 // these may contain module-specific implementations, and effectively allow for custom
864 // type-specific logic. These members may reference different objects or the same object.
865 // Functions of these decorators will be invoked to initialize and register type-specific
866 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800867 generators []Generator
868 compiler compiler
869 linker linker
870 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500871
Spandan Dase12d2522023-09-12 21:42:31 +0000872 features []feature
873 stl *stl
874 sanitize *sanitize
875 coverage *coverage
876 fuzzer *fuzzer
877 sabi *sabi
878 vndkdep *vndkdep
879 lto *lto
880 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000881 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800882
Colin Cross31076b32020-10-23 17:22:06 -0700883 library libraryInterface
884
Colin Cross635c3b02016-05-18 15:37:25 -0700885 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800886
Colin Crossb98c8b02016-07-29 13:44:28 -0700887 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700888
889 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800890
891 // Flags used to compile this module
892 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700893
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800894 // Shared flags among build rules of this module
895 sharedFlags SharedFlags
896
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800897 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700898 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900899
900 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800901 // Kythe (source file indexer) paths for this compilation module
902 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700903 // Object .o file output paths for this compilation module
904 objFiles android.Paths
905 // Tidy .tidy file output paths for this compilation module
906 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900907
908 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700909 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700910
911 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800912
913 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800914 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700915}
916
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200917func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400918 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
919 if b, ok := c.compiler.(*baseCompiler); ok {
920 hasAidl = b.hasSrcExt(".aidl")
921 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
922 hasProto = b.hasSrcExt(".proto")
923 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
924 hasSysprop = b.hasSrcExt(".sysprop")
925 hasWinMsg = b.hasSrcExt(".mc")
926 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
927 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200928 c.AndroidModuleBase().AddJSONData(d)
929 (*d)["Cc"] = map[string]interface{}{
930 "SdkVersion": c.SdkVersion(),
931 "MinSdkVersion": c.MinSdkVersion(),
932 "VndkVersion": c.VndkVersion(),
933 "ProductSpecific": c.ProductSpecific(),
934 "SocSpecific": c.SocSpecific(),
935 "DeviceSpecific": c.DeviceSpecific(),
936 "InProduct": c.InProduct(),
937 "InVendor": c.InVendor(),
938 "InRamdisk": c.InRamdisk(),
939 "InVendorRamdisk": c.InVendorRamdisk(),
940 "InRecovery": c.InRecovery(),
941 "VendorAvailable": c.VendorAvailable(),
942 "ProductAvailable": c.ProductAvailable(),
943 "RamdiskAvailable": c.RamdiskAvailable(),
944 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
945 "RecoveryAvailable": c.RecoveryAvailable(),
946 "OdmAvailable": c.OdmAvailable(),
947 "InstallInData": c.InstallInData(),
948 "InstallInRamdisk": c.InstallInRamdisk(),
949 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
950 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
951 "InstallInRecovery": c.InstallInRecovery(),
952 "InstallInRoot": c.InstallInRoot(),
953 "IsVndk": c.IsVndk(),
954 "IsVndkExt": c.IsVndkExt(),
955 "IsVndkPrivate": c.IsVndkPrivate(),
956 "IsVndkSp": c.IsVndkSp(),
957 "IsLlndk": c.IsLlndk(),
958 "IsLlndkPublic": c.IsLlndkPublic(),
959 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
960 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
961 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
962 "ApexSdkVersion": c.apexSdkVersion,
963 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400964 "AidlSrcs": hasAidl,
965 "LexSrcs": hasLex,
966 "ProtoSrcs": hasProto,
967 "RenderscriptSrcs": hasRenderscript,
968 "SyspropSrcs": hasSysprop,
969 "WinMsgSrcs": hasWinMsg,
970 "YaccSrsc": hasYacc,
971 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200972 }
973}
974
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500975func (c *Module) SetPreventInstall() {
976 c.Properties.PreventInstall = true
977}
978
979func (c *Module) SetHideFromMake() {
980 c.Properties.HideFromMake = true
981}
982
Ivan Lozanod7586b62021-04-01 09:49:36 -0400983func (c *Module) HiddenFromMake() bool {
984 return c.Properties.HideFromMake
985}
986
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800987func (c *Module) RequiredModuleNames() []string {
988 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
989 if c.ImageVariation().Variation == android.CoreVariation {
990 required = append(required, c.Properties.Target.Platform.Required...)
991 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
992 } else if c.InRecovery() {
993 required = append(required, c.Properties.Target.Recovery.Required...)
994 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
995 }
996 return android.FirstUniqueStrings(required)
997}
998
Ivan Lozano52767be2019-10-18 14:49:46 -0700999func (c *Module) Toc() android.OptionalPath {
1000 if c.linker != nil {
1001 if library, ok := c.linker.(libraryInterface); ok {
1002 return library.toc()
1003 }
1004 }
1005 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1006}
1007
1008func (c *Module) ApiLevel() string {
1009 if c.linker != nil {
1010 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001011 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001012 }
1013 }
1014 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1015}
1016
1017func (c *Module) Static() bool {
1018 if c.linker != nil {
1019 if library, ok := c.linker.(libraryInterface); ok {
1020 return library.static()
1021 }
1022 }
1023 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1024}
1025
1026func (c *Module) Shared() bool {
1027 if c.linker != nil {
1028 if library, ok := c.linker.(libraryInterface); ok {
1029 return library.shared()
1030 }
1031 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001032
Ivan Lozano52767be2019-10-18 14:49:46 -07001033 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1034}
1035
1036func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001037 if c.stl != nil {
1038 return c.stl.Properties.SelectedStl
1039 }
1040 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001041}
1042
Ivan Lozano52767be2019-10-18 14:49:46 -07001043func (c *Module) NdkPrebuiltStl() bool {
1044 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1045 return true
1046 }
1047 return false
1048}
1049
1050func (c *Module) StubDecorator() bool {
1051 if _, ok := c.linker.(*stubDecorator); ok {
1052 return true
1053 }
1054 return false
1055}
1056
1057func (c *Module) SdkVersion() string {
1058 return String(c.Properties.Sdk_version)
1059}
1060
Artur Satayev480e25b2020-04-27 18:53:18 +01001061func (c *Module) MinSdkVersion() string {
1062 return String(c.Properties.Min_sdk_version)
1063}
1064
Jiyong Park5df7bd32021-08-25 16:18:46 +09001065func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001066 if linker, ok := c.linker.(*objectLinker); ok {
1067 return linker.isCrt()
1068 }
1069 return false
1070}
1071
Jiyong Park5df7bd32021-08-25 16:18:46 +09001072func (c *Module) SplitPerApiLevel() bool {
1073 return c.canUseSdk() && c.isCrt()
1074}
1075
Colin Crossc511bc52020-04-07 16:50:32 +00001076func (c *Module) AlwaysSdk() bool {
1077 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1078}
1079
Ivan Lozano183a3212019-10-18 14:18:45 -07001080func (c *Module) CcLibrary() bool {
1081 if c.linker != nil {
1082 if _, ok := c.linker.(*libraryDecorator); ok {
1083 return true
1084 }
Colin Crossd48fe732020-09-23 20:37:24 -07001085 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1086 return true
1087 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001088 }
1089 return false
1090}
1091
1092func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001093 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001094 return true
1095 }
1096 return false
1097}
1098
Spandan Dase12d2522023-09-12 21:42:31 +00001099func (c *Module) IsNdkPrebuiltStl() bool {
1100 if c.linker == nil {
1101 return false
1102 }
1103 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1104 return true
1105 }
1106 return false
1107}
1108
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001109func (c *Module) RlibStd() bool {
1110 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1111}
1112
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001113func (c *Module) RustLibraryInterface() bool {
1114 return false
1115}
1116
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001117func (c *Module) IsFuzzModule() bool {
1118 if _, ok := c.compiler.(*fuzzBinary); ok {
1119 return true
1120 }
1121 return false
1122}
1123
1124func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1125 return c.FuzzModule
1126}
1127
1128func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1129 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1130 return fuzzer.fuzzPackagedModule
1131 }
1132 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1133}
1134
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001135func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001136 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1137 return fuzzer.sharedLibraries
1138 }
1139 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1140}
1141
Ivan Lozano2b262972019-11-21 12:30:50 -08001142func (c *Module) NonCcVariants() bool {
1143 return false
1144}
1145
Ivan Lozano183a3212019-10-18 14:18:45 -07001146func (c *Module) SetStatic() {
1147 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001148 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001149 library.setStatic()
1150 return
1151 }
1152 }
1153 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1154}
1155
1156func (c *Module) SetShared() {
1157 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001158 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001159 library.setShared()
1160 return
1161 }
1162 }
1163 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1164}
1165
1166func (c *Module) BuildStaticVariant() bool {
1167 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001168 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001169 return library.buildStatic()
1170 }
1171 }
1172 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1173}
1174
1175func (c *Module) BuildSharedVariant() bool {
1176 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001177 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001178 return library.buildShared()
1179 }
1180 }
1181 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1182}
1183
1184func (c *Module) Module() android.Module {
1185 return c
1186}
1187
Jiyong Parkc20eee32018-09-05 22:36:17 +09001188func (c *Module) OutputFile() android.OptionalPath {
1189 return c.outputFile
1190}
1191
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001192func (c *Module) CoverageFiles() android.Paths {
1193 if c.linker != nil {
1194 if library, ok := c.linker.(libraryInterface); ok {
1195 return library.objs().coverageFiles
1196 }
1197 }
1198 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1199}
1200
Ivan Lozano183a3212019-10-18 14:18:45 -07001201var _ LinkableInterface = (*Module)(nil)
1202
Jiyong Park719b4462019-01-13 00:39:51 +09001203func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001204 if c.linker != nil {
1205 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001206 }
1207 return nil
1208}
1209
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001210func (c *Module) CoverageOutputFile() android.OptionalPath {
1211 if c.linker != nil {
1212 return c.linker.coverageOutputFilePath()
1213 }
1214 return android.OptionalPath{}
1215}
1216
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001217func (c *Module) RelativeInstallPath() string {
1218 if c.installer != nil {
1219 return c.installer.relativeInstallPath()
1220 }
1221 return ""
1222}
1223
Jooyung Han344d5432019-08-23 11:17:39 +09001224func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001225 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001226}
1227
Colin Cross36242852017-06-23 15:06:31 -07001228func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001229 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001230 for _, generator := range c.generators {
1231 c.AddProperties(generator.GeneratorProps()...)
1232 }
Colin Crossca860ac2016-01-04 14:34:37 -08001233 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001234 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001235 }
1236 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001237 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001238 }
1239 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001240 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001241 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001242 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001243 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001244 }
Colin Cross16b23492016-01-06 14:41:07 -08001245 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001246 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001247 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001248 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001249 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001250 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001251 if c.fuzzer != nil {
1252 c.AddProperties(c.fuzzer.props()...)
1253 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001254 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001255 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001256 }
Justin Yun8effde42017-06-23 19:24:43 +09001257 if c.vndkdep != nil {
1258 c.AddProperties(c.vndkdep.props()...)
1259 }
Stephen Craneba090d12017-05-09 15:44:35 -07001260 if c.lto != nil {
1261 c.AddProperties(c.lto.props()...)
1262 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001263 if c.afdo != nil {
1264 c.AddProperties(c.afdo.props()...)
1265 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001266 if c.orderfile != nil {
1267 c.AddProperties(c.orderfile.props()...)
1268 }
Colin Crossca860ac2016-01-04 14:34:37 -08001269 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001270 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001271 }
Colin Crossc472d572015-03-17 15:06:21 -07001272
Colin Cross36242852017-06-23 15:06:31 -07001273 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001274 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001275 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001276
Colin Cross36242852017-06-23 15:06:31 -07001277 return c
Colin Crossc472d572015-03-17 15:06:21 -07001278}
1279
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001280// UseVndk() returns true if this module is built against VNDK.
1281// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001282func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001283 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001284}
1285
Colin Crossc511bc52020-04-07 16:50:32 +00001286func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001287 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
1288 !c.UseVndk() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001289}
1290
1291func (c *Module) UseSdk() bool {
1292 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001293 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001294 }
1295 return false
1296}
1297
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001298func (c *Module) isCoverageVariant() bool {
1299 return c.coverage.Properties.IsCoverageVariant
1300}
1301
Colin Cross95f1ca02020-10-29 20:47:22 -07001302func (c *Module) IsNdk(config android.Config) bool {
1303 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001304}
1305
Colin Cross127bb8b2020-12-16 16:46:01 -08001306func (c *Module) IsLlndk() bool {
1307 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001308}
1309
Colin Cross127bb8b2020-12-16 16:46:01 -08001310func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001311 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001312}
1313
Colin Cross1f3f1302021-04-26 18:37:44 -07001314func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001315 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001316 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001317}
1318
Colin Cross5271fea2021-04-27 13:06:04 -07001319func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1320 lib := moduleLibraryInterface(m)
1321 return lib != nil && (lib.hasVendorPublicLibrary())
1322}
1323
1324// IsVendorPublicLibrary returns true for vendor public libraries.
1325func (c *Module) IsVendorPublicLibrary() bool {
1326 return c.VendorProperties.IsVendorPublicLibrary
1327}
1328
Ivan Lozanof1868af2022-04-12 13:08:36 -04001329func (c *Module) IsVndkPrebuiltLibrary() bool {
1330 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1331 return true
1332 }
1333 return false
1334}
1335
1336func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1337 return c.Properties.SdkAndPlatformVariantVisibleToMake
1338}
1339
Ivan Lozanod7586b62021-04-01 09:49:36 -04001340func (c *Module) HasLlndkStubs() bool {
1341 lib := moduleLibraryInterface(c)
1342 return lib != nil && lib.hasLLNDKStubs()
1343}
1344
1345func (c *Module) StubsVersion() string {
1346 if lib, ok := c.linker.(versionedInterface); ok {
1347 return lib.stubsVersion()
1348 }
1349 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1350}
1351
Colin Cross127bb8b2020-12-16 16:46:01 -08001352// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1353// and does not set llndk.vendor_available: false.
1354func (c *Module) isImplementationForLLNDKPublic() bool {
1355 library, _ := c.library.(*libraryDecorator)
1356 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001357 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001358}
1359
Justin Yunfd9e8042020-12-23 18:23:14 +09001360// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001361func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001362 // Check if VNDK-core-private or VNDK-SP-private
1363 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001364 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001365 }
1366
1367 // Check if LLNDK-private
1368 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001369 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001370 }
1371
1372 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001373}
1374
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001375// IsVndk() returns true if this module has a vndk variant.
1376// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1377// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001378func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001379 if vndkdep := c.vndkdep; vndkdep != nil {
1380 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001381 }
1382 return false
1383}
1384
Yi Kong4ef54592022-02-14 20:00:10 +08001385func (c *Module) isAfdoCompile() bool {
1386 if afdo := c.afdo; afdo != nil {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001387 return afdo.Properties.FdoProfilePath != nil
Yi Kong4ef54592022-02-14 20:00:10 +08001388 }
1389 return false
1390}
1391
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001392func (c *Module) isOrderfileCompile() bool {
1393 if orderfile := c.orderfile; orderfile != nil {
1394 return orderfile.Properties.OrderfileLoad
1395 }
1396 return false
1397}
1398
Yi Kongc702ebd2022-08-19 16:02:45 +08001399func (c *Module) isCfi() bool {
1400 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001401 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001402 }
1403 return false
1404}
1405
Yi Konged79fa32023-06-04 17:15:42 +09001406func (c *Module) isFuzzer() bool {
1407 if sanitize := c.sanitize; sanitize != nil {
1408 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1409 }
1410 return false
1411}
1412
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001413func (c *Module) isNDKStubLibrary() bool {
1414 if _, ok := c.compiler.(*stubDecorator); ok {
1415 return true
1416 }
1417 return false
1418}
1419
Ivan Lozanod7586b62021-04-01 09:49:36 -04001420func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001421 if vndkdep := c.vndkdep; vndkdep != nil {
1422 return vndkdep.isVndkSp()
1423 }
1424 return false
1425}
1426
Ivan Lozanof9e21722020-12-02 09:00:51 -05001427func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001428 if vndkdep := c.vndkdep; vndkdep != nil {
1429 return vndkdep.isVndkExt()
1430 }
1431 return false
1432}
1433
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001434func (c *Module) SubName() string {
1435 return c.Properties.SubName
1436}
1437
Ivan Lozano52767be2019-10-18 14:49:46 -07001438func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001439 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001440}
1441
Logan Chienf3511742017-10-31 18:04:35 +08001442func (c *Module) getVndkExtendsModuleName() string {
1443 if vndkdep := c.vndkdep; vndkdep != nil {
1444 return vndkdep.getVndkExtendsModuleName()
1445 }
1446 return ""
1447}
1448
Jiyong Park25fc6a92018-11-18 18:02:45 +09001449func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001450 if lib := c.library; lib != nil {
1451 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001452 }
1453 return false
1454}
1455
1456func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001457 if lib := c.library; lib != nil {
1458 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001459 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001460 return false
1461}
1462
Alan Stokes73feba32022-11-14 12:21:24 +00001463func (c *Module) IsStubsImplementationRequired() bool {
1464 if lib := c.library; lib != nil {
1465 return lib.isStubsImplementationRequired()
1466 }
1467 return false
1468}
1469
Colin Cross0477b422020-10-13 18:43:54 -07001470// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1471// the implementation. If it is an implementation library it returns its own name.
1472func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1473 name := ctx.OtherModuleName(c)
1474 if versioned, ok := c.linker.(versionedInterface); ok {
1475 name = versioned.implementationModuleName(name)
1476 }
1477 return name
1478}
1479
Martin Stjernholm2856c662020-12-02 15:03:42 +00001480// Similar to ImplementationModuleName, but uses the Make variant of the module
1481// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1482// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1483// under the premise that the prebuilt module overrides its source counterpart
1484// if it is exposed to Make).
1485func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1486 name := c.BaseModuleName()
1487 if versioned, ok := c.linker.(versionedInterface); ok {
1488 name = versioned.implementationModuleName(name)
1489 }
1490 return name
1491}
1492
Jiyong Park7d55b612021-06-11 17:22:09 +09001493func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001494 return Bool(c.Properties.Bootstrap)
1495}
1496
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001497func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001498 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1499 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1500 return false
1501 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001502 return c.linker != nil && c.linker.nativeCoverage()
1503}
1504
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001505func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001506 if p, ok := c.linker.(SnapshotInterface); ok {
1507 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001508 }
1509 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001510}
1511
Bill Peckham945441c2020-08-31 16:07:58 -07001512func (c *Module) ExcludeFromVendorSnapshot() bool {
1513 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1514}
1515
Jose Galmesf7294582020-11-13 12:07:36 -08001516func (c *Module) ExcludeFromRecoverySnapshot() bool {
1517 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1518}
1519
Jiyong Parkf1194352019-02-25 11:05:47 +09001520func isBionic(name string) bool {
1521 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001522 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001523 return true
1524 }
1525 return false
1526}
1527
Martin Stjernholm279de572019-09-10 23:18:20 +01001528func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001529 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001530 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001531 }
1532 return isBionic(name)
1533}
1534
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001535func (c *Module) XrefCcFiles() android.Paths {
1536 return c.kytheFiles
1537}
1538
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001539func (c *Module) isCfiAssemblySupportEnabled() bool {
1540 return c.sanitize != nil &&
1541 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1542}
1543
Inseob Kim800d1142021-06-14 12:03:51 +09001544func (c *Module) InstallInRoot() bool {
1545 return c.installer != nil && c.installer.installInRoot()
1546}
1547
Colin Crossca860ac2016-01-04 14:34:37 -08001548type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001549 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001550 moduleContextImpl
1551}
1552
Colin Cross37047f12016-12-13 17:06:13 -08001553type depsContext struct {
1554 android.BottomUpMutatorContext
1555 moduleContextImpl
1556}
1557
Colin Crossca860ac2016-01-04 14:34:37 -08001558type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001559 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001560 moduleContextImpl
1561}
1562
1563type moduleContextImpl struct {
1564 mod *Module
1565 ctx BaseModuleContext
1566}
1567
Colin Crossb98c8b02016-07-29 13:44:28 -07001568func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001569 return ctx.mod.toolchain(ctx.ctx)
1570}
1571
1572func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001573 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001574}
1575
1576func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001577 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001578}
1579
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001580func (ctx *moduleContextImpl) testBinary() bool {
1581 return ctx.mod.testBinary()
1582}
1583
Yi Kong56fc1b62022-09-06 16:24:00 +08001584func (ctx *moduleContextImpl) testLibrary() bool {
1585 return ctx.mod.testLibrary()
1586}
1587
Jiyong Park1d1119f2019-07-29 21:27:18 +09001588func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001589 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001590}
1591
Inseob Kim7f283f42020-06-01 21:53:49 +09001592func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001593 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001594}
1595
Inseob Kim1042d292020-06-01 23:23:05 +09001596func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001597 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001598}
1599
Jooyung Hanccce2f22020-03-07 03:45:53 +09001600func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001601 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001602}
1603
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001604func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001605 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001606}
1607
1608func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001609 if ctx.ctx.Device() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001610 if ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001611 vndkVer := ctx.mod.VndkVersion()
Jooyung Han03302ee2020-04-08 09:22:26 +09001612 if inList(vndkVer, ctx.ctx.Config().PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001613 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001614 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001615 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001616 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001617 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001618 }
1619 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001620}
1621
Jiyong Parkb35a8192020-08-10 15:59:36 +09001622func (ctx *moduleContextImpl) minSdkVersion() string {
1623 ver := ctx.mod.MinSdkVersion()
1624 if ver == "apex_inherit" && !ctx.isForPlatform() {
1625 ver = ctx.apexSdkVersion().String()
1626 }
1627 if ver == "apex_inherit" || ver == "" {
1628 ver = ctx.sdkVersion()
1629 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001630 // For crt objects, the meaning of min_sdk_version is very different from other types of
1631 // module. For them, min_sdk_version defines the oldest version that the build system will
1632 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1633 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1634 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001635 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1636 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1637 // support such an old version. The version is set to the later version in case when the
1638 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1639 // it's for an APEX.
1640 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1641 if ctx.isForPlatform() {
1642 ver = strconv.Itoa(android.FutureApiLevelInt)
1643 } else { // for apex
1644 ver = ctx.apexSdkVersion().String()
1645 if ver == "" { // in case when min_sdk_version was not set by the APEX
1646 ver = ctx.sdkVersion()
1647 }
1648 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001649 }
1650
Jiyong Parkb35a8192020-08-10 15:59:36 +09001651 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1652 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1653 minSdkVersionInt, err2 := strconv.Atoi(ver)
1654 if err == nil && err2 == nil {
1655 if sdkVersionInt < minSdkVersionInt {
1656 return strconv.Itoa(sdkVersionInt)
1657 }
1658 }
1659 return ver
1660}
1661
1662func (ctx *moduleContextImpl) isSdkVariant() bool {
1663 return ctx.mod.IsSdkVariant()
1664}
1665
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001666func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001667 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001668}
Justin Yun8effde42017-06-23 19:24:43 +09001669
Colin Cross95f1ca02020-10-29 20:47:22 -07001670func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1671 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001672}
1673
Colin Cross127bb8b2020-12-16 16:46:01 -08001674func (ctx *moduleContextImpl) IsLlndk() bool {
1675 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001676}
1677
Colin Cross127bb8b2020-12-16 16:46:01 -08001678func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1679 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001680}
1681
Colin Cross127bb8b2020-12-16 16:46:01 -08001682func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1683 return ctx.mod.isImplementationForLLNDKPublic()
1684}
1685
1686func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1687 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001688}
1689
Logan Chienf3511742017-10-31 18:04:35 +08001690func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001691 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001692}
1693
Yi Kong4ef54592022-02-14 20:00:10 +08001694func (ctx *moduleContextImpl) isAfdoCompile() bool {
1695 return ctx.mod.isAfdoCompile()
1696}
1697
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001698func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1699 return ctx.mod.isOrderfileCompile()
1700}
1701
Yi Kongc702ebd2022-08-19 16:02:45 +08001702func (ctx *moduleContextImpl) isCfi() bool {
1703 return ctx.mod.isCfi()
1704}
1705
Yi Konged79fa32023-06-04 17:15:42 +09001706func (ctx *moduleContextImpl) isFuzzer() bool {
1707 return ctx.mod.isFuzzer()
1708}
1709
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001710func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1711 return ctx.mod.isNDKStubLibrary()
1712}
1713
Justin Yun8effde42017-06-23 19:24:43 +09001714func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001715 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001716}
1717
Ivan Lozanof9e21722020-12-02 09:00:51 -05001718func (ctx *moduleContextImpl) IsVndkExt() bool {
1719 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001720}
1721
Colin Cross5271fea2021-04-27 13:06:04 -07001722func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1723 return ctx.mod.IsVendorPublicLibrary()
1724}
1725
Vic Yangefd249e2018-11-12 20:19:56 -08001726func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001727 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001728}
1729
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001730func (ctx *moduleContextImpl) selectedStl() string {
1731 if stl := ctx.mod.stl; stl != nil {
1732 return stl.Properties.SelectedStl
1733 }
1734 return ""
1735}
1736
Ivan Lozanobd721262018-11-27 14:33:03 -08001737func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1738 return ctx.mod.linker.useClangLld(actx)
1739}
1740
Colin Crossce75d2c2016-10-06 16:12:58 -07001741func (ctx *moduleContextImpl) baseModuleName() string {
1742 return ctx.mod.ModuleBase.BaseModuleName()
1743}
1744
Logan Chienf3511742017-10-31 18:04:35 +08001745func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1746 return ctx.mod.getVndkExtendsModuleName()
1747}
1748
Logan Chiene274fc92019-12-03 11:18:32 -08001749func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001750 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1751 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001752}
1753
Colin Crosse07f2312020-08-13 11:24:56 -07001754func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001755 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1756 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001757}
1758
Dan Albertc8060532020-07-22 22:32:17 -07001759func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001760 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001761}
1762
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001763func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001764 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001765}
1766
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001767func (ctx *moduleContextImpl) nativeCoverage() bool {
1768 return ctx.mod.nativeCoverage()
1769}
1770
Colin Cross56a83212020-09-15 18:30:11 -07001771func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1772 return ctx.mod.DirectlyInAnyApex()
1773}
1774
Colin Cross95b07f22020-12-16 11:06:50 -08001775func (ctx *moduleContextImpl) isPreventInstall() bool {
1776 return ctx.mod.Properties.PreventInstall
1777}
1778
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001779func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1780 shared := &ctx.mod.sharedFlags
1781 if shared.flagsMap == nil {
1782 shared.numSharedFlags = 0
1783 shared.flagsMap = make(map[string]string)
1784 }
1785 return shared
1786}
1787
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001788func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1789 return ctx.mod.isCfiAssemblySupportEnabled()
1790}
1791
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001792func (ctx *moduleContextImpl) notInPlatform() bool {
1793 return ctx.mod.NotInPlatform()
1794}
1795
Colin Cross635c3b02016-05-18 15:37:25 -07001796func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001797 return &Module{
1798 hod: hod,
1799 multilib: multilib,
1800 }
1801}
1802
Colin Cross635c3b02016-05-18 15:37:25 -07001803func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001804 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001805 module.features = []feature{
1806 &tidyFeature{},
1807 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001808 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001809 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001810 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001811 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001812 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001813 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001814 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001815 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001816 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001817 return module
1818}
1819
Colin Crossce75d2c2016-10-06 16:12:58 -07001820func (c *Module) Prebuilt() *android.Prebuilt {
1821 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1822 return p.prebuilt()
1823 }
1824 return nil
1825}
1826
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001827func (c *Module) IsPrebuilt() bool {
1828 return c.Prebuilt() != nil
1829}
1830
Colin Crossce75d2c2016-10-06 16:12:58 -07001831func (c *Module) Name() string {
1832 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001833 if p, ok := c.linker.(interface {
1834 Name(string) string
1835 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001836 name = p.Name(name)
1837 }
1838 return name
1839}
1840
Alex Light3d673592019-01-18 14:37:31 -08001841func (c *Module) Symlinks() []string {
1842 if p, ok := c.installer.(interface {
1843 symlinkList() []string
1844 }); ok {
1845 return p.symlinkList()
1846 }
1847 return nil
1848}
1849
Roland Levillainf89cd092019-07-29 16:22:59 +01001850func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1851 test, ok := c.linker.(testPerSrc)
1852 return ok && test.isAllTestsVariation()
1853}
1854
Chris Parsons216e10a2020-07-09 17:12:52 -04001855func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001856 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001857 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001858 }); ok {
1859 return p.dataPaths()
1860 }
1861 return nil
1862}
1863
Ivan Lozanof1868af2022-04-12 13:08:36 -04001864func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001865 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1866 // "current", it will append the VNDK version to the name suffix.
1867 var vndkVersion string
1868 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001869 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001870 if c.ProductSpecific() {
1871 // If the module is product specific with 'product_specific: true',
1872 // do not add a name suffix because it is a base module.
1873 return ""
1874 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001875 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001876 } else {
1877 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001878 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001879 }
1880 if vndkVersion == "current" {
1881 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1882 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001883 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001884 // add version suffix only if the module is using different vndk version than the
1885 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001886 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001887 }
1888 return nameSuffix
1889}
1890
Ivan Lozanof1868af2022-04-12 13:08:36 -04001891func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1892 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001893
1894 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001895 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001896 }
1897
Colin Cross127bb8b2020-12-16 16:46:01 -08001898 llndk := c.IsLlndk()
Colin Cross627280f2021-04-26 16:53:58 -07001899 if llndk || (c.UseVndk() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001900 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1901 // added for product variant only when we have vendor and product variants with core
1902 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001903 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001904 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001905 subName += vendorPublicLibrarySuffix
1906 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001907 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1908 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001909 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001910 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001911 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001912 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001913 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001914 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001915 subName += RecoverySuffix
1916 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1917 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001918 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001919 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001920 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001921 } else if c.IsStubs() && c.IsSdkVariant() {
1922 // Public API surface (NDK)
1923 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1924 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001925 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001926
1927 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001928}
1929
Sam Delmerico75dbca22023-04-20 13:13:25 +00001930func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1931 ctx := &moduleContext{
1932 ModuleContext: actx,
1933 moduleContextImpl: moduleContextImpl{
1934 mod: c,
1935 },
1936 }
1937 ctx.ctx = ctx
1938 return ctx
1939}
1940
Spandan Das20fce2d2023-04-12 17:21:39 +00001941// TODO (b/277651159): Remove this allowlist
1942var (
1943 skipStubLibraryMultipleApexViolation = map[string]bool{
1944 "libclang_rt.asan": true,
1945 "libclang_rt.hwasan": true,
1946 // runtime apex
1947 "libc": true,
1948 "libc_hwasan": true,
1949 "libdl_android": true,
1950 "libm": true,
1951 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001952 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001953 // art apex
1954 "libandroidio": true,
1955 "libdexfile": true,
1956 "libnativebridge": true,
1957 "libnativehelper": true,
1958 "libnativeloader": true,
1959 "libsigchain": true,
1960 }
1961)
1962
1963// Returns true if a stub library could be installed in multiple apexes
1964func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1965 // If this is not an apex variant, no check necessary
1966 if !c.InAnyApex() {
1967 return false
1968 }
1969 // If this is not a stub library, no check necessary
1970 if !c.HasStubsVariants() {
1971 return false
1972 }
1973 // Skip the allowlist
1974 // Use BaseModuleName so that this matches prebuilts.
1975 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1976 return false
1977 }
1978
1979 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1980 // Stub libraries should not have more than one apex_available
1981 if len(aaWithoutTestApexes) > 1 {
1982 return true
1983 }
1984 // Stub libraries should not use the wildcard
1985 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
1986 return true
1987 }
1988 // Default: no violation
1989 return false
1990}
1991
Chris Parsons8d6e4332021-02-22 16:13:50 -05001992func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05001993 // Handle the case of a test module split by `test_per_src` mutator.
1994 //
1995 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
1996 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
1997 // module and return early, as this module does not produce an output file per se.
1998 if c.IsTestPerSrcAllTestsVariation() {
1999 c.outputFile = android.OptionalPath{}
2000 return
2001 }
2002
Ivan Lozanof1868af2022-04-12 13:08:36 -04002003 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002004 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002005 if !apexInfo.IsForPlatform() {
2006 c.hideApexVariantFromMake = true
2007 }
2008
Chris Parsonseefc9e62021-04-02 17:36:47 -04002009 c.makeLinkType = GetMakeLinkType(actx, c)
2010
Sam Delmerico75dbca22023-04-20 13:13:25 +00002011 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002012
Colin Crossf18e1102017-11-16 14:33:08 -08002013 deps := c.depsToPaths(ctx)
2014 if ctx.Failed() {
2015 return
2016 }
2017
Joe Onorato37f900c2023-07-18 16:58:16 -07002018 for _, generator := range c.generators {
2019 gen := generator.GeneratorSources(ctx)
2020 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2021 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2022 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2023 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2024 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2025 if len(deps.Objs.objFiles) == 0 {
2026 // If we are reusuing object files (which happens when we're a shared library and we're
2027 // reusing our static variant's object files), then skip adding the actual source files,
2028 // because we already have the object for it.
2029 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2030 }
2031 }
2032
2033 if ctx.Failed() {
2034 return
2035 }
2036
Spandan Das20fce2d2023-04-12 17:21:39 +00002037 if c.stubLibraryMultipleApexViolation(actx) {
2038 actx.PropertyErrorf("apex_available",
2039 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2040 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002041 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2042 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002043 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2044 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002045 }
2046
Colin Crossca860ac2016-01-04 14:34:37 -08002047 flags := Flags{
2048 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002049 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002050 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002051 for _, generator := range c.generators {
2052 flags = generator.GeneratorFlags(ctx, flags, deps)
2053 }
Colin Crossca860ac2016-01-04 14:34:37 -08002054 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002055 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002056 }
2057 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002058 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002059 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002060 if c.stl != nil {
2061 flags = c.stl.flags(ctx, flags)
2062 }
Colin Cross16b23492016-01-06 14:41:07 -08002063 if c.sanitize != nil {
2064 flags = c.sanitize.flags(ctx, flags)
2065 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002066 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002067 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002068 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002069 if c.fuzzer != nil {
2070 flags = c.fuzzer.flags(ctx, flags)
2071 }
Stephen Craneba090d12017-05-09 15:44:35 -07002072 if c.lto != nil {
2073 flags = c.lto.flags(ctx, flags)
2074 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002075 if c.afdo != nil {
2076 flags = c.afdo.flags(ctx, flags)
2077 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002078 if c.orderfile != nil {
2079 flags = c.orderfile.flags(ctx, flags)
2080 }
Colin Crossca860ac2016-01-04 14:34:37 -08002081 for _, feature := range c.features {
2082 flags = feature.flags(ctx, flags)
2083 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002084 if ctx.Failed() {
2085 return
2086 }
2087
Colin Cross4af21ed2019-11-04 09:37:55 -08002088 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2089 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2090 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002091
Colin Cross4af21ed2019-11-04 09:37:55 -08002092 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002093
2094 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002095 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002096 }
2097 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002098 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002099 }
2100
Colin Cross3e5e7782022-06-17 22:17:05 +00002101 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2102
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002103 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002104 // We need access to all the flags seen by a source file.
2105 if c.sabi != nil {
2106 flags = c.sabi.flags(ctx, flags)
2107 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002108
Colin Cross4af21ed2019-11-04 09:37:55 -08002109 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002110
Joe Onorato37f900c2023-07-18 16:58:16 -07002111 for _, generator := range c.generators {
2112 generator.GeneratorBuildActions(ctx, flags, deps)
2113 }
2114
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002115 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002116 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002117 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002118 if ctx.Failed() {
2119 return
2120 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002121 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002122 c.objFiles = objs.objFiles
2123 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002124 }
2125
Colin Crossca860ac2016-01-04 14:34:37 -08002126 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002127 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002128 if ctx.Failed() {
2129 return
2130 }
Colin Cross635c3b02016-05-18 15:37:25 -07002131 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002132
Chris Parsons94a0bba2021-06-04 15:03:47 -04002133 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002134
Jose Galmes6f843bc2020-12-11 13:36:29 -08002135 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2136 // RECOVERY_SNAPSHOT_VERSION is current.
2137 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002138 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002139 i.collectHeadersForSnapshot(ctx)
2140 }
2141 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002142 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002143 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002144 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002145 }
Colin Cross40213022023-12-13 15:19:49 -08002146 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002147
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002148 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002149
Chris Parsons94a0bba2021-06-04 15:03:47 -04002150 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002151
2152 if c.linker != nil {
2153 moduleInfoJSON := ctx.ModuleInfoJSON()
2154 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2155 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2156 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2157 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2158 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2159
2160 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2161 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2162 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2163 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2164
2165 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2166 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2167 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2168 moduleInfoJSON.SubName += ".cfi"
2169 }
2170 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2171 moduleInfoJSON.SubName += ".hwasan"
2172 }
2173 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2174 moduleInfoJSON.SubName += ".scs"
2175 }
2176 }
2177 moduleInfoJSON.SubName += c.Properties.SubName
2178
2179 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2180 moduleInfoJSON.Uninstallable = true
2181 }
2182
2183 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002184}
2185
2186func (c *Module) maybeUnhideFromMake() {
2187 // If a lib is directly included in any of the APEXes or is not available to the
2188 // platform (which is often the case when the stub is provided as a prebuilt),
2189 // unhide the stubs variant having the latest version gets visible to make. In
2190 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2191 // force anything in the make world to link against the stubs library. (unless it
2192 // is explicitly referenced via .bootstrap suffix or the module is marked with
2193 // 'bootstrap: true').
2194 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
2195 !c.InRecovery() && !c.UseVndk() && !c.static() && !c.isCoverageVariant() &&
2196 c.IsStubs() && !c.InVendorRamdisk() {
2197 c.Properties.HideFromMake = false // unhide
2198 // Note: this is still non-installable
2199 }
2200}
2201
Colin Cross8ff10582023-12-07 13:10:56 -08002202// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2203// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002204func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002205 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002206 // If the module has been specifically configure to not be installed then
2207 // hide from make as otherwise it will break when running inside make
2208 // as the output path to install will not be specified. Not all uninstallable
2209 // modules can be hidden from make as some are needed for resolving make side
2210 // dependencies.
2211 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002212 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002213 c.SkipInstall()
2214 }
2215
2216 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2217 // to allow using the outputs in a genrule.
2218 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002219 c.installer.install(ctx, c.outputFile.Path())
2220 if ctx.Failed() {
2221 return
Colin Crossca860ac2016-01-04 14:34:37 -08002222 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002223 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002224}
2225
Colin Cross0ea8ba82019-06-06 14:33:29 -07002226func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002227 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002228 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002229 }
Colin Crossca860ac2016-01-04 14:34:37 -08002230 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002231}
2232
Colin Crossca860ac2016-01-04 14:34:37 -08002233func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002234 for _, generator := range c.generators {
2235 generator.GeneratorInit(ctx)
2236 }
Colin Crossca860ac2016-01-04 14:34:37 -08002237 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002238 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002239 }
Colin Crossca860ac2016-01-04 14:34:37 -08002240 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002241 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002242 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002243 if c.stl != nil {
2244 c.stl.begin(ctx)
2245 }
Colin Cross16b23492016-01-06 14:41:07 -08002246 if c.sanitize != nil {
2247 c.sanitize.begin(ctx)
2248 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002249 if c.coverage != nil {
2250 c.coverage.begin(ctx)
2251 }
Yi Kong9723e332023-12-04 14:52:53 +09002252 if c.afdo != nil {
2253 c.afdo.begin(ctx)
2254 }
Stephen Craneba090d12017-05-09 15:44:35 -07002255 if c.lto != nil {
2256 c.lto.begin(ctx)
2257 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002258 if c.orderfile != nil {
2259 c.orderfile.begin(ctx)
2260 }
Dan Albert92fe7402020-07-15 13:33:30 -07002261 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002262 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002263 if err != nil {
2264 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002265 c.Properties.Sdk_version = nil
2266 } else {
2267 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002268 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002269 }
Colin Crossca860ac2016-01-04 14:34:37 -08002270}
2271
Colin Cross37047f12016-12-13 17:06:13 -08002272func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002273 deps := Deps{}
2274
Joe Onorato37f900c2023-07-18 16:58:16 -07002275 for _, generator := range c.generators {
2276 deps = generator.GeneratorDeps(ctx, deps)
2277 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002278 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002279 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002280 }
2281 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002282 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002283 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002284 if c.stl != nil {
2285 deps = c.stl.deps(ctx, deps)
2286 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002287 if c.coverage != nil {
2288 deps = c.coverage.deps(ctx, deps)
2289 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002290
Colin Crossb6715442017-10-24 11:13:31 -07002291 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2292 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2293 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2294 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2295 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2296 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002297 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002298
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002299 for _, lib := range deps.ReexportSharedLibHeaders {
2300 if !inList(lib, deps.SharedLibs) {
2301 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2302 }
2303 }
2304
2305 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002306 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2307 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 -07002308 }
2309 }
2310
Colin Cross5950f382016-12-13 12:50:57 -08002311 for _, lib := range deps.ReexportHeaderLibHeaders {
2312 if !inList(lib, deps.HeaderLibs) {
2313 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2314 }
2315 }
2316
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002317 for _, gen := range deps.ReexportGeneratedHeaders {
2318 if !inList(gen, deps.GeneratedHeaders) {
2319 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2320 }
2321 }
2322
Colin Crossc99deeb2016-04-11 15:06:20 -07002323 return deps
2324}
2325
Dan Albert7e9d2952016-08-04 13:02:36 -07002326func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002327 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002328 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002329 moduleContextImpl: moduleContextImpl{
2330 mod: c,
2331 },
2332 }
2333 ctx.ctx = ctx
2334
Vinh Tran44cb78c2023-03-09 22:07:19 -05002335 if !actx.Host() || !ctx.static() || ctx.staticBinary() {
2336 c.afdo.addDep(ctx, actx)
2337 }
2338
Colin Crossca860ac2016-01-04 14:34:37 -08002339 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002340}
2341
Jiyong Park7ed9de32018-10-15 22:25:07 +09002342// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002343func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002344 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2345 version := name[sharp+1:]
2346 libname := name[:sharp]
2347 return libname, version
2348 }
2349 return name, ""
2350}
2351
Dan Albert92fe7402020-07-15 13:33:30 -07002352func GetCrtVariations(ctx android.BottomUpMutatorContext,
2353 m LinkableInterface) []blueprint.Variation {
2354 if ctx.Os() != android.Android {
2355 return nil
2356 }
2357 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002358 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2359 minSdkVersion := m.MinSdkVersion()
2360 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2361 minSdkVersion = m.SdkVersion()
2362 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002363 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2364 if err != nil {
2365 ctx.PropertyErrorf("min_sdk_version", err.Error())
2366 }
Colin Cross363ec762023-01-13 13:45:14 -08002367
2368 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002369 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002370 if apiLevel.LessThan(minApiForArch) {
2371 apiLevel = minApiForArch
2372 }
2373
Dan Albert92fe7402020-07-15 13:33:30 -07002374 return []blueprint.Variation{
2375 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002376 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002377 }
2378 }
2379 return []blueprint.Variation{
2380 {Mutator: "sdk", Variation: ""},
2381 }
2382}
2383
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002384func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2385 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002386
2387 variations = append([]blueprint.Variation(nil), variations...)
2388
Liz Kammer23942242022-04-08 15:41:00 -04002389 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002390 // Version is explicitly specified. i.e. libFoo#30
2391 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002392 if tag, ok := depTag.(libraryDependencyTag); ok {
2393 tag.explicitlyVersioned = true
2394 } else {
2395 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2396 }
Colin Crosse7257d22020-09-24 09:56:18 -07002397 }
Colin Crosse7257d22020-09-24 09:56:18 -07002398
Colin Cross0de8a1e2020-09-18 14:15:30 -07002399 if far {
2400 ctx.AddFarVariationDependencies(variations, depTag, name)
2401 } else {
2402 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002403 }
2404}
2405
Kiyoung Kim487689e2022-07-26 09:48:22 +09002406func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2407 apiImportInfo := multitree.ApiImportInfo{}
2408
2409 if c.Device() {
2410 var apiImportModule []blueprint.Module
2411 if actx.OtherModuleExists("api_imports") {
2412 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2413 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002414 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002415 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002416 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002417 }
2418 }
2419 }
2420
2421 return apiImportInfo
2422}
2423
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002424func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002425 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002426 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002427 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002428 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2429 // between the modules in the snapshot and the snapshot itself.
2430 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002431 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002432 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002433 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002434 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2435 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002436 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002437 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002438 *snapshotInfo = &snapshot
2439 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002440 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002441 }
2442 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002443 if *snapshotInfo == nil {
2444 *snapshotInfo = &SnapshotInfo{}
2445 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002446 return **snapshotInfo
2447}
2448
Kiyoung Kim487689e2022-07-26 09:48:22 +09002449func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2450 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002451 return snapshot
2452 }
2453
2454 return lib
2455}
2456
2457// RewriteLibs takes a list of names of shared libraries and scans it for three types
2458// of names:
2459//
2460// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002461//
2462// For each of these, it adds the name of the prebuilt module (which will be in
2463// prebuilts/ndk) to the list of nonvariant libs.
2464//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002465// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002466//
2467// For each of these, it adds the name of the ndk_library module to the list of
2468// variant libs.
2469//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002470// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002471//
2472// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002473//
2474// The caller can then know to add the variantLibs dependencies differently from the
2475// nonvariantLibs
2476func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2477 variantLibs = []string{}
2478
2479 nonvariantLibs = []string{}
2480 for _, entry := range list {
2481 // strip #version suffix out
2482 name, _ := StubsLibNameAndVersion(entry)
2483 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002484 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002485 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2486 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2487 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002488 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002489 } else {
2490 // put name#version back
2491 nonvariantLibs = append(nonvariantLibs, entry)
2492 }
2493 }
2494 return nonvariantLibs, variantLibs
2495}
2496
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002497func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2498 nonVariantLibs := []string{}
2499 variantLibs := []string{}
2500
2501 for _, lib := range libs {
2502 replaceLibName := GetReplaceModuleName(lib, replaceList)
2503 if replaceLibName == lib {
2504 // Do not handle any libs which are not in API imports
2505 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2506 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2507 variantLibs = append(variantLibs, replaceLibName)
2508 } else {
2509 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2510 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002511 }
2512
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002513 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002514}
2515
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002516func (c *Module) shouldUseApiSurface() bool {
2517 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2518 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2519 // LLNDK Variant
2520 return true
2521 }
2522
2523 if c.Properties.IsSdkVariant {
2524 // NDK Variant
2525 return true
2526 }
2527
2528 if c.isImportedApiLibrary() {
2529 // API Library should depend on API headers
2530 return true
2531 }
2532 }
2533
2534 return false
2535}
2536
Colin Cross1e676be2016-10-12 14:38:15 -07002537func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002538 if !c.Enabled() {
2539 return
2540 }
2541
Colin Cross37047f12016-12-13 17:06:13 -08002542 ctx := &depsContext{
2543 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002544 moduleContextImpl: moduleContextImpl{
2545 mod: c,
2546 },
2547 }
2548 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002549
Colin Crossc99deeb2016-04-11 15:06:20 -07002550 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002551 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002552
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002553 apiNdkLibs := []string{}
2554 apiLateNdkLibs := []string{}
2555
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002556 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002557 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2558 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2559 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2560 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2561 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002562 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002563
Yo Chiang219968c2020-09-22 18:45:04 +08002564 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2565
Colin Crosse0edaf92021-01-11 17:31:17 -08002566 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002567
Dan Albert914449f2016-06-17 16:45:24 -07002568 variantNdkLibs := []string{}
2569 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002570 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002571 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2572 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2573 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002574
2575 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002576 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002577 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002578 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002579
Colin Cross32ec36c2016-12-15 07:39:51 -08002580 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002581 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002582 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002583 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002584 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002585
Kiyoung Kim51279d32022-08-24 14:10:46 +09002586 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002587 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002588 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2589 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002590 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002591
Spandan Das73bcafc2022-08-18 23:26:00 +00002592 if c.isNDKStubLibrary() {
2593 // ndk_headers do not have any variations
2594 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002595 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002596 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002597 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002598 } else {
2599 actx.AddVariationDependencies(nil, depTag, lib)
2600 }
2601 }
2602
Dan Albertf1d14c72020-07-30 14:32:55 -07002603 if c.isNDKStubLibrary() {
2604 // NDK stubs depend on their implementation because the ABI dumps are
2605 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002606
Spandan Das8b08aea2023-03-14 19:29:34 +00002607 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2608 c.ImageVariation(),
2609 blueprint.Variation{Mutator: "link", Variation: "shared"},
2610 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002611 }
2612
Jiyong Park5d1598f2019-02-25 22:14:17 +09002613 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002614 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002615
Kiyoung Kim487689e2022-07-26 09:48:22 +09002616 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002617
Jiyong Park5d1598f2019-02-25 22:14:17 +09002618 actx.AddVariationDependencies([]blueprint.Variation{
2619 {Mutator: "link", Variation: "static"},
2620 }, depTag, lib)
2621 }
2622
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002623 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002624 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002625 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002626 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002627 }
Jiyong Parke3867542020-12-03 17:28:25 +09002628 if inList(lib, deps.ExcludeLibsForApex) {
2629 depTag.excludeInApex = true
2630 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002631
Kiyoung Kim487689e2022-07-26 09:48:22 +09002632 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002633
Dan Willemsen59339a22018-07-22 21:18:45 -07002634 actx.AddVariationDependencies([]blueprint.Variation{
2635 {Mutator: "link", Variation: "static"},
2636 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002637 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002638
Jooyung Han75568392020-03-20 04:29:24 +09002639 // staticUnwinderDep is treated as staticDep for Q apexes
2640 // so that native libraries/binaries are linked with static unwinder
2641 // because Q libc doesn't have unwinder APIs
2642 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002643 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002644 actx.AddVariationDependencies([]blueprint.Variation{
2645 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002646 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002647 }
2648
Jiyong Park7ed9de32018-10-15 22:25:07 +09002649 // shared lib names without the #version suffix
2650 var sharedLibNames []string
2651
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002652 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002653 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002654 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002655 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002656 }
Jiyong Parke3867542020-12-03 17:28:25 +09002657 if inList(lib, deps.ExcludeLibsForApex) {
2658 depTag.excludeInApex = true
2659 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002660 if inList(lib, deps.ExcludeLibsForNonApex) {
2661 depTag.excludeInNonApex = true
2662 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002663
Jiyong Park73c54ee2019-10-22 20:31:18 +09002664 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002665 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2666 name = apiLibraryName
2667 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002668 sharedLibNames = append(sharedLibNames, name)
2669
Colin Crosse7257d22020-09-24 09:56:18 -07002670 variations := []blueprint.Variation{
2671 {Mutator: "link", Variation: "shared"},
2672 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002673
2674 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2675 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2676 }
2677
2678 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2679 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2680 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002681 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002682
Colin Crossfe9acfe2021-06-14 16:13:03 -07002683 for _, lib := range deps.LateStaticLibs {
2684 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2685 actx.AddVariationDependencies([]blueprint.Variation{
2686 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002687 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002688 }
2689
Colin Cross3e5e7782022-06-17 22:17:05 +00002690 for _, lib := range deps.UnexportedStaticLibs {
2691 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2692 actx.AddVariationDependencies([]blueprint.Variation{
2693 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002694 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002695 }
2696
Jiyong Park7ed9de32018-10-15 22:25:07 +09002697 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002698 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002699 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2700 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2701 // linking against both the stubs lib and the non-stubs lib at the same time.
2702 continue
2703 }
Colin Cross6e511a92020-07-27 21:26:48 -07002704 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002705 variations := []blueprint.Variation{
2706 {Mutator: "link", Variation: "shared"},
2707 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002708 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002709 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002710
Dan Willemsen59339a22018-07-22 21:18:45 -07002711 actx.AddVariationDependencies([]blueprint.Variation{
2712 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002713 }, dataLibDepTag, deps.DataLibs...)
2714
Colin Crossc8caa062021-09-24 16:50:14 -07002715 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2716
Chris Parsons79d66a52020-06-05 17:26:16 -04002717 actx.AddVariationDependencies([]blueprint.Variation{
2718 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002719 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002720
Colin Cross68861832016-07-08 10:41:41 -07002721 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002722
2723 for _, gen := range deps.GeneratedHeaders {
2724 depTag := genHeaderDepTag
2725 if inList(gen, deps.ReexportGeneratedHeaders) {
2726 depTag = genHeaderExportDepTag
2727 }
2728 actx.AddDependency(c, depTag, gen)
2729 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002730
Dan Albert92fe7402020-07-15 13:33:30 -07002731 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002732 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002733 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002734 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002735 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002736 }
Colin Crossc465efd2021-06-11 18:00:04 -07002737 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002738 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002739 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002740 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002741 if deps.DynamicLinker != "" {
2742 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002743 }
Dan Albert914449f2016-06-17 16:45:24 -07002744
2745 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002746
2747 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002748 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002749 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002750 {Mutator: "link", Variation: "shared"},
2751 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002752 actx.AddVariationDependencies([]blueprint.Variation{
2753 {Mutator: "version", Variation: version},
2754 {Mutator: "link", Variation: "shared"},
2755 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002756
2757 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002758 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002759 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002760 {Mutator: "link", Variation: "shared"},
2761 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002762 actx.AddVariationDependencies([]blueprint.Variation{
2763 {Mutator: "version", Variation: version},
2764 {Mutator: "link", Variation: "shared"},
2765 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002766
2767 if vndkdep := c.vndkdep; vndkdep != nil {
2768 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002769 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002770 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002771 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002772 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002773 }
2774 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002775
Vinh Tran367d89d2023-04-28 11:21:25 -04002776 if len(deps.AidlLibs) > 0 {
2777 actx.AddDependency(
2778 c,
2779 aidlLibraryTag,
2780 deps.AidlLibs...,
2781 )
2782 }
2783
Kiyoung Kimee58c932022-10-25 22:59:41 +09002784 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002785}
Colin Cross21b9a242015-03-24 14:15:58 -07002786
Colin Crosse40b4ea2018-10-02 22:25:58 -07002787func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002788 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2789 c.beginMutator(ctx)
2790 }
2791}
2792
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002793// Whether a module can link to another module, taking into
2794// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002795func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002796 tag blueprint.DependencyTag) {
2797
2798 switch t := tag.(type) {
2799 case dependencyTag:
2800 if t != vndkExtDepTag {
2801 return
2802 }
2803 case libraryDependencyTag:
2804 default:
2805 return
2806 }
2807
Ivan Lozanof9e21722020-12-02 09:00:51 -05002808 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002809 // Host code is not restricted
2810 return
2811 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002812
2813 // VNDK is cc.Module supported only for now.
2814 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002815 // Though allowed dependency is limited by the image mutator,
2816 // each vendor and product module needs to check link-type
2817 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002818 if ccTo, ok := to.(*Module); ok {
2819 if ccFrom.vndkdep != nil {
2820 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2821 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002822 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002823 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002824 }
2825 return
2826 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002827 // TODO(b/244244438) : Remove this once all variants are implemented
2828 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2829 return
2830 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002831 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002832 // Platform code can link to anything
2833 return
2834 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002835 if from.InRamdisk() {
2836 // Ramdisk code is not NDK
2837 return
2838 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002839 if from.InVendorRamdisk() {
2840 // Vendor ramdisk code is not NDK
2841 return
2842 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002843 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002844 // Recovery code is not NDK
2845 return
2846 }
Colin Cross31076b32020-10-23 17:22:06 -07002847 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002848 if c.NdkPrebuiltStl() {
2849 // These are allowed, but they don't set sdk_version
2850 return
2851 }
2852 if c.StubDecorator() {
2853 // These aren't real libraries, but are the stub shared libraries that are included in
2854 // the NDK.
2855 return
2856 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002857 if c.isImportedApiLibrary() {
2858 // Imported library from the API surface is a stub library built against interface definition.
2859 return
2860 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002861 }
Logan Chien834b9a62019-01-14 15:39:03 +08002862
Ivan Lozano52767be2019-10-18 14:49:46 -07002863 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002864 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2865 // to link to libc++ (non-NDK and without sdk_version).
2866 return
2867 }
2868
Ivan Lozano52767be2019-10-18 14:49:46 -07002869 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002870 // NDK code linking to platform code is never okay.
2871 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002872 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002873 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002874 }
2875
2876 // At this point we know we have two NDK libraries, but we need to
2877 // check that we're not linking against anything built against a higher
2878 // API level, as it is only valid to link against older or equivalent
2879 // APIs.
2880
Inseob Kim01a28722018-04-11 09:48:45 +09002881 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002882 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002883 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002884 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002885 // Current can't be linked against by anything else.
2886 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002887 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002888 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002889 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002890 if err != nil {
2891 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002892 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002893 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002894 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002895 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002896 if err != nil {
2897 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002898 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002899 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002900 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002901
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002902 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002903 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002904 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002905 }
2906 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002907 }
Dan Albert202fe492017-12-15 13:56:59 -08002908
2909 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002910 fromStl := from.SelectedStl()
2911 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002912 if fromStl == "" || toStl == "" {
2913 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002914 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002915 // We can be permissive with the system "STL" since it is only the C++
2916 // ABI layer, but in the future we should make sure that everyone is
2917 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002918 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002919 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002920 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2921 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002922 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002923}
2924
Jooyung Han479ca172020-10-19 18:51:07 +09002925func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2926 if c, ok := ctx.Module().(*Module); ok {
2927 ctx.VisitDirectDeps(func(dep android.Module) {
2928 depTag := ctx.OtherModuleDependencyTag(dep)
2929 ccDep, ok := dep.(LinkableInterface)
2930 if ok {
2931 checkLinkType(ctx, c, ccDep, depTag)
2932 }
2933 })
2934 }
2935}
2936
Jiyong Park5fb8c102018-04-09 12:03:06 +09002937// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002938// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2939// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002940// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002941func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2942 check := func(child, parent android.Module) bool {
2943 to, ok := child.(*Module)
2944 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002945 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002946 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002947
Jooyung Hana70f0672019-01-18 15:20:43 +09002948 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2949 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002950 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002951
Jiyong Park0474e1f2021-01-14 14:26:06 +09002952 // These dependencies are not excercised at runtime. Tracking these will give us
2953 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002954 depTag := ctx.OtherModuleDependencyTag(child)
2955 if IsHeaderDepTag(depTag) {
2956 return false
2957 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002958 if depTag == staticVariantTag {
2959 return false
2960 }
2961 if depTag == stubImplDepTag {
2962 return false
2963 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002964
Justin Yun63e9ec72020-10-29 16:49:43 +09002965 // Even if target lib has no vendor variant, keep checking dependency
2966 // graph in case it depends on vendor_available or product_available
2967 // but not double_loadable transtively.
2968 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002969 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002970 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002971
Jiyong Park0474e1f2021-01-14 14:26:06 +09002972 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2973 // one.
2974 if Bool(to.VendorProperties.Double_loadable) {
2975 return true
2976 }
2977
Ivan Lozanod7586b62021-04-01 09:49:36 -04002978 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002979 return false
2980 }
2981
Jooyung Hana70f0672019-01-18 15:20:43 +09002982 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2983 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002984 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002985 return false
2986 }
2987 if module, ok := ctx.Module().(*Module); ok {
2988 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002989 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002990 ctx.WalkDeps(check)
2991 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002992 }
2993 }
2994}
2995
Yu Liue4312402023-01-18 09:15:31 -08002996func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
2997 // For the dependency from platform to apex, use the latest stubs
2998 apexSdkVersion := android.FutureApiLevel
2999 if !apexInfo.IsForPlatform() {
3000 apexSdkVersion = apexInfo.MinSdkVersion
3001 }
3002
3003 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3004 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3005 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3006 // (b/144430859)
3007 apexSdkVersion = android.FutureApiLevel
3008 }
3009
3010 return apexSdkVersion
3011}
3012
Colin Crossc99deeb2016-04-11 15:06:20 -07003013// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003014func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003015 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003016
Colin Cross0de8a1e2020-09-18 14:15:30 -07003017 var directStaticDeps []StaticLibraryInfo
3018 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003019
Colin Cross0de8a1e2020-09-18 14:15:30 -07003020 reexportExporter := func(exporter FlagExporterInfo) {
3021 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3022 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3023 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3024 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3025 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003026 }
3027
Colin Crossff694a82023-12-13 15:54:49 -08003028 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003029 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003030
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003031 skipModuleList := map[string]bool{}
3032
3033 var apiImportInfo multitree.ApiImportInfo
3034 hasApiImportInfo := false
3035
3036 ctx.VisitDirectDeps(func(dep android.Module) {
3037 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003038 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003039 hasApiImportInfo = true
3040 }
3041 })
3042
3043 if hasApiImportInfo {
3044 targetStubModuleList := map[string]string{}
3045 targetOrigModuleList := map[string]string{}
3046
3047 // Search for dependency which both original module and API imported library with APEX stub exists
3048 ctx.VisitDirectDeps(func(dep android.Module) {
3049 depName := ctx.OtherModuleName(dep)
3050 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3051 targetStubModuleList[apiLibrary] = depName
3052 }
3053 })
3054 ctx.VisitDirectDeps(func(dep android.Module) {
3055 depName := ctx.OtherModuleName(dep)
3056 if origLibrary, ok := targetStubModuleList[depName]; ok {
3057 targetOrigModuleList[origLibrary] = depName
3058 }
3059 })
3060
3061 // Decide which library should be used between original and API imported library
3062 ctx.VisitDirectDeps(func(dep android.Module) {
3063 depName := ctx.OtherModuleName(dep)
3064 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003065 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003066 skipModuleList[depName] = true
3067 } else {
3068 skipModuleList[apiLibrary] = true
3069 }
3070 }
3071 })
3072 }
3073
Colin Crossd11fcda2017-10-23 17:59:01 -07003074 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003075 depName := ctx.OtherModuleName(dep)
3076 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003077
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003078 if _, ok := skipModuleList[depName]; ok {
3079 // skip this module because original module or API imported module matching with this should be used instead.
3080 return
3081 }
3082
Dan Willemsen47450072021-10-19 20:24:49 -07003083 if depTag == android.DarwinUniversalVariantTag {
3084 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3085 return
3086 }
3087
Vinh Tran367d89d2023-04-28 11:21:25 -04003088 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003089 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003090 depPaths.AidlLibraryInfos = append(
3091 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003092 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003093 )
3094 }
3095 }
3096
Ivan Lozano52767be2019-10-18 14:49:46 -07003097 ccDep, ok := dep.(LinkableInterface)
3098 if !ok {
3099
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003100 // handling for a few module types that aren't cc Module but that are also supported
3101 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003102 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003103 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003104 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3105 genRule.GeneratedSourceFiles()...)
3106 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003107 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003108 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003109 // Support exported headers from a generated_sources dependency
3110 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003111 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003112 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003113 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003114 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003115 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003116 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003117 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003118 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003119 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3120 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003121 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003122 // 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 +09003123 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003124
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003125 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003126 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003127 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003128 }
Colin Crosscef792e2021-06-11 18:01:26 -07003129 case CrtBeginDepTag:
3130 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3131 case CrtEndDepTag:
3132 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003133 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003134 return
3135 }
3136
Colin Crossfe17f6f2019-03-28 19:30:56 -07003137 if depTag == android.ProtoPluginDepTag {
3138 return
3139 }
3140
Colin Crossd11fcda2017-10-23 17:59:01 -07003141 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003142 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3143 return
3144 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003145 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003146 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3147 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003148 return
3149 }
3150
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003151 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003152 // Skip reused objects for stub libraries, they use their own stub object file instead.
3153 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3154 // version mutator, so the stubs variant is created from the shared variant that
3155 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003156 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003157 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003158 objs := staticAnalogue.ReuseObjects
3159 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003160 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003161 reexportExporter(depExporterInfo)
3162 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003163 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003164 }
3165
Colin Cross6e511a92020-07-27 21:26:48 -07003166 linkFile := ccDep.OutputFile()
3167
3168 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3169 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003170 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003171 return
3172 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003173
Jiyong Parke3867542020-12-03 17:28:25 +09003174 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3175 return
3176 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003177 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3178 return
3179 }
Jiyong Parke3867542020-12-03 17:28:25 +09003180
Colin Cross313aa542023-12-13 13:47:44 -08003181 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003182
Colin Cross6e511a92020-07-27 21:26:48 -07003183 var ptr *android.Paths
3184 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003185
Colin Cross6e511a92020-07-27 21:26:48 -07003186 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003187
Colin Cross6e511a92020-07-27 21:26:48 -07003188 switch {
3189 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003190 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003191 if !ctx.Config().AllowMissingDependencies() {
3192 ctx.ModuleErrorf("module %q is not a header library", depName)
3193 } else {
3194 ctx.AddMissingDependencies([]string{depName})
3195 }
3196 return
3197 }
Colin Cross6e511a92020-07-27 21:26:48 -07003198 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003199 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003200 if !ctx.Config().AllowMissingDependencies() {
3201 ctx.ModuleErrorf("module %q is not a shared library", depName)
3202 } else {
3203 ctx.AddMissingDependencies([]string{depName})
3204 }
3205 return
3206 }
Jiyong Parke3867542020-12-03 17:28:25 +09003207
Jiyong Park7d55b612021-06-11 17:22:09 +09003208 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3209 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003210
Jiyong Park1ad8e162020-12-01 23:40:09 +09003211 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3212 // linkFile, depFile, and ptr.
3213 if c.IsStubs() {
3214 break
3215 }
3216
Colin Cross0de8a1e2020-09-18 14:15:30 -07003217 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3218 depFile = sharedLibraryInfo.TableOfContents
3219
Colin Cross6e511a92020-07-27 21:26:48 -07003220 ptr = &depPaths.SharedLibs
3221 switch libDepTag.Order {
3222 case earlyLibraryDependency:
3223 ptr = &depPaths.EarlySharedLibs
3224 depPtr = &depPaths.EarlySharedLibsDeps
3225 case normalLibraryDependency:
3226 ptr = &depPaths.SharedLibs
3227 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003228 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003229 case lateLibraryDependency:
3230 ptr = &depPaths.LateSharedLibs
3231 depPtr = &depPaths.LateSharedLibsDeps
3232 default:
3233 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003234 }
Colin Cross6e511a92020-07-27 21:26:48 -07003235 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003236 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3237 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003238 if !ctx.Config().AllowMissingDependencies() {
3239 ctx.ModuleErrorf("module %q is not a static library", depName)
3240 } else {
3241 ctx.AddMissingDependencies([]string{depName})
3242 }
3243 return
3244 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003245
3246 // Stubs lib doesn't link to the static lib dependencies. Don't set
3247 // linkFile, depFile, and ptr.
3248 if c.IsStubs() {
3249 break
3250 }
3251
Colin Cross0de8a1e2020-09-18 14:15:30 -07003252 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003253 if libDepTag.wholeStatic {
3254 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003255 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3256 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003257 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003258 // This case normally catches prebuilt static
3259 // libraries, but it can also occur when
3260 // AllowMissingDependencies is on and the
3261 // dependencies has no sources of its own
3262 // but has a whole_static_libs dependency
3263 // on a missing library. We want to depend
3264 // on the .a file so that there is something
3265 // in the dependency tree that contains the
3266 // error rule for the missing transitive
3267 // dependency.
3268 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003269 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003270 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3271 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003272 } else {
3273 switch libDepTag.Order {
3274 case earlyLibraryDependency:
3275 panic(fmt.Errorf("early static libs not suppported"))
3276 case normalLibraryDependency:
3277 // static dependencies will be handled separately so they can be ordered
3278 // using transitive dependencies.
3279 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003280 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003281 case lateLibraryDependency:
3282 ptr = &depPaths.LateStaticLibs
3283 default:
3284 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003285 }
3286 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003287 if libDepTag.unexportedSymbols {
3288 depPaths.LdFlags = append(depPaths.LdFlags,
3289 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3290 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003291 }
3292
Colin Cross6e511a92020-07-27 21:26:48 -07003293 if libDepTag.static() && !libDepTag.wholeStatic {
3294 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3295 ctx.ModuleErrorf("module %q not a static library", depName)
3296 return
3297 }
Logan Chien43d34c32017-12-20 01:17:32 +08003298
Colin Cross6e511a92020-07-27 21:26:48 -07003299 // When combining coverage files for shared libraries and executables, coverage files
3300 // in static libraries act as if they were whole static libraries. The same goes for
3301 // source based Abi dump files.
3302 if c, ok := ccDep.(*Module); ok {
3303 staticLib := c.linker.(libraryInterface)
3304 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3305 staticLib.objs().coverageFiles...)
3306 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3307 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003308 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003309 // Handle non-CC modules here
3310 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003311 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003312 }
3313 }
3314
Colin Cross6e511a92020-07-27 21:26:48 -07003315 if ptr != nil {
3316 if !linkFile.Valid() {
3317 if !ctx.Config().AllowMissingDependencies() {
3318 ctx.ModuleErrorf("module %q missing output file", depName)
3319 } else {
3320 ctx.AddMissingDependencies([]string{depName})
3321 }
3322 return
3323 }
3324 *ptr = append(*ptr, linkFile.Path())
3325 }
3326
3327 if depPtr != nil {
3328 dep := depFile
3329 if !dep.Valid() {
3330 dep = linkFile
3331 }
3332 *depPtr = append(*depPtr, dep.Path())
3333 }
3334
Colin Cross0de8a1e2020-09-18 14:15:30 -07003335 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3336 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3337 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3338 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3339
3340 if libDepTag.reexportFlags {
3341 reexportExporter(depExporterInfo)
3342 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3343 // Re-exported shared library headers must be included as well since they can help us with type information
3344 // about template instantiations (instantiated from their headers).
3345 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3346 // scripts.
3347 c.sabi.Properties.ReexportedIncludes = append(
3348 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3349 }
3350
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003351 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003352 switch {
3353 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003354 c.Properties.AndroidMkHeaderLibs = append(
3355 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003356 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003357 if lib := moduleLibraryInterface(dep); lib != nil {
3358 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003359 // Add the dependency to the APEX(es) providing the library so that
3360 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003361 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003362 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003363 c.Properties.ApexesProvidingSharedLibs = append(
3364 c.Properties.ApexesProvidingSharedLibs, an)
3365 }
3366 }
3367 }
3368
3369 // Note: the order of libs in this list is not important because
3370 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003371 c.Properties.AndroidMkSharedLibs = append(
3372 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003373 // Record BaseLibName for snapshots.
3374 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003375 case libDepTag.static():
3376 if libDepTag.wholeStatic {
3377 c.Properties.AndroidMkWholeStaticLibs = append(
3378 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3379 } else {
3380 c.Properties.AndroidMkStaticLibs = append(
3381 c.Properties.AndroidMkStaticLibs, makeLibName)
3382 }
Justin Yun5e035862021-06-29 20:50:37 +09003383 // Record BaseLibName for snapshots.
3384 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003385 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003386 } else if !c.IsStubs() {
3387 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3388
Colin Cross6e511a92020-07-27 21:26:48 -07003389 switch depTag {
3390 case runtimeDepTag:
3391 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003392 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003393 // Record BaseLibName for snapshots.
3394 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003395 case objDepTag:
3396 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3397 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003398 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003399 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003400 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003401 case dynamicLinkerDepTag:
3402 depPaths.DynamicLinker = linkFile
3403 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003404 }
Colin Crossca860ac2016-01-04 14:34:37 -08003405 })
3406
Jeff Gaston294356f2017-09-27 17:05:30 -07003407 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003408 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3409 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3410 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003411
Colin Crossdd84e052017-05-17 13:44:16 -07003412 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003413 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003414 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3415 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003416 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003417 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3418 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003419 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003420 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003421 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003422
3423 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003424 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003425 }
Colin Crossdd84e052017-05-17 13:44:16 -07003426
Colin Crossca860ac2016-01-04 14:34:37 -08003427 return depPaths
3428}
3429
Spandan Das604f3762023-03-16 22:51:40 +00003430func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003431 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003432 thisModule, ok := ctx.Module().(android.ApexModule)
3433 if !ok {
3434 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3435 }
3436
3437 useVndk := false
3438 bootstrap := false
3439 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3440 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3441 } else {
3442 useVndk = linkable.UseVndk()
3443 bootstrap = linkable.Bootstrap()
3444 }
3445
Colin Crossff694a82023-12-13 15:54:49 -08003446 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003447
3448 useStubs := false
3449
3450 if lib := moduleLibraryInterface(dep); lib.buildStubs() && useVndk { // LLNDK
3451 if !apexInfo.IsForPlatform() {
3452 // For platform libraries, use current version of LLNDK
3453 // If this is for use_vendor apex we will apply the same rules
3454 // of apex sdk enforcement below to choose right version.
3455 useStubs = true
3456 }
3457 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3458 // If not building for APEX or the containing APEX allows the use of
3459 // platform APIs, use stubs only when it is from an APEX (and not from
3460 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3461 // bootstrap modules, always link to non-stub variant
3462 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3463
3464 isApexImportedApiLibrary := false
3465
3466 if cc, ok := dep.(*Module); ok {
3467 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3468 if apiLibrary.hasApexStubs() {
3469 isApexImportedApiLibrary = true
3470 }
3471 }
3472 }
3473
3474 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3475
3476 if useStubs {
3477 // Another exception: if this module is a test for an APEX, then
3478 // it is linked with the non-stub variant of a module in the APEX
3479 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003480 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003481 for _, apexContents := range testFor.ApexContents {
3482 if apexContents.DirectlyInApex(depName) {
3483 useStubs = false
3484 break
3485 }
3486 }
3487 }
3488 if useStubs {
3489 // Yet another exception: If this module and the dependency are
3490 // available to the same APEXes then skip stubs between their
3491 // platform variants. This complements the test_for case above,
3492 // which avoids the stubs on a direct APEX library dependency, by
3493 // avoiding stubs for indirect test dependencies as well.
3494 //
3495 // TODO(b/183882457): This doesn't work if the two libraries have
3496 // only partially overlapping apex_available. For that test_for
3497 // modules would need to be split into APEX variants and resolved
3498 // separately for each APEX they have access to.
3499 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3500 useStubs = false
3501 }
3502 }
3503 } else {
3504 // If building for APEX, use stubs when the parent is in any APEX that
3505 // the child is not in.
3506 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3507 }
3508
3509 return useStubs
3510}
3511
3512// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3513// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3514// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3515// has different level of updatability. For example, if a library foo in an APEX depends on a
3516// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3517// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3518// same APEX as foo, the non-stub variant of bar is used.
3519func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3520 depTag := ctx.OtherModuleDependencyTag(dep)
3521 libDepTag, ok := depTag.(libraryDependencyTag)
3522 if !ok || !libDepTag.shared() {
3523 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3524 }
3525
Colin Cross313aa542023-12-13 13:47:44 -08003526 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3527 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3528 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003529
3530 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003531 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003532 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003533 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3534 toUse := stubs[len(stubs)-1]
3535 sharedLibraryInfo = toUse.SharedLibraryInfo
3536 depExporterInfo = toUse.FlagExporterInfo
3537 }
3538 }
3539 return sharedLibraryInfo, depExporterInfo
3540}
3541
Colin Cross0de8a1e2020-09-18 14:15:30 -07003542// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3543// to match the topological order of the dependency tree, including any static analogues of
3544// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3545// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003546func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3547 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003548 var staticPaths android.Paths
3549 for _, staticDep := range staticDeps {
3550 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3551 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3552 }
3553 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003554 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3555 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003556 }
3557 }
3558 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3559
3560 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3561
3562 // reorder the dependencies based on transitive dependencies
3563 staticPaths = android.FirstUniquePaths(staticPaths)
3564 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3565
3566 if len(orderedStaticPaths) != len(staticPaths) {
3567 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3568 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3569 }
3570
3571 return orderedStaticPaths, transitiveStaticLibs
3572}
3573
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003574// BaseLibName trims known prefixes and suffixes
3575func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003576 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3577 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003578 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003579 return libName
3580}
3581
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003582func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003583 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003584 ccDepModule, _ := ccDep.(*Module)
3585 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003586 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003587
Justin Yuncbca3732021-02-03 19:24:13 +09003588 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003589 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003590 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003591 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003592
Ivan Lozanod1dec542021-05-26 15:33:11 -04003593 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003594 }
3595 }
3596
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003597 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3598 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003599 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3600 // core module instead.
3601 return libName
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003602 } else if ccDep.UseVndk() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003603 // The vendor and product modules in Make will have been renamed to not conflict with the
3604 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003605 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003606 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003607 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003608 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003609 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003610 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003611 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003612 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003613 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003614 } else {
3615 return libName
3616 }
3617}
3618
Colin Crossca860ac2016-01-04 14:34:37 -08003619func (c *Module) InstallInData() bool {
3620 if c.installer == nil {
3621 return false
3622 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003623 return c.installer.inData()
3624}
3625
3626func (c *Module) InstallInSanitizerDir() bool {
3627 if c.installer == nil {
3628 return false
3629 }
3630 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003631 return true
3632 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003633 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003634}
3635
Yifan Hong1b3348d2020-01-21 15:53:22 -08003636func (c *Module) InstallInRamdisk() bool {
3637 return c.InRamdisk()
3638}
3639
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003640func (c *Module) InstallInVendorRamdisk() bool {
3641 return c.InVendorRamdisk()
3642}
3643
Jiyong Parkf9332f12018-02-01 00:54:12 +09003644func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003645 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003646}
3647
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003648func (c *Module) MakeUninstallable() {
3649 if c.installer == nil {
3650 c.ModuleBase.MakeUninstallable()
3651 return
3652 }
3653 c.installer.makeUninstallable(c)
3654}
3655
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003656func (c *Module) HostToolPath() android.OptionalPath {
3657 if c.installer == nil {
3658 return android.OptionalPath{}
3659 }
3660 return c.installer.hostToolPath()
3661}
3662
Nan Zhangd4e641b2017-07-12 12:55:28 -07003663func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3664 return c.outputFile
3665}
3666
Colin Cross41955e82019-05-29 14:40:35 -07003667func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3668 switch tag {
3669 case "":
3670 if c.outputFile.Valid() {
3671 return android.Paths{c.outputFile.Path()}, nil
3672 }
3673 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003674 case "unstripped":
3675 if c.linker != nil {
3676 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3677 }
3678 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003679 case "stripped_all":
3680 if c.linker != nil {
3681 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3682 }
3683 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003684 default:
3685 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003686 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003687}
3688
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003689func (c *Module) static() bool {
3690 if static, ok := c.linker.(interface {
3691 static() bool
3692 }); ok {
3693 return static.static()
3694 }
3695 return false
3696}
3697
Jiyong Park379de2f2018-12-19 02:47:14 +09003698func (c *Module) staticBinary() bool {
3699 if static, ok := c.linker.(interface {
3700 staticBinary() bool
3701 }); ok {
3702 return static.staticBinary()
3703 }
3704 return false
3705}
3706
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003707func (c *Module) testBinary() bool {
3708 if test, ok := c.linker.(interface {
3709 testBinary() bool
3710 }); ok {
3711 return test.testBinary()
3712 }
3713 return false
3714}
3715
Jingwen Chen537242c2022-08-24 11:53:27 +00003716func (c *Module) testLibrary() bool {
3717 if test, ok := c.linker.(interface {
3718 testLibrary() bool
3719 }); ok {
3720 return test.testLibrary()
3721 }
3722 return false
3723}
3724
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003725func (c *Module) benchmarkBinary() bool {
3726 if b, ok := c.linker.(interface {
3727 benchmarkBinary() bool
3728 }); ok {
3729 return b.benchmarkBinary()
3730 }
3731 return false
3732}
3733
3734func (c *Module) fuzzBinary() bool {
3735 if f, ok := c.linker.(interface {
3736 fuzzBinary() bool
3737 }); ok {
3738 return f.fuzzBinary()
3739 }
3740 return false
3741}
3742
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003743// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3744func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003745 if h, ok := c.linker.(interface {
3746 header() bool
3747 }); ok {
3748 return h.header()
3749 }
3750 return false
3751}
3752
Ivan Lozanod7586b62021-04-01 09:49:36 -04003753func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003754 if b, ok := c.linker.(interface {
3755 binary() bool
3756 }); ok {
3757 return b.binary()
3758 }
3759 return false
3760}
3761
Justin Yun5e035862021-06-29 20:50:37 +09003762func (c *Module) StaticExecutable() bool {
3763 if b, ok := c.linker.(*binaryDecorator); ok {
3764 return b.static()
3765 }
3766 return false
3767}
3768
Ivan Lozanod7586b62021-04-01 09:49:36 -04003769func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003770 if o, ok := c.linker.(interface {
3771 object() bool
3772 }); ok {
3773 return o.object()
3774 }
3775 return false
3776}
3777
Ivan Lozanof9e21722020-12-02 09:00:51 -05003778func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Ivan Lozano52767be2019-10-18 14:49:46 -07003779 if c.UseVndk() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003780 if c.IsLlndk() {
3781 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003782 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003783 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003784 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003785 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003786 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003787 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003788 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003789 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003790 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003791 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003792 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003793 return "native:product"
3794 }
Jooyung Han38002912019-05-16 04:01:54 +09003795 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003796 } else if c.InRamdisk() {
3797 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003798 } else if c.InVendorRamdisk() {
3799 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003800 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003801 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003802 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003803 return "native:ndk:none:none"
3804 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3805 //family, link := getNdkStlFamilyAndLinkType(c)
3806 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003807 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003808 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003809 } else {
3810 return "native:platform"
3811 }
3812}
3813
Jiyong Park9d452992018-10-03 00:38:19 +09003814// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003815// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003816func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003817 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003818 // Stub libs and prebuilt libs in a versioned SDK are not
3819 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003820 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003821 } else if _, ok := c.linker.(testPerSrc); ok {
3822 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003823 }
3824 return false
3825}
3826
Jiyong Parka90ca002019-10-07 15:47:24 +09003827func (c *Module) AvailableFor(what string) bool {
3828 if linker, ok := c.linker.(interface {
3829 availableFor(string) bool
3830 }); ok {
3831 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3832 } else {
3833 return c.ApexModuleBase.AvailableFor(what)
3834 }
3835}
3836
Jiyong Park62304bb2020-04-13 16:19:48 +09003837func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003838 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003839}
3840
Paul Duffin0cb37b92020-03-04 14:52:46 +00003841func (c *Module) EverInstallable() bool {
3842 return c.installer != nil &&
3843 // Check to see whether the module is actually ever installable.
3844 c.installer.everInstallable()
3845}
3846
Ivan Lozanod7586b62021-04-01 09:49:36 -04003847func (c *Module) PreventInstall() bool {
3848 return c.Properties.PreventInstall
3849}
3850
3851func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003852 if c.library != nil {
3853 if i := c.library.installable(); i != nil {
3854 return i
3855 }
3856 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003857 return c.Properties.Installable
3858}
3859
3860func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003861 ret := c.EverInstallable() &&
3862 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003863 proptools.BoolDefault(c.Installable(), true) &&
3864 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003865
3866 // The platform variant doesn't need further condition. Apex variants however might not
3867 // be installable because it will likely to be included in the APEX and won't appear
3868 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003869 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003870 return ret
3871 }
3872
3873 // Special case for modules that are configured to be installed to /data, which includes
3874 // test modules. For these modules, both APEX and non-APEX variants are considered as
3875 // installable. This is because even the APEX variants won't be included in the APEX, but
3876 // will anyway be installed to /data/*.
3877 // See b/146995717
3878 if c.InstallInData() {
3879 return ret
3880 }
3881
3882 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003883}
3884
Logan Chien41eabe62019-04-10 13:33:58 +08003885func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3886 if c.linker != nil {
3887 if library, ok := c.linker.(*libraryDecorator); ok {
3888 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3889 }
3890 }
3891}
3892
Jiyong Park45bf82e2020-12-15 22:29:02 +09003893var _ android.ApexModule = (*Module)(nil)
3894
3895// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003896func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003897 depTag := ctx.OtherModuleDependencyTag(dep)
3898 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3899
3900 if cc, ok := dep.(*Module); ok {
3901 if cc.HasStubsVariants() {
3902 if isLibDepTag && libDepTag.shared() {
3903 // dynamic dep to a stubs lib crosses APEX boundary
3904 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003905 }
Colin Cross6e511a92020-07-27 21:26:48 -07003906 if IsRuntimeDepTag(depTag) {
3907 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003908 return false
3909 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003910 }
Zhijun Heec285872021-04-24 10:47:08 -07003911 if cc.IsLlndk() {
3912 return false
3913 }
Colin Crossaac32222020-07-29 12:51:56 -07003914 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003915 // shared_lib dependency from a static lib is considered as crossing
3916 // the APEX boundary because the dependency doesn't actually is
3917 // linked; the dependency is used only during the compilation phase.
3918 return false
3919 }
Jiyong Parke3867542020-12-03 17:28:25 +09003920
3921 if isLibDepTag && libDepTag.excludeInApex {
3922 return false
3923 }
Colin Cross6e511a92020-07-27 21:26:48 -07003924 }
Colin Crossc1b36442021-05-06 13:42:48 -07003925 if depTag == stubImplDepTag {
3926 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003927 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003928 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003929 if depTag == staticVariantTag {
3930 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3931 // actually mean that the static lib (and its dependencies) are copied into the
3932 // APEX.
3933 return false
3934 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003935 return true
3936}
3937
Jiyong Park45bf82e2020-12-15 22:29:02 +09003938// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003939func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3940 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003941 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3942 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3943 return nil
3944 }
Jooyung Han749dc692020-04-15 11:03:39 +09003945 // We don't check for prebuilt modules
3946 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3947 return nil
3948 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003949
Jooyung Han749dc692020-04-15 11:03:39 +09003950 minSdkVersion := c.MinSdkVersion()
3951 if minSdkVersion == "apex_inherit" {
3952 return nil
3953 }
3954 if minSdkVersion == "" {
3955 // JNI libs within APK-in-APEX fall into here
3956 // Those are okay to set sdk_version instead
3957 // We don't have to check if this is a SDK variant because
3958 // non-SDK variant resets sdk_version, which works too.
3959 minSdkVersion = c.SdkVersion()
3960 }
Dan Albertc8060532020-07-22 22:32:17 -07003961 if minSdkVersion == "" {
3962 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3963 }
3964 // Not using nativeApiLevelFromUser because the context here is not
3965 // necessarily a native context.
3966 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003967 if err != nil {
3968 return err
3969 }
Dan Albertc8060532020-07-22 22:32:17 -07003970
Colin Cross8ca61c12022-10-06 21:00:14 -07003971 // A dependency only needs to support a min_sdk_version at least
3972 // as high as the api level that the architecture was introduced in.
3973 // This allows introducing new architectures in the platform that
3974 // need to be included in apexes that normally require an older
3975 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003976 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003977 if sdkVersion.LessThan(minApiForArch) {
3978 sdkVersion = minApiForArch
3979 }
3980
Dan Albertc8060532020-07-22 22:32:17 -07003981 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003982 return fmt.Errorf("newer SDK(%v)", ver)
3983 }
3984 return nil
3985}
3986
Paul Duffinb5769c12021-05-12 16:16:51 +01003987// Implements android.ApexModule
3988func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3989 // stub libraries and native bridge libraries are always available to platform
3990 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3991}
3992
Jooyung Han91f92032022-02-04 12:36:33 +09003993// Overrides android.ApexModuleBase.UniqueApexVariations
3994func (c *Module) UniqueApexVariations() bool {
3995 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
3996 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
3997 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09003998 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09003999 return c.UseVndk() && c.IsVndk()
4000}
4001
Inseob Kima1888ce2022-10-04 14:42:02 +09004002func (c *Module) overriddenModules() []string {
4003 if o, ok := c.linker.(overridable); ok {
4004 return o.overriddenModules()
4005 }
4006 return nil
4007}
4008
Rob Seymour925aa092021-08-10 20:42:03 +00004009var _ snapshot.RelativeInstallPath = (*Module)(nil)
4010
Liz Kammer35ca77e2021-12-22 15:31:40 -05004011type moduleType int
4012
4013const (
4014 unknownType moduleType = iota
4015 binary
4016 object
4017 fullLibrary
4018 staticLibrary
4019 sharedLibrary
4020 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004021 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004022 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004023 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004024)
4025
4026func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004027 if c.testBinary() {
4028 // testBinary is also a binary, so this comes before the c.Binary()
4029 // conditional. A testBinary has additional implicit dependencies and
4030 // other test-only semantics.
4031 return testBin
4032 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004033 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004034 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004035 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004036 } else if c.testLibrary() {
4037 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4038 // will let them add implicit compile deps on gtest, for example.
4039 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004040 // For now, treat them as regular libraries.
4041 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004042 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004043 static := false
4044 shared := false
4045 if library, ok := c.linker.(*libraryDecorator); ok {
4046 static = library.MutatedProperties.BuildStatic
4047 shared = library.MutatedProperties.BuildShared
4048 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4049 static = library.MutatedProperties.BuildStatic
4050 shared = library.MutatedProperties.BuildShared
4051 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004052 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004053 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004054 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004055 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004056 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004057 return staticLibrary
4058 }
4059 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004060 } else if c.isNDKStubLibrary() {
4061 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004062 } else if c.IsNdkPrebuiltStl() {
4063 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004064 }
4065 return unknownType
4066}
4067
Colin Crosscfad1192015-11-02 16:43:11 -08004068// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004069type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004070 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004071 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004072 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004073}
4074
Patrice Arrudac249c712019-03-19 17:00:29 -07004075// cc_defaults provides a set of properties that can be inherited by other cc
4076// modules. A module can use the properties from a cc_defaults using
4077// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4078// merged (when possible) by prepending the default module's values to the
4079// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004080func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004081 return DefaultsFactory()
4082}
4083
Colin Cross36242852017-06-23 15:06:31 -07004084func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004085 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004086
Colin Cross36242852017-06-23 15:06:31 -07004087 module.AddProperties(props...)
4088 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004089 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004090 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004091 &BaseCompilerProperties{},
4092 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004093 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004094 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004095 &StaticProperties{},
4096 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004097 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004098 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004099 &TestLinkerProperties{},
4100 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004101 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004102 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004103 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004104 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004105 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004106 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004107 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004108 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004109 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004110 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004111 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004112 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004113 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004114 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004115 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004116 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4117 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004118 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004119 )
Colin Crosscfad1192015-11-02 16:43:11 -08004120
Jooyung Hancc372c52019-09-25 15:18:44 +09004121 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004122
4123 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004124}
4125
Jiyong Park2286afd2020-06-16 21:58:53 +09004126func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004127 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004128}
4129
Kiyoung Kim51279d32022-08-24 14:10:46 +09004130func (c *Module) isImportedApiLibrary() bool {
4131 _, ok := c.linker.(*apiLibraryDecorator)
4132 return ok
4133}
4134
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004135func kytheExtractAllFactory() android.Singleton {
4136 return &kytheExtractAllSingleton{}
4137}
4138
4139type kytheExtractAllSingleton struct {
4140}
4141
4142func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4143 var xrefTargets android.Paths
4144 ctx.VisitAllModules(func(module android.Module) {
4145 if ccModule, ok := module.(xref); ok {
4146 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4147 }
4148 })
4149 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4150 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004151 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004152 }
4153}
4154
Jihoon Kangf78a8902022-09-01 22:47:07 +00004155func (c *Module) Partition() string {
4156 if p, ok := c.installer.(interface {
4157 getPartition() string
4158 }); ok {
4159 return p.getPartition()
4160 }
4161 return ""
4162}
4163
Colin Cross06a931b2015-10-28 17:23:31 -07004164var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004165var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004166var BoolPtr = proptools.BoolPtr
4167var String = proptools.String
4168var StringPtr = proptools.StringPtr