blob: 6dd26821a9c7afd3da929d1c864f5fe780127a7c [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"
Colin Cross3f40fa42015-01-30 17:27:36 -080038)
39
Colin Cross463a90e2015-06-17 14:20:06 -070040func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000041 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070042
Inseob Kim3b244062023-07-11 13:31:36 +090043 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000044 pctx.Import("android/soong/cc/config")
45}
46
47func RegisterCCBuildComponents(ctx android.RegistrationContext) {
48 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
49
50 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossc511bc52020-04-07 16:50:32 +000051 ctx.BottomUp("sdk", sdkMutator).Parallel()
Inseob Kim64c43952019-08-26 16:52:35 +090052 ctx.BottomUp("vndk", VndkMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070053 ctx.BottomUp("link", LinkageMutator).Parallel()
Roland Levillain9b5fde92019-06-28 15:41:19 +010054 ctx.BottomUp("test_per_src", TestPerSrcMutator).Parallel()
Colin Crossd1f898e2020-08-18 18:35:15 -070055 ctx.BottomUp("version", versionMutator).Parallel()
Colin Crosse40b4ea2018-10-02 22:25:58 -070056 ctx.BottomUp("begin", BeginMutator).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070057 })
Colin Cross16b23492016-01-06 14:41:07 -080058
Paul Duffin036e7002019-12-19 19:16:28 +000059 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040060 for _, san := range Sanitizers {
61 san.registerMutators(ctx)
62 }
Dan Willemsen581341d2017-02-09 16:16:31 -080063
Colin Cross0b908332019-06-19 23:00:20 -070064 ctx.TopDown("sanitize_runtime_deps", sanitizerRuntimeDepsMutator).Parallel()
Jiyong Park379de2f2018-12-19 02:47:14 +090065 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator).Parallel()
Ivan Lozano30c5db22018-02-21 15:49:20 -080066
Cory Barkera1da26f2022-06-07 20:12:06 +000067 ctx.TopDown("fuzz_deps", fuzzMutatorDeps)
Cory Barkera1da26f2022-06-07 20:12:06 +000068
Colin Crossf5f4ad32024-01-19 15:41:48 -080069 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070070
Colin Crossd38feb02024-01-23 16:38:06 -080071 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +080072
Colin Cross33e0c812024-01-23 16:36:07 -080073 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000074
Colin Cross6ac83a82024-01-23 11:23:10 -080075 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090076
Jooyung Han479ca172020-10-19 18:51:07 +090077 ctx.BottomUp("check_linktype", checkLinkTypeMutator).Parallel()
Jooyung Hana70f0672019-01-18 15:20:43 +090078 ctx.TopDown("double_loadable", checkDoubleLoadableLibraries).Parallel()
Colin Cross1e676be2016-10-12 14:38:15 -070079 })
Colin Crossb98c8b02016-07-29 13:44:28 -070080
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080081 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
82 // sabi mutator needs to be run after apex mutator finishes.
83 ctx.TopDown("sabi_deps", sabiDepsMutator)
84 })
85
LaMont Jones0c10e4d2023-05-16 00:58:37 +000086 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070087}
88
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050089// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
90// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
91// edges to these modules.
92// This object is constructed in DepsMutator, by calling to various module delegates to set
93// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
94// dependencies.
95// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
96// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080097type Deps struct {
98 SharedLibs, LateSharedLibs []string
99 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800100 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800101 RuntimeLibs []string
Ivan Lozano0a468a42024-05-13 21:03:34 -0400102 Rlibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700103
Colin Cross3e5e7782022-06-17 22:17:05 +0000104 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
105 // prevent automatically exporting symbols.
106 UnexportedStaticLibs []string
107
Chris Parsons79d66a52020-06-05 17:26:16 -0400108 // Used for data dependencies adjacent to tests
109 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700110 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400111
Yo Chiang219968c2020-09-22 18:45:04 +0800112 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
113 SystemSharedLibs []string
114
Vinh Tran367d89d2023-04-28 11:21:25 -0400115 // Used by DepMutator to pass aidl_library modules to aidl compiler
116 AidlLibs []string
117
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500118 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800119 StaticUnwinderIfLegacy bool
120
Colin Cross5950f382016-12-13 12:50:57 -0800121 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700122
Colin Cross81413472016-04-11 14:37:39 -0700123 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700124
Dan Willemsenb40aab62016-04-20 14:21:14 -0700125 GeneratedSources []string
126 GeneratedHeaders []string
Inseob Kimd110f872019-12-06 13:15:38 +0900127 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700128
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700129 ReexportGeneratedHeaders []string
130
Colin Crossc465efd2021-06-11 18:00:04 -0700131 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700132
133 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700134 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900135
136 // List of libs that need to be excluded for APEX variant
137 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900138 // List of libs that need to be excluded for non-APEX variant
139 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800140
141 // LLNDK headers for the ABI checker to check LLNDK implementation library.
142 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
143 // The core variant cannot depend on the vendor variant because of the order of CreateVariations.
144 // Instead, the LLNDK implementation depends on the LLNDK header libs.
145 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700146}
147
Ivan Lozano0a468a42024-05-13 21:03:34 -0400148// A struct which to collect flags for rlib dependencies
149type RustRlibDep struct {
150 LibPath android.Path // path to the rlib
151 LinkDirs []string // flags required for dependency (e.g. -L flags)
152 CrateName string // crateNames associated with rlibDeps
153}
154
155func EqRustRlibDeps(a RustRlibDep, b RustRlibDep) bool {
156 return a.LibPath == b.LibPath
157}
158
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500159// PathDeps is a struct containing file paths to dependencies of a module.
160// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
161// It's used to construct flags for various build statements (such as for compiling and linking).
162// It is then passed to module decorator functions responsible for registering build statements
163// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800164type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700165 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900166 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700167 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900168 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700169 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700170 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400171 // Paths and crateNames for RustStaticLib dependencies
172 RustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700173
Colin Cross0de8a1e2020-09-18 14:15:30 -0700174 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossc85750b2022-04-21 12:50:51 -0700175 TranstiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700176
Colin Cross26c34ed2016-09-30 17:10:16 -0700177 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100178 Objs Objects
179 // Paths to .o files in dependencies that provide them. Note that these lists
180 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800181 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700182 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700183
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100184 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
185 // the libs from all whole_static_lib dependencies.
186 WholeStaticLibsFromPrebuilts android.Paths
187
Colin Cross26c34ed2016-09-30 17:10:16 -0700188 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700189 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900190 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700191
Inseob Kimd110f872019-12-06 13:15:38 +0900192 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000193 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900194 IncludeDirs android.Paths
195 SystemIncludeDirs android.Paths
196 ReexportedDirs android.Paths
197 ReexportedSystemDirs android.Paths
198 ReexportedFlags []string
199 ReexportedGeneratedHeaders android.Paths
200 ReexportedDeps android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400201 ReexportedRustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700202
Colin Cross26c34ed2016-09-30 17:10:16 -0700203 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700204 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700205
Dan Willemsena0790e32018-10-12 00:24:23 -0700206 // Path to the dynamic linker binary
207 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700208
209 // For Darwin builds, the path to the second architecture's output that should
210 // be combined with this architectures's output into a FAT MachO file.
211 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400212
213 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
214 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800215
216 // LLNDK headers for the ABI checker to check LLNDK implementation library.
217 LlndkIncludeDirs android.Paths
218 LlndkSystemIncludeDirs android.Paths
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700219}
220
Colin Cross4af21ed2019-11-04 09:37:55 -0800221// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
222// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
223// command line so they can be overridden by the local module flags).
224type LocalOrGlobalFlags struct {
225 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700226 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800227 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700228 CFlags []string // Flags that apply to C and C++ source files
229 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
230 ConlyFlags []string // Flags that apply to C source files
231 CppFlags []string // Flags that apply to C++ source files
232 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700233 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800234}
235
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500236// Flags contains various types of command line flags (and settings) for use in building build
237// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800238type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500239 // Local flags (which individual modules are responsible for). These may override global flags.
240 Local LocalOrGlobalFlags
241 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700242 Global LocalOrGlobalFlags
243 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800244
245 aidlFlags []string // Flags that apply to aidl source files
246 rsFlags []string // Flags that apply to renderscript source files
247 libFlags []string // Flags to add libraries early to the link order
248 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
249 TidyFlags []string // Flags that apply to clang-tidy
250 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700251
Colin Crossc3199482017-03-30 15:03:04 -0700252 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800253 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700254 SystemIncludeFlags []string
255
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800256 Toolchain config.Toolchain
257 Tidy bool // True if ninja .tidy rules should be generated.
258 NeedTidyFiles bool // True if module link should depend on .tidy files
259 GcovCoverage bool // True if coverage files should be generated.
260 SAbiDump bool // True if header abi dumps should be generated.
261 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
Colin Crossca860ac2016-01-04 14:34:37 -0800262
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500263 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800264 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500265 // The target-device system path to the dynamic linker.
266 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800267
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700268 CFlagsDeps android.Paths // Files depended on by compiler flags
269 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800270
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500271 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700272 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800273
Colin Cross19878da2019-03-28 14:45:07 -0700274 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700275 protoC bool // Whether to use C instead of C++
276 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700277
278 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200279 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700280}
281
Colin Crossca860ac2016-01-04 14:34:37 -0800282// Properties used to compile all C or C++ modules
283type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700284 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800285 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700286
Jiyong Parkb35a8192020-08-10 15:59:36 +0900287 // The API level that this module is built against. The APIs of this API level will be
288 // visible at build time, but use of any APIs newer than min_sdk_version will render the
289 // module unloadable on older devices. In the future it will be possible to weakly-link new
290 // APIs, making the behavior match Java: such modules will load on older devices, but
291 // calling new APIs on devices that do not support them will result in a crash.
292 //
293 // This property has the same behavior as sdk_version does for Java modules. For those
294 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
295 // does for Java code.
296 //
297 // In addition, setting this property causes two variants to be built, one for the platform
298 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800299 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700300
Jiyong Parkb35a8192020-08-10 15:59:36 +0900301 // Minimum OS API level supported by this C or C++ module. This property becomes the value
302 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
303 // this property is also used to ensure that the min_sdk_version of the containing module is
304 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
305 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
306 // min_sdk_version of the containing APEX. When the module
307 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900308 Min_sdk_version *string
309
Colin Crossc511bc52020-04-07 16:50:32 +0000310 // If true, always create an sdk variant and don't create a platform variant.
311 Sdk_variant_only *bool
312
Jiyong Parkde866cb2018-12-07 23:08:36 +0900313 AndroidMkSharedLibs []string `blueprint:"mutated"`
314 AndroidMkStaticLibs []string `blueprint:"mutated"`
Ivan Lozano0a468a42024-05-13 21:03:34 -0400315 AndroidMkRlibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900316 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
317 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700318 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900319 HideFromMake bool `blueprint:"mutated"`
320 PreventInstall bool `blueprint:"mutated"`
321 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700322
Yo Chiang219968c2020-09-22 18:45:04 +0800323 // Set by DepsMutator.
324 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
325
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900326 // The name of the image this module is built for
327 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200328
329 // The VNDK version this module is built against. If empty, the module is not
330 // build against the VNDK.
331 VndkVersion string `blueprint:"mutated"`
332
333 // Suffix for the name of Android.mk entries generated by this module
334 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800335
336 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
337 // file
338 Logtags []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900339
Yifan Hong39143a92020-10-26 12:43:12 -0700340 // Make this module available when building for ramdisk.
341 // On device without a dedicated recovery partition, the module is only
342 // available after switching root into
343 // /first_stage_ramdisk. To expose the module before switching root, install
344 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800345 Ramdisk_available *bool
346
Yifan Hong39143a92020-10-26 12:43:12 -0700347 // Make this module available when building for vendor ramdisk.
348 // On device without a dedicated recovery partition, the module is only
349 // available after switching root into
350 // /first_stage_ramdisk. To expose the module before switching root, install
351 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700352 Vendor_ramdisk_available *bool
353
Jiyong Parkf9332f12018-02-01 00:54:12 +0900354 // Make this module available when building for recovery
355 Recovery_available *bool
356
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200357 // Used by imageMutator, set by ImageMutatorBegin()
358 CoreVariantNeeded bool `blueprint:"mutated"`
359 RamdiskVariantNeeded bool `blueprint:"mutated"`
360 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
361 RecoveryVariantNeeded bool `blueprint:"mutated"`
362
363 // A list of variations for the "image" mutator of the form
364 //<image name> '.' <version char>, for example, 'vendor.S'
365 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900366
367 // Allows this module to use non-APEX version of libraries. Useful
368 // for building binaries that are started before APEXes are activated.
369 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900370
371 // Even if DeviceConfig().VndkUseCoreVariant() is set, this module must use vendor variant.
372 // see soong/cc/config/vndk.go
373 MustUseVendorVariant bool `blueprint:"mutated"`
Inseob Kim8471cda2019-11-15 09:59:12 +0900374
Colin Cross1bc94122021-10-28 13:25:54 -0700375 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000376
377 // Set by factories of module types that can only be referenced from variants compiled against
378 // the SDK.
379 AlwaysSdk bool `blueprint:"mutated"`
380
381 // Variant is an SDK variant created by sdkMutator
382 IsSdkVariant bool `blueprint:"mutated"`
383 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
384 // variant to have a ".sdk" suffix.
385 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700386
Jiyong Park46a512f2020-12-04 18:02:13 +0900387 // List of APEXes that this module has private access to for testing purpose. The module
388 // can depend on libraries that are not exported by the APEXes and use private symbols
389 // from the exported libraries.
Martin Stjernholm855e90b2021-03-25 02:33:14 +0000390 Test_for []string `android:"arch_variant"`
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800391
392 Target struct {
393 Platform struct {
394 // List of modules required by the core variant.
395 Required []string `android:"arch_variant"`
396
397 // List of modules not required by the core variant.
398 Exclude_required []string `android:"arch_variant"`
399 } `android:"arch_variant"`
400
401 Recovery struct {
402 // List of modules required by the recovery variant.
403 Required []string `android:"arch_variant"`
404
405 // List of modules not required by the recovery variant.
406 Exclude_required []string `android:"arch_variant"`
407 } `android:"arch_variant"`
408 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700409}
410
411type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900412 // whether this module should be allowed to be directly depended by other
413 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900414 // If set to true, two variants will be built separately, one like
415 // normal, and the other limited to the set of libraries and headers
416 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700417 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900418 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700419 // so it shouldn't have any unversioned runtime dependencies, or
420 // make assumptions about the system that may not be true in the
421 // future.
422 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900423 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900424 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900425 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900426 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900427 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700428 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
429 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900430
Justin Yunebcf0c52021-01-08 18:00:19 +0900431 // This is the same as the "vendor_available" except that the install path
432 // of the vendor variant is /odm or /vendor/odm.
433 // By replacing "vendor_available: true" with "odm_available: true", the
434 // module will install its vendor variant to the /odm partition or /vendor/odm.
435 // As the modules with "odm_available: true" still create the vendor variants,
436 // they can link to the other vendor modules as the vendor_available modules do.
437 // Also, the vendor modules can link to odm_available modules.
438 //
439 // It may not be used for VNDK modules.
440 Odm_available *bool
441
Justin Yun63e9ec72020-10-29 16:49:43 +0900442 // whether this module should be allowed to be directly depended by other
443 // modules with `product_specific: true` or `product_available: true`.
444 // If set to true, an additional product variant will be built separately
445 // that is limited to the set of libraries and headers that are exposed to
446 // /product modules.
447 //
448 // The product variant may be used with a different (newer) /system,
449 // so it shouldn't have any unversioned runtime dependencies, or
450 // make assumptions about the system that may not be true in the
451 // future.
452 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900453 // If set to false, this module becomes inaccessible from /product modules.
454 //
455 // Different from the 'vendor_available' property, the modules with
456 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
457 // library without 'product_available' may not be depended on by any other
458 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900459 //
460 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
461 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
462 Product_available *bool
463
Jiyong Park5fb8c102018-04-09 12:03:06 +0900464 // whether this module is capable of being loaded with other instance
465 // (possibly an older version) of the same module in the same process.
466 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
467 // can be double loaded in a vendor process if the library is also a
468 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
469 // explicitly marked as `double_loadable: true` by the owner, or the dependency
470 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
471 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800472
473 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
474 IsLLNDK bool `blueprint:"mutated"`
475
Colin Cross78212242021-01-06 14:51:30 -0800476 // IsVNDKUsingCoreVariant is true for VNDK modules if the global VndkUseCoreVariant option is
477 // set and the module is not listed in VndkMustUseVendorVariantList.
478 IsVNDKUsingCoreVariant bool `blueprint:"mutated"`
479
480 // IsVNDKCore is set if a VNDK module does not set the vndk.support_system_process property.
481 IsVNDKCore bool `blueprint:"mutated"`
482
483 // IsVNDKSP is set if a VNDK module sets the vndk.support_system_process property.
484 IsVNDKSP bool `blueprint:"mutated"`
485
486 // IsVNDKPrivate is set if a VNDK module sets the vndk.private property or an LLNDK
487 // module sets the llndk.private property.
488 IsVNDKPrivate bool `blueprint:"mutated"`
489
490 // IsVNDKProduct is set if a VNDK module sets the product_available property.
491 IsVNDKProduct bool `blueprint:"mutated"`
Colin Cross5271fea2021-04-27 13:06:04 -0700492
493 // IsVendorPublicLibrary is set for the core and product variants of a library that has
494 // vendor_public_library stubs.
495 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800496}
497
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500498// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
499// to understanding details about the type of the current module.
500// For example, one might call these functions to determine whether the current module is a static
501// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800502type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800503 static() bool
504 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700505 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800506 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900507 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900508 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900509 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700510 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900511 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700512 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800513 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900514 minSdkVersion() string
515 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700516 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700517 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800518 IsLlndk() bool
519 IsLlndkPublic() bool
520 isImplementationForLLNDKPublic() bool
521 IsVndkPrivate() bool
Justin Yun8effde42017-06-23 19:24:43 +0900522 isVndk() bool
523 isVndkSp() bool
Ivan Lozanof9e21722020-12-02 09:00:51 -0500524 IsVndkExt() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700525 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900526 inProduct() bool
527 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800528 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700529 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900530 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900531 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700532 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700533 baseModuleName() string
Logan Chienf3511742017-10-31 18:04:35 +0800534 getVndkExtendsModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800535 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000536 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800537 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900538 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800539 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800540 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800541 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700542 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700543 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900544 bootstrap() bool
Vic Yangefd249e2018-11-12 20:19:56 -0800545 mustUseVendorVariant() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700546 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700547 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800548 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800549 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800550 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800551 notInPlatform() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800552}
553
554type SharedFlags struct {
555 numSharedFlags int
556 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800557}
558
559type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700560 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800561 ModuleContextIntf
562}
563
564type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700565 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800566 ModuleContextIntf
567}
568
Colin Cross37047f12016-12-13 17:06:13 -0800569type DepsContext interface {
570 android.BottomUpMutatorContext
571 ModuleContextIntf
572}
573
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500574// feature represents additional (optional) steps to building cc-related modules, such as invocation
575// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800576type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800577 flags(ctx ModuleContext, flags Flags) Flags
578 props() []interface{}
579}
580
Joe Onorato37f900c2023-07-18 16:58:16 -0700581// Information returned from Generator about the source code it's generating
582type GeneratedSource struct {
583 IncludeDirs android.Paths
584 Sources android.Paths
585 Headers android.Paths
586 ReexportedDirs android.Paths
587}
588
589// generator allows injection of generated code
590type Generator interface {
591 GeneratorProps() []interface{}
592 GeneratorInit(ctx BaseModuleContext)
593 GeneratorDeps(ctx DepsContext, deps Deps) Deps
594 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
595 GeneratorSources(ctx ModuleContext) GeneratedSource
596 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
597}
598
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500599// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500600// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800601type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700602 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800603 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800604 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700605 compilerProps() []interface{}
606
Colin Cross76fada02016-07-27 10:31:13 -0700607 appendCflags([]string)
608 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700609 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800610}
611
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500612// linker is the interface for a linker decorator object. Individual module types can provide
613// their own implementation for this decorator, and thus specify custom logic regarding build
614// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800615type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700616 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800617 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700618 linkerFlags(ctx ModuleContext, flags Flags) Flags
619 linkerProps() []interface{}
Ivan Lozanobd721262018-11-27 14:33:03 -0800620 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700621
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700622 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700623 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900624 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800625 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700626
627 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900628 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000629
630 // Get the deps that have been explicitly specified in the properties.
Paul Duffin13f02712020-03-06 12:30:43 +0000631 linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800632
633 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000634}
635
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500636// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000637type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500638 sharedLibs []string
639 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
640 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700641 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800642}
643
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500644// installer is the interface for an installer helper object. This helper is responsible for
645// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800646type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700647 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700648 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000649 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800650 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700651 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700652 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900653 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000654 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900655 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800656}
657
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800658type xref interface {
659 XrefCcFiles() android.Paths
660}
661
Inseob Kima1888ce2022-10-04 14:42:02 +0900662type overridable interface {
663 overriddenModules() []string
664}
665
Colin Cross6e511a92020-07-27 21:26:48 -0700666type libraryDependencyKind int
667
668const (
669 headerLibraryDependency = iota
670 sharedLibraryDependency
671 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400672 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700673)
674
675func (k libraryDependencyKind) String() string {
676 switch k {
677 case headerLibraryDependency:
678 return "headerLibraryDependency"
679 case sharedLibraryDependency:
680 return "sharedLibraryDependency"
681 case staticLibraryDependency:
682 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400683 case rlibLibraryDependency:
684 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700685 default:
686 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
687 }
688}
689
690type libraryDependencyOrder int
691
692const (
693 earlyLibraryDependency = -1
694 normalLibraryDependency = 0
695 lateLibraryDependency = 1
696)
697
698func (o libraryDependencyOrder) String() string {
699 switch o {
700 case earlyLibraryDependency:
701 return "earlyLibraryDependency"
702 case normalLibraryDependency:
703 return "normalLibraryDependency"
704 case lateLibraryDependency:
705 return "lateLibraryDependency"
706 default:
707 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
708 }
709}
710
711// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
712// tags that have a set of predefined tag objects that are reused for each dependency, a
713// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
714// That means that comparing a libraryDependencyTag for equality will only be equal if all
715// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
716// then check individual metadata fields instead.
717type libraryDependencyTag struct {
718 blueprint.BaseDependencyTag
719
720 // These are exported so that fmt.Printf("%#v") can call their String methods.
721 Kind libraryDependencyKind
722 Order libraryDependencyOrder
723
724 wholeStatic bool
725
726 reexportFlags bool
727 explicitlyVersioned bool
728 dataLib bool
729 ndk bool
730
731 staticUnwinder bool
732
733 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900734
Cindy Zhou18417cb2020-12-10 07:12:38 -0800735 // Whether or not this dependency should skip the apex dependency check
736 skipApexAllowedDependenciesCheck bool
737
Jiyong Parke3867542020-12-03 17:28:25 +0900738 // Whether or not this dependency has to be followed for the apex variants
739 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900740 // Whether or not this dependency has to be followed for the non-apex variants
741 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000742
743 // If true, don't automatically export symbols from the static library into a shared library.
744 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700745}
746
747// header returns true if the libraryDependencyTag is tagging a header lib dependency.
748func (d libraryDependencyTag) header() bool {
749 return d.Kind == headerLibraryDependency
750}
751
752// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
753func (d libraryDependencyTag) shared() bool {
754 return d.Kind == sharedLibraryDependency
755}
756
757// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
758func (d libraryDependencyTag) static() bool {
759 return d.Kind == staticLibraryDependency
760}
761
Ivan Lozano0a468a42024-05-13 21:03:34 -0400762// rlib returns true if the libraryDependencyTag is tagging an rlib dependency.
763func (d libraryDependencyTag) rlib() bool {
764 return d.Kind == rlibLibraryDependency
765}
766
Colin Cross65cb3142021-12-10 23:05:02 +0000767func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
768 if d.shared() {
769 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
770 }
771 return nil
772}
773
774var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
775
Colin Crosse9fe2942020-11-10 18:12:15 -0800776// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
777// binaries or other shared libraries are installed as dependencies.
778func (d libraryDependencyTag) InstallDepNeeded() bool {
779 return d.shared()
780}
781
782var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
783
Yu Liu67a28422024-03-05 00:36:31 +0000784func (d libraryDependencyTag) PropagateAconfigValidation() bool {
785 return d.static()
786}
787
788var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
789
Colin Crosse9fe2942020-11-10 18:12:15 -0800790// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700791// libraryDependencyTag. Each tag object is created globally and reused for multiple
792// dependencies (although since the object contains no references, assigning a tag to a
793// variable and modifying it will not modify the original). Users can compare the tag
794// returned by ctx.OtherModuleDependencyTag against the global original
795type dependencyTag struct {
796 blueprint.BaseDependencyTag
797 name string
798}
799
Colin Crosse9fe2942020-11-10 18:12:15 -0800800// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
801// libraryDependencyTag, but where the dependency needs to be installed when the parent is
802// installed.
803type installDependencyTag struct {
804 blueprint.BaseDependencyTag
805 android.InstallAlwaysNeededDependencyTag
806 name string
807}
808
Colin Crossc99deeb2016-04-11 15:06:20 -0700809var (
Colin Cross6e511a92020-07-27 21:26:48 -0700810 genSourceDepTag = dependencyTag{name: "gen source"}
811 genHeaderDepTag = dependencyTag{name: "gen header"}
812 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
813 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900814 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700815 reuseObjTag = dependencyTag{name: "reuse objects"}
816 staticVariantTag = dependencyTag{name: "static variant"}
817 vndkExtDepTag = dependencyTag{name: "vndk extends"}
818 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700819 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800820 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross6e511a92020-07-27 21:26:48 -0700821 testPerSrcDepTag = dependencyTag{name: "test_per_src"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700822 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000823 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500824 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400825 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800826 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700827)
828
Roland Levillainf89cd092019-07-29 16:22:59 +0100829func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700830 ccLibDepTag, ok := depTag.(libraryDependencyTag)
831 return ok && ccLibDepTag.shared()
832}
833
834func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
835 ccLibDepTag, ok := depTag.(libraryDependencyTag)
836 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100837}
838
Zach Johnson3df4e632020-11-06 11:56:27 -0800839func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
840 ccLibDepTag, ok := depTag.(libraryDependencyTag)
841 return ok && ccLibDepTag.header()
842}
843
Roland Levillainf89cd092019-07-29 16:22:59 +0100844func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800845 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100846}
847
848func IsTestPerSrcDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700849 ccDepTag, ok := depTag.(dependencyTag)
Roland Levillainf89cd092019-07-29 16:22:59 +0100850 return ok && ccDepTag == testPerSrcDepTag
851}
852
Colin Crossca860ac2016-01-04 14:34:37 -0800853// Module contains the properties and members used by all C/C++ module types, and implements
854// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500855// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
856// interface.
857//
858// To define a C/C++ related module, construct a new Module object and point its delegates to
859// type-specific structs. These delegates will be invoked to register module-specific build
860// statements which may be unique to the module type. For example, module.compiler.compile() should
861// be defined so as to register build statements which are responsible for compiling the module.
862//
863// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
864// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
865// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
866// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800867type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700868 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700869
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700870 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700871 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700872 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700873
Colin Crossca860ac2016-01-04 14:34:37 -0800874 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000875 hod android.HostOrDeviceSupported
876 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000877 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700878
Paul Duffina0843f62019-12-13 19:50:38 +0000879 // Allowable SdkMemberTypes of this module type.
880 sdkMemberTypes []android.SdkMemberType
881
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500882 // decorator delegates, initialize before calling Init
883 // these may contain module-specific implementations, and effectively allow for custom
884 // type-specific logic. These members may reference different objects or the same object.
885 // Functions of these decorators will be invoked to initialize and register type-specific
886 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800887 generators []Generator
888 compiler compiler
889 linker linker
890 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500891
Spandan Dase12d2522023-09-12 21:42:31 +0000892 features []feature
893 stl *stl
894 sanitize *sanitize
895 coverage *coverage
896 fuzzer *fuzzer
897 sabi *sabi
898 vndkdep *vndkdep
899 lto *lto
900 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000901 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800902
Colin Cross31076b32020-10-23 17:22:06 -0700903 library libraryInterface
904
Colin Cross635c3b02016-05-18 15:37:25 -0700905 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800906
Colin Crossb98c8b02016-07-29 13:44:28 -0700907 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700908
909 subAndroidMkOnce map[subAndroidMkProvider]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800910
911 // Flags used to compile this module
912 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700913
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800914 // Shared flags among build rules of this module
915 sharedFlags SharedFlags
916
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800917 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700918 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900919
920 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800921 // Kythe (source file indexer) paths for this compilation module
922 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700923 // Object .o file output paths for this compilation module
924 objFiles android.Paths
925 // Tidy .tidy file output paths for this compilation module
926 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900927
928 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700929 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700930
931 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800932
933 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
Colin Crossd788b3e2023-11-28 13:14:56 -0800934 mergedAconfigFiles map[string]android.Paths
Colin Crossc472d572015-03-17 15:06:21 -0700935}
936
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200937func (c *Module) AddJSONData(d *map[string]interface{}) {
Liz Kammer74ec1682021-08-17 17:29:51 -0400938 var hasAidl, hasLex, hasProto, hasRenderscript, hasSysprop, hasWinMsg, hasYacc bool
939 if b, ok := c.compiler.(*baseCompiler); ok {
940 hasAidl = b.hasSrcExt(".aidl")
941 hasLex = b.hasSrcExt(".l") || b.hasSrcExt(".ll")
942 hasProto = b.hasSrcExt(".proto")
943 hasRenderscript = b.hasSrcExt(".rscript") || b.hasSrcExt(".fs")
944 hasSysprop = b.hasSrcExt(".sysprop")
945 hasWinMsg = b.hasSrcExt(".mc")
946 hasYacc = b.hasSrcExt(".y") || b.hasSrcExt(".yy")
947 }
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200948 c.AndroidModuleBase().AddJSONData(d)
949 (*d)["Cc"] = map[string]interface{}{
950 "SdkVersion": c.SdkVersion(),
951 "MinSdkVersion": c.MinSdkVersion(),
952 "VndkVersion": c.VndkVersion(),
953 "ProductSpecific": c.ProductSpecific(),
954 "SocSpecific": c.SocSpecific(),
955 "DeviceSpecific": c.DeviceSpecific(),
956 "InProduct": c.InProduct(),
957 "InVendor": c.InVendor(),
958 "InRamdisk": c.InRamdisk(),
959 "InVendorRamdisk": c.InVendorRamdisk(),
960 "InRecovery": c.InRecovery(),
961 "VendorAvailable": c.VendorAvailable(),
962 "ProductAvailable": c.ProductAvailable(),
963 "RamdiskAvailable": c.RamdiskAvailable(),
964 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
965 "RecoveryAvailable": c.RecoveryAvailable(),
966 "OdmAvailable": c.OdmAvailable(),
967 "InstallInData": c.InstallInData(),
968 "InstallInRamdisk": c.InstallInRamdisk(),
969 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
970 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
971 "InstallInRecovery": c.InstallInRecovery(),
972 "InstallInRoot": c.InstallInRoot(),
973 "IsVndk": c.IsVndk(),
974 "IsVndkExt": c.IsVndkExt(),
975 "IsVndkPrivate": c.IsVndkPrivate(),
976 "IsVndkSp": c.IsVndkSp(),
977 "IsLlndk": c.IsLlndk(),
978 "IsLlndkPublic": c.IsLlndkPublic(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200979 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
980 "ApexSdkVersion": c.apexSdkVersion,
981 "TestFor": c.TestFor(),
Liz Kammer74ec1682021-08-17 17:29:51 -0400982 "AidlSrcs": hasAidl,
983 "LexSrcs": hasLex,
984 "ProtoSrcs": hasProto,
985 "RenderscriptSrcs": hasRenderscript,
986 "SyspropSrcs": hasSysprop,
987 "WinMsgSrcs": hasWinMsg,
988 "YaccSrsc": hasYacc,
989 "OnlyCSrcs": !(hasAidl || hasLex || hasProto || hasRenderscript || hasSysprop || hasWinMsg || hasYacc),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200990 }
991}
992
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500993func (c *Module) SetPreventInstall() {
994 c.Properties.PreventInstall = true
995}
996
997func (c *Module) SetHideFromMake() {
998 c.Properties.HideFromMake = true
999}
1000
Ivan Lozanod7586b62021-04-01 09:49:36 -04001001func (c *Module) HiddenFromMake() bool {
1002 return c.Properties.HideFromMake
1003}
1004
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001005func (c *Module) RequiredModuleNames() []string {
1006 required := android.CopyOf(c.ModuleBase.RequiredModuleNames())
1007 if c.ImageVariation().Variation == android.CoreVariation {
1008 required = append(required, c.Properties.Target.Platform.Required...)
1009 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1010 } else if c.InRecovery() {
1011 required = append(required, c.Properties.Target.Recovery.Required...)
1012 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1013 }
1014 return android.FirstUniqueStrings(required)
1015}
1016
Ivan Lozano52767be2019-10-18 14:49:46 -07001017func (c *Module) Toc() android.OptionalPath {
1018 if c.linker != nil {
1019 if library, ok := c.linker.(libraryInterface); ok {
1020 return library.toc()
1021 }
1022 }
1023 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1024}
1025
1026func (c *Module) ApiLevel() string {
1027 if c.linker != nil {
1028 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001029 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001030 }
1031 }
1032 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1033}
1034
1035func (c *Module) Static() bool {
1036 if c.linker != nil {
1037 if library, ok := c.linker.(libraryInterface); ok {
1038 return library.static()
1039 }
1040 }
1041 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1042}
1043
1044func (c *Module) Shared() bool {
1045 if c.linker != nil {
1046 if library, ok := c.linker.(libraryInterface); ok {
1047 return library.shared()
1048 }
1049 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001050
Ivan Lozano52767be2019-10-18 14:49:46 -07001051 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1052}
1053
1054func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001055 if c.stl != nil {
1056 return c.stl.Properties.SelectedStl
1057 }
1058 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001059}
1060
Ivan Lozano52767be2019-10-18 14:49:46 -07001061func (c *Module) NdkPrebuiltStl() bool {
1062 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1063 return true
1064 }
1065 return false
1066}
1067
1068func (c *Module) StubDecorator() bool {
1069 if _, ok := c.linker.(*stubDecorator); ok {
1070 return true
1071 }
1072 return false
1073}
1074
1075func (c *Module) SdkVersion() string {
1076 return String(c.Properties.Sdk_version)
1077}
1078
Artur Satayev480e25b2020-04-27 18:53:18 +01001079func (c *Module) MinSdkVersion() string {
1080 return String(c.Properties.Min_sdk_version)
1081}
1082
Jiyong Park5df7bd32021-08-25 16:18:46 +09001083func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001084 if linker, ok := c.linker.(*objectLinker); ok {
1085 return linker.isCrt()
1086 }
1087 return false
1088}
1089
Jiyong Park5df7bd32021-08-25 16:18:46 +09001090func (c *Module) SplitPerApiLevel() bool {
1091 return c.canUseSdk() && c.isCrt()
1092}
1093
Colin Crossc511bc52020-04-07 16:50:32 +00001094func (c *Module) AlwaysSdk() bool {
1095 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1096}
1097
Ivan Lozano183a3212019-10-18 14:18:45 -07001098func (c *Module) CcLibrary() bool {
1099 if c.linker != nil {
1100 if _, ok := c.linker.(*libraryDecorator); ok {
1101 return true
1102 }
Colin Crossd48fe732020-09-23 20:37:24 -07001103 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1104 return true
1105 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001106 }
1107 return false
1108}
1109
1110func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001111 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001112 return true
1113 }
1114 return false
1115}
1116
Spandan Dase12d2522023-09-12 21:42:31 +00001117func (c *Module) IsNdkPrebuiltStl() bool {
1118 if c.linker == nil {
1119 return false
1120 }
1121 if _, ok := c.linker.(*ndkPrebuiltStlLinker); ok {
1122 return true
1123 }
1124 return false
1125}
1126
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001127func (c *Module) RlibStd() bool {
1128 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1129}
1130
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001131func (c *Module) RustLibraryInterface() bool {
1132 return false
1133}
1134
Ivan Lozano0a468a42024-05-13 21:03:34 -04001135func (c *Module) CrateName() string {
1136 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1137}
1138
1139func (c *Module) ExportedCrateLinkDirs() []string {
1140 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1141}
1142
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001143func (c *Module) IsFuzzModule() bool {
1144 if _, ok := c.compiler.(*fuzzBinary); ok {
1145 return true
1146 }
1147 return false
1148}
1149
1150func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1151 return c.FuzzModule
1152}
1153
1154func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1155 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1156 return fuzzer.fuzzPackagedModule
1157 }
1158 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1159}
1160
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001161func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001162 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1163 return fuzzer.sharedLibraries
1164 }
1165 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1166}
1167
Ivan Lozano2b262972019-11-21 12:30:50 -08001168func (c *Module) NonCcVariants() bool {
1169 return false
1170}
1171
Ivan Lozano183a3212019-10-18 14:18:45 -07001172func (c *Module) SetStatic() {
1173 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001174 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001175 library.setStatic()
1176 return
1177 }
1178 }
1179 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1180}
1181
1182func (c *Module) SetShared() {
1183 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001184 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001185 library.setShared()
1186 return
1187 }
1188 }
1189 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1190}
1191
1192func (c *Module) BuildStaticVariant() bool {
1193 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001194 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001195 return library.buildStatic()
1196 }
1197 }
1198 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1199}
1200
1201func (c *Module) BuildSharedVariant() bool {
1202 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001203 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001204 return library.buildShared()
1205 }
1206 }
1207 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1208}
1209
1210func (c *Module) Module() android.Module {
1211 return c
1212}
1213
Jiyong Parkc20eee32018-09-05 22:36:17 +09001214func (c *Module) OutputFile() android.OptionalPath {
1215 return c.outputFile
1216}
1217
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001218func (c *Module) CoverageFiles() android.Paths {
1219 if c.linker != nil {
1220 if library, ok := c.linker.(libraryInterface); ok {
1221 return library.objs().coverageFiles
1222 }
1223 }
1224 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1225}
1226
Ivan Lozano183a3212019-10-18 14:18:45 -07001227var _ LinkableInterface = (*Module)(nil)
1228
Jiyong Park719b4462019-01-13 00:39:51 +09001229func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001230 if c.linker != nil {
1231 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001232 }
1233 return nil
1234}
1235
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001236func (c *Module) CoverageOutputFile() android.OptionalPath {
1237 if c.linker != nil {
1238 return c.linker.coverageOutputFilePath()
1239 }
1240 return android.OptionalPath{}
1241}
1242
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001243func (c *Module) RelativeInstallPath() string {
1244 if c.installer != nil {
1245 return c.installer.relativeInstallPath()
1246 }
1247 return ""
1248}
1249
Jooyung Han344d5432019-08-23 11:17:39 +09001250func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001251 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001252}
1253
Colin Cross36242852017-06-23 15:06:31 -07001254func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001255 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001256 for _, generator := range c.generators {
1257 c.AddProperties(generator.GeneratorProps()...)
1258 }
Colin Crossca860ac2016-01-04 14:34:37 -08001259 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001260 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001261 }
1262 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001263 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001264 }
1265 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001266 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001267 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001268 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001269 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001270 }
Colin Cross16b23492016-01-06 14:41:07 -08001271 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001272 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001273 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001274 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001275 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001276 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001277 if c.fuzzer != nil {
1278 c.AddProperties(c.fuzzer.props()...)
1279 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001280 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001281 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001282 }
Justin Yun8effde42017-06-23 19:24:43 +09001283 if c.vndkdep != nil {
1284 c.AddProperties(c.vndkdep.props()...)
1285 }
Stephen Craneba090d12017-05-09 15:44:35 -07001286 if c.lto != nil {
1287 c.AddProperties(c.lto.props()...)
1288 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001289 if c.afdo != nil {
1290 c.AddProperties(c.afdo.props()...)
1291 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001292 if c.orderfile != nil {
1293 c.AddProperties(c.orderfile.props()...)
1294 }
Colin Crossca860ac2016-01-04 14:34:37 -08001295 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001296 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001297 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001298 // Allow test-only on libraries that are not cc_test_library
1299 if c.library != nil && !c.testLibrary() {
1300 c.AddProperties(&c.sourceProperties)
1301 }
Colin Crossc472d572015-03-17 15:06:21 -07001302
Colin Cross36242852017-06-23 15:06:31 -07001303 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001304 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001305 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001306
Colin Cross36242852017-06-23 15:06:31 -07001307 return c
Colin Crossc472d572015-03-17 15:06:21 -07001308}
1309
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001310// UseVndk() returns true if this module is built against VNDK.
1311// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001312func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001313 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001314}
1315
Colin Crossc511bc52020-04-07 16:50:32 +00001316func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001317 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001318 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001319}
1320
1321func (c *Module) UseSdk() bool {
1322 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001323 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001324 }
1325 return false
1326}
1327
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001328func (c *Module) isCoverageVariant() bool {
1329 return c.coverage.Properties.IsCoverageVariant
1330}
1331
Colin Cross95f1ca02020-10-29 20:47:22 -07001332func (c *Module) IsNdk(config android.Config) bool {
1333 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001334}
1335
Colin Cross127bb8b2020-12-16 16:46:01 -08001336func (c *Module) IsLlndk() bool {
1337 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001338}
1339
Colin Cross127bb8b2020-12-16 16:46:01 -08001340func (c *Module) IsLlndkPublic() bool {
Colin Cross78212242021-01-06 14:51:30 -08001341 return c.VendorProperties.IsLLNDK && !c.VendorProperties.IsVNDKPrivate
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001342}
1343
Colin Cross1f3f1302021-04-26 18:37:44 -07001344func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001345 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001346 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001347}
1348
Colin Cross5271fea2021-04-27 13:06:04 -07001349func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1350 lib := moduleLibraryInterface(m)
1351 return lib != nil && (lib.hasVendorPublicLibrary())
1352}
1353
1354// IsVendorPublicLibrary returns true for vendor public libraries.
1355func (c *Module) IsVendorPublicLibrary() bool {
1356 return c.VendorProperties.IsVendorPublicLibrary
1357}
1358
Ivan Lozanof1868af2022-04-12 13:08:36 -04001359func (c *Module) IsVndkPrebuiltLibrary() bool {
1360 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1361 return true
1362 }
1363 return false
1364}
1365
1366func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1367 return c.Properties.SdkAndPlatformVariantVisibleToMake
1368}
1369
Ivan Lozanod7586b62021-04-01 09:49:36 -04001370func (c *Module) HasLlndkStubs() bool {
1371 lib := moduleLibraryInterface(c)
1372 return lib != nil && lib.hasLLNDKStubs()
1373}
1374
1375func (c *Module) StubsVersion() string {
1376 if lib, ok := c.linker.(versionedInterface); ok {
1377 return lib.stubsVersion()
1378 }
1379 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1380}
1381
Colin Cross127bb8b2020-12-16 16:46:01 -08001382// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1383// and does not set llndk.vendor_available: false.
1384func (c *Module) isImplementationForLLNDKPublic() bool {
1385 library, _ := c.library.(*libraryDecorator)
1386 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001387 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001388}
1389
Justin Yunfd9e8042020-12-23 18:23:14 +09001390// Returns true for LLNDK-private, VNDK-SP-private, and VNDK-core-private.
Colin Cross127bb8b2020-12-16 16:46:01 -08001391func (c *Module) IsVndkPrivate() bool {
Justin Yunfd9e8042020-12-23 18:23:14 +09001392 // Check if VNDK-core-private or VNDK-SP-private
1393 if c.IsVndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001394 return Bool(c.vndkdep.Properties.Vndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001395 }
1396
1397 // Check if LLNDK-private
1398 if library, ok := c.library.(*libraryDecorator); ok && c.IsLlndk() {
Justin Yunc0d8c492021-01-07 17:45:31 +09001399 return Bool(library.Properties.Llndk.Private)
Justin Yunfd9e8042020-12-23 18:23:14 +09001400 }
1401
1402 return false
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001403}
1404
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001405// IsVndk() returns true if this module has a vndk variant.
1406// Note that IsVndk() returns true for all variants of vndk-enabled libraries. Not only vendor variant,
1407// but also platform and product variants of vndk-enabled libraries return true for IsVndk().
Ivan Lozano52767be2019-10-18 14:49:46 -07001408func (c *Module) IsVndk() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001409 if vndkdep := c.vndkdep; vndkdep != nil {
1410 return vndkdep.isVndk()
Justin Yun8effde42017-06-23 19:24:43 +09001411 }
1412 return false
1413}
1414
Colin Cross3513fb12024-01-24 14:44:47 -08001415func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001416 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001417 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001418 }
1419 return false
1420}
1421
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001422func (c *Module) isOrderfileCompile() bool {
1423 if orderfile := c.orderfile; orderfile != nil {
1424 return orderfile.Properties.OrderfileLoad
1425 }
1426 return false
1427}
1428
Yi Kongc702ebd2022-08-19 16:02:45 +08001429func (c *Module) isCfi() bool {
1430 if sanitize := c.sanitize; sanitize != nil {
Yi Kongddffe722023-07-18 16:40:36 +09001431 return Bool(sanitize.Properties.SanitizeMutated.Cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001432 }
1433 return false
1434}
1435
Yi Konged79fa32023-06-04 17:15:42 +09001436func (c *Module) isFuzzer() bool {
1437 if sanitize := c.sanitize; sanitize != nil {
1438 return Bool(sanitize.Properties.SanitizeMutated.Fuzzer)
1439 }
1440 return false
1441}
1442
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001443func (c *Module) isNDKStubLibrary() bool {
1444 if _, ok := c.compiler.(*stubDecorator); ok {
1445 return true
1446 }
1447 return false
1448}
1449
Ivan Lozanod7586b62021-04-01 09:49:36 -04001450func (c *Module) IsVndkSp() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001451 if vndkdep := c.vndkdep; vndkdep != nil {
1452 return vndkdep.isVndkSp()
1453 }
1454 return false
1455}
1456
Ivan Lozanof9e21722020-12-02 09:00:51 -05001457func (c *Module) IsVndkExt() bool {
Logan Chienf3511742017-10-31 18:04:35 +08001458 if vndkdep := c.vndkdep; vndkdep != nil {
1459 return vndkdep.isVndkExt()
1460 }
1461 return false
1462}
1463
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001464func (c *Module) SubName() string {
1465 return c.Properties.SubName
1466}
1467
Ivan Lozano52767be2019-10-18 14:49:46 -07001468func (c *Module) MustUseVendorVariant() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001469 return c.IsVndkSp() || c.Properties.MustUseVendorVariant
Vic Yangefd249e2018-11-12 20:19:56 -08001470}
1471
Logan Chienf3511742017-10-31 18:04:35 +08001472func (c *Module) getVndkExtendsModuleName() string {
1473 if vndkdep := c.vndkdep; vndkdep != nil {
1474 return vndkdep.getVndkExtendsModuleName()
1475 }
1476 return ""
1477}
1478
Jiyong Park25fc6a92018-11-18 18:02:45 +09001479func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001480 if lib := c.library; lib != nil {
1481 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001482 }
1483 return false
1484}
1485
1486func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001487 if lib := c.library; lib != nil {
1488 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001489 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001490 return false
1491}
1492
Alan Stokes73feba32022-11-14 12:21:24 +00001493func (c *Module) IsStubsImplementationRequired() bool {
1494 if lib := c.library; lib != nil {
1495 return lib.isStubsImplementationRequired()
1496 }
1497 return false
1498}
1499
Colin Cross0477b422020-10-13 18:43:54 -07001500// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1501// the implementation. If it is an implementation library it returns its own name.
1502func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1503 name := ctx.OtherModuleName(c)
1504 if versioned, ok := c.linker.(versionedInterface); ok {
1505 name = versioned.implementationModuleName(name)
1506 }
1507 return name
1508}
1509
Martin Stjernholm2856c662020-12-02 15:03:42 +00001510// Similar to ImplementationModuleName, but uses the Make variant of the module
1511// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1512// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1513// under the premise that the prebuilt module overrides its source counterpart
1514// if it is exposed to Make).
1515func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1516 name := c.BaseModuleName()
1517 if versioned, ok := c.linker.(versionedInterface); ok {
1518 name = versioned.implementationModuleName(name)
1519 }
1520 return name
1521}
1522
Jiyong Park7d55b612021-06-11 17:22:09 +09001523func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001524 return Bool(c.Properties.Bootstrap)
1525}
1526
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001527func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001528 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1529 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1530 return false
1531 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001532 return c.linker != nil && c.linker.nativeCoverage()
1533}
1534
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001535func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001536 if p, ok := c.linker.(SnapshotInterface); ok {
1537 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001538 }
1539 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001540}
1541
Jiyong Parkf1194352019-02-25 11:05:47 +09001542func isBionic(name string) bool {
1543 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001544 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001545 return true
1546 }
1547 return false
1548}
1549
Martin Stjernholm279de572019-09-10 23:18:20 +01001550func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001551 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001552 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001553 }
1554 return isBionic(name)
1555}
1556
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001557func (c *Module) XrefCcFiles() android.Paths {
1558 return c.kytheFiles
1559}
1560
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001561func (c *Module) isCfiAssemblySupportEnabled() bool {
1562 return c.sanitize != nil &&
1563 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1564}
1565
Inseob Kim800d1142021-06-14 12:03:51 +09001566func (c *Module) InstallInRoot() bool {
1567 return c.installer != nil && c.installer.installInRoot()
1568}
1569
Colin Crossca860ac2016-01-04 14:34:37 -08001570type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001571 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001572 moduleContextImpl
1573}
1574
Colin Cross37047f12016-12-13 17:06:13 -08001575type depsContext struct {
1576 android.BottomUpMutatorContext
1577 moduleContextImpl
1578}
1579
Colin Crossca860ac2016-01-04 14:34:37 -08001580type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001581 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001582 moduleContextImpl
1583}
1584
1585type moduleContextImpl struct {
1586 mod *Module
1587 ctx BaseModuleContext
1588}
1589
Colin Crossb98c8b02016-07-29 13:44:28 -07001590func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001591 return ctx.mod.toolchain(ctx.ctx)
1592}
1593
1594func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001595 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001596}
1597
1598func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001599 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001600}
1601
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001602func (ctx *moduleContextImpl) testBinary() bool {
1603 return ctx.mod.testBinary()
1604}
1605
Yi Kong56fc1b62022-09-06 16:24:00 +08001606func (ctx *moduleContextImpl) testLibrary() bool {
1607 return ctx.mod.testLibrary()
1608}
1609
Jiyong Park1d1119f2019-07-29 21:27:18 +09001610func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001611 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001612}
1613
Inseob Kim7f283f42020-06-01 21:53:49 +09001614func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001615 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001616}
1617
Inseob Kim1042d292020-06-01 23:23:05 +09001618func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001619 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001620}
1621
Jooyung Hanccce2f22020-03-07 03:45:53 +09001622func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001623 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001624}
1625
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001626func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001627 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001628}
1629
1630func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001631 if ctx.ctx.Device() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001632 config := ctx.ctx.Config()
1633 if !config.IsVndkDeprecated() && ctx.useVndk() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001634 vndkVer := ctx.mod.VndkVersion()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001635 if inList(vndkVer, config.PlatformVersionActiveCodenames()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001636 return "current"
Justin Yun732aa6a2018-03-23 17:43:47 +09001637 }
Justin Yun5f7f7e82019-11-18 19:52:14 +09001638 return vndkVer
Dan Willemsend2ede872016-11-18 14:54:24 -08001639 }
Justin Yun732aa6a2018-03-23 17:43:47 +09001640 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001641 }
1642 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001643}
1644
Jiyong Parkb35a8192020-08-10 15:59:36 +09001645func (ctx *moduleContextImpl) minSdkVersion() string {
1646 ver := ctx.mod.MinSdkVersion()
1647 if ver == "apex_inherit" && !ctx.isForPlatform() {
1648 ver = ctx.apexSdkVersion().String()
1649 }
1650 if ver == "apex_inherit" || ver == "" {
1651 ver = ctx.sdkVersion()
1652 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001653
1654 if ctx.ctx.Device() {
1655 config := ctx.ctx.Config()
1656 if config.IsVndkDeprecated() && ctx.inVendor() {
1657 // If building for vendor with final API, then use the latest _stable_ API as "current".
1658 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1659 ver = config.PlatformSdkVersion().String()
1660 }
1661 }
1662 }
1663
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001664 // For crt objects, the meaning of min_sdk_version is very different from other types of
1665 // module. For them, min_sdk_version defines the oldest version that the build system will
1666 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1667 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1668 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001669 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1670 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1671 // support such an old version. The version is set to the later version in case when the
1672 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1673 // it's for an APEX.
1674 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1675 if ctx.isForPlatform() {
1676 ver = strconv.Itoa(android.FutureApiLevelInt)
1677 } else { // for apex
1678 ver = ctx.apexSdkVersion().String()
1679 if ver == "" { // in case when min_sdk_version was not set by the APEX
1680 ver = ctx.sdkVersion()
1681 }
1682 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001683 }
1684
Jiyong Parkb35a8192020-08-10 15:59:36 +09001685 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1686 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1687 minSdkVersionInt, err2 := strconv.Atoi(ver)
1688 if err == nil && err2 == nil {
1689 if sdkVersionInt < minSdkVersionInt {
1690 return strconv.Itoa(sdkVersionInt)
1691 }
1692 }
1693 return ver
1694}
1695
1696func (ctx *moduleContextImpl) isSdkVariant() bool {
1697 return ctx.mod.IsSdkVariant()
1698}
1699
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001700func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001701 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001702}
Justin Yun8effde42017-06-23 19:24:43 +09001703
Kiyoung Kimaa394802024-01-08 12:55:45 +09001704func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1705 return ctx.mod.InVendorOrProduct()
1706}
1707
Colin Cross95f1ca02020-10-29 20:47:22 -07001708func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1709 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001710}
1711
Colin Cross127bb8b2020-12-16 16:46:01 -08001712func (ctx *moduleContextImpl) IsLlndk() bool {
1713 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001714}
1715
Colin Cross127bb8b2020-12-16 16:46:01 -08001716func (ctx *moduleContextImpl) IsLlndkPublic() bool {
1717 return ctx.mod.IsLlndkPublic()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001718}
1719
Colin Cross127bb8b2020-12-16 16:46:01 -08001720func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1721 return ctx.mod.isImplementationForLLNDKPublic()
1722}
1723
1724func (ctx *moduleContextImpl) IsVndkPrivate() bool {
1725 return ctx.mod.IsVndkPrivate()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001726}
1727
Logan Chienf3511742017-10-31 18:04:35 +08001728func (ctx *moduleContextImpl) isVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001729 return ctx.mod.IsVndk()
Logan Chienf3511742017-10-31 18:04:35 +08001730}
1731
Colin Cross3513fb12024-01-24 14:44:47 -08001732func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1733 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001734}
1735
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001736func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1737 return ctx.mod.isOrderfileCompile()
1738}
1739
Yi Kongc702ebd2022-08-19 16:02:45 +08001740func (ctx *moduleContextImpl) isCfi() bool {
1741 return ctx.mod.isCfi()
1742}
1743
Yi Konged79fa32023-06-04 17:15:42 +09001744func (ctx *moduleContextImpl) isFuzzer() bool {
1745 return ctx.mod.isFuzzer()
1746}
1747
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001748func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1749 return ctx.mod.isNDKStubLibrary()
1750}
1751
Justin Yun8effde42017-06-23 19:24:43 +09001752func (ctx *moduleContextImpl) isVndkSp() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001753 return ctx.mod.IsVndkSp()
Logan Chienf3511742017-10-31 18:04:35 +08001754}
1755
Ivan Lozanof9e21722020-12-02 09:00:51 -05001756func (ctx *moduleContextImpl) IsVndkExt() bool {
1757 return ctx.mod.IsVndkExt()
Justin Yun8effde42017-06-23 19:24:43 +09001758}
1759
Colin Cross5271fea2021-04-27 13:06:04 -07001760func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1761 return ctx.mod.IsVendorPublicLibrary()
1762}
1763
Vic Yangefd249e2018-11-12 20:19:56 -08001764func (ctx *moduleContextImpl) mustUseVendorVariant() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001765 return ctx.mod.MustUseVendorVariant()
Vic Yangefd249e2018-11-12 20:19:56 -08001766}
1767
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001768func (ctx *moduleContextImpl) selectedStl() string {
1769 if stl := ctx.mod.stl; stl != nil {
1770 return stl.Properties.SelectedStl
1771 }
1772 return ""
1773}
1774
Ivan Lozanobd721262018-11-27 14:33:03 -08001775func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1776 return ctx.mod.linker.useClangLld(actx)
1777}
1778
Colin Crossce75d2c2016-10-06 16:12:58 -07001779func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001780 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001781}
1782
Logan Chienf3511742017-10-31 18:04:35 +08001783func (ctx *moduleContextImpl) getVndkExtendsModuleName() string {
1784 return ctx.mod.getVndkExtendsModuleName()
1785}
1786
Logan Chiene274fc92019-12-03 11:18:32 -08001787func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001788 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1789 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001790}
1791
Colin Crosse07f2312020-08-13 11:24:56 -07001792func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001793 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1794 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001795}
1796
Dan Albertc8060532020-07-22 22:32:17 -07001797func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001798 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001799}
1800
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001801func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001802 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001803}
1804
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001805func (ctx *moduleContextImpl) nativeCoverage() bool {
1806 return ctx.mod.nativeCoverage()
1807}
1808
Colin Cross56a83212020-09-15 18:30:11 -07001809func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1810 return ctx.mod.DirectlyInAnyApex()
1811}
1812
Colin Cross95b07f22020-12-16 11:06:50 -08001813func (ctx *moduleContextImpl) isPreventInstall() bool {
1814 return ctx.mod.Properties.PreventInstall
1815}
1816
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001817func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1818 shared := &ctx.mod.sharedFlags
1819 if shared.flagsMap == nil {
1820 shared.numSharedFlags = 0
1821 shared.flagsMap = make(map[string]string)
1822 }
1823 return shared
1824}
1825
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001826func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1827 return ctx.mod.isCfiAssemblySupportEnabled()
1828}
1829
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001830func (ctx *moduleContextImpl) notInPlatform() bool {
1831 return ctx.mod.NotInPlatform()
1832}
1833
Colin Cross635c3b02016-05-18 15:37:25 -07001834func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001835 return &Module{
1836 hod: hod,
1837 multilib: multilib,
1838 }
1839}
1840
Colin Cross635c3b02016-05-18 15:37:25 -07001841func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001842 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001843 module.features = []feature{
1844 &tidyFeature{},
1845 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001846 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001847 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001848 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001849 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001850 module.sabi = &sabi{}
Justin Yun8effde42017-06-23 19:24:43 +09001851 module.vndkdep = &vndkdep{}
Stephen Craneba090d12017-05-09 15:44:35 -07001852 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001853 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001854 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001855 return module
1856}
1857
Colin Crossce75d2c2016-10-06 16:12:58 -07001858func (c *Module) Prebuilt() *android.Prebuilt {
1859 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1860 return p.prebuilt()
1861 }
1862 return nil
1863}
1864
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001865func (c *Module) IsPrebuilt() bool {
1866 return c.Prebuilt() != nil
1867}
1868
Colin Crossce75d2c2016-10-06 16:12:58 -07001869func (c *Module) Name() string {
1870 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001871 if p, ok := c.linker.(interface {
1872 Name(string) string
1873 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001874 name = p.Name(name)
1875 }
1876 return name
1877}
1878
Alex Light3d673592019-01-18 14:37:31 -08001879func (c *Module) Symlinks() []string {
1880 if p, ok := c.installer.(interface {
1881 symlinkList() []string
1882 }); ok {
1883 return p.symlinkList()
1884 }
1885 return nil
1886}
1887
Roland Levillainf89cd092019-07-29 16:22:59 +01001888func (c *Module) IsTestPerSrcAllTestsVariation() bool {
1889 test, ok := c.linker.(testPerSrc)
1890 return ok && test.isAllTestsVariation()
1891}
1892
Chris Parsons216e10a2020-07-09 17:12:52 -04001893func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001894 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001895 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001896 }); ok {
1897 return p.dataPaths()
1898 }
1899 return nil
1900}
1901
Ivan Lozanof1868af2022-04-12 13:08:36 -04001902func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001903 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1904 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001905 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001906 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001907 if c.ProductSpecific() {
1908 // If the module is product specific with 'product_specific: true',
1909 // do not add a name suffix because it is a base module.
1910 return ""
1911 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001912 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001913 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001914 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001915 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001916 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001917 // add version suffix only if the module is using different vndk version than the
1918 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001919 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001920 }
1921 return nameSuffix
1922}
1923
Ivan Lozanof1868af2022-04-12 13:08:36 -04001924func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1925 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001926
1927 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001928 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001929 }
1930
Colin Cross127bb8b2020-12-16 16:46:01 -08001931 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001932 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001933 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1934 // added for product variant only when we have vendor and product variants with core
1935 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001936 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001937 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001938 subName += vendorPublicLibrarySuffix
1939 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001940 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1941 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001942 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001943 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001944 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001945 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001946 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001947 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001948 subName += RecoverySuffix
1949 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1950 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001951 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001952 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001953 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001954 } else if c.IsStubs() && c.IsSdkVariant() {
1955 // Public API surface (NDK)
1956 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1957 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001958 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001959
1960 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001961}
1962
Sam Delmerico75dbca22023-04-20 13:13:25 +00001963func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1964 ctx := &moduleContext{
1965 ModuleContext: actx,
1966 moduleContextImpl: moduleContextImpl{
1967 mod: c,
1968 },
1969 }
1970 ctx.ctx = ctx
1971 return ctx
1972}
1973
Spandan Das20fce2d2023-04-12 17:21:39 +00001974// TODO (b/277651159): Remove this allowlist
1975var (
1976 skipStubLibraryMultipleApexViolation = map[string]bool{
1977 "libclang_rt.asan": true,
1978 "libclang_rt.hwasan": true,
1979 // runtime apex
1980 "libc": true,
1981 "libc_hwasan": true,
1982 "libdl_android": true,
1983 "libm": true,
1984 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001985 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001986 // art apex
1987 "libandroidio": true,
1988 "libdexfile": true,
1989 "libnativebridge": true,
1990 "libnativehelper": true,
1991 "libnativeloader": true,
1992 "libsigchain": true,
1993 }
1994)
1995
1996// Returns true if a stub library could be installed in multiple apexes
1997func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1998 // If this is not an apex variant, no check necessary
1999 if !c.InAnyApex() {
2000 return false
2001 }
2002 // If this is not a stub library, no check necessary
2003 if !c.HasStubsVariants() {
2004 return false
2005 }
2006 // Skip the allowlist
2007 // Use BaseModuleName so that this matches prebuilts.
2008 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
2009 return false
2010 }
2011
2012 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
2013 // Stub libraries should not have more than one apex_available
2014 if len(aaWithoutTestApexes) > 1 {
2015 return true
2016 }
2017 // Stub libraries should not use the wildcard
2018 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
2019 return true
2020 }
2021 // Default: no violation
2022 return false
2023}
2024
LaMont Jonesafe7baf2024-01-09 22:47:39 +00002025func (d *Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2026 android.CollectDependencyAconfigFiles(ctx, &d.mergedAconfigFiles)
2027}
2028
Chris Parsons8d6e4332021-02-22 16:13:50 -05002029func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002030 ctx := moduleContextFromAndroidModuleContext(actx, c)
2031
2032 // If Test_only is set on a module in bp file, respect the setting, otherwise
2033 // see if is a known test module type.
2034 testOnly := c.testModule || c.testLibrary()
2035 if c.sourceProperties.Test_only != nil {
2036 testOnly = Bool(c.sourceProperties.Test_only)
2037 }
2038 // Keep before any early returns.
2039 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2040 TestOnly: testOnly,
2041 TopLevelTarget: c.testModule,
2042 })
2043
Chris Parsons8d6e4332021-02-22 16:13:50 -05002044 // Handle the case of a test module split by `test_per_src` mutator.
2045 //
2046 // The `test_per_src` mutator adds an extra variation named "", depending on all the other
2047 // `test_per_src` variations of the test module. Set `outputFile` to an empty path for this
2048 // module and return early, as this module does not produce an output file per se.
2049 if c.IsTestPerSrcAllTestsVariation() {
2050 c.outputFile = android.OptionalPath{}
2051 return
2052 }
2053
Ivan Lozanof1868af2022-04-12 13:08:36 -04002054 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002055 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002056 if !apexInfo.IsForPlatform() {
2057 c.hideApexVariantFromMake = true
2058 }
2059
Chris Parsonseefc9e62021-04-02 17:36:47 -04002060 c.makeLinkType = GetMakeLinkType(actx, c)
2061
Colin Crossf18e1102017-11-16 14:33:08 -08002062 deps := c.depsToPaths(ctx)
2063 if ctx.Failed() {
2064 return
2065 }
2066
Joe Onorato37f900c2023-07-18 16:58:16 -07002067 for _, generator := range c.generators {
2068 gen := generator.GeneratorSources(ctx)
2069 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2070 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2071 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2072 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2073 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2074 if len(deps.Objs.objFiles) == 0 {
2075 // If we are reusuing object files (which happens when we're a shared library and we're
2076 // reusing our static variant's object files), then skip adding the actual source files,
2077 // because we already have the object for it.
2078 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2079 }
2080 }
2081
2082 if ctx.Failed() {
2083 return
2084 }
2085
Spandan Das20fce2d2023-04-12 17:21:39 +00002086 if c.stubLibraryMultipleApexViolation(actx) {
2087 actx.PropertyErrorf("apex_available",
2088 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2089 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002090 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2091 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002092 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2093 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002094 }
2095
Colin Crossca860ac2016-01-04 14:34:37 -08002096 flags := Flags{
2097 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002098 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002099 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002100 for _, generator := range c.generators {
2101 flags = generator.GeneratorFlags(ctx, flags, deps)
2102 }
Colin Crossca860ac2016-01-04 14:34:37 -08002103 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002104 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002105 }
2106 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002107 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002108 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002109 if c.stl != nil {
2110 flags = c.stl.flags(ctx, flags)
2111 }
Colin Cross16b23492016-01-06 14:41:07 -08002112 if c.sanitize != nil {
2113 flags = c.sanitize.flags(ctx, flags)
2114 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002115 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002116 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002117 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002118 if c.fuzzer != nil {
2119 flags = c.fuzzer.flags(ctx, flags)
2120 }
Stephen Craneba090d12017-05-09 15:44:35 -07002121 if c.lto != nil {
2122 flags = c.lto.flags(ctx, flags)
2123 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002124 if c.afdo != nil {
2125 flags = c.afdo.flags(ctx, flags)
2126 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002127 if c.orderfile != nil {
2128 flags = c.orderfile.flags(ctx, flags)
2129 }
Colin Crossca860ac2016-01-04 14:34:37 -08002130 for _, feature := range c.features {
2131 flags = feature.flags(ctx, flags)
2132 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002133 if ctx.Failed() {
2134 return
2135 }
2136
Colin Cross4af21ed2019-11-04 09:37:55 -08002137 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2138 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2139 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002140
Colin Cross4af21ed2019-11-04 09:37:55 -08002141 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002142
2143 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002144 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002145 }
2146 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002147 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002148 }
2149
Colin Cross3e5e7782022-06-17 22:17:05 +00002150 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2151
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002152 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002153 // We need access to all the flags seen by a source file.
2154 if c.sabi != nil {
2155 flags = c.sabi.flags(ctx, flags)
2156 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002157
Colin Cross4af21ed2019-11-04 09:37:55 -08002158 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002159
Joe Onorato37f900c2023-07-18 16:58:16 -07002160 for _, generator := range c.generators {
2161 generator.GeneratorBuildActions(ctx, flags, deps)
2162 }
2163
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002164 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002165 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002166 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002167 if ctx.Failed() {
2168 return
2169 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002170 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002171 c.objFiles = objs.objFiles
2172 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002173 }
2174
Colin Crossca860ac2016-01-04 14:34:37 -08002175 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002176 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002177 if ctx.Failed() {
2178 return
2179 }
Colin Cross635c3b02016-05-18 15:37:25 -07002180 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002181
Chris Parsons94a0bba2021-06-04 15:03:47 -04002182 c.maybeUnhideFromMake()
Colin Crossce75d2c2016-10-06 16:12:58 -07002183 }
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002184 if c.testModule {
Colin Cross40213022023-12-13 15:19:49 -08002185 android.SetProvider(ctx, testing.TestModuleProviderKey, testing.TestModuleProviderData{})
Aditya Choudhary87b2ab22023-11-17 15:27:06 +00002186 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002187
Colin Cross40213022023-12-13 15:19:49 -08002188 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002189
LaMont Jonesaa005ae2023-12-19 19:01:57 +00002190 android.CollectDependencyAconfigFiles(ctx, &c.mergedAconfigFiles)
Yu Liueae7b362023-11-16 17:05:47 -08002191
Chris Parsons94a0bba2021-06-04 15:03:47 -04002192 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002193
2194 if c.linker != nil {
2195 moduleInfoJSON := ctx.ModuleInfoJSON()
2196 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2197 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2198 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2199 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2200 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2201
2202 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2203 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2204 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2205 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2206
2207 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2208 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2209 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2210 moduleInfoJSON.SubName += ".cfi"
2211 }
2212 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2213 moduleInfoJSON.SubName += ".hwasan"
2214 }
2215 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2216 moduleInfoJSON.SubName += ".scs"
2217 }
2218 }
2219 moduleInfoJSON.SubName += c.Properties.SubName
2220
2221 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2222 moduleInfoJSON.Uninstallable = true
2223 }
2224
2225 }
Chris Parsons94a0bba2021-06-04 15:03:47 -04002226}
2227
2228func (c *Module) maybeUnhideFromMake() {
2229 // If a lib is directly included in any of the APEXes or is not available to the
2230 // platform (which is often the case when the stub is provided as a prebuilt),
2231 // unhide the stubs variant having the latest version gets visible to make. In
2232 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2233 // force anything in the make world to link against the stubs library. (unless it
2234 // is explicitly referenced via .bootstrap suffix or the module is marked with
2235 // 'bootstrap: true').
2236 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002237 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002238 c.IsStubs() && !c.InVendorRamdisk() {
2239 c.Properties.HideFromMake = false // unhide
2240 // Note: this is still non-installable
2241 }
2242}
2243
Colin Cross8ff10582023-12-07 13:10:56 -08002244// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2245// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002246func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002247 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002248 // If the module has been specifically configure to not be installed then
2249 // hide from make as otherwise it will break when running inside make
2250 // as the output path to install will not be specified. Not all uninstallable
2251 // modules can be hidden from make as some are needed for resolving make side
2252 // dependencies.
2253 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002254 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002255 c.SkipInstall()
2256 }
2257
2258 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2259 // to allow using the outputs in a genrule.
2260 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002261 c.installer.install(ctx, c.outputFile.Path())
2262 if ctx.Failed() {
2263 return
Colin Crossca860ac2016-01-04 14:34:37 -08002264 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002265 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002266}
2267
Colin Cross0ea8ba82019-06-06 14:33:29 -07002268func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002269 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002270 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002271 }
Colin Crossca860ac2016-01-04 14:34:37 -08002272 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002273}
2274
Colin Crossca860ac2016-01-04 14:34:37 -08002275func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002276 for _, generator := range c.generators {
2277 generator.GeneratorInit(ctx)
2278 }
Colin Crossca860ac2016-01-04 14:34:37 -08002279 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002280 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002281 }
Colin Crossca860ac2016-01-04 14:34:37 -08002282 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002283 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002284 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002285 if c.stl != nil {
2286 c.stl.begin(ctx)
2287 }
Colin Cross16b23492016-01-06 14:41:07 -08002288 if c.sanitize != nil {
2289 c.sanitize.begin(ctx)
2290 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002291 if c.coverage != nil {
2292 c.coverage.begin(ctx)
2293 }
Yi Kong9723e332023-12-04 14:52:53 +09002294 if c.afdo != nil {
2295 c.afdo.begin(ctx)
2296 }
Stephen Craneba090d12017-05-09 15:44:35 -07002297 if c.lto != nil {
2298 c.lto.begin(ctx)
2299 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002300 if c.orderfile != nil {
2301 c.orderfile.begin(ctx)
2302 }
Dan Albert92fe7402020-07-15 13:33:30 -07002303 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002304 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002305 if err != nil {
2306 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002307 c.Properties.Sdk_version = nil
2308 } else {
2309 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002310 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002311 }
Colin Crossca860ac2016-01-04 14:34:37 -08002312}
2313
Colin Cross37047f12016-12-13 17:06:13 -08002314func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002315 deps := Deps{}
2316
Joe Onorato37f900c2023-07-18 16:58:16 -07002317 for _, generator := range c.generators {
2318 deps = generator.GeneratorDeps(ctx, deps)
2319 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002320 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002321 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002322 }
2323 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002324 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002325 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002326 if c.stl != nil {
2327 deps = c.stl.deps(ctx, deps)
2328 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002329 if c.coverage != nil {
2330 deps = c.coverage.deps(ctx, deps)
2331 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002332
Colin Crossb6715442017-10-24 11:13:31 -07002333 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2334 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
Ivan Lozano0a468a42024-05-13 21:03:34 -04002335 deps.Rlibs = android.LastUniqueStrings(deps.Rlibs)
Colin Crossb6715442017-10-24 11:13:31 -07002336 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2337 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2338 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2339 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002340 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002341 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002342
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002343 for _, lib := range deps.ReexportSharedLibHeaders {
2344 if !inList(lib, deps.SharedLibs) {
2345 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2346 }
2347 }
2348
2349 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002350 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2351 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 -07002352 }
2353 }
2354
Colin Cross5950f382016-12-13 12:50:57 -08002355 for _, lib := range deps.ReexportHeaderLibHeaders {
2356 if !inList(lib, deps.HeaderLibs) {
2357 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2358 }
2359 }
2360
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002361 for _, gen := range deps.ReexportGeneratedHeaders {
2362 if !inList(gen, deps.GeneratedHeaders) {
2363 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2364 }
2365 }
2366
Colin Crossc99deeb2016-04-11 15:06:20 -07002367 return deps
2368}
2369
Dan Albert7e9d2952016-08-04 13:02:36 -07002370func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002371 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002372 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002373 moduleContextImpl: moduleContextImpl{
2374 mod: c,
2375 },
2376 }
2377 ctx.ctx = ctx
2378
Colin Crossca860ac2016-01-04 14:34:37 -08002379 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002380}
2381
Jiyong Park7ed9de32018-10-15 22:25:07 +09002382// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002383func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002384 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2385 version := name[sharp+1:]
2386 libname := name[:sharp]
2387 return libname, version
2388 }
2389 return name, ""
2390}
2391
Dan Albert92fe7402020-07-15 13:33:30 -07002392func GetCrtVariations(ctx android.BottomUpMutatorContext,
2393 m LinkableInterface) []blueprint.Variation {
2394 if ctx.Os() != android.Android {
2395 return nil
2396 }
2397 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002398 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2399 minSdkVersion := m.MinSdkVersion()
2400 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2401 minSdkVersion = m.SdkVersion()
2402 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002403 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2404 if err != nil {
2405 ctx.PropertyErrorf("min_sdk_version", err.Error())
2406 }
Colin Cross363ec762023-01-13 13:45:14 -08002407
2408 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002409 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002410 if apiLevel.LessThan(minApiForArch) {
2411 apiLevel = minApiForArch
2412 }
2413
Dan Albert92fe7402020-07-15 13:33:30 -07002414 return []blueprint.Variation{
2415 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002416 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002417 }
2418 }
2419 return []blueprint.Variation{
2420 {Mutator: "sdk", Variation: ""},
2421 }
2422}
2423
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002424func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2425 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002426
2427 variations = append([]blueprint.Variation(nil), variations...)
2428
Liz Kammer23942242022-04-08 15:41:00 -04002429 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002430 // Version is explicitly specified. i.e. libFoo#30
2431 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002432 if tag, ok := depTag.(libraryDependencyTag); ok {
2433 tag.explicitlyVersioned = true
2434 } else {
2435 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2436 }
Colin Crosse7257d22020-09-24 09:56:18 -07002437 }
Colin Crosse7257d22020-09-24 09:56:18 -07002438
Colin Cross0de8a1e2020-09-18 14:15:30 -07002439 if far {
2440 ctx.AddFarVariationDependencies(variations, depTag, name)
2441 } else {
2442 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002443 }
2444}
2445
Kiyoung Kim487689e2022-07-26 09:48:22 +09002446func GetApiImports(c LinkableInterface, actx android.BottomUpMutatorContext) multitree.ApiImportInfo {
2447 apiImportInfo := multitree.ApiImportInfo{}
2448
2449 if c.Device() {
2450 var apiImportModule []blueprint.Module
2451 if actx.OtherModuleExists("api_imports") {
2452 apiImportModule = actx.AddDependency(c, nil, "api_imports")
2453 if len(apiImportModule) > 0 && apiImportModule[0] != nil {
Colin Cross313aa542023-12-13 13:47:44 -08002454 apiInfo, _ := android.OtherModuleProvider(actx, apiImportModule[0], multitree.ApiImportsProvider)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002455 apiImportInfo = apiInfo
Colin Cross40213022023-12-13 15:19:49 -08002456 android.SetProvider(actx, multitree.ApiImportsProvider, apiInfo)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002457 }
2458 }
2459 }
2460
2461 return apiImportInfo
2462}
2463
Kiyoung Kim487689e2022-07-26 09:48:22 +09002464func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2465 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002466 return snapshot
2467 }
2468
2469 return lib
2470}
2471
Kiyoung Kim37693d02024-04-04 09:56:15 +09002472// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002473// of names:
2474//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002475// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002476//
2477// For each of these, it adds the name of the ndk_library module to the list of
2478// variant libs.
2479//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002480// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002481//
2482// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002483//
2484// The caller can then know to add the variantLibs dependencies differently from the
2485// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002486func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002487 variantLibs = []string{}
2488
2489 nonvariantLibs = []string{}
2490 for _, entry := range list {
2491 // strip #version suffix out
2492 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002493 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002494 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002495 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002496 nonvariantLibs = append(nonvariantLibs, entry)
2497 }
2498 }
2499 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002500
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002501}
2502
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002503func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2504 nonVariantLibs := []string{}
2505 variantLibs := []string{}
2506
2507 for _, lib := range libs {
2508 replaceLibName := GetReplaceModuleName(lib, replaceList)
2509 if replaceLibName == lib {
2510 // Do not handle any libs which are not in API imports
2511 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2512 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2513 variantLibs = append(variantLibs, replaceLibName)
2514 } else {
2515 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2516 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002517 }
2518
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002519 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002520}
2521
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002522func (c *Module) shouldUseApiSurface() bool {
2523 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2524 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2525 // LLNDK Variant
2526 return true
2527 }
2528
2529 if c.Properties.IsSdkVariant {
2530 // NDK Variant
2531 return true
2532 }
2533
2534 if c.isImportedApiLibrary() {
2535 // API Library should depend on API headers
2536 return true
2537 }
2538 }
2539
2540 return false
2541}
2542
Colin Cross1e676be2016-10-12 14:38:15 -07002543func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002544 if !c.Enabled() {
2545 return
2546 }
2547
Colin Cross37047f12016-12-13 17:06:13 -08002548 ctx := &depsContext{
2549 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002550 moduleContextImpl: moduleContextImpl{
2551 mod: c,
2552 },
2553 }
2554 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002555
Colin Crossc99deeb2016-04-11 15:06:20 -07002556 deps := c.deps(ctx)
Kiyoung Kim487689e2022-07-26 09:48:22 +09002557 apiImportInfo := GetApiImports(c, actx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002558
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002559 apiNdkLibs := []string{}
2560 apiLateNdkLibs := []string{}
2561
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002562 if c.shouldUseApiSurface() {
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002563 deps.SharedLibs, apiNdkLibs = rewriteLibsForApiImports(c, deps.SharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2564 deps.LateSharedLibs, apiLateNdkLibs = rewriteLibsForApiImports(c, deps.LateSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2565 deps.SystemSharedLibs, _ = rewriteLibsForApiImports(c, deps.SystemSharedLibs, apiImportInfo.SharedLibs, ctx.Config())
2566 deps.ReexportHeaderLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportHeaderLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
2567 deps.ReexportSharedLibHeaders, _ = rewriteLibsForApiImports(c, deps.ReexportSharedLibHeaders, apiImportInfo.SharedLibs, ctx.Config())
Kiyoung Kim11d91082022-10-19 19:20:57 +09002568 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002569
Yo Chiang219968c2020-09-22 18:45:04 +08002570 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2571
Dan Albert914449f2016-06-17 16:45:24 -07002572 variantNdkLibs := []string{}
2573 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002574 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002575 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2576 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2577 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002578 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002579
Colin Cross32ec36c2016-12-15 07:39:51 -08002580 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002581 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002582 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002583 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002584 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002585
Kiyoung Kim51279d32022-08-24 14:10:46 +09002586 // Check header lib replacement from API surface first, and then check again with VSDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002587 if c.shouldUseApiSurface() {
Kiyoung Kim11d91082022-10-19 19:20:57 +09002588 lib = GetReplaceModuleName(lib, apiImportInfo.HeaderLibs)
2589 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002590
Spandan Das73bcafc2022-08-18 23:26:00 +00002591 if c.isNDKStubLibrary() {
2592 // ndk_headers do not have any variations
2593 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
Kiyoung Kim51279d32022-08-24 14:10:46 +09002594 } else if c.IsStubs() && !c.isImportedApiLibrary() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002595 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002596 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002597 } else {
2598 actx.AddVariationDependencies(nil, depTag, lib)
2599 }
2600 }
2601
Dan Albertf1d14c72020-07-30 14:32:55 -07002602 if c.isNDKStubLibrary() {
2603 // NDK stubs depend on their implementation because the ABI dumps are
2604 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002605
Spandan Das8b08aea2023-03-14 19:29:34 +00002606 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2607 c.ImageVariation(),
2608 blueprint.Variation{Mutator: "link", Variation: "shared"},
2609 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002610 }
2611
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002612 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2613 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2614 c.Target().NativeBridge == android.NativeBridgeDisabled {
2615 actx.AddVariationDependencies(
2616 []blueprint.Variation{{Mutator: "image", Variation: VendorVariation}},
2617 llndkHeaderLibTag,
2618 deps.LlndkHeaderLibs...)
2619 }
2620
Jiyong Park5d1598f2019-02-25 22:14:17 +09002621 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002622 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002623
Jiyong Park5d1598f2019-02-25 22:14:17 +09002624 actx.AddVariationDependencies([]blueprint.Variation{
2625 {Mutator: "link", Variation: "static"},
2626 }, depTag, lib)
2627 }
2628
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002629 for _, lib := range deps.StaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002630 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002631 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002632 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002633 }
Jiyong Parke3867542020-12-03 17:28:25 +09002634 if inList(lib, deps.ExcludeLibsForApex) {
2635 depTag.excludeInApex = true
2636 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002637
Dan Willemsen59339a22018-07-22 21:18:45 -07002638 actx.AddVariationDependencies([]blueprint.Variation{
2639 {Mutator: "link", Variation: "static"},
2640 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002641 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002642
Ivan Lozano0a468a42024-05-13 21:03:34 -04002643 for _, lib := range deps.Rlibs {
2644 depTag := libraryDependencyTag{Kind: rlibLibraryDependency}
2645 actx.AddVariationDependencies([]blueprint.Variation{
2646 {Mutator: "link", Variation: ""},
2647 {Mutator: "rust_libraries", Variation: "rlib"},
2648 {Mutator: "rust_stdlinkage", Variation: "rlib-std"},
2649 }, depTag, lib)
2650 }
2651
Jooyung Han75568392020-03-20 04:29:24 +09002652 // staticUnwinderDep is treated as staticDep for Q apexes
2653 // so that native libraries/binaries are linked with static unwinder
2654 // because Q libc doesn't have unwinder APIs
2655 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002656 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002657 actx.AddVariationDependencies([]blueprint.Variation{
2658 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002659 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002660 }
2661
Jiyong Park7ed9de32018-10-15 22:25:07 +09002662 // shared lib names without the #version suffix
2663 var sharedLibNames []string
2664
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002665 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002666 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002667 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002668 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002669 }
Jiyong Parke3867542020-12-03 17:28:25 +09002670 if inList(lib, deps.ExcludeLibsForApex) {
2671 depTag.excludeInApex = true
2672 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002673 if inList(lib, deps.ExcludeLibsForNonApex) {
2674 depTag.excludeInNonApex = true
2675 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002676
Jiyong Park73c54ee2019-10-22 20:31:18 +09002677 name, version := StubsLibNameAndVersion(lib)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002678 if apiLibraryName, ok := apiImportInfo.SharedLibs[name]; ok && !ctx.OtherModuleExists(name) {
2679 name = apiLibraryName
2680 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002681 sharedLibNames = append(sharedLibNames, name)
2682
Colin Crosse7257d22020-09-24 09:56:18 -07002683 variations := []blueprint.Variation{
2684 {Mutator: "link", Variation: "shared"},
2685 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002686
2687 if _, ok := apiImportInfo.ApexSharedLibs[name]; !ok || ctx.OtherModuleExists(name) {
2688 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
2689 }
2690
2691 if apiLibraryName, ok := apiImportInfo.ApexSharedLibs[name]; ok {
2692 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, apiLibraryName, version, false)
2693 }
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002694 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002695
Colin Crossfe9acfe2021-06-14 16:13:03 -07002696 for _, lib := range deps.LateStaticLibs {
2697 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2698 actx.AddVariationDependencies([]blueprint.Variation{
2699 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002700 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002701 }
2702
Colin Cross3e5e7782022-06-17 22:17:05 +00002703 for _, lib := range deps.UnexportedStaticLibs {
2704 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2705 actx.AddVariationDependencies([]blueprint.Variation{
2706 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002707 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002708 }
2709
Jiyong Park7ed9de32018-10-15 22:25:07 +09002710 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002711 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002712 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2713 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2714 // linking against both the stubs lib and the non-stubs lib at the same time.
2715 continue
2716 }
Colin Cross6e511a92020-07-27 21:26:48 -07002717 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002718 variations := []blueprint.Variation{
2719 {Mutator: "link", Variation: "shared"},
2720 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002721 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002722 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002723
Dan Willemsen59339a22018-07-22 21:18:45 -07002724 actx.AddVariationDependencies([]blueprint.Variation{
2725 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002726 }, dataLibDepTag, deps.DataLibs...)
2727
Colin Crossc8caa062021-09-24 16:50:14 -07002728 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2729
Chris Parsons79d66a52020-06-05 17:26:16 -04002730 actx.AddVariationDependencies([]blueprint.Variation{
2731 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002732 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002733
Colin Cross68861832016-07-08 10:41:41 -07002734 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002735
2736 for _, gen := range deps.GeneratedHeaders {
2737 depTag := genHeaderDepTag
2738 if inList(gen, deps.ReexportGeneratedHeaders) {
2739 depTag = genHeaderExportDepTag
2740 }
2741 actx.AddDependency(c, depTag, gen)
2742 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002743
Dan Albert92fe7402020-07-15 13:33:30 -07002744 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002745 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002746 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002747 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002748 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08002749 }
Colin Crossc465efd2021-06-11 18:00:04 -07002750 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002751 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002752 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07002753 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002754 if deps.DynamicLinker != "" {
2755 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002756 }
Dan Albert914449f2016-06-17 16:45:24 -07002757
2758 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002759
2760 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002761 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002762 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002763 {Mutator: "link", Variation: "shared"},
2764 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002765 actx.AddVariationDependencies([]blueprint.Variation{
2766 {Mutator: "version", Variation: version},
2767 {Mutator: "link", Variation: "shared"},
2768 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002769
2770 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002771 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002772 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002773 {Mutator: "link", Variation: "shared"},
2774 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002775 actx.AddVariationDependencies([]blueprint.Variation{
2776 {Mutator: "version", Variation: version},
2777 {Mutator: "link", Variation: "shared"},
2778 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002779
2780 if vndkdep := c.vndkdep; vndkdep != nil {
2781 if vndkdep.isVndkExt() {
Logan Chienf3511742017-10-31 18:04:35 +08002782 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross7228ecd2019-11-18 16:00:16 -08002783 c.ImageVariation(),
Dan Willemsen59339a22018-07-22 21:18:45 -07002784 {Mutator: "link", Variation: "shared"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002785 }, vndkExtDepTag, vndkdep.getVndkExtendsModuleName())
Logan Chienf3511742017-10-31 18:04:35 +08002786 }
2787 }
Kiyoung Kimee58c932022-10-25 22:59:41 +09002788
Vinh Tran367d89d2023-04-28 11:21:25 -04002789 if len(deps.AidlLibs) > 0 {
2790 actx.AddDependency(
2791 c,
2792 aidlLibraryTag,
2793 deps.AidlLibs...,
2794 )
2795 }
2796
Kiyoung Kimee58c932022-10-25 22:59:41 +09002797 updateImportedLibraryDependency(ctx)
Colin Cross6362e272015-10-29 15:25:03 -07002798}
Colin Cross21b9a242015-03-24 14:15:58 -07002799
Colin Crosse40b4ea2018-10-02 22:25:58 -07002800func BeginMutator(ctx android.BottomUpMutatorContext) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002801 if c, ok := ctx.Module().(*Module); ok && c.Enabled() {
2802 c.beginMutator(ctx)
2803 }
2804}
2805
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002806// Whether a module can link to another module, taking into
2807// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002808func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002809 tag blueprint.DependencyTag) {
2810
2811 switch t := tag.(type) {
2812 case dependencyTag:
2813 if t != vndkExtDepTag {
2814 return
2815 }
2816 case libraryDependencyTag:
2817 default:
2818 return
2819 }
2820
Ivan Lozanof9e21722020-12-02 09:00:51 -05002821 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002822 // Host code is not restricted
2823 return
2824 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002825
2826 // VNDK is cc.Module supported only for now.
2827 if ccFrom, ok := from.(*Module); ok && from.UseVndk() {
Justin Yun63e9ec72020-10-29 16:49:43 +09002828 // Though allowed dependency is limited by the image mutator,
2829 // each vendor and product module needs to check link-type
2830 // for VNDK.
Ivan Lozano52767be2019-10-18 14:49:46 -07002831 if ccTo, ok := to.(*Module); ok {
2832 if ccFrom.vndkdep != nil {
2833 ccFrom.vndkdep.vndkCheckLinkType(ctx, ccTo, tag)
2834 }
Ivan Lozanoc08897c2021-04-02 12:41:32 -04002835 } else if _, ok := to.(LinkableInterface); !ok {
Ivan Lozano52767be2019-10-18 14:49:46 -07002836 ctx.ModuleErrorf("Attempting to link VNDK cc.Module with unsupported module type")
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002837 }
2838 return
2839 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002840 // TODO(b/244244438) : Remove this once all variants are implemented
2841 if ccFrom, ok := from.(*Module); ok && ccFrom.isImportedApiLibrary() {
2842 return
2843 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002844 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002845 // Platform code can link to anything
2846 return
2847 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002848 if from.InRamdisk() {
2849 // Ramdisk code is not NDK
2850 return
2851 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002852 if from.InVendorRamdisk() {
2853 // Vendor ramdisk code is not NDK
2854 return
2855 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002856 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002857 // Recovery code is not NDK
2858 return
2859 }
Colin Cross31076b32020-10-23 17:22:06 -07002860 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002861 if c.NdkPrebuiltStl() {
2862 // These are allowed, but they don't set sdk_version
2863 return
2864 }
2865 if c.StubDecorator() {
2866 // These aren't real libraries, but are the stub shared libraries that are included in
2867 // the NDK.
2868 return
2869 }
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002870 if c.isImportedApiLibrary() {
2871 // Imported library from the API surface is a stub library built against interface definition.
2872 return
2873 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002874 }
Logan Chien834b9a62019-01-14 15:39:03 +08002875
Ivan Lozano52767be2019-10-18 14:49:46 -07002876 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002877 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2878 // to link to libc++ (non-NDK and without sdk_version).
2879 return
2880 }
2881
Ivan Lozano52767be2019-10-18 14:49:46 -07002882 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002883 // NDK code linking to platform code is never okay.
2884 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002885 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002886 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002887 }
2888
2889 // At this point we know we have two NDK libraries, but we need to
2890 // check that we're not linking against anything built against a higher
2891 // API level, as it is only valid to link against older or equivalent
2892 // APIs.
2893
Inseob Kim01a28722018-04-11 09:48:45 +09002894 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002895 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002896 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002897 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002898 // Current can't be linked against by anything else.
2899 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002900 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002901 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002902 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002903 if err != nil {
2904 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002905 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002906 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002907 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002908 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002909 if err != nil {
2910 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002911 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002912 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002913 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002914
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002915 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002916 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002917 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002918 }
2919 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002920 }
Dan Albert202fe492017-12-15 13:56:59 -08002921
2922 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002923 fromStl := from.SelectedStl()
2924 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002925 if fromStl == "" || toStl == "" {
2926 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002927 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002928 // We can be permissive with the system "STL" since it is only the C++
2929 // ABI layer, but in the future we should make sure that everyone is
2930 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002931 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002932 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002933 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2934 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002935 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002936}
2937
Jooyung Han479ca172020-10-19 18:51:07 +09002938func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2939 if c, ok := ctx.Module().(*Module); ok {
2940 ctx.VisitDirectDeps(func(dep android.Module) {
2941 depTag := ctx.OtherModuleDependencyTag(dep)
2942 ccDep, ok := dep.(LinkableInterface)
2943 if ok {
2944 checkLinkType(ctx, c, ccDep, depTag)
2945 }
2946 })
2947 }
2948}
2949
Jiyong Park5fb8c102018-04-09 12:03:06 +09002950// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002951// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2952// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002953// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Jooyung Hana70f0672019-01-18 15:20:43 +09002954func checkDoubleLoadableLibraries(ctx android.TopDownMutatorContext) {
2955 check := func(child, parent android.Module) bool {
2956 to, ok := child.(*Module)
2957 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002958 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002959 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002960
Jooyung Hana70f0672019-01-18 15:20:43 +09002961 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2962 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002963 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002964
Jiyong Park0474e1f2021-01-14 14:26:06 +09002965 // These dependencies are not excercised at runtime. Tracking these will give us
2966 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002967 depTag := ctx.OtherModuleDependencyTag(child)
2968 if IsHeaderDepTag(depTag) {
2969 return false
2970 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002971 if depTag == staticVariantTag {
2972 return false
2973 }
2974 if depTag == stubImplDepTag {
2975 return false
2976 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002977 if depTag == android.RequiredDepTag {
2978 return false
2979 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002980
Justin Yun63e9ec72020-10-29 16:49:43 +09002981 // Even if target lib has no vendor variant, keep checking dependency
2982 // graph in case it depends on vendor_available or product_available
2983 // but not double_loadable transtively.
2984 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002985 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002986 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002987
Jiyong Park0474e1f2021-01-14 14:26:06 +09002988 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2989 // one.
2990 if Bool(to.VendorProperties.Double_loadable) {
2991 return true
2992 }
2993
Ivan Lozanod7586b62021-04-01 09:49:36 -04002994 if to.IsVndkSp() || to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002995 return false
2996 }
2997
Jooyung Hana70f0672019-01-18 15:20:43 +09002998 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2999 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003000 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003001 return false
3002 }
3003 if module, ok := ctx.Module().(*Module); ok {
3004 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003005 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003006 ctx.WalkDeps(check)
3007 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003008 }
3009 }
3010}
3011
Yu Liue4312402023-01-18 09:15:31 -08003012func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3013 // For the dependency from platform to apex, use the latest stubs
3014 apexSdkVersion := android.FutureApiLevel
3015 if !apexInfo.IsForPlatform() {
3016 apexSdkVersion = apexInfo.MinSdkVersion
3017 }
3018
3019 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3020 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3021 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3022 // (b/144430859)
3023 apexSdkVersion = android.FutureApiLevel
3024 }
3025
3026 return apexSdkVersion
3027}
3028
Colin Crossc99deeb2016-04-11 15:06:20 -07003029// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003030func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003031 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003032
Colin Cross0de8a1e2020-09-18 14:15:30 -07003033 var directStaticDeps []StaticLibraryInfo
3034 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003035
Colin Cross0de8a1e2020-09-18 14:15:30 -07003036 reexportExporter := func(exporter FlagExporterInfo) {
3037 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3038 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3039 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3040 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3041 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003042 }
3043
Colin Crossff694a82023-12-13 15:54:49 -08003044 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003045 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003046
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003047 skipModuleList := map[string]bool{}
3048
3049 var apiImportInfo multitree.ApiImportInfo
3050 hasApiImportInfo := false
3051
3052 ctx.VisitDirectDeps(func(dep android.Module) {
3053 if dep.Name() == "api_imports" {
Colin Cross313aa542023-12-13 13:47:44 -08003054 apiImportInfo, _ = android.OtherModuleProvider(ctx, dep, multitree.ApiImportsProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003055 hasApiImportInfo = true
3056 }
3057 })
3058
3059 if hasApiImportInfo {
3060 targetStubModuleList := map[string]string{}
3061 targetOrigModuleList := map[string]string{}
3062
3063 // Search for dependency which both original module and API imported library with APEX stub exists
3064 ctx.VisitDirectDeps(func(dep android.Module) {
3065 depName := ctx.OtherModuleName(dep)
3066 if apiLibrary, ok := apiImportInfo.ApexSharedLibs[depName]; ok {
3067 targetStubModuleList[apiLibrary] = depName
3068 }
3069 })
3070 ctx.VisitDirectDeps(func(dep android.Module) {
3071 depName := ctx.OtherModuleName(dep)
3072 if origLibrary, ok := targetStubModuleList[depName]; ok {
3073 targetOrigModuleList[origLibrary] = depName
3074 }
3075 })
3076
3077 // Decide which library should be used between original and API imported library
3078 ctx.VisitDirectDeps(func(dep android.Module) {
3079 depName := ctx.OtherModuleName(dep)
3080 if apiLibrary, ok := targetOrigModuleList[depName]; ok {
Spandan Das604f3762023-03-16 22:51:40 +00003081 if ShouldUseStubForApex(ctx, dep) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003082 skipModuleList[depName] = true
3083 } else {
3084 skipModuleList[apiLibrary] = true
3085 }
3086 }
3087 })
3088 }
3089
Colin Crossd11fcda2017-10-23 17:59:01 -07003090 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003091 depName := ctx.OtherModuleName(dep)
3092 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003093
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003094 if _, ok := skipModuleList[depName]; ok {
3095 // skip this module because original module or API imported module matching with this should be used instead.
3096 return
3097 }
3098
Dan Willemsen47450072021-10-19 20:24:49 -07003099 if depTag == android.DarwinUniversalVariantTag {
3100 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
3101 return
3102 }
3103
Vinh Tran367d89d2023-04-28 11:21:25 -04003104 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003105 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003106 depPaths.AidlLibraryInfos = append(
3107 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003108 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003109 )
3110 }
3111 }
3112
Ivan Lozano52767be2019-10-18 14:49:46 -07003113 ccDep, ok := dep.(LinkableInterface)
3114 if !ok {
3115
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003116 // handling for a few module types that aren't cc Module but that are also supported
3117 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003118 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003119 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003120 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
3121 genRule.GeneratedSourceFiles()...)
3122 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003123 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003124 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003125 // Support exported headers from a generated_sources dependency
3126 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003127 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003128 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003129 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08003130 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09003131 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09003132 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003133 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003134 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003135 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
3136 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09003137 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003138 // 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 +09003139 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003140
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003141 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003142 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003143 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003144 }
Colin Crosscef792e2021-06-11 18:01:26 -07003145 case CrtBeginDepTag:
3146 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3147 case CrtEndDepTag:
3148 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003149 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003150 return
3151 }
3152
Colin Crossfe17f6f2019-03-28 19:30:56 -07003153 if depTag == android.ProtoPluginDepTag {
3154 return
3155 }
3156
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003157 if depTag == android.RequiredDepTag {
3158 return
3159 }
3160
Colin Crossd11fcda2017-10-23 17:59:01 -07003161 if dep.Target().Os != ctx.Os() {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003162 ctx.ModuleErrorf("OS mismatch between %q and %q", ctx.ModuleName(), depName)
3163 return
3164 }
Colin Crossd11fcda2017-10-23 17:59:01 -07003165 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003166 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
3167 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003168 return
3169 }
3170
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003171 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003172 // Skip reused objects for stub libraries, they use their own stub object file instead.
3173 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3174 // version mutator, so the stubs variant is created from the shared variant that
3175 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003176 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003177 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003178 objs := staticAnalogue.ReuseObjects
3179 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003180 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003181 reexportExporter(depExporterInfo)
3182 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003183 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003184 }
3185
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003186 if depTag == llndkHeaderLibTag {
3187 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3188 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3189 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3190 }
3191
Colin Cross6e511a92020-07-27 21:26:48 -07003192 linkFile := ccDep.OutputFile()
3193
3194 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3195 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003196 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003197 return
3198 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003199
Jiyong Parke3867542020-12-03 17:28:25 +09003200 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3201 return
3202 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003203 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3204 return
3205 }
Jiyong Parke3867542020-12-03 17:28:25 +09003206
Colin Cross313aa542023-12-13 13:47:44 -08003207 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003208
Colin Cross6e511a92020-07-27 21:26:48 -07003209 var ptr *android.Paths
3210 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003211
Colin Cross6e511a92020-07-27 21:26:48 -07003212 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003213
Colin Cross6e511a92020-07-27 21:26:48 -07003214 switch {
3215 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003216 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003217 if !ctx.Config().AllowMissingDependencies() {
3218 ctx.ModuleErrorf("module %q is not a header library", depName)
3219 } else {
3220 ctx.AddMissingDependencies([]string{depName})
3221 }
3222 return
3223 }
Colin Cross6e511a92020-07-27 21:26:48 -07003224 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003225 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003226 if !ctx.Config().AllowMissingDependencies() {
3227 ctx.ModuleErrorf("module %q is not a shared library", depName)
3228 } else {
3229 ctx.AddMissingDependencies([]string{depName})
3230 }
3231 return
3232 }
Jiyong Parke3867542020-12-03 17:28:25 +09003233
Jiyong Park7d55b612021-06-11 17:22:09 +09003234 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3235 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003236
Jiyong Park1ad8e162020-12-01 23:40:09 +09003237 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3238 // linkFile, depFile, and ptr.
3239 if c.IsStubs() {
3240 break
3241 }
3242
Colin Cross0de8a1e2020-09-18 14:15:30 -07003243 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3244 depFile = sharedLibraryInfo.TableOfContents
3245
Colin Cross6e511a92020-07-27 21:26:48 -07003246 ptr = &depPaths.SharedLibs
3247 switch libDepTag.Order {
3248 case earlyLibraryDependency:
3249 ptr = &depPaths.EarlySharedLibs
3250 depPtr = &depPaths.EarlySharedLibsDeps
3251 case normalLibraryDependency:
3252 ptr = &depPaths.SharedLibs
3253 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003254 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003255 case lateLibraryDependency:
3256 ptr = &depPaths.LateSharedLibs
3257 depPtr = &depPaths.LateSharedLibsDeps
3258 default:
3259 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003260 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003261
3262 case libDepTag.rlib():
3263 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: ccDep.CrateName(), LinkDirs: ccDep.ExportedCrateLinkDirs()}
3264 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
3265 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3266 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3267 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3268
Colin Cross6e511a92020-07-27 21:26:48 -07003269 case libDepTag.static():
Colin Cross313aa542023-12-13 13:47:44 -08003270 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3271 if !isStaticLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003272 if !ctx.Config().AllowMissingDependencies() {
3273 ctx.ModuleErrorf("module %q is not a static library", depName)
3274 } else {
3275 ctx.AddMissingDependencies([]string{depName})
3276 }
3277 return
3278 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003279
3280 // Stubs lib doesn't link to the static lib dependencies. Don't set
3281 // linkFile, depFile, and ptr.
3282 if c.IsStubs() {
3283 break
3284 }
3285
Colin Cross0de8a1e2020-09-18 14:15:30 -07003286 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
Colin Cross6e511a92020-07-27 21:26:48 -07003287 if libDepTag.wholeStatic {
3288 ptr = &depPaths.WholeStaticLibs
Colin Cross0de8a1e2020-09-18 14:15:30 -07003289 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3290 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
Inseob Kimeec88e12020-01-22 11:11:29 +09003291 } else {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003292 // This case normally catches prebuilt static
3293 // libraries, but it can also occur when
3294 // AllowMissingDependencies is on and the
3295 // dependencies has no sources of its own
3296 // but has a whole_static_libs dependency
3297 // on a missing library. We want to depend
3298 // on the .a file so that there is something
3299 // in the dependency tree that contains the
3300 // error rule for the missing transitive
3301 // dependency.
3302 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003303 }
Colin Crossa2bcf2c2022-02-11 13:11:55 -08003304 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3305 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
Colin Cross6e511a92020-07-27 21:26:48 -07003306 } else {
3307 switch libDepTag.Order {
3308 case earlyLibraryDependency:
3309 panic(fmt.Errorf("early static libs not suppported"))
3310 case normalLibraryDependency:
3311 // static dependencies will be handled separately so they can be ordered
3312 // using transitive dependencies.
3313 ptr = nil
Colin Cross0de8a1e2020-09-18 14:15:30 -07003314 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003315 case lateLibraryDependency:
3316 ptr = &depPaths.LateStaticLibs
3317 default:
3318 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Inseob Kimeec88e12020-01-22 11:11:29 +09003319 }
3320 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003321
3322 // We re-export the Rust static_rlibs so rlib dependencies don't need to be redeclared by cc_library_static dependents.
3323 // E.g. libfoo (cc_library_static) depends on libfoo.ffi (a rust_ffi rlib), libbar depending on libfoo shouldn't have to also add libfoo.ffi to static_rlibs.
3324 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3325 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3326
Colin Cross3e5e7782022-06-17 22:17:05 +00003327 if libDepTag.unexportedSymbols {
3328 depPaths.LdFlags = append(depPaths.LdFlags,
3329 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3330 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003331 }
3332
Colin Cross6e511a92020-07-27 21:26:48 -07003333 if libDepTag.static() && !libDepTag.wholeStatic {
3334 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3335 ctx.ModuleErrorf("module %q not a static library", depName)
3336 return
3337 }
Logan Chien43d34c32017-12-20 01:17:32 +08003338
Colin Cross6e511a92020-07-27 21:26:48 -07003339 // When combining coverage files for shared libraries and executables, coverage files
3340 // in static libraries act as if they were whole static libraries. The same goes for
3341 // source based Abi dump files.
3342 if c, ok := ccDep.(*Module); ok {
3343 staticLib := c.linker.(libraryInterface)
3344 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3345 staticLib.objs().coverageFiles...)
3346 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3347 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003348 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003349 // Handle non-CC modules here
3350 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003351 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003352 }
3353 }
3354
Colin Cross6e511a92020-07-27 21:26:48 -07003355 if ptr != nil {
3356 if !linkFile.Valid() {
3357 if !ctx.Config().AllowMissingDependencies() {
3358 ctx.ModuleErrorf("module %q missing output file", depName)
3359 } else {
3360 ctx.AddMissingDependencies([]string{depName})
3361 }
3362 return
3363 }
3364 *ptr = append(*ptr, linkFile.Path())
3365 }
3366
3367 if depPtr != nil {
3368 dep := depFile
3369 if !dep.Valid() {
3370 dep = linkFile
3371 }
3372 *depPtr = append(*depPtr, dep.Path())
3373 }
3374
Colin Cross0de8a1e2020-09-18 14:15:30 -07003375 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3376 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3377 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3378 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003379 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3380
3381 // Only re-export RustRlibDeps for cc static libs
3382 if c.static() {
3383 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3384 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003385
3386 if libDepTag.reexportFlags {
3387 reexportExporter(depExporterInfo)
3388 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3389 // Re-exported shared library headers must be included as well since they can help us with type information
3390 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003391 c.sabi.Properties.ReexportedIncludes = append(
3392 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003393 c.sabi.Properties.ReexportedSystemIncludes = append(
3394 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003395 }
3396
Spandan Das3faa7922024-02-26 19:42:32 +00003397 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003398 switch {
3399 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003400 c.Properties.AndroidMkHeaderLibs = append(
3401 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003402 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003403 if lib := moduleLibraryInterface(dep); lib != nil {
3404 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003405 // Add the dependency to the APEX(es) providing the library so that
3406 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003407 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003408 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003409 c.Properties.ApexesProvidingSharedLibs = append(
3410 c.Properties.ApexesProvidingSharedLibs, an)
3411 }
3412 }
3413 }
3414
3415 // Note: the order of libs in this list is not important because
3416 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003417 c.Properties.AndroidMkSharedLibs = append(
3418 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003419 case libDepTag.static():
3420 if libDepTag.wholeStatic {
3421 c.Properties.AndroidMkWholeStaticLibs = append(
3422 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3423 } else {
3424 c.Properties.AndroidMkStaticLibs = append(
3425 c.Properties.AndroidMkStaticLibs, makeLibName)
3426 }
3427 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003428 } else if !c.IsStubs() {
3429 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3430
Colin Cross6e511a92020-07-27 21:26:48 -07003431 switch depTag {
3432 case runtimeDepTag:
3433 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003434 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003435 case objDepTag:
3436 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3437 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003438 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003439 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003440 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003441 case dynamicLinkerDepTag:
3442 depPaths.DynamicLinker = linkFile
3443 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003444 }
Colin Crossca860ac2016-01-04 14:34:37 -08003445 })
3446
Jeff Gaston294356f2017-09-27 17:05:30 -07003447 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003448 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3449 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3450 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003451
Colin Crossdd84e052017-05-17 13:44:16 -07003452 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003453 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003454 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3455 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003456 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003457 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3458
Jiyong Park74955042019-10-22 20:19:51 +09003459 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3460 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003461 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003462 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003463 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003464 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003465
3466 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003467 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003468 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003469 }
Colin Crossdd84e052017-05-17 13:44:16 -07003470
Colin Crossca860ac2016-01-04 14:34:37 -08003471 return depPaths
3472}
3473
Spandan Das604f3762023-03-16 22:51:40 +00003474func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09003475 depName := ctx.OtherModuleName(dep)
Jiyong Park7d55b612021-06-11 17:22:09 +09003476 thisModule, ok := ctx.Module().(android.ApexModule)
3477 if !ok {
3478 panic(fmt.Errorf("Not an APEX module: %q", ctx.ModuleName()))
3479 }
3480
Kiyoung Kimaa394802024-01-08 12:55:45 +09003481 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003482 bootstrap := false
3483 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3484 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3485 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003486 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003487 bootstrap = linkable.Bootstrap()
3488 }
3489
Colin Crossff694a82023-12-13 15:54:49 -08003490 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003491
3492 useStubs := false
3493
Kiyoung Kimaa394802024-01-08 12:55:45 +09003494 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003495 if !apexInfo.IsForPlatform() {
3496 // For platform libraries, use current version of LLNDK
3497 // If this is for use_vendor apex we will apply the same rules
3498 // of apex sdk enforcement below to choose right version.
3499 useStubs = true
3500 }
3501 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3502 // If not building for APEX or the containing APEX allows the use of
3503 // platform APIs, use stubs only when it is from an APEX (and not from
3504 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3505 // bootstrap modules, always link to non-stub variant
3506 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3507
3508 isApexImportedApiLibrary := false
3509
3510 if cc, ok := dep.(*Module); ok {
3511 if apiLibrary, ok := cc.linker.(*apiLibraryDecorator); ok {
3512 if apiLibrary.hasApexStubs() {
3513 isApexImportedApiLibrary = true
3514 }
3515 }
3516 }
3517
3518 useStubs = (isNotInPlatform || isApexImportedApiLibrary) && !bootstrap
3519
3520 if useStubs {
3521 // Another exception: if this module is a test for an APEX, then
3522 // it is linked with the non-stub variant of a module in the APEX
3523 // as if this is part of the APEX.
Colin Crossff694a82023-12-13 15:54:49 -08003524 testFor, _ := android.ModuleProvider(ctx, android.ApexTestForInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003525 for _, apexContents := range testFor.ApexContents {
3526 if apexContents.DirectlyInApex(depName) {
3527 useStubs = false
3528 break
3529 }
3530 }
3531 }
3532 if useStubs {
3533 // Yet another exception: If this module and the dependency are
3534 // available to the same APEXes then skip stubs between their
3535 // platform variants. This complements the test_for case above,
3536 // which avoids the stubs on a direct APEX library dependency, by
3537 // avoiding stubs for indirect test dependencies as well.
3538 //
3539 // TODO(b/183882457): This doesn't work if the two libraries have
3540 // only partially overlapping apex_available. For that test_for
3541 // modules would need to be split into APEX variants and resolved
3542 // separately for each APEX they have access to.
3543 if !isApexImportedApiLibrary && android.AvailableToSameApexes(thisModule, dep.(android.ApexModule)) {
3544 useStubs = false
3545 }
3546 }
3547 } else {
3548 // If building for APEX, use stubs when the parent is in any APEX that
3549 // the child is not in.
3550 useStubs = !android.DirectlyInAllApexes(apexInfo, depName)
3551 }
3552
3553 return useStubs
3554}
3555
3556// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3557// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3558// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3559// has different level of updatability. For example, if a library foo in an APEX depends on a
3560// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3561// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3562// same APEX as foo, the non-stub variant of bar is used.
3563func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3564 depTag := ctx.OtherModuleDependencyTag(dep)
3565 libDepTag, ok := depTag.(libraryDependencyTag)
3566 if !ok || !libDepTag.shared() {
3567 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3568 }
3569
Colin Cross313aa542023-12-13 13:47:44 -08003570 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3571 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3572 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003573
3574 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003575 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003576 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003577 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3578 toUse := stubs[len(stubs)-1]
3579 sharedLibraryInfo = toUse.SharedLibraryInfo
3580 depExporterInfo = toUse.FlagExporterInfo
3581 }
3582 }
3583 return sharedLibraryInfo, depExporterInfo
3584}
3585
Colin Cross0de8a1e2020-09-18 14:15:30 -07003586// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3587// to match the topological order of the dependency tree, including any static analogues of
3588// direct shared libraries. It returns the ordered static dependencies, and an android.DepSet
3589// of the transitive dependencies.
Colin Crossc85750b2022-04-21 12:50:51 -07003590func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive *android.DepSet[android.Path]) {
3591 transitiveStaticLibsBuilder := android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003592 var staticPaths android.Paths
3593 for _, staticDep := range staticDeps {
3594 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3595 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3596 }
3597 for _, sharedDep := range sharedDeps {
Liz Kammeref6dfea2021-06-08 15:37:09 -04003598 if sharedDep.TransitiveStaticLibrariesForOrdering != nil {
3599 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003600 }
3601 }
3602 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3603
3604 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3605
3606 // reorder the dependencies based on transitive dependencies
3607 staticPaths = android.FirstUniquePaths(staticPaths)
3608 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3609
3610 if len(orderedStaticPaths) != len(staticPaths) {
3611 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3612 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3613 }
3614
3615 return orderedStaticPaths, transitiveStaticLibs
3616}
3617
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003618// BaseLibName trims known prefixes and suffixes
3619func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003620 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3621 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003622 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003623 return libName
3624}
3625
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003626func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003627 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003628 ccDepModule, _ := ccDep.(*Module)
3629 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003630 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003631
Justin Yuncbca3732021-02-03 19:24:13 +09003632 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003633 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003634 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003635 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003636
Ivan Lozanod1dec542021-05-26 15:33:11 -04003637 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003638 }
3639 }
3640
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003641 if ctx.DeviceConfig().VndkUseCoreVariant() && ccDep.IsVndk() && !ccDep.MustUseVendorVariant() &&
3642 !c.InRamdisk() && !c.InVendorRamdisk() && !c.InRecovery() {
Colin Cross6e511a92020-07-27 21:26:48 -07003643 // The vendor module is a no-vendor-variant VNDK library. Depend on the
3644 // core module instead.
3645 return libName
Kiyoung Kimaa394802024-01-08 12:55:45 +09003646 } else if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003647 // The vendor and product modules in Make will have been renamed to not conflict with the
3648 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003649 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003650 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003651 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003652 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003653 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003654 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003655 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003656 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003657 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003658 } else {
3659 return libName
3660 }
3661}
3662
Colin Crossca860ac2016-01-04 14:34:37 -08003663func (c *Module) InstallInData() bool {
3664 if c.installer == nil {
3665 return false
3666 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003667 return c.installer.inData()
3668}
3669
3670func (c *Module) InstallInSanitizerDir() bool {
3671 if c.installer == nil {
3672 return false
3673 }
3674 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003675 return true
3676 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003677 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003678}
3679
Yifan Hong1b3348d2020-01-21 15:53:22 -08003680func (c *Module) InstallInRamdisk() bool {
3681 return c.InRamdisk()
3682}
3683
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003684func (c *Module) InstallInVendorRamdisk() bool {
3685 return c.InVendorRamdisk()
3686}
3687
Jiyong Parkf9332f12018-02-01 00:54:12 +09003688func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003689 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003690}
3691
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003692func (c *Module) MakeUninstallable() {
3693 if c.installer == nil {
3694 c.ModuleBase.MakeUninstallable()
3695 return
3696 }
3697 c.installer.makeUninstallable(c)
3698}
3699
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003700func (c *Module) HostToolPath() android.OptionalPath {
3701 if c.installer == nil {
3702 return android.OptionalPath{}
3703 }
3704 return c.installer.hostToolPath()
3705}
3706
Nan Zhangd4e641b2017-07-12 12:55:28 -07003707func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3708 return c.outputFile
3709}
3710
Colin Cross41955e82019-05-29 14:40:35 -07003711func (c *Module) OutputFiles(tag string) (android.Paths, error) {
3712 switch tag {
3713 case "":
3714 if c.outputFile.Valid() {
3715 return android.Paths{c.outputFile.Path()}, nil
3716 }
3717 return android.Paths{}, nil
Colin Cross31d89b42022-10-04 16:35:39 -07003718 case "unstripped":
3719 if c.linker != nil {
3720 return android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), nil
3721 }
3722 return nil, nil
Wei Li5f5d2712023-12-11 15:40:29 -08003723 case "stripped_all":
3724 if c.linker != nil {
3725 return android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), nil
3726 }
3727 return nil, nil
Colin Cross41955e82019-05-29 14:40:35 -07003728 default:
3729 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003730 }
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003731}
3732
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003733func (c *Module) static() bool {
3734 if static, ok := c.linker.(interface {
3735 static() bool
3736 }); ok {
3737 return static.static()
3738 }
3739 return false
3740}
3741
Jiyong Park379de2f2018-12-19 02:47:14 +09003742func (c *Module) staticBinary() bool {
3743 if static, ok := c.linker.(interface {
3744 staticBinary() bool
3745 }); ok {
3746 return static.staticBinary()
3747 }
3748 return false
3749}
3750
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003751func (c *Module) testBinary() bool {
3752 if test, ok := c.linker.(interface {
3753 testBinary() bool
3754 }); ok {
3755 return test.testBinary()
3756 }
3757 return false
3758}
3759
Jingwen Chen537242c2022-08-24 11:53:27 +00003760func (c *Module) testLibrary() bool {
3761 if test, ok := c.linker.(interface {
3762 testLibrary() bool
3763 }); ok {
3764 return test.testLibrary()
3765 }
3766 return false
3767}
3768
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003769func (c *Module) benchmarkBinary() bool {
3770 if b, ok := c.linker.(interface {
3771 benchmarkBinary() bool
3772 }); ok {
3773 return b.benchmarkBinary()
3774 }
3775 return false
3776}
3777
3778func (c *Module) fuzzBinary() bool {
3779 if f, ok := c.linker.(interface {
3780 fuzzBinary() bool
3781 }); ok {
3782 return f.fuzzBinary()
3783 }
3784 return false
3785}
3786
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003787// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3788func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003789 if h, ok := c.linker.(interface {
3790 header() bool
3791 }); ok {
3792 return h.header()
3793 }
3794 return false
3795}
3796
Ivan Lozanod7586b62021-04-01 09:49:36 -04003797func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003798 if b, ok := c.linker.(interface {
3799 binary() bool
3800 }); ok {
3801 return b.binary()
3802 }
3803 return false
3804}
3805
Justin Yun5e035862021-06-29 20:50:37 +09003806func (c *Module) StaticExecutable() bool {
3807 if b, ok := c.linker.(*binaryDecorator); ok {
3808 return b.static()
3809 }
3810 return false
3811}
3812
Ivan Lozanod7586b62021-04-01 09:49:36 -04003813func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003814 if o, ok := c.linker.(interface {
3815 object() bool
3816 }); ok {
3817 return o.object()
3818 }
3819 return false
3820}
3821
Kiyoung Kim37693d02024-04-04 09:56:15 +09003822func (m *Module) Dylib() bool {
3823 return false
3824}
3825
3826func (m *Module) Rlib() bool {
3827 return false
3828}
3829
Ivan Lozanof9e21722020-12-02 09:00:51 -05003830func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003831 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003832 if c.IsLlndk() {
3833 if !c.IsLlndkPublic() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003834 return "native:vndk_private"
Colin Crossb60190a2018-09-04 16:28:17 -07003835 }
Colin Cross127bb8b2020-12-16 16:46:01 -08003836 return "native:vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003837 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003838 if c.IsVndk() && !c.IsVndkExt() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003839 if c.IsVndkPrivate() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003840 return "native:vndk_private"
Jooyung Han38002912019-05-16 04:01:54 +09003841 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003842 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003843 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003844 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003845 return "native:product"
3846 }
Jooyung Han38002912019-05-16 04:01:54 +09003847 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003848 } else if c.InRamdisk() {
3849 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003850 } else if c.InVendorRamdisk() {
3851 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003852 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003853 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003854 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003855 return "native:ndk:none:none"
3856 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3857 //family, link := getNdkStlFamilyAndLinkType(c)
3858 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
Ivan Lozano52767be2019-10-18 14:49:46 -07003859 } else if actx.DeviceConfig().VndkUseCoreVariant() && !c.MustUseVendorVariant() {
Vic Yangefd249e2018-11-12 20:19:56 -08003860 return "native:platform_vndk"
Colin Crossb60190a2018-09-04 16:28:17 -07003861 } else {
3862 return "native:platform"
3863 }
3864}
3865
Jiyong Park9d452992018-10-03 00:38:19 +09003866// Overrides ApexModule.IsInstallabeToApex()
Roland Levillainf89cd092019-07-29 16:22:59 +01003867// Only shared/runtime libraries and "test_per_src" tests are installable to APEX.
Jiyong Park9d452992018-10-03 00:38:19 +09003868func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003869 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003870 // Stub libs and prebuilt libs in a versioned SDK are not
3871 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003872 return lib.shared() && !lib.buildStubs()
Roland Levillainf89cd092019-07-29 16:22:59 +01003873 } else if _, ok := c.linker.(testPerSrc); ok {
3874 return true
Jiyong Park9d452992018-10-03 00:38:19 +09003875 }
3876 return false
3877}
3878
Jiyong Parka90ca002019-10-07 15:47:24 +09003879func (c *Module) AvailableFor(what string) bool {
3880 if linker, ok := c.linker.(interface {
3881 availableFor(string) bool
3882 }); ok {
3883 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3884 } else {
3885 return c.ApexModuleBase.AvailableFor(what)
3886 }
3887}
3888
Jiyong Park62304bb2020-04-13 16:19:48 +09003889func (c *Module) TestFor() []string {
Jiyong Park46a512f2020-12-04 18:02:13 +09003890 return c.Properties.Test_for
Jiyong Park62304bb2020-04-13 16:19:48 +09003891}
3892
Paul Duffin0cb37b92020-03-04 14:52:46 +00003893func (c *Module) EverInstallable() bool {
3894 return c.installer != nil &&
3895 // Check to see whether the module is actually ever installable.
3896 c.installer.everInstallable()
3897}
3898
Ivan Lozanod7586b62021-04-01 09:49:36 -04003899func (c *Module) PreventInstall() bool {
3900 return c.Properties.PreventInstall
3901}
3902
3903func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003904 if c.library != nil {
3905 if i := c.library.installable(); i != nil {
3906 return i
3907 }
3908 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003909 return c.Properties.Installable
3910}
3911
3912func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003913 ret := c.EverInstallable() &&
3914 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003915 proptools.BoolDefault(c.Installable(), true) &&
3916 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003917
3918 // The platform variant doesn't need further condition. Apex variants however might not
3919 // be installable because it will likely to be included in the APEX and won't appear
3920 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003921 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003922 return ret
3923 }
3924
3925 // Special case for modules that are configured to be installed to /data, which includes
3926 // test modules. For these modules, both APEX and non-APEX variants are considered as
3927 // installable. This is because even the APEX variants won't be included in the APEX, but
3928 // will anyway be installed to /data/*.
3929 // See b/146995717
3930 if c.InstallInData() {
3931 return ret
3932 }
3933
3934 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003935}
3936
Logan Chien41eabe62019-04-10 13:33:58 +08003937func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3938 if c.linker != nil {
3939 if library, ok := c.linker.(*libraryDecorator); ok {
3940 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3941 }
3942 }
3943}
3944
Jiyong Park45bf82e2020-12-15 22:29:02 +09003945var _ android.ApexModule = (*Module)(nil)
3946
3947// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003948func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003949 depTag := ctx.OtherModuleDependencyTag(dep)
3950 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3951
3952 if cc, ok := dep.(*Module); ok {
3953 if cc.HasStubsVariants() {
3954 if isLibDepTag && libDepTag.shared() {
3955 // dynamic dep to a stubs lib crosses APEX boundary
3956 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003957 }
Colin Cross6e511a92020-07-27 21:26:48 -07003958 if IsRuntimeDepTag(depTag) {
3959 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003960 return false
3961 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003962 }
Zhijun Heec285872021-04-24 10:47:08 -07003963 if cc.IsLlndk() {
3964 return false
3965 }
Colin Crossaac32222020-07-29 12:51:56 -07003966 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003967 // shared_lib dependency from a static lib is considered as crossing
3968 // the APEX boundary because the dependency doesn't actually is
3969 // linked; the dependency is used only during the compilation phase.
3970 return false
3971 }
Jiyong Parke3867542020-12-03 17:28:25 +09003972
3973 if isLibDepTag && libDepTag.excludeInApex {
3974 return false
3975 }
Colin Cross6e511a92020-07-27 21:26:48 -07003976 }
Colin Crossc1b36442021-05-06 13:42:48 -07003977 if depTag == stubImplDepTag {
3978 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003979 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003980 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003981 if depTag == staticVariantTag {
3982 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3983 // actually mean that the static lib (and its dependencies) are copied into the
3984 // APEX.
3985 return false
3986 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003987 return true
3988}
3989
Jiyong Park45bf82e2020-12-15 22:29:02 +09003990// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003991func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3992 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003993 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3994 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3995 return nil
3996 }
Jooyung Han749dc692020-04-15 11:03:39 +09003997 // We don't check for prebuilt modules
3998 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3999 return nil
4000 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09004001
Jooyung Han749dc692020-04-15 11:03:39 +09004002 minSdkVersion := c.MinSdkVersion()
4003 if minSdkVersion == "apex_inherit" {
4004 return nil
4005 }
4006 if minSdkVersion == "" {
4007 // JNI libs within APK-in-APEX fall into here
4008 // Those are okay to set sdk_version instead
4009 // We don't have to check if this is a SDK variant because
4010 // non-SDK variant resets sdk_version, which works too.
4011 minSdkVersion = c.SdkVersion()
4012 }
Dan Albertc8060532020-07-22 22:32:17 -07004013 if minSdkVersion == "" {
4014 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
4015 }
4016 // Not using nativeApiLevelFromUser because the context here is not
4017 // necessarily a native context.
4018 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09004019 if err != nil {
4020 return err
4021 }
Dan Albertc8060532020-07-22 22:32:17 -07004022
Colin Cross8ca61c12022-10-06 21:00:14 -07004023 // A dependency only needs to support a min_sdk_version at least
4024 // as high as the api level that the architecture was introduced in.
4025 // This allows introducing new architectures in the platform that
4026 // need to be included in apexes that normally require an older
4027 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08004028 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07004029 if sdkVersion.LessThan(minApiForArch) {
4030 sdkVersion = minApiForArch
4031 }
4032
Dan Albertc8060532020-07-22 22:32:17 -07004033 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004034 return fmt.Errorf("newer SDK(%v)", ver)
4035 }
4036 return nil
4037}
4038
Paul Duffinb5769c12021-05-12 16:16:51 +01004039// Implements android.ApexModule
4040func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4041 // stub libraries and native bridge libraries are always available to platform
4042 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4043}
4044
Jooyung Han91f92032022-02-04 12:36:33 +09004045// Overrides android.ApexModuleBase.UniqueApexVariations
4046func (c *Module) UniqueApexVariations() bool {
4047 // When a vendor APEX needs a VNDK lib in it (use_vndk_as_stable: false), it should be a unique
4048 // APEX variation. Otherwise, another vendor APEX with use_vndk_as_stable:true may use a wrong
4049 // variation of the VNDK lib because APEX variations are merged/grouped.
Jooyung Handfc864c2023-03-20 18:19:07 +09004050 // TODO(b/274401041) Find a way to merge APEX variations for vendor apexes.
Jooyung Han91f92032022-02-04 12:36:33 +09004051 return c.UseVndk() && c.IsVndk()
4052}
4053
Inseob Kima1888ce2022-10-04 14:42:02 +09004054func (c *Module) overriddenModules() []string {
4055 if o, ok := c.linker.(overridable); ok {
4056 return o.overriddenModules()
4057 }
4058 return nil
4059}
4060
Liz Kammer35ca77e2021-12-22 15:31:40 -05004061type moduleType int
4062
4063const (
4064 unknownType moduleType = iota
4065 binary
4066 object
4067 fullLibrary
4068 staticLibrary
4069 sharedLibrary
4070 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004071 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004072 ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004073 ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004074)
4075
4076func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004077 if c.testBinary() {
4078 // testBinary is also a binary, so this comes before the c.Binary()
4079 // conditional. A testBinary has additional implicit dependencies and
4080 // other test-only semantics.
4081 return testBin
4082 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004083 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004084 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004085 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004086 } else if c.testLibrary() {
4087 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4088 // will let them add implicit compile deps on gtest, for example.
4089 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004090 // For now, treat them as regular libraries.
4091 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004092 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004093 static := false
4094 shared := false
4095 if library, ok := c.linker.(*libraryDecorator); ok {
4096 static = library.MutatedProperties.BuildStatic
4097 shared = library.MutatedProperties.BuildShared
4098 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4099 static = library.MutatedProperties.BuildStatic
4100 shared = library.MutatedProperties.BuildShared
4101 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004102 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004103 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004104 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004105 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004106 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004107 return staticLibrary
4108 }
4109 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004110 } else if c.isNDKStubLibrary() {
4111 return ndkLibrary
Spandan Dase12d2522023-09-12 21:42:31 +00004112 } else if c.IsNdkPrebuiltStl() {
4113 return ndkPrebuiltStl
Liz Kammer35ca77e2021-12-22 15:31:40 -05004114 }
4115 return unknownType
4116}
4117
Colin Crosscfad1192015-11-02 16:43:11 -08004118// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004119type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004120 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004121 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004122 android.ApexModuleBase
LaMont Jonesafe7baf2024-01-09 22:47:39 +00004123
4124 // Aconfig files for all transitive deps. Also exposed via TransitiveDeclarationsInfo
4125 mergedAconfigFiles map[string]android.Paths
Colin Crosscfad1192015-11-02 16:43:11 -08004126}
4127
Patrice Arrudac249c712019-03-19 17:00:29 -07004128// cc_defaults provides a set of properties that can be inherited by other cc
4129// modules. A module can use the properties from a cc_defaults using
4130// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4131// merged (when possible) by prepending the default module's values to the
4132// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004133func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004134 return DefaultsFactory()
4135}
4136
Colin Cross36242852017-06-23 15:06:31 -07004137func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004138 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004139
Colin Cross36242852017-06-23 15:06:31 -07004140 module.AddProperties(props...)
4141 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004142 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004143 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004144 &BaseCompilerProperties{},
4145 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004146 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004147 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004148 &StaticProperties{},
4149 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004150 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004151 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004152 &TestLinkerProperties{},
4153 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004154 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004155 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004156 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004157 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004158 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004159 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004160 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004161 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004162 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004163 &SAbiProperties{},
Justin Yun4b2382f2017-07-26 14:22:10 +09004164 &VndkProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004165 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004166 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004167 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004168 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004169 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4170 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004171 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004172 )
Colin Crosscfad1192015-11-02 16:43:11 -08004173
Jooyung Hancc372c52019-09-25 15:18:44 +09004174 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004175
4176 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004177}
4178
Jiyong Park2286afd2020-06-16 21:58:53 +09004179func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004180 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004181}
4182
Kiyoung Kim51279d32022-08-24 14:10:46 +09004183func (c *Module) isImportedApiLibrary() bool {
4184 _, ok := c.linker.(*apiLibraryDecorator)
4185 return ok
4186}
4187
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004188func kytheExtractAllFactory() android.Singleton {
4189 return &kytheExtractAllSingleton{}
4190}
4191
4192type kytheExtractAllSingleton struct {
4193}
4194
4195func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4196 var xrefTargets android.Paths
4197 ctx.VisitAllModules(func(module android.Module) {
4198 if ccModule, ok := module.(xref); ok {
4199 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
4200 }
4201 })
4202 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4203 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004204 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004205 }
4206}
4207
Jihoon Kangf78a8902022-09-01 22:47:07 +00004208func (c *Module) Partition() string {
4209 if p, ok := c.installer.(interface {
4210 getPartition() string
4211 }); ok {
4212 return p.getPartition()
4213 }
4214 return ""
4215}
4216
Spandan Das2b6dfb52024-01-19 00:22:22 +00004217type sourceModuleName interface {
4218 sourceModuleName() string
4219}
4220
4221func (c *Module) BaseModuleName() string {
4222 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4223 // if the prebuilt module sets a source_module_name in Android.bp, use that
4224 return smn.sourceModuleName()
4225 }
4226 return c.ModuleBase.BaseModuleName()
4227}
4228
Colin Cross06a931b2015-10-28 17:23:31 -07004229var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004230var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004231var BoolPtr = proptools.BoolPtr
4232var String = proptools.String
4233var StringPtr = proptools.StringPtr