blob: 5a901e530a15d5ea2fb8ea19b11091623c17cfb2 [file] [log] [blame]
Colin Cross5049f022015-03-18 13:28:46 -07001// Copyright 2015 Google Inc. All rights reserved.
Colin Cross3f40fa42015-01-30 17:27:36 -08002//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17// This file contains the module types for compiling C/C++ for Android, and converts the properties
18// into the flags and filenames necessary to pass to the compiler. The final creation of the rules
19// is handled in builder.go
20
21import (
Colin Cross41955e82019-05-29 14:40:35 -070022 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080023 "io"
Dan Albert9e10cd42016-08-03 14:12:14 -070024 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080025 "strings"
26
Aditya Choudhary87b2ab22023-11-17 15:27:06 +000027 "android/soong/testing"
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +090028
Colin Cross97ba0732015-03-23 17:50:24 -070029 "github.com/google/blueprint"
Colin Cross06a931b2015-10-28 17:23:31 -070030 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070031
Vinh Tran367d89d2023-04-28 11:21:25 -040032 "android/soong/aidl_library"
Colin Cross635c3b02016-05-18 15:37:25 -070033 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070034 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070035 "android/soong/fuzz"
Colin Cross5049f022015-03-18 13:28:46 -070036 "android/soong/genrule"
Kiyoung Kim487689e2022-07-26 09:48:22 +090037 "android/soong/multitree"
Rob Seymour925aa092021-08-10 20:42:03 +000038 "android/soong/snapshot"
Colin Cross3f40fa42015-01-30 17:27:36 -080039)
40
Colin Cross463a90e2015-06-17 14:20:06 -070041func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000042 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070043
Inseob Kim3b244062023-07-11 13:31:36 +090044 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000045 pctx.Import("android/soong/cc/config")
46}
47
48func RegisterCCBuildComponents(ctx android.RegistrationContext) {
49 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
50
51 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000052 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090053 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070054 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010055 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070056 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070057 ctx.BottomUp("begin", BeginMutator).Parallel()
Vinh Tran44cb78c2023-03-09 22:07:19 -050058 ctx.BottomUp("fdo_profile", fdoProfileMutator)
Colin Cross1e676be2016-10-12 14:38:15 -070059 })
Colin Cross16b23492016-01-06 14:41:07 -080060
Paul Duffin036e7002019-12-19 19:16:28 +000061 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040062 for _, san := range Sanitizers {
63 san.registerMutators(ctx)
64 }
Dan Willemsen581341d2017-02-09 16:16:31 -080065
Colin Cross0b908332019-06-19 23:00:20 -070066 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090067 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080068
Cory Barkera1da26f2022-06-07 20:12:06 +000069 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000070
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -080071 ctx.BottomUp("coverage", coverageMutator).Parallel()
Stephen Craneba090d12017-05-09 15:44:35 -070072
Yi Kongeb8efc92021-12-09 18:06:29 +080073 ctx.TopDown("afdo_deps", afdoDepsMutator)
74 ctx.BottomUp("afdo", afdoMutator).Parallel()
75
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000076 ctx.TopDown("orderfile_deps", orderfileDepsMutator)
77 ctx.BottomUp("orderfile", orderfileMutator).Parallel()
78
Stephen Craneba090d12017-05-09 15:44:35 -070079 ctx.TopDown("lto_deps", ltoDepsMutator)
80 ctx.BottomUp("lto", ltoMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090081
Jooyung Han479ca172020-10-19 18:51:07 +090082 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090083 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070084 })
Colin Crossb98c8b02016-07-29 13:44:28 -070085
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080086 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
87 // sabi mutator needs to be run after apex mutator finishes.
88 ctx.TopDown("sabi_deps", sabiDepsMutator)
89 })
90
LaMont Jones0c10e4d2023-05-16 00:58:37 +000091 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070092}
93
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050094// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
95// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
96// edges to these modules.
97// This object is constructed in DepsMutator, by calling to various module delegates to set
98// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
99// dependencies.
100// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
101// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800102type Deps struct {
103 SharedLibs, LateSharedLibs []string
104 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800105 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800106 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700107
Colin Cross3e5e7782022-06-17 22:17:05 +0000108 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
109 // prevent automatically exporting symbols.
110 UnexportedStaticLibs []string
111
Chris Parsons79d66a52020-06-05 17:26:16 -0400112 // Used for data dependencies adjacent to tests
113 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700114 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400115
Yo Chiang219968c2020-09-22 18:45:04 +0800116 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
117 SystemSharedLibs []string
118
Vinh Tran367d89d2023-04-28 11:21:25 -0400119 // Used by DepMutator to pass aidl_library modules to aidl compiler
120 AidlLibs []string
121
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500122 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800123 StaticUnwinderIfLegacy bool
124
Colin Cross5950f382016-12-13 12:50:57 -0800125 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700126
Colin Cross81413472016-04-11 14:37:39 -0700127 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700128
Dan Willemsenb40aab62016-04-20 14:21:14 -0700129 GeneratedSources []string
130 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900131 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700132
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700133 ReexportGeneratedHeaders []string
134
Colin Crossc465efd2021-06-11 18:00:04 -0700135 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700136
137 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700138 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900139
140 // List of libs that need to be excluded for APEX variant
141 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900142 // List of libs that need to be excluded for non-APEX variant
143 ExcludeLibsForNonApex []string
Colin Crossc472d572015-03-17 15:06:21 -0700144}
145
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500146// PathDeps is a struct containing file paths to dependencies of a module.
147// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
148// It's used to construct flags for various build statements (such as for compiling and linking).
149// It is then passed to module decorator functions responsible for registering build statements
150// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800151type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700152 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900153 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700154 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900155 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700156 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700157 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700158
Colin Cross0de8a1e2020-09-18 14:15:30 -0700159 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700160 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700161
Colin Cross26c34ed2016-09-30 17:10:16 -0700162 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100163 Objs Objects
164 // Paths to .o files in dependencies that provide them. Note that these lists
165 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800166 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700167 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700168
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100169 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
170 // the libs from all whole_static_lib dependencies.
171 WholeStaticLibsFromPrebuilts android.Paths
172
Colin Cross26c34ed2016-09-30 17:10:16 -0700173 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700174 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900175 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700176
Inseob Kimd110f872019-12-06 13:15:38 +0900177 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000178 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900179 IncludeDirs android.Paths
180 SystemIncludeDirs android.Paths
181 ReexportedDirs android.Paths
182 ReexportedSystemDirs android.Paths
183 ReexportedFlags []string
184 ReexportedGeneratedHeaders android.Paths
185 ReexportedDeps android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700186
Colin Cross26c34ed2016-09-30 17:10:16 -0700187 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700188 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700189
Dan Willemsena0790e32018-10-12 00:24:23 -0700190 // Path to the dynamic linker binary
191 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700192
193 // For Darwin builds, the path to the second architecture's output that should
194 // be combined with this architectures's output into a FAT MachO file.
195 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400196
197 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
198 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700199}
200
Colin Cross4af21ed2019-11-04 09:37:55 -0800201// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
202// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
203// command line so they can be overridden by the local module flags).
204type LocalOrGlobalFlags struct {
205 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700206 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800207 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700208 CFlags []string // Flags that apply to C and C++ source files
209 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
210 ConlyFlags []string // Flags that apply to C source files
211 CppFlags []string // Flags that apply to C++ source files
212 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700213 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800214}
215
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500216// Flags contains various types of command line flags (and settings) for use in building build
217// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800218type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500219 // Local flags (which individual modules are responsible for). These may override global flags.
220 Local LocalOrGlobalFlags
221 // Global flags (which build system or toolchain is responsible for).
Colin Cross4af21ed2019-11-04 09:37:55 -0800222 Global LocalOrGlobalFlags
223
224 aidlFlags []string // Flags that apply to aidl source files
225 rsFlags []string // Flags that apply to renderscript source files
226 libFlags []string // Flags to add libraries early to the link order
227 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
228 TidyFlags []string // Flags that apply to clang-tidy
229 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700230
Colin Crossc3199482017-03-30 15:03:04 -0700231 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800232 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700233 SystemIncludeFlags []string
234
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800235 Toolchain config.Toolchain
236 Tidy bool // True if ninja .tidy rules should be generated.
237 NeedTidyFiles bool // True if module link should depend on .tidy files
238 GcovCoverage bool // True if coverage files should be generated.
239 SAbiDump bool // True if header abi dumps should be generated.
240 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800241
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500242 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800243 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500244 // The target-device system path to the dynamic linker.
245 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800246
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700247 CFlagsDeps android.Paths // Files depended on by compiler flags
248 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800249
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500250 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700251 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800252
Colin Cross19878da2019-03-28 14:45:07 -0700253 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700254 protoC bool // Whether to use C instead of C++
255 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700256
257 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200258 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700259}
260
Colin Crossca860ac2016-01-04 14:34:37 -0800261// Properties used to compile all C or C++ modules
262type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700263 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800264 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700265
Jiyong Parkb35a8192020-08-10 15:59:36 +0900266 // The API level that this module is built against. The APIs of this API level will be
267 // visible at build time, but use of any APIs newer than min_sdk_version will render the
268 // module unloadable on older devices. In the future it will be possible to weakly-link new
269 // APIs, making the behavior match Java: such modules will load on older devices, but
270 // calling new APIs on devices that do not support them will result in a crash.
271 //
272 // This property has the same behavior as sdk_version does for Java modules. For those
273 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
274 // does for Java code.
275 //
276 // In addition, setting this property causes two variants to be built, one for the platform
277 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800278 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700279
Jiyong Parkb35a8192020-08-10 15:59:36 +0900280 // Minimum OS API level supported by this C or C++ module. This property becomes the value
281 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
282 // this property is also used to ensure that the min_sdk_version of the containing module is
283 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
284 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
285 // min_sdk_version of the containing APEX. When the module
286 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900287 Min_sdk_version *string
288
Colin Crossc511bc52020-04-07 16:50:32 +0000289 // If true, always create an sdk variant and don't create a platform variant.
290 Sdk_variant_only *bool
291
Jiyong Parkde866cb2018-12-07 23:08:36 +0900292 AndroidMkSharedLibs []string `blueprint:"mutated"`
293 AndroidMkStaticLibs []string `blueprint:"mutated"`
294 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
295 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700296 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900297 HideFromMake bool `blueprint:"mutated"`
298 PreventInstall bool `blueprint:"mutated"`
299 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700300
Yo Chiang219968c2020-09-22 18:45:04 +0800301 // Set by DepsMutator.
302 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
303
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900304 // The name of the image this module is built for
305 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200306
307 // The VNDK version this module is built against. If empty, the module is not
308 // build against the VNDK.
309 VndkVersion string `blueprint:"mutated"`
310
311 // Suffix for the name of Android.mk entries generated by this module
312 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800313
314 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
315 // file
316 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900317
Yifan Hong39143a92020-10-26 12:43:12 -0700318 // Make this module available when building for ramdisk.
319 // On device without a dedicated recovery partition, the module is only
320 // available after switching root into
321 // /first_stage_ramdisk. To expose the module before switching root, install
322 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800323 Ramdisk_available *bool
324
Yifan Hong39143a92020-10-26 12:43:12 -0700325 // Make this module available when building for vendor ramdisk.
326 // On device without a dedicated recovery partition, the module is only
327 // available after switching root into
328 // /first_stage_ramdisk. To expose the module before switching root, install
329 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700330 Vendor_ramdisk_available *bool
331
Jiyong Parkf9332f12018-02-01 00:54:12 +0900332 // Make this module available when building for recovery
333 Recovery_available *bool
334
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200335 // Used by imageMutator, set by ImageMutatorBegin()
336 CoreVariantNeeded bool `blueprint:"mutated"`
337 RamdiskVariantNeeded bool `blueprint:"mutated"`
338 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
339 RecoveryVariantNeeded bool `blueprint:"mutated"`
340
341 // A list of variations for the "image" mutator of the form
342 //<image name> '.' <version char>, for example, 'vendor.S'
343 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900344
345 // Allows this module to use non-APEX version of libraries. Useful
346 // for building binaries that are started before APEXes are activated.
347 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900348
349 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
350 // see soong/cc/config/vndk.go
351 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900352
353 // Used by vendor snapshot to record dependencies from snapshot modules.
354 SnapshotSharedLibs []string `blueprint:"mutated"`
Justin Yun5e035862021-06-29 20:50:37 +0900355 SnapshotStaticLibs []string `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900356 SnapshotRuntimeLibs []string `blueprint:"mutated"`
Paul Duffin0cb37b92020-03-04 14:52:46 +0000357
Colin Cross1bc94122021-10-28 13:25:54 -0700358 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000359
360 // Set by factories of module types that can only be referenced from variants compiled against
361 // the SDK.
362 AlwaysSdk bool `blueprint:"mutated"`
363
364 // Variant is an SDK variant created by sdkMutator
365 IsSdkVariant bool `blueprint:"mutated"`
366 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
367 // variant to have a ".sdk" suffix.
368 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700369
370 // Normally Soong uses the directory structure to decide which modules
371 // should be included (framework) or excluded (non-framework) from the
Jose Galmes6f843bc2020-12-11 13:36:29 -0800372 // different snapshots (vendor, recovery, etc.), but this property
373 // allows a partner to exclude a module normally thought of as a
374 // framework module from the vendor snapshot.
375 Exclude_from_vendor_snapshot *bool
376
377 // Normally Soong uses the directory structure to decide which modules
378 // should be included (framework) or excluded (non-framework) from the
379 // different snapshots (vendor, recovery, etc.), but this property
380 // allows a partner to exclude a module normally thought of as a
381 // framework module from the recovery snapshot.
Jose Galmesf7294582020-11-13 12:07:36 -0800382 Exclude_from_recovery_snapshot *bool
Jiyong Park46a512f2020-12-04 18:02:13 +0900383
384 // List of APEXes that this module has private access to for testing purpose. The module
385 // can depend on libraries that are not exported by the APEXes and use private symbols
386 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000387 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800388
389 Target struct {
390 Platform struct {
391 // List of modules required by the core variant.
392 Required []string `android:"arch_variant"`
393
394 // List of modules not required by the core variant.
395 Exclude_required []string `android:"arch_variant"`
396 } `android:"arch_variant"`
397
398 Recovery struct {
399 // List of modules required by the recovery variant.
400 Required []string `android:"arch_variant"`
401
402 // List of modules not required by the recovery variant.
403 Exclude_required []string `android:"arch_variant"`
404 } `android:"arch_variant"`
405 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700406}
407
408type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900409 // whether this module should be allowed to be directly depended by other
410 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900411 // If set to true, two variants will be built separately, one like
412 // normal, and the other limited to the set of libraries and headers
413 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700414 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900415 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700416 // so it shouldn't have any unversioned runtime dependencies, or
417 // make assumptions about the system that may not be true in the
418 // future.
419 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900420 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900421 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900422 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900423 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900424 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700425 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
426 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900427
Justin Yunebcf0c52021-01-08 18:00:19 +0900428 // This is the same as the "vendor_available" except that the install path
429 // of the vendor variant is /odm or /vendor/odm.
430 // By replacing "vendor_available: true" with "odm_available: true", the
431 // module will install its vendor variant to the /odm partition or /vendor/odm.
432 // As the modules with "odm_available: true" still create the vendor variants,
433 // they can link to the other vendor modules as the vendor_available modules do.
434 // Also, the vendor modules can link to odm_available modules.
435 //
436 // It may not be used for VNDK modules.
437 Odm_available *bool
438
Justin Yun63e9ec72020-10-29 16:49:43 +0900439 // whether this module should be allowed to be directly depended by other
440 // modules with `product_specific: true` or `product_available: true`.
441 // If set to true, an additional product variant will be built separately
442 // that is limited to the set of libraries and headers that are exposed to
443 // /product modules.
444 //
445 // The product variant may be used with a different (newer) /system,
446 // so it shouldn't have any unversioned runtime dependencies, or
447 // make assumptions about the system that may not be true in the
448 // future.
449 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900450 // If set to false, this module becomes inaccessible from /product modules.
451 //
452 // Different from the 'vendor_available' property, the modules with
453 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
454 // library without 'product_available' may not be depended on by any other
455 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900456 //
457 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
458 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
459 Product_available *bool
460
Jiyong Park5fb8c102018-04-09 12:03:06 +0900461 // whether this module is capable of being loaded with other instance
462 // (possibly an older version) of the same module in the same process.
463 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
464 // can be double loaded in a vendor process if the library is also a
465 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
466 // explicitly marked as `double_loadable: true` by the owner, or the dependency
467 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
468 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800469
470 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
471 IsLLNDK bool `blueprint:"mutated"`
472
Colin Cross78212242021-01-06 14:51:30 -0800473 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
474 // set and the module is not listed in VndkMustUseVendorVariantList.
475 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
476
477 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
478 IsVNDKCore bool `blueprint:"mutated"`
479
480 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
481 IsVNDKSP bool `blueprint:"mutated"`
482
483 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
484 // module sets the llndk.private property.
485 IsVNDKPrivate bool `blueprint:"mutated"`
486
487 // IsVNDKProduct is set if a VNDK module sets the product_available property.
488 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700489
490 // IsVendorPublicLibrary is set for the core and product variants of a library that has
491 // vendor_public_library stubs.
492 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800493}
494
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500495// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
496// to understanding details about the type of the current module.
497// For example, one might call these functions to determine whether the current module is a static
498// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800499type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800500 static() bool
501 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700502 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800503 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900504 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900505 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900506 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700507 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900508 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700509 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800510 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900511 minSdkVersion() string
512 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700513 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700514 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800515 IsLlndk() bool
516 IsLlndkPublic() bool
517 isImplementationForLLNDKPublic() bool
518 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900519 isVndk() bool
520 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500521 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700522 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900523 inProduct() bool
524 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800525 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700526 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900527 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900528 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700529 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700530 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800531 getVndkExtendsModuleName() string
Yi Kong4ef54592022-02-14 20:00:10 +0800532 isAfdoCompile() bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000533 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800534 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900535 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800536 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800537 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800538 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700539 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700540 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900541 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800542 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700543 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700544 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800545 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800546 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800547 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800548 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800549}
550
551type SharedFlags struct {
552 numSharedFlags int
553 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800554}
555
556type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700557 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800558 ModuleContextIntf
559}
560
561type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700562 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800563 ModuleContextIntf
564}
565
Colin Cross37047f12016-12-13 17:06:13 -0800566type DepsContext interface {
567 android.BottomUpMutatorContext
568 ModuleContextIntf
569}
570
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500571// feature represents additional (optional) steps to building cc-related modules, such as invocation
572// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800573type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800574 flags(ctx ModuleContext, flags Flags) Flags
575 props() []interface{}
576}
577
Joe Onorato37f900c2023-07-18 16:58:16 -0700578// Information returned from Generator about the source code it's generating
579type GeneratedSource struct {
580 IncludeDirs android.Paths
581 Sources android.Paths
582 Headers android.Paths
583 ReexportedDirs android.Paths
584}
585
586// generator allows injection of generated code
587type Generator interface {
588 GeneratorProps() []interface{}
589 GeneratorInit(ctx BaseModuleContext)
590 GeneratorDeps(ctx DepsContext, deps Deps) Deps
591 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
592 GeneratorSources(ctx ModuleContext) GeneratedSource
593 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
594}
595
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500596// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500597// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800598type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700599 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800600 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800601 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700602 compilerProps() []interface{}
603
Colin Cross76fada02016-07-27 10:31:13 -0700604 appendCflags([]string)
605 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700606 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800607}
608
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500609// linker is the interface for a linker decorator object. Individual module types can provide
610// their own implementation for this decorator, and thus specify custom logic regarding build
611// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800612type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700613 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800614 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700615 linkerFlags(ctx ModuleContext, flags Flags) Flags
616 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800617 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700618
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700619 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700620 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900621 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800622 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700623
624 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900625 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000626
627 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000628 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800629
630 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000631}
632
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500633// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000634type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500635 sharedLibs []string
636 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
637 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700638 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800639}
640
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500641// installer is the interface for an installer helper object. This helper is responsible for
642// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800643type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700644 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700645 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000646 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800647 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700648 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700649 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900650 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000651 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900652 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800653}
654
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800655type xref interface {
656 XrefCcFiles() android.Paths
657}
658
Inseob Kima1888ce2022-10-04 14:42:02 +0900659type overridable interface {
660 overriddenModules() []string
661}
662
Colin Cross6e511a92020-07-27 21:26:48 -0700663type libraryDependencyKind int
664
665const (
666 headerLibraryDependency = iota
667 sharedLibraryDependency
668 staticLibraryDependency
669)
670
671func (k libraryDependencyKind) String() string {
672 switch k {
673 case headerLibraryDependency:
674 return "headerLibraryDependency"
675 case sharedLibraryDependency:
676 return "sharedLibraryDependency"
677 case staticLibraryDependency:
678 return "staticLibraryDependency"
679 default:
680 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
681 }
682}
683
684type libraryDependencyOrder int
685
686const (
687 earlyLibraryDependency = -1
688 normalLibraryDependency = 0
689 lateLibraryDependency = 1
690)
691
692func (o libraryDependencyOrder) String() string {
693 switch o {
694 case earlyLibraryDependency:
695 return "earlyLibraryDependency"
696 case normalLibraryDependency:
697 return "normalLibraryDependency"
698 case lateLibraryDependency:
699 return "lateLibraryDependency"
700 default:
701 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
702 }
703}
704
705// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
706// tags that have a set of predefined tag objects that are reused for each dependency, a
707// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
708// That means that comparing a libraryDependencyTag for equality will only be equal if all
709// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
710// then check individual metadata fields instead.
711type libraryDependencyTag struct {
712 blueprint.BaseDependencyTag
713
714 // These are exported so that fmt.Printf("%#v") can call their String methods.
715 Kind libraryDependencyKind
716 Order libraryDependencyOrder
717
718 wholeStatic bool
719
720 reexportFlags bool
721 explicitlyVersioned bool
722 dataLib bool
723 ndk bool
724
725 staticUnwinder bool
726
727 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900728
Cindy Zhou18417cb2020-12-10 07:12:38 -0800729 // Whether or not this dependency should skip the apex dependency check
730 skipApexAllowedDependenciesCheck bool
731
Jiyong Parke3867542020-12-03 17:28:25 +0900732 // Whether or not this dependency has to be followed for the apex variants
733 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900734 // Whether or not this dependency has to be followed for the non-apex variants
735 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000736
737 // If true, don't automatically export symbols from the static library into a shared library.
738 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700739}
740
741// header returns true if the libraryDependencyTag is tagging a header lib dependency.
742func (d libraryDependencyTag) header() bool {
743 return d.Kind == headerLibraryDependency
744}
745
746// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
747func (d libraryDependencyTag) shared() bool {
748 return d.Kind == sharedLibraryDependency
749}
750
751// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
752func (d libraryDependencyTag) static() bool {
753 return d.Kind == staticLibraryDependency
754}
755
Colin Cross65cb3142021-12-10 23:05:02 +0000756func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
757 if d.shared() {
758 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
759 }
760 return nil
761}
762
763var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
764
Colin Crosse9fe2942020-11-10 18:12:15 -0800765// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
766// binaries or other shared libraries are installed as dependencies.
767func (d libraryDependencyTag) InstallDepNeeded() bool {
768 return d.shared()
769}
770
771var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
772
773// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700774// libraryDependencyTag. Each tag object is created globally and reused for multiple
775// dependencies (although since the object contains no references, assigning a tag to a
776// variable and modifying it will not modify the original). Users can compare the tag
777// returned by ctx.OtherModuleDependencyTag against the global original
778type dependencyTag struct {
779 blueprint.BaseDependencyTag
780 name string
781}
782
Colin Crosse9fe2942020-11-10 18:12:15 -0800783// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
784// libraryDependencyTag, but where the dependency needs to be installed when the parent is
785// installed.
786type installDependencyTag struct {
787 blueprint.BaseDependencyTag
788 android.InstallAlwaysNeededDependencyTag
789 name string
790}
791
Colin Crossc99deeb2016-04-11 15:06:20 -0700792var (
Colin Cross6e511a92020-07-27 21:26:48 -0700793 genSourceDepTag = dependencyTag{name: "gen source"}
794 genHeaderDepTag = dependencyTag{name: "gen header"}
795 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
796 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900797 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700798 reuseObjTag = dependencyTag{name: "reuse objects"}
799 staticVariantTag = dependencyTag{name: "static variant"}
800 vndkExtDepTag = dependencyTag{name: "vndk extends"}
801 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700802 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800803 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700804 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700805 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000806 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500807 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400808 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700809)
810
Roland Levillainf89cd092019-07-29 16:22:59 +0100811func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700812 ccLibDepTag, ok := depTag.(libraryDependencyTag)
813 return ok && ccLibDepTag.shared()
814}
815
816func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
817 ccLibDepTag, ok := depTag.(libraryDependencyTag)
818 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100819}
820
Zach Johnson3df4e632020-11-06 11:56:27 -0800821func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
822 ccLibDepTag, ok := depTag.(libraryDependencyTag)
823 return ok && ccLibDepTag.header()
824}
825
Roland Levillainf89cd092019-07-29 16:22:59 +0100826func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800827 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100828}
829
830func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700831 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100832 return ok && ccDepTag == testPerSrcDepTag
833}
834
Colin Crossca860ac2016-01-04 14:34:37 -0800835// Module contains the properties and members used by all C/C++ module types, and implements
836// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500837// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
838// interface.
839//
840// To define a C/C++ related module, construct a new Module object and point its delegates to
841// type-specific structs. These delegates will be invoked to register module-specific build
842// statements which may be unique to the module type. For example, module.compiler.compile() should
843// be defined so as to register build statements which are responsible for compiling the module.
844//
845// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
846// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
847// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
848// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800849type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700850 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700851
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700852 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700853 Properties BaseProperties
Colin Crossfa138792015-04-24 17:31:52 -0700854
Colin Crossca860ac2016-01-04 14:34:37 -0800855 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000856 hod android.HostOrDeviceSupported
857 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000858 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700859
Paul Duffina0843f62019-12-13 19:50:38 +0000860 // Allowable SdkMemberTypes of this module type.
861 sdkMemberTypes []android.SdkMemberType
862
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500863 // decorator delegates, initialize before calling Init
864 // these may contain module-specific implementations, and effectively allow for custom
865 // type-specific logic. These members may reference different objects or the same object.
866 // Functions of these decorators will be invoked to initialize and register type-specific
867 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800868 generators []Generator
869 compiler compiler
870 linker linker
871 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500872
Spandan Dase12d2522023-09-12 21:42:31 +0000873 features []feature
874 stl *stl
875 sanitize *sanitize
876 coverage *coverage
877 fuzzer *fuzzer
878 sabi *sabi
879 vndkdep *vndkdep
880 lto *lto
881 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000882 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800883
Colin Cross31076b32020-10-23 17:22:06 -0700884 library libraryInterface
885
Colin Cross635c3b02016-05-18 15:37:25 -0700886 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800887
Colin Crossb98c8b02016-07-29 13:44:28 -0700888 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700889
890 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800891
892 // Flags used to compile this module
893 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700894
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800895 // Shared flags among build rules of this module
896 sharedFlags SharedFlags
897
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800898 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700899 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900900
901 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800902 // Kythe (source file indexer) paths for this compilation module
903 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700904 // Object .o file output paths for this compilation module
905 objFiles android.Paths
906 // Tidy .tidy file output paths for this compilation module
907 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900908
909 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700910 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700911
912 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800913
914 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800915 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700916}
917
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200918func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400919 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
920 if b, ok := c.compiler.(*baseCompiler); ok {
921 hasAidl = b.hasSrcExt(".aidl")
922 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
923 hasProto = b.hasSrcExt(".proto")
924 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
925 hasSysprop = b.hasSrcExt(".sysprop")
926 hasWinMsg = b.hasSrcExt(".mc")
927 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
928 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200929 c.AndroidModuleBase().AddJSONData(d)
930 (*d)["Cc"] = map[string]interface{}{
931 "SdkVersion": c.SdkVersion(),
932 "MinSdkVersion": c.MinSdkVersion(),
933 "VndkVersion": c.VndkVersion(),
934 "ProductSpecific": c.ProductSpecific(),
935 "SocSpecific": c.SocSpecific(),
936 "DeviceSpecific": c.DeviceSpecific(),
937 "InProduct": c.InProduct(),
938 "InVendor": c.InVendor(),
939 "InRamdisk": c.InRamdisk(),
940 "InVendorRamdisk": c.InVendorRamdisk(),
941 "InRecovery": c.InRecovery(),
942 "VendorAvailable": c.VendorAvailable(),
943 "ProductAvailable": c.ProductAvailable(),
944 "RamdiskAvailable": c.RamdiskAvailable(),
945 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
946 "RecoveryAvailable": c.RecoveryAvailable(),
947 "OdmAvailable": c.OdmAvailable(),
948 "InstallInData": c.InstallInData(),
949 "InstallInRamdisk": c.InstallInRamdisk(),
950 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
951 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
952 "InstallInRecovery": c.InstallInRecovery(),
953 "InstallInRoot": c.InstallInRoot(),
954 "IsVndk": c.IsVndk(),
955 "IsVndkExt": c.IsVndkExt(),
956 "IsVndkPrivate": c.IsVndkPrivate(),
957 "IsVndkSp": c.IsVndkSp(),
958 "IsLlndk": c.IsLlndk(),
959 "IsLlndkPublic": c.IsLlndkPublic(),
960 "IsSnapshotLibrary": c.IsSnapshotLibrary(),
961 "IsSnapshotPrebuilt": c.IsSnapshotPrebuilt(),
962 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
963 "ApexSdkVersion": c.apexSdkVersion,
964 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400965 "AidlSrcs": hasAidl,
966 "LexSrcs": hasLex,
967 "ProtoSrcs": hasProto,
968 "RenderscriptSrcs": hasRenderscript,
969 "SyspropSrcs": hasSysprop,
970 "WinMsgSrcs": hasWinMsg,
971 "YaccSrsc": hasYacc,
972 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200973 }
974}
975
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500976func (c *Module) SetPreventInstall() {
977 c.Properties.PreventInstall = true
978}
979
980func (c *Module) SetHideFromMake() {
981 c.Properties.HideFromMake = true
982}
983
Ivan Lozanod7586b62021-04-01 09:49:36 -0400984func (c *Module) HiddenFromMake() bool {
985 return c.Properties.HideFromMake
986}
987
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800988func (c *Module) RequiredModuleNames() []string {
989 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
990 if c.ImageVariation().Variation == android.CoreVariation {
991 required = append(required, c.Properties.Target.Platform.Required...)
992 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
993 } else if c.InRecovery() {
994 required = append(required, c.Properties.Target.Recovery.Required...)
995 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
996 }
997 return android.FirstUniqueStrings(required)
998}
999
Ivan Lozano52767be2019-10-18 14:49:46 -07001000func (c *Module) Toc() android.OptionalPath {
1001 if c.linker != nil {
1002 if library, ok := c.linker.(libraryInterface); ok {
1003 return library.toc()
1004 }
1005 }
1006 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1007}
1008
1009func (c *Module) ApiLevel() string {
1010 if c.linker != nil {
1011 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001012 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001013 }
1014 }
1015 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1016}
1017
1018func (c *Module) Static() bool {
1019 if c.linker != nil {
1020 if library, ok := c.linker.(libraryInterface); ok {
1021 return library.static()
1022 }
1023 }
1024 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1025}
1026
1027func (c *Module) Shared() bool {
1028 if c.linker != nil {
1029 if library, ok := c.linker.(libraryInterface); ok {
1030 return library.shared()
1031 }
1032 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001033
Ivan Lozano52767be2019-10-18 14:49:46 -07001034 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1035}
1036
1037func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001038 if c.stl != nil {
1039 return c.stl.Properties.SelectedStl
1040 }
1041 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001042}
1043
Ivan Lozano52767be2019-10-18 14:49:46 -07001044func (c *Module) NdkPrebuiltStl() bool {
1045 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1046 return true
1047 }
1048 return false
1049}
1050
1051func (c *Module) StubDecorator() bool {
1052 if _, ok := c.linker.(*stubDecorator); ok {
1053 return true
1054 }
1055 return false
1056}
1057
1058func (c *Module) SdkVersion() string {
1059 return String(c.Properties.Sdk_version)
1060}
1061
Artur Satayev480e25b2020-04-27 18:53:18 +01001062func (c *Module) MinSdkVersion() string {
1063 return String(c.Properties.Min_sdk_version)
1064}
1065
Jiyong Park5df7bd32021-08-25 16:18:46 +09001066func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001067 if linker, ok := c.linker.(*objectLinker); ok {
1068 return linker.isCrt()
1069 }
1070 return false
1071}
1072
Jiyong Park5df7bd32021-08-25 16:18:46 +09001073func (c *Module) SplitPerApiLevel() bool {
1074 return c.canUseSdk() && c.isCrt()
1075}
1076
Colin Crossc511bc52020-04-07 16:50:32 +00001077func (c *Module) AlwaysSdk() bool {
1078 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1079}
1080
Ivan Lozano183a3212019-10-18 14:18:45 -07001081func (c *Module) CcLibrary() bool {
1082 if c.linker != nil {
1083 if _, ok := c.linker.(*libraryDecorator); ok {
1084 return true
1085 }
Colin Crossd48fe732020-09-23 20:37:24 -07001086 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1087 return true
1088 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001089 }
1090 return false
1091}
1092
1093func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001094 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001095 return true
1096 }
1097 return false
1098}
1099
Spandan Dase12d2522023-09-12 21:42:31 +00001100func (c *Module) IsNdkPrebuiltStl() bool {
1101 if c.linker == nil {
1102 return false
1103 }
1104 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1105 return true
1106 }
1107 return false
1108}
1109
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001110func (c *Module) RlibStd() bool {
1111 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1112}
1113
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001114func (c *Module) RustLibraryInterface() bool {
1115 return false
1116}
1117
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001118func (c *Module) IsFuzzModule() bool {
1119 if _, ok := c.compiler.(*fuzzBinary); ok {
1120 return true
1121 }
1122 return false
1123}
1124
1125func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1126 return c.FuzzModule
1127}
1128
1129func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1130 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1131 return fuzzer.fuzzPackagedModule
1132 }
1133 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1134}
1135
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001136func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001137 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1138 return fuzzer.sharedLibraries
1139 }
1140 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1141}
1142
Ivan Lozano2b262972019-11-21 12:30:50 -08001143func (c *Module) NonCcVariants() bool {
1144 return false
1145}
1146
Ivan Lozano183a3212019-10-18 14:18:45 -07001147func (c *Module) SetStatic() {
1148 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001149 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001150 library.setStatic()
1151 return
1152 }
1153 }
1154 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1155}
1156
1157func (c *Module) SetShared() {
1158 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001159 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001160 library.setShared()
1161 return
1162 }
1163 }
1164 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1165}
1166
1167func (c *Module) BuildStaticVariant() bool {
1168 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001169 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001170 return library.buildStatic()
1171 }
1172 }
1173 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1174}
1175
1176func (c *Module) BuildSharedVariant() bool {
1177 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001178 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001179 return library.buildShared()
1180 }
1181 }
1182 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1183}
1184
1185func (c *Module) Module() android.Module {
1186 return c
1187}
1188
Jiyong Parkc20eee32018-09-05 22:36:17 +09001189func (c *Module) OutputFile() android.OptionalPath {
1190 return c.outputFile
1191}
1192
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001193func (c *Module) CoverageFiles() android.Paths {
1194 if c.linker != nil {
1195 if library, ok := c.linker.(libraryInterface); ok {
1196 return library.objs().coverageFiles
1197 }
1198 }
1199 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1200}
1201
Ivan Lozano183a3212019-10-18 14:18:45 -07001202var _ LinkableInterface = (*Module)(nil)
1203
Jiyong Park719b4462019-01-13 00:39:51 +09001204func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001205 if c.linker != nil {
1206 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001207 }
1208 return nil
1209}
1210
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001211func (c *Module) CoverageOutputFile() android.OptionalPath {
1212 if c.linker != nil {
1213 return c.linker.coverageOutputFilePath()
1214 }
1215 return android.OptionalPath{}
1216}
1217
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001218func (c *Module) RelativeInstallPath() string {
1219 if c.installer != nil {
1220 return c.installer.relativeInstallPath()
1221 }
1222 return ""
1223}
1224
Jooyung Han344d5432019-08-23 11:17:39 +09001225func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001226 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001227}
1228
Colin Cross36242852017-06-23 15:06:31 -07001229func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001230 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001231 for _, generator := range c.generators {
1232 c.AddProperties(generator.GeneratorProps()...)
1233 }
Colin Crossca860ac2016-01-04 14:34:37 -08001234 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001235 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001236 }
1237 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001238 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001239 }
1240 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001241 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001242 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001243 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001244 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001245 }
Colin Cross16b23492016-01-06 14:41:07 -08001246 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001247 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001248 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001249 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001250 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001251 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001252 if c.fuzzer != nil {
1253 c.AddProperties(c.fuzzer.props()...)
1254 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001255 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001256 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001257 }
Justin Yun8effde42017-06-23 19:24:43 +09001258 if c.vndkdep != nil {
1259 c.AddProperties(c.vndkdep.props()...)
1260 }
Stephen Craneba090d12017-05-09 15:44:35 -07001261 if c.lto != nil {
1262 c.AddProperties(c.lto.props()...)
1263 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001264 if c.afdo != nil {
1265 c.AddProperties(c.afdo.props()...)
1266 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001267 if c.orderfile != nil {
1268 c.AddProperties(c.orderfile.props()...)
1269 }
Colin Crossca860ac2016-01-04 14:34:37 -08001270 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001271 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001272 }
Colin Crossc472d572015-03-17 15:06:21 -07001273
Colin Cross36242852017-06-23 15:06:31 -07001274 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001275 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001276 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001277
Colin Cross36242852017-06-23 15:06:31 -07001278 return c
Colin Crossc472d572015-03-17 15:06:21 -07001279}
1280
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001281// UseVndk() returns true if this module is built against VNDK.
1282// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001283func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001284 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001285}
1286
Colin Crossc511bc52020-04-07 16:50:32 +00001287func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001288 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001289 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001290}
1291
1292func (c *Module) UseSdk() bool {
1293 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001294 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001295 }
1296 return false
1297}
1298
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001299func (c *Module) isCoverageVariant() bool {
1300 return c.coverage.Properties.IsCoverageVariant
1301}
1302
Colin Cross95f1ca02020-10-29 20:47:22 -07001303func (c *Module) IsNdk(config android.Config) bool {
1304 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001305}
1306
Colin Cross127bb8b2020-12-16 16:46:01 -08001307func (c *Module) IsLlndk() bool {
1308 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001309}
1310
Colin Cross127bb8b2020-12-16 16:46:01 -08001311func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001312 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001313}
1314
Colin Cross1f3f1302021-04-26 18:37:44 -07001315func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001316 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001317 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001318}
1319
Colin Cross5271fea2021-04-27 13:06:04 -07001320func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1321 lib := moduleLibraryInterface(m)
1322 return lib != nil && (lib.hasVendorPublicLibrary())
1323}
1324
1325// IsVendorPublicLibrary returns true for vendor public libraries.
1326func (c *Module) IsVendorPublicLibrary() bool {
1327 return c.VendorProperties.IsVendorPublicLibrary
1328}
1329
Ivan Lozanof1868af2022-04-12 13:08:36 -04001330func (c *Module) IsVndkPrebuiltLibrary() bool {
1331 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1332 return true
1333 }
1334 return false
1335}
1336
1337func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1338 return c.Properties.SdkAndPlatformVariantVisibleToMake
1339}
1340
Ivan Lozanod7586b62021-04-01 09:49:36 -04001341func (c *Module) HasLlndkStubs() bool {
1342 lib := moduleLibraryInterface(c)
1343 return lib != nil && lib.hasLLNDKStubs()
1344}
1345
1346func (c *Module) StubsVersion() string {
1347 if lib, ok := c.linker.(versionedInterface); ok {
1348 return lib.stubsVersion()
1349 }
1350 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1351}
1352
Colin Cross127bb8b2020-12-16 16:46:01 -08001353// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1354// and does not set llndk.vendor_available: false.
1355func (c *Module) isImplementationForLLNDKPublic() bool {
1356 library, _ := c.library.(*libraryDecorator)
1357 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001358 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001359}
1360
Justin Yunfd9e8042020-12-23 18:23:14 +09001361// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001362func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001363 // Check if VNDK-core-private or VNDK-SP-private
1364 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001365 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001366 }
1367
1368 // Check if LLNDK-private
1369 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001370 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001371 }
1372
1373 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001374}
1375
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001376// IsVndk() returns true if this module has a vndk variant.
1377// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1378// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001379func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001380 if vndkdep := c.vndkdep; vndkdep != nil {
1381 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001382 }
1383 return false
1384}
1385
Yi Kong4ef54592022-02-14 20:00:10 +08001386func (c *Module) isAfdoCompile() bool {
1387 if afdo := c.afdo; afdo != nil {
Vinh Tran44cb78c2023-03-09 22:07:19 -05001388 return afdo.Properties.FdoProfilePath != nil
Yi Kong4ef54592022-02-14 20:00:10 +08001389 }
1390 return false
1391}
1392
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001393func (c *Module) isOrderfileCompile() bool {
1394 if orderfile := c.orderfile; orderfile != nil {
1395 return orderfile.Properties.OrderfileLoad
1396 }
1397 return false
1398}
1399
Yi Kongc702ebd2022-08-19 16:02:45 +08001400func (c *Module) isCfi() bool {
1401 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001402 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001403 }
1404 return false
1405}
1406
Yi Konged79fa32023-06-04 17:15:42 +09001407func (c *Module) isFuzzer() bool {
1408 if sanitize := c.sanitize; sanitize != nil {
1409 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1410 }
1411 return false
1412}
1413
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001414func (c *Module) isNDKStubLibrary() bool {
1415 if _, ok := c.compiler.(*stubDecorator); ok {
1416 return true
1417 }
1418 return false
1419}
1420
Ivan Lozanod7586b62021-04-01 09:49:36 -04001421func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001422 if vndkdep := c.vndkdep; vndkdep != nil {
1423 return vndkdep.isVndkSp()
1424 }
1425 return false
1426}
1427
Ivan Lozanof9e21722020-12-02 09:00:51 -05001428func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001429 if vndkdep := c.vndkdep; vndkdep != nil {
1430 return vndkdep.isVndkExt()
1431 }
1432 return false
1433}
1434
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001435func (c *Module) SubName() string {
1436 return c.Properties.SubName
1437}
1438
Ivan Lozano52767be2019-10-18 14:49:46 -07001439func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001440 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001441}
1442
Logan Chienf3511742017-10-31 18:04:35 +08001443func (c *Module) getVndkExtendsModuleName() string {
1444 if vndkdep := c.vndkdep; vndkdep != nil {
1445 return vndkdep.getVndkExtendsModuleName()
1446 }
1447 return ""
1448}
1449
Jiyong Park25fc6a92018-11-18 18:02:45 +09001450func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001451 if lib := c.library; lib != nil {
1452 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001453 }
1454 return false
1455}
1456
1457func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001458 if lib := c.library; lib != nil {
1459 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001460 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001461 return false
1462}
1463
Alan Stokes73feba32022-11-14 12:21:24 +00001464func (c *Module) IsStubsImplementationRequired() bool {
1465 if lib := c.library; lib != nil {
1466 return lib.isStubsImplementationRequired()
1467 }
1468 return false
1469}
1470
Colin Cross0477b422020-10-13 18:43:54 -07001471// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1472// the implementation. If it is an implementation library it returns its own name.
1473func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1474 name := ctx.OtherModuleName(c)
1475 if versioned, ok := c.linker.(versionedInterface); ok {
1476 name = versioned.implementationModuleName(name)
1477 }
1478 return name
1479}
1480
Martin Stjernholm2856c662020-12-02 15:03:42 +00001481// Similar to ImplementationModuleName, but uses the Make variant of the module
1482// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1483// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1484// under the premise that the prebuilt module overrides its source counterpart
1485// if it is exposed to Make).
1486func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1487 name := c.BaseModuleName()
1488 if versioned, ok := c.linker.(versionedInterface); ok {
1489 name = versioned.implementationModuleName(name)
1490 }
1491 return name
1492}
1493
Jiyong Park7d55b612021-06-11 17:22:09 +09001494func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001495 return Bool(c.Properties.Bootstrap)
1496}
1497
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001498func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001499 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1500 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1501 return false
1502 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001503 return c.linker != nil && c.linker.nativeCoverage()
1504}
1505
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001506func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001507 if p, ok := c.linker.(SnapshotInterface); ok {
1508 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001509 }
1510 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001511}
1512
Bill Peckham945441c2020-08-31 16:07:58 -07001513func (c *Module) ExcludeFromVendorSnapshot() bool {
1514 return Bool(c.Properties.Exclude_from_vendor_snapshot)
1515}
1516
Jose Galmesf7294582020-11-13 12:07:36 -08001517func (c *Module) ExcludeFromRecoverySnapshot() bool {
1518 return Bool(c.Properties.Exclude_from_recovery_snapshot)
1519}
1520
Jiyong Parkf1194352019-02-25 11:05:47 +09001521func isBionic(name string) bool {
1522 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001523 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001524 return true
1525 }
1526 return false
1527}
1528
Martin Stjernholm279de572019-09-10 23:18:20 +01001529func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001530 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001531 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001532 }
1533 return isBionic(name)
1534}
1535
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001536func (c *Module) XrefCcFiles() android.Paths {
1537 return c.kytheFiles
1538}
1539
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001540func (c *Module) isCfiAssemblySupportEnabled() bool {
1541 return c.sanitize != nil &&
1542 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1543}
1544
Inseob Kim800d1142021-06-14 12:03:51 +09001545func (c *Module) InstallInRoot() bool {
1546 return c.installer != nil && c.installer.installInRoot()
1547}
1548
Colin Crossca860ac2016-01-04 14:34:37 -08001549type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001550 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001551 moduleContextImpl
1552}
1553
Colin Cross37047f12016-12-13 17:06:13 -08001554type depsContext struct {
1555 android.BottomUpMutatorContext
1556 moduleContextImpl
1557}
1558
Colin Crossca860ac2016-01-04 14:34:37 -08001559type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001560 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001561 moduleContextImpl
1562}
1563
1564type moduleContextImpl struct {
1565 mod *Module
1566 ctx BaseModuleContext
1567}
1568
Colin Crossb98c8b02016-07-29 13:44:28 -07001569func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001570 return ctx.mod.toolchain(ctx.ctx)
1571}
1572
1573func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001574 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001575}
1576
1577func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001578 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001579}
1580
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001581func (ctx *moduleContextImpl) testBinary() bool {
1582 return ctx.mod.testBinary()
1583}
1584
Yi Kong56fc1b62022-09-06 16:24:00 +08001585func (ctx *moduleContextImpl) testLibrary() bool {
1586 return ctx.mod.testLibrary()
1587}
1588
Jiyong Park1d1119f2019-07-29 21:27:18 +09001589func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001590 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001591}
1592
Inseob Kim7f283f42020-06-01 21:53:49 +09001593func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001594 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001595}
1596
Inseob Kim1042d292020-06-01 23:23:05 +09001597func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001598 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001599}
1600
Jooyung Hanccce2f22020-03-07 03:45:53 +09001601func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001602 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001603}
1604
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001605func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001606 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001607}
1608
1609func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001610 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001611 config := ctx.ctx.Config()
1612 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001613 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001614 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001615 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001616 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001617 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001618 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001619 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001620 }
1621 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001622}
1623
Jiyong Parkb35a8192020-08-10 15:59:36 +09001624func (ctx *moduleContextImpl) minSdkVersion() string {
1625 ver := ctx.mod.MinSdkVersion()
1626 if ver == "apex_inherit" && !ctx.isForPlatform() {
1627 ver = ctx.apexSdkVersion().String()
1628 }
1629 if ver == "apex_inherit" || ver == "" {
1630 ver = ctx.sdkVersion()
1631 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001632
1633 if ctx.ctx.Device() {
1634 config := ctx.ctx.Config()
1635 if config.IsVndkDeprecated() && ctx.inVendor() {
1636 // If building for vendor with final API, then use the latest _stable_ API as "current".
1637 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1638 ver = config.PlatformSdkVersion().String()
1639 }
1640 }
1641 }
1642
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001643 // For crt objects, the meaning of min_sdk_version is very different from other types of
1644 // module. For them, min_sdk_version defines the oldest version that the build system will
1645 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1646 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1647 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001648 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1649 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1650 // support such an old version. The version is set to the later version in case when the
1651 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1652 // it's for an APEX.
1653 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1654 if ctx.isForPlatform() {
1655 ver = strconv.Itoa(android.FutureApiLevelInt)
1656 } else { // for apex
1657 ver = ctx.apexSdkVersion().String()
1658 if ver == "" { // in case when min_sdk_version was not set by the APEX
1659 ver = ctx.sdkVersion()
1660 }
1661 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001662 }
1663
Jiyong Parkb35a8192020-08-10 15:59:36 +09001664 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1665 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1666 minSdkVersionInt, err2 := strconv.Atoi(ver)
1667 if err == nil && err2 == nil {
1668 if sdkVersionInt < minSdkVersionInt {
1669 return strconv.Itoa(sdkVersionInt)
1670 }
1671 }
1672 return ver
1673}
1674
1675func (ctx *moduleContextImpl) isSdkVariant() bool {
1676 return ctx.mod.IsSdkVariant()
1677}
1678
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001679func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001680 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001681}
Justin Yun8effde42017-06-23 19:24:43 +09001682
Kiyoung Kimaa394802024-01-08 12:55:45 +09001683func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1684 return ctx.mod.InVendorOrProduct()
1685}
1686
Colin Cross95f1ca02020-10-29 20:47:22 -07001687func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1688 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001689}
1690
Colin Cross127bb8b2020-12-16 16:46:01 -08001691func (ctx *moduleContextImpl) IsLlndk() bool {
1692 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001693}
1694
Colin Cross127bb8b2020-12-16 16:46:01 -08001695func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1696 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001697}
1698
Colin Cross127bb8b2020-12-16 16:46:01 -08001699func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1700 return ctx.mod.isImplementationForLLNDKPublic()
1701}
1702
1703func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1704 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001705}
1706
Logan Chienf3511742017-10-31 18:04:35 +08001707func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001708 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001709}
1710
Yi Kong4ef54592022-02-14 20:00:10 +08001711func (ctx *moduleContextImpl) isAfdoCompile() bool {
1712 return ctx.mod.isAfdoCompile()
1713}
1714
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001715func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1716 return ctx.mod.isOrderfileCompile()
1717}
1718
Yi Kongc702ebd2022-08-19 16:02:45 +08001719func (ctx *moduleContextImpl) isCfi() bool {
1720 return ctx.mod.isCfi()
1721}
1722
Yi Konged79fa32023-06-04 17:15:42 +09001723func (ctx *moduleContextImpl) isFuzzer() bool {
1724 return ctx.mod.isFuzzer()
1725}
1726
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001727func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1728 return ctx.mod.isNDKStubLibrary()
1729}
1730
Justin Yun8effde42017-06-23 19:24:43 +09001731func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001732 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001733}
1734
Ivan Lozanof9e21722020-12-02 09:00:51 -05001735func (ctx *moduleContextImpl) IsVndkExt() bool {
1736 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001737}
1738
Colin Cross5271fea2021-04-27 13:06:04 -07001739func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1740 return ctx.mod.IsVendorPublicLibrary()
1741}
1742
Vic Yangefd249e2018-11-12 20:19:56 -08001743func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001744 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001745}
1746
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001747func (ctx *moduleContextImpl) selectedStl() string {
1748 if stl := ctx.mod.stl; stl != nil {
1749 return stl.Properties.SelectedStl
1750 }
1751 return ""
1752}
1753
Ivan Lozanobd721262018-11-27 14:33:03 -08001754func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1755 return ctx.mod.linker.useClangLld(actx)
1756}
1757
Colin Crossce75d2c2016-10-06 16:12:58 -07001758func (ctx *moduleContextImpl) baseModuleName() string {
1759 return ctx.mod.ModuleBase.BaseModuleName()
1760}
1761
Logan Chienf3511742017-10-31 18:04:35 +08001762func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1763 return ctx.mod.getVndkExtendsModuleName()
1764}
1765
Logan Chiene274fc92019-12-03 11:18:32 -08001766func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001767 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1768 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001769}
1770
Colin Crosse07f2312020-08-13 11:24:56 -07001771func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001772 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1773 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001774}
1775
Dan Albertc8060532020-07-22 22:32:17 -07001776func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001777 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001778}
1779
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001780func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001781 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001782}
1783
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001784func (ctx *moduleContextImpl) nativeCoverage() bool {
1785 return ctx.mod.nativeCoverage()
1786}
1787
Colin Cross56a83212020-09-15 18:30:11 -07001788func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1789 return ctx.mod.DirectlyInAnyApex()
1790}
1791
Colin Cross95b07f22020-12-16 11:06:50 -08001792func (ctx *moduleContextImpl) isPreventInstall() bool {
1793 return ctx.mod.Properties.PreventInstall
1794}
1795
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001796func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1797 shared := &ctx.mod.sharedFlags
1798 if shared.flagsMap == nil {
1799 shared.numSharedFlags = 0
1800 shared.flagsMap = make(map[string]string)
1801 }
1802 return shared
1803}
1804
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001805func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1806 return ctx.mod.isCfiAssemblySupportEnabled()
1807}
1808
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001809func (ctx *moduleContextImpl) notInPlatform() bool {
1810 return ctx.mod.NotInPlatform()
1811}
1812
Colin Cross635c3b02016-05-18 15:37:25 -07001813func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001814 return &Module{
1815 hod: hod,
1816 multilib: multilib,
1817 }
1818}
1819
Colin Cross635c3b02016-05-18 15:37:25 -07001820func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001821 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001822 module.features = []feature{
1823 &tidyFeature{},
1824 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001825 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001826 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001827 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001828 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001829 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001830 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001831 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001832 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001833 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001834 return module
1835}
1836
Colin Crossce75d2c2016-10-06 16:12:58 -07001837func (c *Module) Prebuilt() *android.Prebuilt {
1838 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1839 return p.prebuilt()
1840 }
1841 return nil
1842}
1843
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001844func (c *Module) IsPrebuilt() bool {
1845 return c.Prebuilt() != nil
1846}
1847
Colin Crossce75d2c2016-10-06 16:12:58 -07001848func (c *Module) Name() string {
1849 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001850 if p, ok := c.linker.(interface {
1851 Name(string) string
1852 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001853 name = p.Name(name)
1854 }
1855 return name
1856}
1857
Alex Light3d673592019-01-18 14:37:31 -08001858func (c *Module) Symlinks() []string {
1859 if p, ok := c.installer.(interface {
1860 symlinkList() []string
1861 }); ok {
1862 return p.symlinkList()
1863 }
1864 return nil
1865}
1866
Roland Levillainf89cd092019-07-29 16:22:59 +01001867func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1868 test, ok := c.linker.(testPerSrc)
1869 return ok && test.isAllTestsVariation()
1870}
1871
Chris Parsons216e10a2020-07-09 17:12:52 -04001872func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001873 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001874 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001875 }); ok {
1876 return p.dataPaths()
1877 }
1878 return nil
1879}
1880
Ivan Lozanof1868af2022-04-12 13:08:36 -04001881func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001882 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1883 // "current", it will append the VNDK version to the name suffix.
1884 var vndkVersion string
1885 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001886 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001887 if c.ProductSpecific() {
1888 // If the module is product specific with 'product_specific: true',
1889 // do not add a name suffix because it is a base module.
1890 return ""
1891 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001892 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001893 } else {
1894 vndkVersion = ctx.DeviceConfig().VndkVersion()
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001895 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001896 }
1897 if vndkVersion == "current" {
1898 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
1899 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001900 if c.VndkVersion() != vndkVersion && c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001901 // add version suffix only if the module is using different vndk version than the
1902 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001903 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001904 }
1905 return nameSuffix
1906}
1907
Ivan Lozanof1868af2022-04-12 13:08:36 -04001908func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1909 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001910
1911 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001912 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001913 }
1914
Colin Cross127bb8b2020-12-16 16:46:01 -08001915 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001916 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001917 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1918 // added for product variant only when we have vendor and product variants with core
1919 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001920 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001921 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001922 subName += vendorPublicLibrarySuffix
1923 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001924 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1925 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001926 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001927 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001928 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001929 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001930 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001931 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001932 subName += RecoverySuffix
1933 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1934 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001935 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001936 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001937 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001938 } else if c.IsStubs() && c.IsSdkVariant() {
1939 // Public API surface (NDK)
1940 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1941 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001942 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001943
1944 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001945}
1946
Sam Delmerico75dbca22023-04-20 13:13:25 +00001947func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1948 ctx := &moduleContext{
1949 ModuleContext: actx,
1950 moduleContextImpl: moduleContextImpl{
1951 mod: c,
1952 },
1953 }
1954 ctx.ctx = ctx
1955 return ctx
1956}
1957
Spandan Das20fce2d2023-04-12 17:21:39 +00001958// TODO (b/277651159): Remove this allowlist
1959var (
1960 skipStubLibraryMultipleApexViolation = map[string]bool{
1961 "libclang_rt.asan": true,
1962 "libclang_rt.hwasan": true,
1963 // runtime apex
1964 "libc": true,
1965 "libc_hwasan": true,
1966 "libdl_android": true,
1967 "libm": true,
1968 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001969 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001970 // art apex
1971 "libandroidio": true,
1972 "libdexfile": true,
1973 "libnativebridge": true,
1974 "libnativehelper": true,
1975 "libnativeloader": true,
1976 "libsigchain": true,
1977 }
1978)
1979
1980// Returns true if a stub library could be installed in multiple apexes
1981func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1982 // If this is not an apex variant, no check necessary
1983 if !c.InAnyApex() {
1984 return false
1985 }
1986 // If this is not a stub library, no check necessary
1987 if !c.HasStubsVariants() {
1988 return false
1989 }
1990 // Skip the allowlist
1991 // Use BaseModuleName so that this matches prebuilts.
1992 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1993 return false
1994 }
1995
1996 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1997 // Stub libraries should not have more than one apex_available
1998 if len(aaWithoutTestApexes) > 1 {
1999 return true
2000 }
2001 // Stub libraries should not use the wildcard
2002 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2003 return true
2004 }
2005 // Default: no violation
2006 return false
2007}
2008
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002009func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2010 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2011}
2012
Chris Parsons8d6e4332021-02-22 16:13:50 -05002013func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Chris Parsons8d6e4332021-02-22 16:13:50 -05002014 // Handle the case of a test module split by `test_per_src` mutator.
2015 //
2016 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2017 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2018 // module and return early, as this module does not produce an output file per se.
2019 if c.IsTestPerSrcAllTestsVariation() {
2020 c.outputFile = android.OptionalPath{}
2021 return
2022 }
2023
Ivan Lozanof1868af2022-04-12 13:08:36 -04002024 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002025 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002026 if !apexInfo.IsForPlatform() {
2027 c.hideApexVariantFromMake = true
2028 }
2029
Chris Parsonseefc9e62021-04-02 17:36:47 -04002030 c.makeLinkType = GetMakeLinkType(actx, c)
2031
Sam Delmerico75dbca22023-04-20 13:13:25 +00002032 ctx := moduleContextFromAndroidModuleContext(actx, c)
Colin Crossca860ac2016-01-04 14:34:37 -08002033
Colin Crossf18e1102017-11-16 14:33:08 -08002034 deps := c.depsToPaths(ctx)
2035 if ctx.Failed() {
2036 return
2037 }
2038
Joe Onorato37f900c2023-07-18 16:58:16 -07002039 for _, generator := range c.generators {
2040 gen := generator.GeneratorSources(ctx)
2041 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2042 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2043 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2044 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2045 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2046 if len(deps.Objs.objFiles) == 0 {
2047 // If we are reusuing object files (which happens when we're a shared library and we're
2048 // reusing our static variant's object files), then skip adding the actual source files,
2049 // because we already have the object for it.
2050 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2051 }
2052 }
2053
2054 if ctx.Failed() {
2055 return
2056 }
2057
Spandan Das20fce2d2023-04-12 17:21:39 +00002058 if c.stubLibraryMultipleApexViolation(actx) {
2059 actx.PropertyErrorf("apex_available",
2060 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2061 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002062 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2063 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002064 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2065 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002066 }
2067
Colin Crossca860ac2016-01-04 14:34:37 -08002068 flags := Flags{
2069 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002070 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002071 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002072 for _, generator := range c.generators {
2073 flags = generator.GeneratorFlags(ctx, flags, deps)
2074 }
Colin Crossca860ac2016-01-04 14:34:37 -08002075 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002076 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002077 }
2078 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002079 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002080 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002081 if c.stl != nil {
2082 flags = c.stl.flags(ctx, flags)
2083 }
Colin Cross16b23492016-01-06 14:41:07 -08002084 if c.sanitize != nil {
2085 flags = c.sanitize.flags(ctx, flags)
2086 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002087 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002088 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002089 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002090 if c.fuzzer != nil {
2091 flags = c.fuzzer.flags(ctx, flags)
2092 }
Stephen Craneba090d12017-05-09 15:44:35 -07002093 if c.lto != nil {
2094 flags = c.lto.flags(ctx, flags)
2095 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002096 if c.afdo != nil {
2097 flags = c.afdo.flags(ctx, flags)
2098 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002099 if c.orderfile != nil {
2100 flags = c.orderfile.flags(ctx, flags)
2101 }
Colin Crossca860ac2016-01-04 14:34:37 -08002102 for _, feature := range c.features {
2103 flags = feature.flags(ctx, flags)
2104 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002105 if ctx.Failed() {
2106 return
2107 }
2108
Colin Cross4af21ed2019-11-04 09:37:55 -08002109 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2110 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2111 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002112
Colin Cross4af21ed2019-11-04 09:37:55 -08002113 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002114
2115 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002116 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002117 }
2118 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002119 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002120 }
2121
Colin Cross3e5e7782022-06-17 22:17:05 +00002122 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2123
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002124 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002125 // We need access to all the flags seen by a source file.
2126 if c.sabi != nil {
2127 flags = c.sabi.flags(ctx, flags)
2128 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002129
Colin Cross4af21ed2019-11-04 09:37:55 -08002130 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002131
Joe Onorato37f900c2023-07-18 16:58:16 -07002132 for _, generator := range c.generators {
2133 generator.GeneratorBuildActions(ctx, flags, deps)
2134 }
2135
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002136 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002137 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002138 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002139 if ctx.Failed() {
2140 return
2141 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002142 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002143 c.objFiles = objs.objFiles
2144 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002145 }
2146
Colin Crossca860ac2016-01-04 14:34:37 -08002147 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002148 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002149 if ctx.Failed() {
2150 return
2151 }
Colin Cross635c3b02016-05-18 15:37:25 -07002152 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002153
Chris Parsons94a0bba2021-06-04 15:03:47 -04002154 c.maybeUnhideFromMake()
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002155
Jose Galmes6f843bc2020-12-11 13:36:29 -08002156 // glob exported headers for snapshot, if BOARD_VNDK_VERSION is current or
2157 // RECOVERY_SNAPSHOT_VERSION is current.
2158 if i, ok := c.linker.(snapshotLibraryInterface); ok {
Ivan Lozanod7586b62021-04-01 09:49:36 -04002159 if ShouldCollectHeadersForSnapshot(ctx, c, apexInfo) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09002160 i.collectHeadersForSnapshot(ctx)
2161 }
2162 }
Colin Crossce75d2c2016-10-06 16:12:58 -07002163 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002164 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002165 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002166 }
Colin Cross40213022023-12-13 15:19:49 -08002167 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002168
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002169 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002170
Chris Parsons94a0bba2021-06-04 15:03:47 -04002171 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002172
2173 if c.linker != nil {
2174 moduleInfoJSON := ctx.ModuleInfoJSON()
2175 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2176 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2177 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2178 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2179 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2180
2181 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2182 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2183 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2184 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2185
2186 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2187 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2188 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2189 moduleInfoJSON.SubName += ".cfi"
2190 }
2191 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2192 moduleInfoJSON.SubName += ".hwasan"
2193 }
2194 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2195 moduleInfoJSON.SubName += ".scs"
2196 }
2197 }
2198 moduleInfoJSON.SubName += c.Properties.SubName
2199
2200 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2201 moduleInfoJSON.Uninstallable = true
2202 }
2203
2204 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002205}
2206
2207func (c *Module) maybeUnhideFromMake() {
2208 // If a lib is directly included in any of the APEXes or is not available to the
2209 // platform (which is often the case when the stub is provided as a prebuilt),
2210 // unhide the stubs variant having the latest version gets visible to make. In
2211 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2212 // force anything in the make world to link against the stubs library. (unless it
2213 // is explicitly referenced via .bootstrap suffix or the module is marked with
2214 // 'bootstrap: true').
2215 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002216 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002217 c.IsStubs() && !c.InVendorRamdisk() {
2218 c.Properties.HideFromMake = false // unhide
2219 // Note: this is still non-installable
2220 }
2221}
2222
Colin Cross8ff10582023-12-07 13:10:56 -08002223// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2224// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002225func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002226 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002227 // If the module has been specifically configure to not be installed then
2228 // hide from make as otherwise it will break when running inside make
2229 // as the output path to install will not be specified. Not all uninstallable
2230 // modules can be hidden from make as some are needed for resolving make side
2231 // dependencies.
2232 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002233 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002234 c.SkipInstall()
2235 }
2236
2237 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2238 // to allow using the outputs in a genrule.
2239 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002240 c.installer.install(ctx, c.outputFile.Path())
2241 if ctx.Failed() {
2242 return
Colin Crossca860ac2016-01-04 14:34:37 -08002243 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002244 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002245}
2246
Colin Cross0ea8ba82019-06-06 14:33:29 -07002247func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002248 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002249 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002250 }
Colin Crossca860ac2016-01-04 14:34:37 -08002251 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002252}
2253
Colin Crossca860ac2016-01-04 14:34:37 -08002254func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002255 for _, generator := range c.generators {
2256 generator.GeneratorInit(ctx)
2257 }
Colin Crossca860ac2016-01-04 14:34:37 -08002258 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002259 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002260 }
Colin Crossca860ac2016-01-04 14:34:37 -08002261 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002262 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002263 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002264 if c.stl != nil {
2265 c.stl.begin(ctx)
2266 }
Colin Cross16b23492016-01-06 14:41:07 -08002267 if c.sanitize != nil {
2268 c.sanitize.begin(ctx)
2269 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002270 if c.coverage != nil {
2271 c.coverage.begin(ctx)
2272 }
Yi Kong9723e332023-12-04 14:52:53 +09002273 if c.afdo != nil {
2274 c.afdo.begin(ctx)
2275 }
Stephen Craneba090d12017-05-09 15:44:35 -07002276 if c.lto != nil {
2277 c.lto.begin(ctx)
2278 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002279 if c.orderfile != nil {
2280 c.orderfile.begin(ctx)
2281 }
Dan Albert92fe7402020-07-15 13:33:30 -07002282 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002283 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002284 if err != nil {
2285 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002286 c.Properties.Sdk_version = nil
2287 } else {
2288 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002289 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002290 }
Colin Crossca860ac2016-01-04 14:34:37 -08002291}
2292
Colin Cross37047f12016-12-13 17:06:13 -08002293func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002294 deps := Deps{}
2295
Joe Onorato37f900c2023-07-18 16:58:16 -07002296 for _, generator := range c.generators {
2297 deps = generator.GeneratorDeps(ctx, deps)
2298 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002299 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002300 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002301 }
2302 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002303 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002304 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002305 if c.stl != nil {
2306 deps = c.stl.deps(ctx, deps)
2307 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002308 if c.coverage != nil {
2309 deps = c.coverage.deps(ctx, deps)
2310 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002311
Colin Crossb6715442017-10-24 11:13:31 -07002312 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2313 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2314 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2315 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2316 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2317 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002318 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002319
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002320 for _, lib := range deps.ReexportSharedLibHeaders {
2321 if !inList(lib, deps.SharedLibs) {
2322 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2323 }
2324 }
2325
2326 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002327 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2328 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 -07002329 }
2330 }
2331
Colin Cross5950f382016-12-13 12:50:57 -08002332 for _, lib := range deps.ReexportHeaderLibHeaders {
2333 if !inList(lib, deps.HeaderLibs) {
2334 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2335 }
2336 }
2337
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002338 for _, gen := range deps.ReexportGeneratedHeaders {
2339 if !inList(gen, deps.GeneratedHeaders) {
2340 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2341 }
2342 }
2343
Colin Crossc99deeb2016-04-11 15:06:20 -07002344 return deps
2345}
2346
Dan Albert7e9d2952016-08-04 13:02:36 -07002347func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002348 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002349 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002350 moduleContextImpl: moduleContextImpl{
2351 mod: c,
2352 },
2353 }
2354 ctx.ctx = ctx
2355
Vinh Tran44cb78c2023-03-09 22:07:19 -05002356 if !actx.Host() || !ctx.static() || ctx.staticBinary() {
2357 c.afdo.addDep(ctx, actx)
2358 }
2359
Colin Crossca860ac2016-01-04 14:34:37 -08002360 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002361}
2362
Jiyong Park7ed9de32018-10-15 22:25:07 +09002363// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002364func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002365 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2366 version := name[sharp+1:]
2367 libname := name[:sharp]
2368 return libname, version
2369 }
2370 return name, ""
2371}
2372
Dan Albert92fe7402020-07-15 13:33:30 -07002373func GetCrtVariations(ctx android.BottomUpMutatorContext,
2374 m LinkableInterface) []blueprint.Variation {
2375 if ctx.Os() != android.Android {
2376 return nil
2377 }
2378 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002379 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2380 minSdkVersion := m.MinSdkVersion()
2381 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2382 minSdkVersion = m.SdkVersion()
2383 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002384 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2385 if err != nil {
2386 ctx.PropertyErrorf("min_sdk_version", err.Error())
2387 }
Colin Cross363ec762023-01-13 13:45:14 -08002388
2389 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002390 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002391 if apiLevel.LessThan(minApiForArch) {
2392 apiLevel = minApiForArch
2393 }
2394
Dan Albert92fe7402020-07-15 13:33:30 -07002395 return []blueprint.Variation{
2396 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002397 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002398 }
2399 }
2400 return []blueprint.Variation{
2401 {Mutator: "sdk", Variation: ""},
2402 }
2403}
2404
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002405func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2406 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002407
2408 variations = append([]blueprint.Variation(nil), variations...)
2409
Liz Kammer23942242022-04-08 15:41:00 -04002410 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002411 // Version is explicitly specified. i.e. libFoo#30
2412 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002413 if tag, ok := depTag.(libraryDependencyTag); ok {
2414 tag.explicitlyVersioned = true
2415 } else {
2416 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2417 }
Colin Crosse7257d22020-09-24 09:56:18 -07002418 }
Colin Crosse7257d22020-09-24 09:56:18 -07002419
Colin Cross0de8a1e2020-09-18 14:15:30 -07002420 if far {
2421 ctx.AddFarVariationDependencies(variations, depTag, name)
2422 } else {
2423 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002424 }
2425}
2426
Kiyoung Kim487689e2022-07-26 09:48:22 +09002427func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2428 apiImportInfo := multitree.ApiImportInfo{}
2429
2430 if c.Device() {
2431 var apiImportModule []blueprint.Module
2432 if actx.OtherModuleExists("api_imports") {
2433 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2434 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002435 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002436 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002437 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002438 }
2439 }
2440 }
2441
2442 return apiImportInfo
2443}
2444
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002445func GetSnapshot(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext) SnapshotInfo {
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002446 // Only device modules with BOARD_VNDK_VERSION uses snapshot. Others use the zero value of
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002447 // SnapshotInfo, which provides no mappings.
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002448 if *snapshotInfo == nil && c.Device() {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002449 // Only retrieve the snapshot on demand in order to avoid circular dependencies
2450 // between the modules in the snapshot and the snapshot itself.
2451 var snapshotModule []blueprint.Module
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002452 if c.InVendor() && c.VndkVersion() == actx.DeviceConfig().VndkVersion() && actx.OtherModuleExists("vendor_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002453 snapshotModule = actx.AddVariationDependencies(nil, nil, "vendor_snapshot")
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +09002454 } else if recoverySnapshotVersion := actx.DeviceConfig().RecoverySnapshotVersion(); recoverySnapshotVersion != "current" && recoverySnapshotVersion != "" && c.InRecovery() && actx.OtherModuleExists("recovery_snapshot") {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002455 snapshotModule = actx.AddVariationDependencies(nil, nil, "recovery_snapshot")
2456 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002457 if len(snapshotModule) > 0 && snapshotModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002458 snapshot, _ := android.OtherModuleProvider(actx, snapshotModule[0], SnapshotInfoProvider)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002459 *snapshotInfo = &snapshot
2460 // republish the snapshot for use in later mutators on this module
Colin Cross40213022023-12-13 15:19:49 -08002461 android.SetProvider(actx, SnapshotInfoProvider, snapshot)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002462 }
2463 }
Yi-Yo Chiangec14a4d2021-07-02 21:26:00 +08002464 if *snapshotInfo == nil {
2465 *snapshotInfo = &SnapshotInfo{}
2466 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002467 return **snapshotInfo
2468}
2469
Kiyoung Kim487689e2022-07-26 09:48:22 +09002470func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2471 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002472 return snapshot
2473 }
2474
2475 return lib
2476}
2477
2478// RewriteLibs takes a list of names of shared libraries and scans it for three types
2479// of names:
2480//
2481// 1. Name of an NDK library that refers to a prebuilt module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002482//
2483// For each of these, it adds the name of the prebuilt module (which will be in
2484// prebuilts/ndk) to the list of nonvariant libs.
2485//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002486// 2. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002487//
2488// For each of these, it adds the name of the ndk_library module to the list of
2489// variant libs.
2490//
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002491// 3. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002492//
2493// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002494//
2495// The caller can then know to add the variantLibs dependencies differently from the
2496// nonvariantLibs
2497func RewriteLibs(c LinkableInterface, snapshotInfo **SnapshotInfo, actx android.BottomUpMutatorContext, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
2498 variantLibs = []string{}
2499
2500 nonvariantLibs = []string{}
2501 for _, entry := range list {
2502 // strip #version suffix out
2503 name, _ := StubsLibNameAndVersion(entry)
2504 if c.InRecovery() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002505 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002506 } else if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
2507 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
2508 } else if c.UseVndk() {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002509 nonvariantLibs = append(nonvariantLibs, GetReplaceModuleName(entry, GetSnapshot(c, snapshotInfo, actx).SharedLibs))
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002510 } else {
2511 // put name#version back
2512 nonvariantLibs = append(nonvariantLibs, entry)
2513 }
2514 }
2515 return nonvariantLibs, variantLibs
2516}
2517
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002518func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2519 nonVariantLibs := []string{}
2520 variantLibs := []string{}
2521
2522 for _, lib := range libs {
2523 replaceLibName := GetReplaceModuleName(lib, replaceList)
2524 if replaceLibName == lib {
2525 // Do not handle any libs which are not in API imports
2526 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2527 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2528 variantLibs = append(variantLibs, replaceLibName)
2529 } else {
2530 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2531 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002532 }
2533
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002534 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002535}
2536
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002537func (c *Module) shouldUseApiSurface() bool {
2538 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2539 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2540 // LLNDK Variant
2541 return true
2542 }
2543
2544 if c.Properties.IsSdkVariant {
2545 // NDK Variant
2546 return true
2547 }
2548
2549 if c.isImportedApiLibrary() {
2550 // API Library should depend on API headers
2551 return true
2552 }
2553 }
2554
2555 return false
2556}
2557
Colin Cross1e676be2016-10-12 14:38:15 -07002558func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002559 if !c.Enabled() {
2560 return
2561 }
2562
Colin Cross37047f12016-12-13 17:06:13 -08002563 ctx := &depsContext{
2564 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002565 moduleContextImpl: moduleContextImpl{
2566 mod: c,
2567 },
2568 }
2569 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002570
Colin Crossc99deeb2016-04-11 15:06:20 -07002571 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002572 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002573
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002574 apiNdkLibs := []string{}
2575 apiLateNdkLibs := []string{}
2576
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002577 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002578 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2579 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2580 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2581 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2582 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002583 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002584
Yo Chiang219968c2020-09-22 18:45:04 +08002585 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2586
Colin Crosse0edaf92021-01-11 17:31:17 -08002587 var snapshotInfo *SnapshotInfo
Colin Crosse0edaf92021-01-11 17:31:17 -08002588
Dan Albert914449f2016-06-17 16:45:24 -07002589 variantNdkLibs := []string{}
2590 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002591 if ctx.Os() == android.Android {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002592 deps.SharedLibs, variantNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.SharedLibs)
2593 deps.LateSharedLibs, variantLateNdkLibs = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.LateSharedLibs)
2594 deps.ReexportSharedLibHeaders, _ = RewriteLibs(c, &snapshotInfo, actx, ctx.Config(), deps.ReexportSharedLibHeaders)
Colin Crosse0edaf92021-01-11 17:31:17 -08002595
2596 for idx, lib := range deps.RuntimeLibs {
Kiyoung Kim487689e2022-07-26 09:48:22 +09002597 deps.RuntimeLibs[idx] = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).SharedLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002598 }
Dan Willemsen72d39932016-07-08 23:23:48 -07002599 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002600
Colin Cross32ec36c2016-12-15 07:39:51 -08002601 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002602 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002603 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002604 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002605 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002606
Kiyoung Kim51279d32022-08-24 14:10:46 +09002607 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002608 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002609 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2610 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002611 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).HeaderLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002612
Spandan Das73bcafc2022-08-18 23:26:00 +00002613 if c.isNDKStubLibrary() {
2614 // ndk_headers do not have any variations
2615 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002616 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002617 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002618 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002619 } else {
2620 actx.AddVariationDependencies(nil, depTag, lib)
2621 }
2622 }
2623
Dan Albertf1d14c72020-07-30 14:32:55 -07002624 if c.isNDKStubLibrary() {
2625 // NDK stubs depend on their implementation because the ABI dumps are
2626 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002627
Spandan Das8b08aea2023-03-14 19:29:34 +00002628 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2629 c.ImageVariation(),
2630 blueprint.Variation{Mutator: "link", Variation: "shared"},
2631 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002632 }
2633
Jiyong Park5d1598f2019-02-25 22:14:17 +09002634 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002635 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002636
Kiyoung Kim487689e2022-07-26 09:48:22 +09002637 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002638
Jiyong Park5d1598f2019-02-25 22:14:17 +09002639 actx.AddVariationDependencies([]blueprint.Variation{
2640 {Mutator: "link", Variation: "static"},
2641 }, depTag, lib)
2642 }
2643
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002644 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002645 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002646 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002647 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002648 }
Jiyong Parke3867542020-12-03 17:28:25 +09002649 if inList(lib, deps.ExcludeLibsForApex) {
2650 depTag.excludeInApex = true
2651 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002652
Kiyoung Kim487689e2022-07-26 09:48:22 +09002653 lib = GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs)
Inseob Kimeec88e12020-01-22 11:11:29 +09002654
Dan Willemsen59339a22018-07-22 21:18:45 -07002655 actx.AddVariationDependencies([]blueprint.Variation{
2656 {Mutator: "link", Variation: "static"},
2657 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002658 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002659
Jooyung Han75568392020-03-20 04:29:24 +09002660 // staticUnwinderDep is treated as staticDep for Q apexes
2661 // so that native libraries/binaries are linked with static unwinder
2662 // because Q libc doesn't have unwinder APIs
2663 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002664 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002665 actx.AddVariationDependencies([]blueprint.Variation{
2666 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002667 }, depTag, GetReplaceModuleName(staticUnwinder(actx), GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002668 }
2669
Jiyong Park7ed9de32018-10-15 22:25:07 +09002670 // shared lib names without the #version suffix
2671 var sharedLibNames []string
2672
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002673 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002674 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002675 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002676 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002677 }
Jiyong Parke3867542020-12-03 17:28:25 +09002678 if inList(lib, deps.ExcludeLibsForApex) {
2679 depTag.excludeInApex = true
2680 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002681 if inList(lib, deps.ExcludeLibsForNonApex) {
2682 depTag.excludeInNonApex = true
2683 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002684
Jiyong Park73c54ee2019-10-22 20:31:18 +09002685 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002686 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2687 name = apiLibraryName
2688 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002689 sharedLibNames = append(sharedLibNames, name)
2690
Colin Crosse7257d22020-09-24 09:56:18 -07002691 variations := []blueprint.Variation{
2692 {Mutator: "link", Variation: "shared"},
2693 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002694
2695 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2696 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2697 }
2698
2699 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2700 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2701 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002702 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002703
Colin Crossfe9acfe2021-06-14 16:13:03 -07002704 for _, lib := range deps.LateStaticLibs {
2705 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2706 actx.AddVariationDependencies([]blueprint.Variation{
2707 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002708 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Crossfe9acfe2021-06-14 16:13:03 -07002709 }
2710
Colin Cross3e5e7782022-06-17 22:17:05 +00002711 for _, lib := range deps.UnexportedStaticLibs {
2712 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2713 actx.AddVariationDependencies([]blueprint.Variation{
2714 {Mutator: "link", Variation: "static"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002715 }, depTag, GetReplaceModuleName(lib, GetSnapshot(c, &snapshotInfo, actx).StaticLibs))
Colin Cross3e5e7782022-06-17 22:17:05 +00002716 }
2717
Jiyong Park7ed9de32018-10-15 22:25:07 +09002718 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002719 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002720 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2721 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2722 // linking against both the stubs lib and the non-stubs lib at the same time.
2723 continue
2724 }
Colin Cross6e511a92020-07-27 21:26:48 -07002725 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002726 variations := []blueprint.Variation{
2727 {Mutator: "link", Variation: "shared"},
2728 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002729 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002730 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002731
Dan Willemsen59339a22018-07-22 21:18:45 -07002732 actx.AddVariationDependencies([]blueprint.Variation{
2733 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002734 }, dataLibDepTag, deps.DataLibs...)
2735
Colin Crossc8caa062021-09-24 16:50:14 -07002736 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2737
Chris Parsons79d66a52020-06-05 17:26:16 -04002738 actx.AddVariationDependencies([]blueprint.Variation{
2739 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002740 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002741
Colin Cross68861832016-07-08 10:41:41 -07002742 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002743
2744 for _, gen := range deps.GeneratedHeaders {
2745 depTag := genHeaderDepTag
2746 if inList(gen, deps.ReexportGeneratedHeaders) {
2747 depTag = genHeaderExportDepTag
2748 }
2749 actx.AddDependency(c, depTag, gen)
2750 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002751
Dan Albert92fe7402020-07-15 13:33:30 -07002752 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002753 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002754 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002755 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002756 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Crossca860ac2016-01-04 14:34:37 -08002757 }
Colin Crossc465efd2021-06-11 18:00:04 -07002758 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002759 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim487689e2022-07-26 09:48:22 +09002760 GetReplaceModuleName(crt, GetSnapshot(c, &snapshotInfo, actx).Objects))
Colin Cross21b9a242015-03-24 14:15:58 -07002761 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002762 if deps.DynamicLinker != "" {
2763 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002764 }
Dan Albert914449f2016-06-17 16:45:24 -07002765
2766 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002767
2768 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002769 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002770 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002771 {Mutator: "link", Variation: "shared"},
2772 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002773 actx.AddVariationDependencies([]blueprint.Variation{
2774 {Mutator: "version", Variation: version},
2775 {Mutator: "link", Variation: "shared"},
2776 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002777
2778 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002779 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002780 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002781 {Mutator: "link", Variation: "shared"},
2782 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002783 actx.AddVariationDependencies([]blueprint.Variation{
2784 {Mutator: "version", Variation: version},
2785 {Mutator: "link", Variation: "shared"},
2786 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002787
2788 if vndkdep := c.vndkdep; vndkdep != nil {
2789 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002790 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002791 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002792 {Mutator: "link", Variation: "shared"},
Kiyoung Kim487689e2022-07-26 09:48:22 +09002793 }, vndkExtDepTag, GetReplaceModuleName(vndkdep.getVndkExtendsModuleName(), GetSnapshot(c, &snapshotInfo, actx).SharedLibs))
Logan Chienf3511742017-10-31 18:04:35 +08002794 }
2795 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002796
Vinh Tran367d89d2023-04-28 11:21:25 -04002797 if len(deps.AidlLibs) > 0 {
2798 actx.AddDependency(
2799 c,
2800 aidlLibraryTag,
2801 deps.AidlLibs...,
2802 )
2803 }
2804
Kiyoung Kimee58c932022-10-25 22:59:41 +09002805 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002806}
Colin Cross21b9a242015-03-24 14:15:58 -07002807
Colin Crosse40b4ea2018-10-02 22:25:58 -07002808func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002809 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2810 c.beginMutator(ctx)
2811 }
2812}
2813
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002814// Whether a module can link to another module, taking into
2815// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002816func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002817 tag blueprint.DependencyTag) {
2818
2819 switch t := tag.(type) {
2820 case dependencyTag:
2821 if t != vndkExtDepTag {
2822 return
2823 }
2824 case libraryDependencyTag:
2825 default:
2826 return
2827 }
2828
Ivan Lozanof9e21722020-12-02 09:00:51 -05002829 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002830 // Host code is not restricted
2831 return
2832 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002833
2834 // VNDK is cc.Module supported only for now.
2835 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002836 // Though allowed dependency is limited by the image mutator,
2837 // each vendor and product module needs to check link-type
2838 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002839 if ccTo, ok := to.(*Module); ok {
2840 if ccFrom.vndkdep != nil {
2841 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2842 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002843 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002844 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002845 }
2846 return
2847 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002848 // TODO(b/244244438) : Remove this once all variants are implemented
2849 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2850 return
2851 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002852 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002853 // Platform code can link to anything
2854 return
2855 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002856 if from.InRamdisk() {
2857 // Ramdisk code is not NDK
2858 return
2859 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002860 if from.InVendorRamdisk() {
2861 // Vendor ramdisk code is not NDK
2862 return
2863 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002864 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002865 // Recovery code is not NDK
2866 return
2867 }
Colin Cross31076b32020-10-23 17:22:06 -07002868 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002869 if c.NdkPrebuiltStl() {
2870 // These are allowed, but they don't set sdk_version
2871 return
2872 }
2873 if c.StubDecorator() {
2874 // These aren't real libraries, but are the stub shared libraries that are included in
2875 // the NDK.
2876 return
2877 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002878 if c.isImportedApiLibrary() {
2879 // Imported library from the API surface is a stub library built against interface definition.
2880 return
2881 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002882 }
Logan Chien834b9a62019-01-14 15:39:03 +08002883
Ivan Lozano52767be2019-10-18 14:49:46 -07002884 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002885 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2886 // to link to libc++ (non-NDK and without sdk_version).
2887 return
2888 }
2889
Ivan Lozano52767be2019-10-18 14:49:46 -07002890 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002891 // NDK code linking to platform code is never okay.
2892 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002893 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002894 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002895 }
2896
2897 // At this point we know we have two NDK libraries, but we need to
2898 // check that we're not linking against anything built against a higher
2899 // API level, as it is only valid to link against older or equivalent
2900 // APIs.
2901
Inseob Kim01a28722018-04-11 09:48:45 +09002902 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002903 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002904 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002905 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002906 // Current can't be linked against by anything else.
2907 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002908 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002909 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002910 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002911 if err != nil {
2912 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002913 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002914 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002915 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002916 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002917 if err != nil {
2918 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002919 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002920 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002921 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002922
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002923 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002924 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002925 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002926 }
2927 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002928 }
Dan Albert202fe492017-12-15 13:56:59 -08002929
2930 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002931 fromStl := from.SelectedStl()
2932 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002933 if fromStl == "" || toStl == "" {
2934 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002935 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002936 // We can be permissive with the system "STL" since it is only the C++
2937 // ABI layer, but in the future we should make sure that everyone is
2938 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002939 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002940 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002941 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2942 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002943 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002944}
2945
Jooyung Han479ca172020-10-19 18:51:07 +09002946func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2947 if c, ok := ctx.Module().(*Module); ok {
2948 ctx.VisitDirectDeps(func(dep android.Module) {
2949 depTag := ctx.OtherModuleDependencyTag(dep)
2950 ccDep, ok := dep.(LinkableInterface)
2951 if ok {
2952 checkLinkType(ctx, c, ccDep, depTag)
2953 }
2954 })
2955 }
2956}
2957
Jiyong Park5fb8c102018-04-09 12:03:06 +09002958// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002959// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2960// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002961// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002962func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2963 check := func(child, parent android.Module) bool {
2964 to, ok := child.(*Module)
2965 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002966 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002967 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002968
Jooyung Hana70f0672019-01-18 15:20:43 +09002969 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2970 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002971 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002972
Jiyong Park0474e1f2021-01-14 14:26:06 +09002973 // These dependencies are not excercised at runtime. Tracking these will give us
2974 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002975 depTag := ctx.OtherModuleDependencyTag(child)
2976 if IsHeaderDepTag(depTag) {
2977 return false
2978 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002979 if depTag == staticVariantTag {
2980 return false
2981 }
2982 if depTag == stubImplDepTag {
2983 return false
2984 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002985
Justin Yun63e9ec72020-10-29 16:49:43 +09002986 // Even if target lib has no vendor variant, keep checking dependency
2987 // graph in case it depends on vendor_available or product_available
2988 // but not double_loadable transtively.
2989 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002990 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002991 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002992
Jiyong Park0474e1f2021-01-14 14:26:06 +09002993 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2994 // one.
2995 if Bool(to.VendorProperties.Double_loadable) {
2996 return true
2997 }
2998
Ivan Lozanod7586b62021-04-01 09:49:36 -04002999 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003000 return false
3001 }
3002
Jooyung Hana70f0672019-01-18 15:20:43 +09003003 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3004 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003005 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003006 return false
3007 }
3008 if module, ok := ctx.Module().(*Module); ok {
3009 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003010 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003011 ctx.WalkDeps(check)
3012 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003013 }
3014 }
3015}
3016
Yu Liue4312402023-01-18 09:15:31 -08003017func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3018 // For the dependency from platform to apex, use the latest stubs
3019 apexSdkVersion := android.FutureApiLevel
3020 if !apexInfo.IsForPlatform() {
3021 apexSdkVersion = apexInfo.MinSdkVersion
3022 }
3023
3024 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3025 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3026 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3027 // (b/144430859)
3028 apexSdkVersion = android.FutureApiLevel
3029 }
3030
3031 return apexSdkVersion
3032}
3033
Colin Crossc99deeb2016-04-11 15:06:20 -07003034// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003035func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003036 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003037
Colin Cross0de8a1e2020-09-18 14:15:30 -07003038 var directStaticDeps []StaticLibraryInfo
3039 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003040
Colin Cross0de8a1e2020-09-18 14:15:30 -07003041 reexportExporter := func(exporter FlagExporterInfo) {
3042 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3043 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3044 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3045 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3046 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003047 }
3048
Colin Crossff694a82023-12-13 15:54:49 -08003049 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003050 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003051
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003052 skipModuleList := map[string]bool{}
3053
3054 var apiImportInfo multitree.ApiImportInfo
3055 hasApiImportInfo := false
3056
3057 ctx.VisitDirectDeps(func(dep android.Module) {
3058 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003059 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003060 hasApiImportInfo = true
3061 }
3062 })
3063
3064 if hasApiImportInfo {
3065 targetStubModuleList := map[string]string{}
3066 targetOrigModuleList := map[string]string{}
3067
3068 // Search for dependency which both original module and API imported library with APEX stub exists
3069 ctx.VisitDirectDeps(func(dep android.Module) {
3070 depName := ctx.OtherModuleName(dep)
3071 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3072 targetStubModuleList[apiLibrary] = depName
3073 }
3074 })
3075 ctx.VisitDirectDeps(func(dep android.Module) {
3076 depName := ctx.OtherModuleName(dep)
3077 if origLibrary, ok := targetStubModuleList[depName]; ok {
3078 targetOrigModuleList[origLibrary] = depName
3079 }
3080 })
3081
3082 // Decide which library should be used between original and API imported library
3083 ctx.VisitDirectDeps(func(dep android.Module) {
3084 depName := ctx.OtherModuleName(dep)
3085 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003086 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003087 skipModuleList[depName] = true
3088 } else {
3089 skipModuleList[apiLibrary] = true
3090 }
3091 }
3092 })
3093 }
3094
Colin Crossd11fcda2017-10-23 17:59:01 -07003095 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003096 depName := ctx.OtherModuleName(dep)
3097 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003098
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003099 if _, ok := skipModuleList[depName]; ok {
3100 // skip this module because original module or API imported module matching with this should be used instead.
3101 return
3102 }
3103
Dan Willemsen47450072021-10-19 20:24:49 -07003104 if depTag == android.DarwinUniversalVariantTag {
3105 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3106 return
3107 }
3108
Vinh Tran367d89d2023-04-28 11:21:25 -04003109 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003110 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003111 depPaths.AidlLibraryInfos = append(
3112 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003113 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003114 )
3115 }
3116 }
3117
Ivan Lozano52767be2019-10-18 14:49:46 -07003118 ccDep, ok := dep.(LinkableInterface)
3119 if !ok {
3120
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003121 // handling for a few module types that aren't cc Module but that are also supported
3122 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003123 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003124 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003125 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3126 genRule.GeneratedSourceFiles()...)
3127 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003128 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003129 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003130 // Support exported headers from a generated_sources dependency
3131 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003132 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003133 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003134 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003135 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003136 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003137 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003138 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003139 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003140 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3141 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003142 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003143 // 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 +09003144 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003145
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003146 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003147 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003148 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003149 }
Colin Crosscef792e2021-06-11 18:01:26 -07003150 case CrtBeginDepTag:
3151 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3152 case CrtEndDepTag:
3153 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003154 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003155 return
3156 }
3157
Colin Crossfe17f6f2019-03-28 19:30:56 -07003158 if depTag == android.ProtoPluginDepTag {
3159 return
3160 }
3161
Colin Crossd11fcda2017-10-23 17:59:01 -07003162 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003163 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3164 return
3165 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003166 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003167 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3168 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003169 return
3170 }
3171
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003172 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003173 // Skip reused objects for stub libraries, they use their own stub object file instead.
3174 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3175 // version mutator, so the stubs variant is created from the shared variant that
3176 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003177 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003178 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003179 objs := staticAnalogue.ReuseObjects
3180 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003181 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003182 reexportExporter(depExporterInfo)
3183 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003184 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003185 }
3186
Colin Cross6e511a92020-07-27 21:26:48 -07003187 linkFile := ccDep.OutputFile()
3188
3189 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3190 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003191 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003192 return
3193 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003194
Jiyong Parke3867542020-12-03 17:28:25 +09003195 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3196 return
3197 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003198 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3199 return
3200 }
Jiyong Parke3867542020-12-03 17:28:25 +09003201
Colin Cross313aa542023-12-13 13:47:44 -08003202 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003203
Colin Cross6e511a92020-07-27 21:26:48 -07003204 var ptr *android.Paths
3205 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003206
Colin Cross6e511a92020-07-27 21:26:48 -07003207 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003208
Colin Cross6e511a92020-07-27 21:26:48 -07003209 switch {
3210 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003211 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003212 if !ctx.Config().AllowMissingDependencies() {
3213 ctx.ModuleErrorf("module %q is not a header library", depName)
3214 } else {
3215 ctx.AddMissingDependencies([]string{depName})
3216 }
3217 return
3218 }
Colin Cross6e511a92020-07-27 21:26:48 -07003219 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003220 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003221 if !ctx.Config().AllowMissingDependencies() {
3222 ctx.ModuleErrorf("module %q is not a shared library", depName)
3223 } else {
3224 ctx.AddMissingDependencies([]string{depName})
3225 }
3226 return
3227 }
Jiyong Parke3867542020-12-03 17:28:25 +09003228
Jiyong Park7d55b612021-06-11 17:22:09 +09003229 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3230 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003231
Jiyong Park1ad8e162020-12-01 23:40:09 +09003232 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3233 // linkFile, depFile, and ptr.
3234 if c.IsStubs() {
3235 break
3236 }
3237
Colin Cross0de8a1e2020-09-18 14:15:30 -07003238 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3239 depFile = sharedLibraryInfo.TableOfContents
3240
Colin Cross6e511a92020-07-27 21:26:48 -07003241 ptr = &depPaths.SharedLibs
3242 switch libDepTag.Order {
3243 case earlyLibraryDependency:
3244 ptr = &depPaths.EarlySharedLibs
3245 depPtr = &depPaths.EarlySharedLibsDeps
3246 case normalLibraryDependency:
3247 ptr = &depPaths.SharedLibs
3248 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003249 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003250 case lateLibraryDependency:
3251 ptr = &depPaths.LateSharedLibs
3252 depPtr = &depPaths.LateSharedLibsDeps
3253 default:
3254 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003255 }
Colin Cross6e511a92020-07-27 21:26:48 -07003256 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003257 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3258 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003259 if !ctx.Config().AllowMissingDependencies() {
3260 ctx.ModuleErrorf("module %q is not a static library", depName)
3261 } else {
3262 ctx.AddMissingDependencies([]string{depName})
3263 }
3264 return
3265 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003266
3267 // Stubs lib doesn't link to the static lib dependencies. Don't set
3268 // linkFile, depFile, and ptr.
3269 if c.IsStubs() {
3270 break
3271 }
3272
Colin Cross0de8a1e2020-09-18 14:15:30 -07003273 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003274 if libDepTag.wholeStatic {
3275 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003276 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3277 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003278 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003279 // This case normally catches prebuilt static
3280 // libraries, but it can also occur when
3281 // AllowMissingDependencies is on and the
3282 // dependencies has no sources of its own
3283 // but has a whole_static_libs dependency
3284 // on a missing library. We want to depend
3285 // on the .a file so that there is something
3286 // in the dependency tree that contains the
3287 // error rule for the missing transitive
3288 // dependency.
3289 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003290 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003291 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3292 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003293 } else {
3294 switch libDepTag.Order {
3295 case earlyLibraryDependency:
3296 panic(fmt.Errorf("early static libs not suppported"))
3297 case normalLibraryDependency:
3298 // static dependencies will be handled separately so they can be ordered
3299 // using transitive dependencies.
3300 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003301 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003302 case lateLibraryDependency:
3303 ptr = &depPaths.LateStaticLibs
3304 default:
3305 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003306 }
3307 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003308 if libDepTag.unexportedSymbols {
3309 depPaths.LdFlags = append(depPaths.LdFlags,
3310 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3311 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003312 }
3313
Colin Cross6e511a92020-07-27 21:26:48 -07003314 if libDepTag.static() && !libDepTag.wholeStatic {
3315 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3316 ctx.ModuleErrorf("module %q not a static library", depName)
3317 return
3318 }
Logan Chien43d34c32017-12-20 01:17:32 +08003319
Colin Cross6e511a92020-07-27 21:26:48 -07003320 // When combining coverage files for shared libraries and executables, coverage files
3321 // in static libraries act as if they were whole static libraries. The same goes for
3322 // source based Abi dump files.
3323 if c, ok := ccDep.(*Module); ok {
3324 staticLib := c.linker.(libraryInterface)
3325 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3326 staticLib.objs().coverageFiles...)
3327 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3328 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003329 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003330 // Handle non-CC modules here
3331 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003332 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003333 }
3334 }
3335
Colin Cross6e511a92020-07-27 21:26:48 -07003336 if ptr != nil {
3337 if !linkFile.Valid() {
3338 if !ctx.Config().AllowMissingDependencies() {
3339 ctx.ModuleErrorf("module %q missing output file", depName)
3340 } else {
3341 ctx.AddMissingDependencies([]string{depName})
3342 }
3343 return
3344 }
3345 *ptr = append(*ptr, linkFile.Path())
3346 }
3347
3348 if depPtr != nil {
3349 dep := depFile
3350 if !dep.Valid() {
3351 dep = linkFile
3352 }
3353 *depPtr = append(*depPtr, dep.Path())
3354 }
3355
Colin Cross0de8a1e2020-09-18 14:15:30 -07003356 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3357 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3358 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3359 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
3360
3361 if libDepTag.reexportFlags {
3362 reexportExporter(depExporterInfo)
3363 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3364 // Re-exported shared library headers must be included as well since they can help us with type information
3365 // about template instantiations (instantiated from their headers).
3366 // -isystem headers are not included since for bionic libraries, abi-filtering is taken care of by version
3367 // scripts.
3368 c.sabi.Properties.ReexportedIncludes = append(
3369 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
3370 }
3371
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003372 makeLibName := MakeLibName(ctx, c, ccDep, depName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003373 switch {
3374 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003375 c.Properties.AndroidMkHeaderLibs = append(
3376 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003377 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003378 if lib := moduleLibraryInterface(dep); lib != nil {
3379 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003380 // Add the dependency to the APEX(es) providing the library so that
3381 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003382 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003383 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003384 c.Properties.ApexesProvidingSharedLibs = append(
3385 c.Properties.ApexesProvidingSharedLibs, an)
3386 }
3387 }
3388 }
3389
3390 // Note: the order of libs in this list is not important because
3391 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003392 c.Properties.AndroidMkSharedLibs = append(
3393 c.Properties.AndroidMkSharedLibs, makeLibName)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003394 // Record BaseLibName for snapshots.
3395 c.Properties.SnapshotSharedLibs = append(c.Properties.SnapshotSharedLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003396 case libDepTag.static():
3397 if libDepTag.wholeStatic {
3398 c.Properties.AndroidMkWholeStaticLibs = append(
3399 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3400 } else {
3401 c.Properties.AndroidMkStaticLibs = append(
3402 c.Properties.AndroidMkStaticLibs, makeLibName)
3403 }
Justin Yun5e035862021-06-29 20:50:37 +09003404 // Record BaseLibName for snapshots.
3405 c.Properties.SnapshotStaticLibs = append(c.Properties.SnapshotStaticLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003406 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003407 } else if !c.IsStubs() {
3408 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3409
Colin Cross6e511a92020-07-27 21:26:48 -07003410 switch depTag {
3411 case runtimeDepTag:
3412 c.Properties.AndroidMkRuntimeLibs = append(
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003413 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, depName)+libDepTag.makeSuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003414 // Record BaseLibName for snapshots.
3415 c.Properties.SnapshotRuntimeLibs = append(c.Properties.SnapshotRuntimeLibs, BaseLibName(depName))
Colin Cross6e511a92020-07-27 21:26:48 -07003416 case objDepTag:
3417 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3418 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003419 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003420 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003421 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003422 case dynamicLinkerDepTag:
3423 depPaths.DynamicLinker = linkFile
3424 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003425 }
Colin Crossca860ac2016-01-04 14:34:37 -08003426 })
3427
Jeff Gaston294356f2017-09-27 17:05:30 -07003428 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003429 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3430 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3431 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003432
Colin Crossdd84e052017-05-17 13:44:16 -07003433 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003434 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003435 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3436 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003437 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Jiyong Park74955042019-10-22 20:19:51 +09003438 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3439 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003440 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003441 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003442 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003443
3444 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003445 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003446 }
Colin Crossdd84e052017-05-17 13:44:16 -07003447
Colin Crossca860ac2016-01-04 14:34:37 -08003448 return depPaths
3449}
3450
Spandan Das604f3762023-03-16 22:51:40 +00003451func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003452 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003453 thisModule, ok := ctx.Module().(android.ApexModule)
3454 if !ok {
3455 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3456 }
3457
Kiyoung Kimaa394802024-01-08 12:55:45 +09003458 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003459 bootstrap := false
3460 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3461 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3462 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003463 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003464 bootstrap = linkable.Bootstrap()
3465 }
3466
Colin Crossff694a82023-12-13 15:54:49 -08003467 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003468
3469 useStubs := false
3470
Kiyoung Kimaa394802024-01-08 12:55:45 +09003471 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003472 if !apexInfo.IsForPlatform() {
3473 // For platform libraries, use current version of LLNDK
3474 // If this is for use_vendor apex we will apply the same rules
3475 // of apex sdk enforcement below to choose right version.
3476 useStubs = true
3477 }
3478 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3479 // If not building for APEX or the containing APEX allows the use of
3480 // platform APIs, use stubs only when it is from an APEX (and not from
3481 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3482 // bootstrap modules, always link to non-stub variant
3483 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3484
3485 isApexImportedApiLibrary := false
3486
3487 if cc, ok := dep.(*Module); ok {
3488 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3489 if apiLibrary.hasApexStubs() {
3490 isApexImportedApiLibrary = true
3491 }
3492 }
3493 }
3494
3495 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3496
3497 if useStubs {
3498 // Another exception: if this module is a test for an APEX, then
3499 // it is linked with the non-stub variant of a module in the APEX
3500 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003501 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003502 for _, apexContents := range testFor.ApexContents {
3503 if apexContents.DirectlyInApex(depName) {
3504 useStubs = false
3505 break
3506 }
3507 }
3508 }
3509 if useStubs {
3510 // Yet another exception: If this module and the dependency are
3511 // available to the same APEXes then skip stubs between their
3512 // platform variants. This complements the test_for case above,
3513 // which avoids the stubs on a direct APEX library dependency, by
3514 // avoiding stubs for indirect test dependencies as well.
3515 //
3516 // TODO(b/183882457): This doesn't work if the two libraries have
3517 // only partially overlapping apex_available. For that test_for
3518 // modules would need to be split into APEX variants and resolved
3519 // separately for each APEX they have access to.
3520 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3521 useStubs = false
3522 }
3523 }
3524 } else {
3525 // If building for APEX, use stubs when the parent is in any APEX that
3526 // the child is not in.
3527 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3528 }
3529
3530 return useStubs
3531}
3532
3533// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3534// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3535// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3536// has different level of updatability. For example, if a library foo in an APEX depends on a
3537// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3538// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3539// same APEX as foo, the non-stub variant of bar is used.
3540func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3541 depTag := ctx.OtherModuleDependencyTag(dep)
3542 libDepTag, ok := depTag.(libraryDependencyTag)
3543 if !ok || !libDepTag.shared() {
3544 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3545 }
3546
Colin Cross313aa542023-12-13 13:47:44 -08003547 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3548 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3549 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003550
3551 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003552 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003553 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003554 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3555 toUse := stubs[len(stubs)-1]
3556 sharedLibraryInfo = toUse.SharedLibraryInfo
3557 depExporterInfo = toUse.FlagExporterInfo
3558 }
3559 }
3560 return sharedLibraryInfo, depExporterInfo
3561}
3562
Colin Cross0de8a1e2020-09-18 14:15:30 -07003563// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3564// to match the topological order of the dependency tree, including any static analogues of
3565// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3566// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003567func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3568 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003569 var staticPaths android.Paths
3570 for _, staticDep := range staticDeps {
3571 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3572 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3573 }
3574 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003575 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3576 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003577 }
3578 }
3579 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3580
3581 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3582
3583 // reorder the dependencies based on transitive dependencies
3584 staticPaths = android.FirstUniquePaths(staticPaths)
3585 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3586
3587 if len(orderedStaticPaths) != len(staticPaths) {
3588 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3589 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3590 }
3591
3592 return orderedStaticPaths, transitiveStaticLibs
3593}
3594
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003595// BaseLibName trims known prefixes and suffixes
3596func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003597 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3598 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003599 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003600 return libName
3601}
3602
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003603func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003604 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003605 ccDepModule, _ := ccDep.(*Module)
3606 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003607 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003608
Justin Yuncbca3732021-02-03 19:24:13 +09003609 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003610 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003611 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003612 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003613
Ivan Lozanod1dec542021-05-26 15:33:11 -04003614 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003615 }
3616 }
3617
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003618 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3619 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003620 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3621 // core module instead.
3622 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003623 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003624 // The vendor and product modules in Make will have been renamed to not conflict with the
3625 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003626 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003627 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003628 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003629 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003630 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003631 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003632 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003633 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003634 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003635 } else {
3636 return libName
3637 }
3638}
3639
Colin Crossca860ac2016-01-04 14:34:37 -08003640func (c *Module) InstallInData() bool {
3641 if c.installer == nil {
3642 return false
3643 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003644 return c.installer.inData()
3645}
3646
3647func (c *Module) InstallInSanitizerDir() bool {
3648 if c.installer == nil {
3649 return false
3650 }
3651 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003652 return true
3653 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003654 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003655}
3656
Yifan Hong1b3348d2020-01-21 15:53:22 -08003657func (c *Module) InstallInRamdisk() bool {
3658 return c.InRamdisk()
3659}
3660
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003661func (c *Module) InstallInVendorRamdisk() bool {
3662 return c.InVendorRamdisk()
3663}
3664
Jiyong Parkf9332f12018-02-01 00:54:12 +09003665func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003666 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003667}
3668
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003669func (c *Module) MakeUninstallable() {
3670 if c.installer == nil {
3671 c.ModuleBase.MakeUninstallable()
3672 return
3673 }
3674 c.installer.makeUninstallable(c)
3675}
3676
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003677func (c *Module) HostToolPath() android.OptionalPath {
3678 if c.installer == nil {
3679 return android.OptionalPath{}
3680 }
3681 return c.installer.hostToolPath()
3682}
3683
Nan Zhangd4e641b2017-07-12 12:55:28 -07003684func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3685 return c.outputFile
3686}
3687
Colin Cross41955e82019-05-29 14:40:35 -07003688func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3689 switch tag {
3690 case "":
3691 if c.outputFile.Valid() {
3692 return android.Paths{c.outputFile.Path()}, nil
3693 }
3694 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003695 case "unstripped":
3696 if c.linker != nil {
3697 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3698 }
3699 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003700 case "stripped_all":
3701 if c.linker != nil {
3702 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3703 }
3704 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003705 default:
3706 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003707 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003708}
3709
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003710func (c *Module) static() bool {
3711 if static, ok := c.linker.(interface {
3712 static() bool
3713 }); ok {
3714 return static.static()
3715 }
3716 return false
3717}
3718
Jiyong Park379de2f2018-12-19 02:47:14 +09003719func (c *Module) staticBinary() bool {
3720 if static, ok := c.linker.(interface {
3721 staticBinary() bool
3722 }); ok {
3723 return static.staticBinary()
3724 }
3725 return false
3726}
3727
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003728func (c *Module) testBinary() bool {
3729 if test, ok := c.linker.(interface {
3730 testBinary() bool
3731 }); ok {
3732 return test.testBinary()
3733 }
3734 return false
3735}
3736
Jingwen Chen537242c2022-08-24 11:53:27 +00003737func (c *Module) testLibrary() bool {
3738 if test, ok := c.linker.(interface {
3739 testLibrary() bool
3740 }); ok {
3741 return test.testLibrary()
3742 }
3743 return false
3744}
3745
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003746func (c *Module) benchmarkBinary() bool {
3747 if b, ok := c.linker.(interface {
3748 benchmarkBinary() bool
3749 }); ok {
3750 return b.benchmarkBinary()
3751 }
3752 return false
3753}
3754
3755func (c *Module) fuzzBinary() bool {
3756 if f, ok := c.linker.(interface {
3757 fuzzBinary() bool
3758 }); ok {
3759 return f.fuzzBinary()
3760 }
3761 return false
3762}
3763
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003764// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3765func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003766 if h, ok := c.linker.(interface {
3767 header() bool
3768 }); ok {
3769 return h.header()
3770 }
3771 return false
3772}
3773
Ivan Lozanod7586b62021-04-01 09:49:36 -04003774func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003775 if b, ok := c.linker.(interface {
3776 binary() bool
3777 }); ok {
3778 return b.binary()
3779 }
3780 return false
3781}
3782
Justin Yun5e035862021-06-29 20:50:37 +09003783func (c *Module) StaticExecutable() bool {
3784 if b, ok := c.linker.(*binaryDecorator); ok {
3785 return b.static()
3786 }
3787 return false
3788}
3789
Ivan Lozanod7586b62021-04-01 09:49:36 -04003790func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003791 if o, ok := c.linker.(interface {
3792 object() bool
3793 }); ok {
3794 return o.object()
3795 }
3796 return false
3797}
3798
Ivan Lozanof9e21722020-12-02 09:00:51 -05003799func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003800 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003801 if c.IsLlndk() {
3802 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003803 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003804 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003805 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003806 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003807 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003808 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003809 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003810 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003811 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003812 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003813 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003814 return "native:product"
3815 }
Jooyung Han38002912019-05-16 04:01:54 +09003816 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003817 } else if c.InRamdisk() {
3818 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003819 } else if c.InVendorRamdisk() {
3820 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003821 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003822 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003823 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003824 return "native:ndk:none:none"
3825 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3826 //family, link := getNdkStlFamilyAndLinkType(c)
3827 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003828 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003829 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003830 } else {
3831 return "native:platform"
3832 }
3833}
3834
Jiyong Park9d452992018-10-03 00:38:19 +09003835// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003836// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003837func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003838 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003839 // Stub libs and prebuilt libs in a versioned SDK are not
3840 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003841 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003842 } else if _, ok := c.linker.(testPerSrc); ok {
3843 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003844 }
3845 return false
3846}
3847
Jiyong Parka90ca002019-10-07 15:47:24 +09003848func (c *Module) AvailableFor(what string) bool {
3849 if linker, ok := c.linker.(interface {
3850 availableFor(string) bool
3851 }); ok {
3852 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3853 } else {
3854 return c.ApexModuleBase.AvailableFor(what)
3855 }
3856}
3857
Jiyong Park62304bb2020-04-13 16:19:48 +09003858func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003859 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003860}
3861
Paul Duffin0cb37b92020-03-04 14:52:46 +00003862func (c *Module) EverInstallable() bool {
3863 return c.installer != nil &&
3864 // Check to see whether the module is actually ever installable.
3865 c.installer.everInstallable()
3866}
3867
Ivan Lozanod7586b62021-04-01 09:49:36 -04003868func (c *Module) PreventInstall() bool {
3869 return c.Properties.PreventInstall
3870}
3871
3872func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003873 if c.library != nil {
3874 if i := c.library.installable(); i != nil {
3875 return i
3876 }
3877 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003878 return c.Properties.Installable
3879}
3880
3881func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003882 ret := c.EverInstallable() &&
3883 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003884 proptools.BoolDefault(c.Installable(), true) &&
3885 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003886
3887 // The platform variant doesn't need further condition. Apex variants however might not
3888 // be installable because it will likely to be included in the APEX and won't appear
3889 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003890 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003891 return ret
3892 }
3893
3894 // Special case for modules that are configured to be installed to /data, which includes
3895 // test modules. For these modules, both APEX and non-APEX variants are considered as
3896 // installable. This is because even the APEX variants won't be included in the APEX, but
3897 // will anyway be installed to /data/*.
3898 // See b/146995717
3899 if c.InstallInData() {
3900 return ret
3901 }
3902
3903 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003904}
3905
Logan Chien41eabe62019-04-10 13:33:58 +08003906func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3907 if c.linker != nil {
3908 if library, ok := c.linker.(*libraryDecorator); ok {
3909 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3910 }
3911 }
3912}
3913
Jiyong Park45bf82e2020-12-15 22:29:02 +09003914var _ android.ApexModule = (*Module)(nil)
3915
3916// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003917func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003918 depTag := ctx.OtherModuleDependencyTag(dep)
3919 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3920
3921 if cc, ok := dep.(*Module); ok {
3922 if cc.HasStubsVariants() {
3923 if isLibDepTag && libDepTag.shared() {
3924 // dynamic dep to a stubs lib crosses APEX boundary
3925 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003926 }
Colin Cross6e511a92020-07-27 21:26:48 -07003927 if IsRuntimeDepTag(depTag) {
3928 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003929 return false
3930 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003931 }
Zhijun Heec285872021-04-24 10:47:08 -07003932 if cc.IsLlndk() {
3933 return false
3934 }
Colin Crossaac32222020-07-29 12:51:56 -07003935 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003936 // shared_lib dependency from a static lib is considered as crossing
3937 // the APEX boundary because the dependency doesn't actually is
3938 // linked; the dependency is used only during the compilation phase.
3939 return false
3940 }
Jiyong Parke3867542020-12-03 17:28:25 +09003941
3942 if isLibDepTag && libDepTag.excludeInApex {
3943 return false
3944 }
Colin Cross6e511a92020-07-27 21:26:48 -07003945 }
Colin Crossc1b36442021-05-06 13:42:48 -07003946 if depTag == stubImplDepTag {
3947 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003948 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003949 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003950 if depTag == staticVariantTag {
3951 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3952 // actually mean that the static lib (and its dependencies) are copied into the
3953 // APEX.
3954 return false
3955 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003956 return true
3957}
3958
Jiyong Park45bf82e2020-12-15 22:29:02 +09003959// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003960func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3961 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003962 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3963 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3964 return nil
3965 }
Jooyung Han749dc692020-04-15 11:03:39 +09003966 // We don't check for prebuilt modules
3967 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3968 return nil
3969 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003970
Jooyung Han749dc692020-04-15 11:03:39 +09003971 minSdkVersion := c.MinSdkVersion()
3972 if minSdkVersion == "apex_inherit" {
3973 return nil
3974 }
3975 if minSdkVersion == "" {
3976 // JNI libs within APK-in-APEX fall into here
3977 // Those are okay to set sdk_version instead
3978 // We don't have to check if this is a SDK variant because
3979 // non-SDK variant resets sdk_version, which works too.
3980 minSdkVersion = c.SdkVersion()
3981 }
Dan Albertc8060532020-07-22 22:32:17 -07003982 if minSdkVersion == "" {
3983 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3984 }
3985 // Not using nativeApiLevelFromUser because the context here is not
3986 // necessarily a native context.
3987 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003988 if err != nil {
3989 return err
3990 }
Dan Albertc8060532020-07-22 22:32:17 -07003991
Colin Cross8ca61c12022-10-06 21:00:14 -07003992 // A dependency only needs to support a min_sdk_version at least
3993 // as high as the api level that the architecture was introduced in.
3994 // This allows introducing new architectures in the platform that
3995 // need to be included in apexes that normally require an older
3996 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003997 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003998 if sdkVersion.LessThan(minApiForArch) {
3999 sdkVersion = minApiForArch
4000 }
4001
Dan Albertc8060532020-07-22 22:32:17 -07004002 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004003 return fmt.Errorf("newer SDK(%v)", ver)
4004 }
4005 return nil
4006}
4007
Paul Duffinb5769c12021-05-12 16:16:51 +01004008// Implements android.ApexModule
4009func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4010 // stub libraries and native bridge libraries are always available to platform
4011 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4012}
4013
Jooyung Han91f92032022-02-04 12:36:33 +09004014// Overrides android.ApexModuleBase.UniqueApexVariations
4015func (c *Module) UniqueApexVariations() bool {
4016 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4017 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4018 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004019 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004020 return c.UseVndk() && c.IsVndk()
4021}
4022
Inseob Kima1888ce2022-10-04 14:42:02 +09004023func (c *Module) overriddenModules() []string {
4024 if o, ok := c.linker.(overridable); ok {
4025 return o.overriddenModules()
4026 }
4027 return nil
4028}
4029
Rob Seymour925aa092021-08-10 20:42:03 +00004030var _ snapshot.RelativeInstallPath = (*Module)(nil)
4031
Liz Kammer35ca77e2021-12-22 15:31:40 -05004032type moduleType int
4033
4034const (
4035 unknownType moduleType = iota
4036 binary
4037 object
4038 fullLibrary
4039 staticLibrary
4040 sharedLibrary
4041 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004042 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004043 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004044 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004045)
4046
4047func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004048 if c.testBinary() {
4049 // testBinary is also a binary, so this comes before the c.Binary()
4050 // conditional. A testBinary has additional implicit dependencies and
4051 // other test-only semantics.
4052 return testBin
4053 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004054 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004055 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004056 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004057 } else if c.testLibrary() {
4058 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4059 // will let them add implicit compile deps on gtest, for example.
4060 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004061 // For now, treat them as regular libraries.
4062 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004063 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004064 static := false
4065 shared := false
4066 if library, ok := c.linker.(*libraryDecorator); ok {
4067 static = library.MutatedProperties.BuildStatic
4068 shared = library.MutatedProperties.BuildShared
4069 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4070 static = library.MutatedProperties.BuildStatic
4071 shared = library.MutatedProperties.BuildShared
4072 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004073 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004074 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004075 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004076 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004077 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004078 return staticLibrary
4079 }
4080 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004081 } else if c.isNDKStubLibrary() {
4082 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004083 } else if c.IsNdkPrebuiltStl() {
4084 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004085 }
4086 return unknownType
4087}
4088
Colin Crosscfad1192015-11-02 16:43:11 -08004089// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004090type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004091 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004092 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004093 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004094
4095 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4096 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004097}
4098
Patrice Arrudac249c712019-03-19 17:00:29 -07004099// cc_defaults provides a set of properties that can be inherited by other cc
4100// modules. A module can use the properties from a cc_defaults using
4101// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4102// merged (when possible) by prepending the default module's values to the
4103// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004104func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004105 return DefaultsFactory()
4106}
4107
Colin Cross36242852017-06-23 15:06:31 -07004108func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004109 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004110
Colin Cross36242852017-06-23 15:06:31 -07004111 module.AddProperties(props...)
4112 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004113 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004114 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004115 &BaseCompilerProperties{},
4116 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004117 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004118 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004119 &StaticProperties{},
4120 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004121 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004122 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004123 &TestLinkerProperties{},
4124 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004125 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004126 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004127 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004128 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004129 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004130 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004131 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004132 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004133 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004134 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004135 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004136 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004137 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004138 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004139 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004140 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4141 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004142 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004143 )
Colin Crosscfad1192015-11-02 16:43:11 -08004144
Jooyung Hancc372c52019-09-25 15:18:44 +09004145 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004146
4147 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004148}
4149
Jiyong Park2286afd2020-06-16 21:58:53 +09004150func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004151 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004152}
4153
Kiyoung Kim51279d32022-08-24 14:10:46 +09004154func (c *Module) isImportedApiLibrary() bool {
4155 _, ok := c.linker.(*apiLibraryDecorator)
4156 return ok
4157}
4158
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004159func kytheExtractAllFactory() android.Singleton {
4160 return &kytheExtractAllSingleton{}
4161}
4162
4163type kytheExtractAllSingleton struct {
4164}
4165
4166func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4167 var xrefTargets android.Paths
4168 ctx.VisitAllModules(func(module android.Module) {
4169 if ccModule, ok := module.(xref); ok {
4170 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4171 }
4172 })
4173 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4174 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004175 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004176 }
4177}
4178
Jihoon Kangf78a8902022-09-01 22:47:07 +00004179func (c *Module) Partition() string {
4180 if p, ok := c.installer.(interface {
4181 getPartition() string
4182 }); ok {
4183 return p.getPartition()
4184 }
4185 return ""
4186}
4187
Colin Cross06a931b2015-10-28 17:23:31 -07004188var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004189var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004190var BoolPtr = proptools.BoolPtr
4191var String = proptools.String
4192var StringPtr = proptools.StringPtr