blob: 4da1103076bdcdba9e2d98b3f7098273acb02331 [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 Cross516c5452024-10-28 13:45:21 -070022 "errors"
Colin Cross41955e82019-05-29 14:40:35 -070023 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080024 "io"
Colin Cross516c5452024-10-28 13:45:21 -070025 "slices"
Dan Albert9e10cd42016-08-03 14:12:14 -070026 "strconv"
Colin Cross3f40fa42015-01-30 17:27:36 -080027 "strings"
28
Colin Cross97ba0732015-03-23 17:50:24 -070029 "github.com/google/blueprint"
Colin Crossa14fb6a2024-10-23 16:57:06 -070030 "github.com/google/blueprint/depset"
Colin Cross06a931b2015-10-28 17:23:31 -070031 "github.com/google/blueprint/proptools"
Colin Cross97ba0732015-03-23 17:50:24 -070032
Vinh Tran367d89d2023-04-28 11:21:25 -040033 "android/soong/aidl_library"
Colin Cross635c3b02016-05-18 15:37:25 -070034 "android/soong/android"
Colin Crossb98c8b02016-07-29 13:44:28 -070035 "android/soong/cc/config"
hamzehc0a671f2021-07-22 12:05:08 -070036 "android/soong/fuzz"
Colin Cross3f40fa42015-01-30 17:27:36 -080037)
38
Yu Liu76d94462024-10-31 23:32:36 +000039type CcMakeVarsInfo struct {
40 WarningsAllowed string
41 UsingWnoError string
42 MissingProfile string
43}
44
45var CcMakeVarsInfoProvider = blueprint.NewProvider[*CcMakeVarsInfo]()
46
Yu Liuec7043d2024-11-05 18:22:20 +000047type CcObjectInfo struct {
Yu Liu4f825132024-12-18 00:35:39 +000048 ObjFiles android.Paths
49 TidyFiles android.Paths
50 KytheFiles android.Paths
Yu Liuec7043d2024-11-05 18:22:20 +000051}
52
53var CcObjectInfoProvider = blueprint.NewProvider[CcObjectInfo]()
54
Yu Liu323d77a2024-12-16 23:13:57 +000055type AidlInterfaceInfo struct {
56 // list of aidl_interface sources
57 Sources []string
58 // root directory of AIDL sources
59 AidlRoot string
60 // AIDL backend language (e.g. "cpp", "ndk")
61 Lang string
62 // list of flags passed to AIDL generator
63 Flags []string
64}
65
66type CompilerInfo struct {
67 Srcs android.Paths
68 // list of module-specific flags that will be used for C and C++ compiles.
Cole Faustc9b88c92025-02-06 17:58:26 -080069 Cflags []string
Yu Liu323d77a2024-12-16 23:13:57 +000070 AidlInterfaceInfo AidlInterfaceInfo
71 LibraryDecoratorInfo *LibraryDecoratorInfo
72}
73
74type LinkerInfo struct {
Cole Faustc9b88c92025-02-06 17:58:26 -080075 WholeStaticLibs []string
Yu Liu323d77a2024-12-16 23:13:57 +000076 // list of modules that should be statically linked into this module.
Cole Faustc9b88c92025-02-06 17:58:26 -080077 StaticLibs []string
Yu Liu323d77a2024-12-16 23:13:57 +000078 // list of modules that should be dynamically linked into this module.
Cole Faustc9b88c92025-02-06 17:58:26 -080079 SharedLibs []string
Yu Liu323d77a2024-12-16 23:13:57 +000080 // list of modules that should only provide headers for this module.
Cole Faustc9b88c92025-02-06 17:58:26 -080081 HeaderLibs []string
Yu Liu68a70b72025-01-08 22:54:44 +000082 ImplementationModuleName *string
Yu Liu323d77a2024-12-16 23:13:57 +000083
84 BinaryDecoratorInfo *BinaryDecoratorInfo
85 LibraryDecoratorInfo *LibraryDecoratorInfo
86 TestBinaryInfo *TestBinaryInfo
87 BenchmarkDecoratorInfo *BenchmarkDecoratorInfo
88 ObjectLinkerInfo *ObjectLinkerInfo
Yu Liu8a8d5b42025-01-07 00:48:08 +000089 StubDecoratorInfo *StubDecoratorInfo
Yu Liu323d77a2024-12-16 23:13:57 +000090}
91
92type BinaryDecoratorInfo struct{}
93type LibraryDecoratorInfo struct {
Cole Faustc9b88c92025-02-06 17:58:26 -080094 ExportIncludeDirs []string
Yu Liu116610a2025-01-06 21:54:48 +000095 InjectBsslHash bool
Yu Liu95cef3a2025-02-25 00:54:20 +000096 // Location of the static library in the sysroot. Empty if the library is
97 // not included in the NDK.
98 NdkSysrootPath android.Path
Yu Liu323d77a2024-12-16 23:13:57 +000099}
Yu Liuffe86322024-12-18 18:53:12 +0000100
Yu Liu8024b922024-12-20 23:31:32 +0000101type SnapshotInfo struct {
102 SnapshotAndroidMkSuffix string
Yu Liuffe86322024-12-18 18:53:12 +0000103}
104
Yu Liu323d77a2024-12-16 23:13:57 +0000105type TestBinaryInfo struct {
106 Gtest bool
107}
108type BenchmarkDecoratorInfo struct{}
Yu Liu8a8d5b42025-01-07 00:48:08 +0000109
Yu Liu2a815b62025-02-21 20:46:25 +0000110type StubDecoratorInfo struct {
111 AbiDumpPath android.OutputPath
112 HasAbiDump bool
113 AbiDiffPaths android.Paths
Yu Liu95cef3a2025-02-25 00:54:20 +0000114 InstallPath android.Path
Yu Liu2a815b62025-02-21 20:46:25 +0000115}
Yu Liu8a8d5b42025-01-07 00:48:08 +0000116
Yu Liu95cef3a2025-02-25 00:54:20 +0000117type ObjectLinkerInfo struct {
118 // Location of the object in the sysroot. Empty if the object is not
119 // included in the NDK.
120 NdkSysrootPath android.Path
121}
Yu Liu323d77a2024-12-16 23:13:57 +0000122
Yu Liu8a8d5b42025-01-07 00:48:08 +0000123type LibraryInfo struct {
124 BuildStubs bool
125}
126
Yu Liu2a815b62025-02-21 20:46:25 +0000127type InstallerInfo struct {
128 StubDecoratorInfo *StubDecoratorInfo
129}
130
Yu Liub1bfa9d2024-12-05 18:57:51 +0000131// Common info about the cc module.
132type CcInfo struct {
Yu Liu323d77a2024-12-16 23:13:57 +0000133 IsPrebuilt bool
134 CmakeSnapshotSupported bool
Yu Liu68a70b72025-01-08 22:54:44 +0000135 HasLlndkStubs bool
Yu Liu0a37d422025-02-13 02:05:00 +0000136 DataPaths []android.DataPath
Yu Liu323d77a2024-12-16 23:13:57 +0000137 CompilerInfo *CompilerInfo
138 LinkerInfo *LinkerInfo
Yu Liu8024b922024-12-20 23:31:32 +0000139 SnapshotInfo *SnapshotInfo
Yu Liu8a8d5b42025-01-07 00:48:08 +0000140 LibraryInfo *LibraryInfo
Yu Liu2a815b62025-02-21 20:46:25 +0000141 InstallerInfo *InstallerInfo
Yu Liub1bfa9d2024-12-05 18:57:51 +0000142}
143
Yu Liu8024b922024-12-20 23:31:32 +0000144var CcInfoProvider = blueprint.NewProvider[*CcInfo]()
Yu Liub1bfa9d2024-12-05 18:57:51 +0000145
Yu Liu986d98c2024-11-12 00:28:11 +0000146type LinkableInfo struct {
147 // StaticExecutable returns true if this is a binary module with "static_executable: true".
Yu Liu8024b922024-12-20 23:31:32 +0000148 StaticExecutable bool
149 Static bool
150 Shared bool
151 HasStubsVariants bool
152 StubsVersion string
153 IsStubs bool
154 UnstrippedOutputFile android.Path
155 OutputFile android.OptionalPath
156 CoverageFiles android.Paths
Yu Liuf6f85492025-01-13 21:02:36 +0000157 // CoverageOutputFile returns the output archive of gcno coverage information files.
158 CoverageOutputFile android.OptionalPath
159 SAbiDumpFiles android.Paths
160 // Partition returns the partition string for this module.
161 Partition string
Yu Liu8a8d5b42025-01-07 00:48:08 +0000162 CcLibrary bool
Yu Liu8024b922024-12-20 23:31:32 +0000163 CcLibraryInterface bool
164 RustLibraryInterface bool
165 // CrateName returns the crateName for a Rust library
166 CrateName string
167 // DepFlags returns a slice of Rustc string flags
168 ExportedCrateLinkDirs []string
Yu Liu0a37d422025-02-13 02:05:00 +0000169 HasNonSystemVariants bool
170 IsLlndk bool
Yu Liuf6f85492025-01-13 21:02:36 +0000171 // True if the library is in the configs known NDK list.
172 IsNdk bool
173 InVendorOrProduct bool
Yu Liu8024b922024-12-20 23:31:32 +0000174 // SubName returns the modules SubName, used for image and NDK/SDK variations.
175 SubName string
176 InRamdisk bool
177 OnlyInRamdisk bool
178 InVendorRamdisk bool
179 OnlyInVendorRamdisk bool
180 InRecovery bool
181 OnlyInRecovery bool
Yu Liu367827f2025-02-15 00:18:33 +0000182 InVendor bool
Yu Liu8a8d5b42025-01-07 00:48:08 +0000183 Installable *bool
Yu Liu97880e12025-01-07 19:03:34 +0000184 // RelativeInstallPath returns the relative install path for this module.
185 RelativeInstallPath string
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000186 // TODO(b/362509506): remove this once all apex_exclude uses are switched to stubs.
187 RustApexExclude bool
Yu Liuf6f85492025-01-13 21:02:36 +0000188 // Bootstrap tests if this module is allowed to use non-APEX version of libraries.
Yu Liu0a37d422025-02-13 02:05:00 +0000189 Bootstrap bool
190 Multilib string
191 ImplementationModuleNameForMake string
192 IsStubsImplementationRequired bool
193 // Symlinks returns a list of symlinks that should be created for this module.
Yu Liu367827f2025-02-15 00:18:33 +0000194 Symlinks []string
195 APIListCoverageXMLPath android.ModuleOutPath
Yu Liu119d38c2025-02-25 22:25:11 +0000196 // FuzzSharedLibraries returns the shared library dependencies for this module.
197 // Expects that IsFuzzModule returns true.
198 FuzzSharedLibraries android.RuleBuilderInstalls
Yu Liu986d98c2024-11-12 00:28:11 +0000199}
200
Yu Liu8024b922024-12-20 23:31:32 +0000201var LinkableInfoProvider = blueprint.NewProvider[*LinkableInfo]()
Yu Liu986d98c2024-11-12 00:28:11 +0000202
Colin Cross463a90e2015-06-17 14:20:06 -0700203func init() {
Paul Duffin036e7002019-12-19 19:16:28 +0000204 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -0700205
Inseob Kim3b244062023-07-11 13:31:36 +0900206 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +0000207 pctx.Import("android/soong/cc/config")
208}
209
210func RegisterCCBuildComponents(ctx android.RegistrationContext) {
211 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
212
213 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossac57a6c2024-06-26 13:09:53 -0700214 ctx.Transition("sdk", &sdkTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700215 ctx.BottomUp("llndk", llndkMutator)
Colin Cross767819f2024-05-22 14:22:34 -0700216 ctx.Transition("link", &linkageTransitionMutator{})
Colin Crossadd04a82024-05-22 09:57:59 -0700217 ctx.Transition("version", &versionTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700218 ctx.BottomUp("begin", BeginMutator)
Colin Cross1e676be2016-10-12 14:38:15 -0700219 })
Colin Cross16b23492016-01-06 14:41:07 -0800220
Paul Duffin036e7002019-12-19 19:16:28 +0000221 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -0400222 for _, san := range Sanitizers {
223 san.registerMutators(ctx)
224 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800225
Colin Cross8a962802024-10-09 15:29:27 -0700226 ctx.BottomUp("sanitize_runtime_deps", sanitizerRuntimeDepsMutator)
227 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator)
Ivan Lozano30c5db22018-02-21 15:49:20 -0800228
Colin Cross597bad62024-10-08 15:10:55 -0700229 ctx.Transition("fuzz", &fuzzTransitionMutator{})
Cory Barkera1da26f2022-06-07 20:12:06 +0000230
Colin Crossf5f4ad32024-01-19 15:41:48 -0800231 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -0700232
Colin Crossd38feb02024-01-23 16:38:06 -0800233 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +0800234
Colin Cross33e0c812024-01-23 16:36:07 -0800235 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000236
Colin Cross6ac83a82024-01-23 11:23:10 -0800237 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +0900238
Colin Cross8a962802024-10-09 15:29:27 -0700239 ctx.BottomUp("check_linktype", checkLinkTypeMutator)
240 ctx.BottomUp("double_loadable", checkDoubleLoadableLibraries)
Colin Cross1e676be2016-10-12 14:38:15 -0700241 })
Colin Crossb98c8b02016-07-29 13:44:28 -0700242
Colin Cross91ae5ec2024-10-01 14:03:40 -0700243 ctx.PostApexMutators(func(ctx android.RegisterMutatorsContext) {
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800244 // sabi mutator needs to be run after apex mutator finishes.
Colin Cross91ae5ec2024-10-01 14:03:40 -0700245 ctx.Transition("sabi", &sabiTransitionMutator{})
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800246 })
247
LaMont Jones0c10e4d2023-05-16 00:58:37 +0000248 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -0700249}
250
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500251// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
252// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
253// edges to these modules.
254// This object is constructed in DepsMutator, by calling to various module delegates to set
255// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
256// dependencies.
257// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
258// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800259type Deps struct {
260 SharedLibs, LateSharedLibs []string
261 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800262 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800263 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700264
Colin Cross3e5e7782022-06-17 22:17:05 +0000265 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
266 // prevent automatically exporting symbols.
267 UnexportedStaticLibs []string
268
Chris Parsons79d66a52020-06-05 17:26:16 -0400269 // Used for data dependencies adjacent to tests
270 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700271 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400272
Yo Chiang219968c2020-09-22 18:45:04 +0800273 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
274 SystemSharedLibs []string
275
Vinh Tran367d89d2023-04-28 11:21:25 -0400276 // Used by DepMutator to pass aidl_library modules to aidl compiler
277 AidlLibs []string
278
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500279 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800280 StaticUnwinderIfLegacy bool
281
Colin Cross5950f382016-12-13 12:50:57 -0800282 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700283
Colin Cross81413472016-04-11 14:37:39 -0700284 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700285
Cole Faust65cb40a2024-10-21 15:41:42 -0700286 GeneratedSources []string
287 GeneratedHeaders []string
288 DeviceFirstGeneratedHeaders []string
289 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700290
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700291 ReexportGeneratedHeaders []string
292
Colin Crossc465efd2021-06-11 18:00:04 -0700293 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700294
295 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700296 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900297
298 // List of libs that need to be excluded for APEX variant
299 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900300 // List of libs that need to be excluded for non-APEX variant
301 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800302
303 // LLNDK headers for the ABI checker to check LLNDK implementation library.
304 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
Colin Cross1e954b62024-09-13 13:50:00 -0700305 // The core variant cannot depend on the vendor variant because of the order of imageTransitionMutator.Split().
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800306 // Instead, the LLNDK implementation depends on the LLNDK header libs.
307 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700308}
309
Ivan Lozano0a468a42024-05-13 21:03:34 -0400310// A struct which to collect flags for rlib dependencies
311type RustRlibDep struct {
312 LibPath android.Path // path to the rlib
313 LinkDirs []string // flags required for dependency (e.g. -L flags)
314 CrateName string // crateNames associated with rlibDeps
315}
316
317func EqRustRlibDeps(a RustRlibDep, b RustRlibDep) bool {
318 return a.LibPath == b.LibPath
319}
320
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500321// PathDeps is a struct containing file paths to dependencies of a module.
322// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
323// It's used to construct flags for various build statements (such as for compiling and linking).
324// It is then passed to module decorator functions responsible for registering build statements
325// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800326type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700327 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900328 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700329 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900330 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700331 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700332 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400333 // Paths and crateNames for RustStaticLib dependencies
334 RustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700335
Colin Cross0de8a1e2020-09-18 14:15:30 -0700336 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossa14fb6a2024-10-23 16:57:06 -0700337 TranstiveStaticLibrariesForOrdering depset.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700338
Colin Cross26c34ed2016-09-30 17:10:16 -0700339 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100340 Objs Objects
341 // Paths to .o files in dependencies that provide them. Note that these lists
342 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800343 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700344 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700345
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100346 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
347 // the libs from all whole_static_lib dependencies.
348 WholeStaticLibsFromPrebuilts android.Paths
349
Colin Cross26c34ed2016-09-30 17:10:16 -0700350 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700351 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900352 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700353
Inseob Kimd110f872019-12-06 13:15:38 +0900354 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000355 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900356 IncludeDirs android.Paths
357 SystemIncludeDirs android.Paths
358 ReexportedDirs android.Paths
359 ReexportedSystemDirs android.Paths
360 ReexportedFlags []string
361 ReexportedGeneratedHeaders android.Paths
362 ReexportedDeps android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400363 ReexportedRustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700364
Colin Cross26c34ed2016-09-30 17:10:16 -0700365 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700366 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700367
Dan Willemsena0790e32018-10-12 00:24:23 -0700368 // Path to the dynamic linker binary
369 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700370
371 // For Darwin builds, the path to the second architecture's output that should
372 // be combined with this architectures's output into a FAT MachO file.
373 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400374
375 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
376 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800377
378 // LLNDK headers for the ABI checker to check LLNDK implementation library.
379 LlndkIncludeDirs android.Paths
380 LlndkSystemIncludeDirs android.Paths
Colin Crossb614cd42024-10-11 12:52:21 -0700381
382 directImplementationDeps android.Paths
383 transitiveImplementationDeps []depset.DepSet[android.Path]
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700384}
385
Colin Cross4af21ed2019-11-04 09:37:55 -0800386// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
387// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
388// command line so they can be overridden by the local module flags).
389type LocalOrGlobalFlags struct {
390 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700391 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800392 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700393 CFlags []string // Flags that apply to C and C++ source files
394 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
395 ConlyFlags []string // Flags that apply to C source files
396 CppFlags []string // Flags that apply to C++ source files
397 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700398 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800399}
400
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500401// Flags contains various types of command line flags (and settings) for use in building build
402// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800403type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500404 // Local flags (which individual modules are responsible for). These may override global flags.
405 Local LocalOrGlobalFlags
406 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700407 Global LocalOrGlobalFlags
408 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800409
410 aidlFlags []string // Flags that apply to aidl source files
411 rsFlags []string // Flags that apply to renderscript source files
412 libFlags []string // Flags to add libraries early to the link order
413 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
414 TidyFlags []string // Flags that apply to clang-tidy
415 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700416
Colin Crossc3199482017-03-30 15:03:04 -0700417 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800418 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700419 SystemIncludeFlags []string
420
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800421 Toolchain config.Toolchain
422 Tidy bool // True if ninja .tidy rules should be generated.
423 NeedTidyFiles bool // True if module link should depend on .tidy files
424 GcovCoverage bool // True if coverage files should be generated.
425 SAbiDump bool // True if header abi dumps should be generated.
426 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
kellyhungd62ea302024-05-19 21:16:07 +0800427 ClangVerify bool // If true, append cflags "-Xclang -verify" and append "&& touch $out" to the clang command line.
Colin Crossca860ac2016-01-04 14:34:37 -0800428
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500429 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800430 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500431 // The target-device system path to the dynamic linker.
432 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800433
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700434 CFlagsDeps android.Paths // Files depended on by compiler flags
435 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800436
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500437 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700438 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800439
Colin Cross19878da2019-03-28 14:45:07 -0700440 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700441 protoC bool // Whether to use C instead of C++
442 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700443
444 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200445 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700446}
447
Colin Crossca860ac2016-01-04 14:34:37 -0800448// Properties used to compile all C or C++ modules
449type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700450 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800451 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700452
Yi Kong5786f5c2024-05-28 02:22:34 +0900453 // Aggresively trade performance for smaller binary size.
454 // This should only be used for on-device binaries that are rarely executed and not
455 // performance critical.
456 Optimize_for_size *bool `android:"arch_variant"`
457
Jiyong Parkb35a8192020-08-10 15:59:36 +0900458 // The API level that this module is built against. The APIs of this API level will be
459 // visible at build time, but use of any APIs newer than min_sdk_version will render the
460 // module unloadable on older devices. In the future it will be possible to weakly-link new
461 // APIs, making the behavior match Java: such modules will load on older devices, but
462 // calling new APIs on devices that do not support them will result in a crash.
463 //
464 // This property has the same behavior as sdk_version does for Java modules. For those
465 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
466 // does for Java code.
467 //
468 // In addition, setting this property causes two variants to be built, one for the platform
469 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800470 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700471
Jiyong Parkb35a8192020-08-10 15:59:36 +0900472 // Minimum OS API level supported by this C or C++ module. This property becomes the value
473 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
474 // this property is also used to ensure that the min_sdk_version of the containing module is
475 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
476 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
477 // min_sdk_version of the containing APEX. When the module
478 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900479 Min_sdk_version *string
480
Colin Crossc511bc52020-04-07 16:50:32 +0000481 // If true, always create an sdk variant and don't create a platform variant.
482 Sdk_variant_only *bool
483
Colin Cross4297f402024-11-20 15:20:09 -0800484 AndroidMkSharedLibs []string `blueprint:"mutated"`
485 AndroidMkStaticLibs []string `blueprint:"mutated"`
486 AndroidMkRlibs []string `blueprint:"mutated"`
487 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
488 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
489 AndroidMkHeaderLibs []string `blueprint:"mutated"`
490 HideFromMake bool `blueprint:"mutated"`
491 PreventInstall bool `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700492
Yo Chiang219968c2020-09-22 18:45:04 +0800493 // Set by DepsMutator.
494 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
495
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900496 // The name of the image this module is built for
497 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200498
499 // The VNDK version this module is built against. If empty, the module is not
500 // build against the VNDK.
501 VndkVersion string `blueprint:"mutated"`
502
503 // Suffix for the name of Android.mk entries generated by this module
504 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800505
506 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
507 // file
Inseob Kim37e0bb02024-04-29 15:54:44 +0900508 Logtags []string `android:"path"`
Jiyong Parkf9332f12018-02-01 00:54:12 +0900509
Yifan Hong39143a92020-10-26 12:43:12 -0700510 // Make this module available when building for ramdisk.
511 // On device without a dedicated recovery partition, the module is only
512 // available after switching root into
513 // /first_stage_ramdisk. To expose the module before switching root, install
514 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800515 Ramdisk_available *bool
516
Yifan Hong39143a92020-10-26 12:43:12 -0700517 // Make this module available when building for vendor ramdisk.
518 // On device without a dedicated recovery partition, the module is only
519 // available after switching root into
520 // /first_stage_ramdisk. To expose the module before switching root, install
521 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700522 Vendor_ramdisk_available *bool
523
Jiyong Parkf9332f12018-02-01 00:54:12 +0900524 // Make this module available when building for recovery
525 Recovery_available *bool
526
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200527 // Used by imageMutator, set by ImageMutatorBegin()
Jihoon Kang47e91842024-06-19 00:51:16 +0000528 VendorVariantNeeded bool `blueprint:"mutated"`
529 ProductVariantNeeded bool `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200530 CoreVariantNeeded bool `blueprint:"mutated"`
531 RamdiskVariantNeeded bool `blueprint:"mutated"`
532 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
533 RecoveryVariantNeeded bool `blueprint:"mutated"`
534
535 // A list of variations for the "image" mutator of the form
536 //<image name> '.' <version char>, for example, 'vendor.S'
537 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900538
539 // Allows this module to use non-APEX version of libraries. Useful
540 // for building binaries that are started before APEXes are activated.
541 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900542
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000543 // Allows this module to be included in CMake release snapshots to be built outside of Android
544 // build system and source tree.
545 Cmake_snapshot_supported *bool
546
Colin Cross1bc94122021-10-28 13:25:54 -0700547 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000548
549 // Set by factories of module types that can only be referenced from variants compiled against
550 // the SDK.
551 AlwaysSdk bool `blueprint:"mutated"`
552
553 // Variant is an SDK variant created by sdkMutator
554 IsSdkVariant bool `blueprint:"mutated"`
555 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
556 // variant to have a ".sdk" suffix.
557 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700558
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800559 Target struct {
560 Platform struct {
561 // List of modules required by the core variant.
562 Required []string `android:"arch_variant"`
563
564 // List of modules not required by the core variant.
565 Exclude_required []string `android:"arch_variant"`
566 } `android:"arch_variant"`
567
568 Recovery struct {
569 // List of modules required by the recovery variant.
570 Required []string `android:"arch_variant"`
571
572 // List of modules not required by the recovery variant.
573 Exclude_required []string `android:"arch_variant"`
574 } `android:"arch_variant"`
575 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700576}
577
578type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900579 // whether this module should be allowed to be directly depended by other
580 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900581 // If set to true, two variants will be built separately, one like
582 // normal, and the other limited to the set of libraries and headers
583 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700584 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900585 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700586 // so it shouldn't have any unversioned runtime dependencies, or
587 // make assumptions about the system that may not be true in the
588 // future.
589 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900590 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900591 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900592 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900593 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900594 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700595 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
596 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900597
Justin Yunebcf0c52021-01-08 18:00:19 +0900598 // This is the same as the "vendor_available" except that the install path
599 // of the vendor variant is /odm or /vendor/odm.
600 // By replacing "vendor_available: true" with "odm_available: true", the
601 // module will install its vendor variant to the /odm partition or /vendor/odm.
602 // As the modules with "odm_available: true" still create the vendor variants,
603 // they can link to the other vendor modules as the vendor_available modules do.
604 // Also, the vendor modules can link to odm_available modules.
605 //
606 // It may not be used for VNDK modules.
607 Odm_available *bool
608
Justin Yun63e9ec72020-10-29 16:49:43 +0900609 // whether this module should be allowed to be directly depended by other
610 // modules with `product_specific: true` or `product_available: true`.
611 // If set to true, an additional product variant will be built separately
612 // that is limited to the set of libraries and headers that are exposed to
613 // /product modules.
614 //
615 // The product variant may be used with a different (newer) /system,
616 // so it shouldn't have any unversioned runtime dependencies, or
617 // make assumptions about the system that may not be true in the
618 // future.
619 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900620 // If set to false, this module becomes inaccessible from /product modules.
621 //
622 // Different from the 'vendor_available' property, the modules with
623 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
624 // library without 'product_available' may not be depended on by any other
625 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900626 //
627 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
628 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
629 Product_available *bool
630
Jiyong Park5fb8c102018-04-09 12:03:06 +0900631 // whether this module is capable of being loaded with other instance
632 // (possibly an older version) of the same module in the same process.
633 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
634 // can be double loaded in a vendor process if the library is also a
635 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
636 // explicitly marked as `double_loadable: true` by the owner, or the dependency
637 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
638 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800639
640 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
641 IsLLNDK bool `blueprint:"mutated"`
642
Colin Cross5271fea2021-04-27 13:06:04 -0700643 // IsVendorPublicLibrary is set for the core and product variants of a library that has
644 // vendor_public_library stubs.
645 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800646}
647
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500648// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
649// to understanding details about the type of the current module.
650// For example, one might call these functions to determine whether the current module is a static
651// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800652type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800653 static() bool
654 staticBinary() bool
Colin Cross6a730042024-12-05 13:53:43 -0800655 staticLibrary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700656 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800657 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900658 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900659 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900660 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700661 toolchain() config.Toolchain
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700662 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800663 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900664 minSdkVersion() string
665 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700666 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700667 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800668 IsLlndk() bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800669 isImplementationForLLNDKPublic() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700670 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900671 inProduct() bool
672 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800673 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700674 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900675 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900676 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700677 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700678 baseModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800679 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000680 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800681 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900682 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800683 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800684 useClangLld(actx ModuleContext) bool
Colin Crosse07f2312020-08-13 11:24:56 -0700685 apexVariationName() string
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900686 bootstrap() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700687 nativeCoverage() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800688 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800689 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800690 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800691 notInPlatform() bool
Yi Kong5786f5c2024-05-28 02:22:34 +0900692 optimizeForSize() bool
Yu Liu76d94462024-10-31 23:32:36 +0000693 getOrCreateMakeVarsInfo() *CcMakeVarsInfo
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800694}
695
696type SharedFlags struct {
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000697 NumSharedFlags int
698 FlagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800699}
700
701type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700702 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800703 ModuleContextIntf
704}
705
706type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700707 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800708 ModuleContextIntf
709}
710
Colin Cross37047f12016-12-13 17:06:13 -0800711type DepsContext interface {
712 android.BottomUpMutatorContext
713 ModuleContextIntf
714}
715
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500716// feature represents additional (optional) steps to building cc-related modules, such as invocation
717// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800718type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800719 flags(ctx ModuleContext, flags Flags) Flags
720 props() []interface{}
721}
722
Joe Onorato37f900c2023-07-18 16:58:16 -0700723// Information returned from Generator about the source code it's generating
724type GeneratedSource struct {
725 IncludeDirs android.Paths
726 Sources android.Paths
727 Headers android.Paths
728 ReexportedDirs android.Paths
729}
730
731// generator allows injection of generated code
732type Generator interface {
733 GeneratorProps() []interface{}
734 GeneratorInit(ctx BaseModuleContext)
735 GeneratorDeps(ctx DepsContext, deps Deps) Deps
736 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
737 GeneratorSources(ctx ModuleContext) GeneratedSource
738 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
739}
740
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500741// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500742// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800743type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700744 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800745 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800746 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700747 compilerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000748 baseCompilerProps() BaseCompilerProperties
Colin Cross42742b82016-08-01 13:20:05 -0700749
Colin Cross76fada02016-07-27 10:31:13 -0700750 appendCflags([]string)
751 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700752 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800753}
754
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500755// linker is the interface for a linker decorator object. Individual module types can provide
756// their own implementation for this decorator, and thus specify custom logic regarding build
757// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800758type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700759 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800760 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700761 linkerFlags(ctx ModuleContext, flags Flags) Flags
762 linkerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000763 baseLinkerProps() BaseLinkerProperties
Ivan Lozanobd721262018-11-27 14:33:03 -0800764 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700765
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700766 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700767 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900768 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800769 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700770
771 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900772 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000773
774 // Get the deps that have been explicitly specified in the properties.
Cole Fauste8a87832024-09-11 11:35:46 -0700775 linkerSpecifiedDeps(ctx android.ConfigurableEvaluatorContext, module *Module, specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800776
Cole Faustd143f3e2025-02-24 16:18:18 -0800777 // Gets a list of files that will be disted when using the dist property without specifying
778 // an output file tag.
779 defaultDistFiles() []android.Path
780
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800781 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000782}
783
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500784// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000785type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500786 sharedLibs []string
787 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
788 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700789 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800790}
791
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500792// installer is the interface for an installer helper object. This helper is responsible for
793// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800794type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700795 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700796 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000797 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800798 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700799 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700800 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900801 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000802 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900803 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800804}
805
Inseob Kima1888ce2022-10-04 14:42:02 +0900806type overridable interface {
807 overriddenModules() []string
808}
809
Colin Cross6e511a92020-07-27 21:26:48 -0700810type libraryDependencyKind int
811
812const (
813 headerLibraryDependency = iota
814 sharedLibraryDependency
815 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400816 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700817)
818
819func (k libraryDependencyKind) String() string {
820 switch k {
821 case headerLibraryDependency:
822 return "headerLibraryDependency"
823 case sharedLibraryDependency:
824 return "sharedLibraryDependency"
825 case staticLibraryDependency:
826 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400827 case rlibLibraryDependency:
828 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700829 default:
830 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
831 }
832}
833
834type libraryDependencyOrder int
835
836const (
837 earlyLibraryDependency = -1
838 normalLibraryDependency = 0
839 lateLibraryDependency = 1
840)
841
842func (o libraryDependencyOrder) String() string {
843 switch o {
844 case earlyLibraryDependency:
845 return "earlyLibraryDependency"
846 case normalLibraryDependency:
847 return "normalLibraryDependency"
848 case lateLibraryDependency:
849 return "lateLibraryDependency"
850 default:
851 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
852 }
853}
854
855// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
856// tags that have a set of predefined tag objects that are reused for each dependency, a
857// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
858// That means that comparing a libraryDependencyTag for equality will only be equal if all
859// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
860// then check individual metadata fields instead.
861type libraryDependencyTag struct {
862 blueprint.BaseDependencyTag
863
864 // These are exported so that fmt.Printf("%#v") can call their String methods.
865 Kind libraryDependencyKind
866 Order libraryDependencyOrder
867
868 wholeStatic bool
869
870 reexportFlags bool
871 explicitlyVersioned bool
Colin Crossbd930bc2025-02-03 12:17:42 -0800872 explicitlyImpl bool
Colin Cross6e511a92020-07-27 21:26:48 -0700873 dataLib bool
874 ndk bool
875
876 staticUnwinder bool
877
878 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900879
Cindy Zhou18417cb2020-12-10 07:12:38 -0800880 // Whether or not this dependency should skip the apex dependency check
881 skipApexAllowedDependenciesCheck bool
882
Jiyong Parke3867542020-12-03 17:28:25 +0900883 // Whether or not this dependency has to be followed for the apex variants
884 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900885 // Whether or not this dependency has to be followed for the non-apex variants
886 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000887
888 // If true, don't automatically export symbols from the static library into a shared library.
889 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700890}
891
892// header returns true if the libraryDependencyTag is tagging a header lib dependency.
893func (d libraryDependencyTag) header() bool {
894 return d.Kind == headerLibraryDependency
895}
896
897// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
898func (d libraryDependencyTag) shared() bool {
899 return d.Kind == sharedLibraryDependency
900}
901
902// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
903func (d libraryDependencyTag) static() bool {
904 return d.Kind == staticLibraryDependency
905}
906
Colin Cross65cb3142021-12-10 23:05:02 +0000907func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
908 if d.shared() {
909 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
910 }
911 return nil
912}
913
914var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
915
Colin Crosse9fe2942020-11-10 18:12:15 -0800916// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
917// binaries or other shared libraries are installed as dependencies.
918func (d libraryDependencyTag) InstallDepNeeded() bool {
919 return d.shared()
920}
921
922var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
923
Yu Liu67a28422024-03-05 00:36:31 +0000924func (d libraryDependencyTag) PropagateAconfigValidation() bool {
925 return d.static()
926}
927
928var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
929
Colin Crosse9fe2942020-11-10 18:12:15 -0800930// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700931// libraryDependencyTag. Each tag object is created globally and reused for multiple
932// dependencies (although since the object contains no references, assigning a tag to a
933// variable and modifying it will not modify the original). Users can compare the tag
934// returned by ctx.OtherModuleDependencyTag against the global original
935type dependencyTag struct {
936 blueprint.BaseDependencyTag
937 name string
938}
939
Colin Crosse9fe2942020-11-10 18:12:15 -0800940// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
941// libraryDependencyTag, but where the dependency needs to be installed when the parent is
942// installed.
943type installDependencyTag struct {
944 blueprint.BaseDependencyTag
945 android.InstallAlwaysNeededDependencyTag
946 name string
947}
948
Colin Crossc99deeb2016-04-11 15:06:20 -0700949var (
Colin Cross6e511a92020-07-27 21:26:48 -0700950 genSourceDepTag = dependencyTag{name: "gen source"}
951 genHeaderDepTag = dependencyTag{name: "gen header"}
952 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
953 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900954 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700955 reuseObjTag = dependencyTag{name: "reuse objects"}
956 staticVariantTag = dependencyTag{name: "static variant"}
957 vndkExtDepTag = dependencyTag{name: "vndk extends"}
958 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700959 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800960 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000961 StubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000962 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500963 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400964 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800965 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700966)
967
Colin Crossbd930bc2025-02-03 12:17:42 -0800968func IsExplicitImplSharedDepTag(depTag blueprint.DependencyTag) bool {
969 ccLibDepTag, ok := depTag.(libraryDependencyTag)
970 return ok && ccLibDepTag.shared() && ccLibDepTag.explicitlyImpl
971}
972
Roland Levillainf89cd092019-07-29 16:22:59 +0100973func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700974 ccLibDepTag, ok := depTag.(libraryDependencyTag)
975 return ok && ccLibDepTag.shared()
976}
977
978func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
979 ccLibDepTag, ok := depTag.(libraryDependencyTag)
980 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100981}
982
Zach Johnson3df4e632020-11-06 11:56:27 -0800983func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
984 ccLibDepTag, ok := depTag.(libraryDependencyTag)
985 return ok && ccLibDepTag.header()
986}
987
Roland Levillainf89cd092019-07-29 16:22:59 +0100988func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800989 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100990}
991
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000992func ExcludeInApexDepTag(depTag blueprint.DependencyTag) bool {
993 ccLibDepTag, ok := depTag.(libraryDependencyTag)
994 return ok && ccLibDepTag.excludeInApex
995}
996
Colin Crossca860ac2016-01-04 14:34:37 -0800997// Module contains the properties and members used by all C/C++ module types, and implements
998// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500999// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
1000// interface.
1001//
1002// To define a C/C++ related module, construct a new Module object and point its delegates to
1003// type-specific structs. These delegates will be invoked to register module-specific build
1004// statements which may be unique to the module type. For example, module.compiler.compile() should
1005// be defined so as to register build statements which are responsible for compiling the module.
1006//
1007// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
1008// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
1009// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
1010// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -08001011type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -07001012 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -07001013
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07001014 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -07001015 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -07001016 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -07001017
Colin Crossca860ac2016-01-04 14:34:37 -08001018 // initialize before calling Init
Yu Liu76d94462024-10-31 23:32:36 +00001019 hod android.HostOrDeviceSupported
1020 multilib android.Multilib
1021 testModule bool
1022 incremental bool
Colin Crossc472d572015-03-17 15:06:21 -07001023
Paul Duffina0843f62019-12-13 19:50:38 +00001024 // Allowable SdkMemberTypes of this module type.
1025 sdkMemberTypes []android.SdkMemberType
1026
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001027 // decorator delegates, initialize before calling Init
1028 // these may contain module-specific implementations, and effectively allow for custom
1029 // type-specific logic. These members may reference different objects or the same object.
1030 // Functions of these decorators will be invoked to initialize and register type-specific
1031 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -08001032 generators []Generator
1033 compiler compiler
1034 linker linker
1035 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001036
Spandan Dase12d2522023-09-12 21:42:31 +00001037 features []feature
1038 stl *stl
1039 sanitize *sanitize
1040 coverage *coverage
1041 fuzzer *fuzzer
1042 sabi *sabi
Spandan Dase12d2522023-09-12 21:42:31 +00001043 lto *lto
1044 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001045 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -08001046
Colin Cross31076b32020-10-23 17:22:06 -07001047 library libraryInterface
1048
Colin Cross635c3b02016-05-18 15:37:25 -07001049 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -08001050
Colin Crossb98c8b02016-07-29 13:44:28 -07001051 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -07001052
Yu Liue70976d2024-10-15 20:45:35 +00001053 subAndroidMkOnce map[subAndroidMkProviderInfoProducer]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001054
1055 // Flags used to compile this module
1056 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -07001057
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001058 // Shared flags among build rules of this module
1059 sharedFlags SharedFlags
1060
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001061 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -07001062 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +09001063
1064 makeLinkType string
Jooyung Han75568392020-03-20 04:29:24 +09001065
1066 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -07001067 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07001068
1069 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -08001070
Inseob Kim37e0bb02024-04-29 15:54:44 +09001071 logtagsPaths android.Paths
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001072
1073 WholeRustStaticlib bool
Cole Faust96a692b2024-08-08 14:47:51 -07001074
1075 hasAidl bool
1076 hasLex bool
1077 hasProto bool
1078 hasRenderscript bool
1079 hasSysprop bool
1080 hasWinMsg bool
1081 hasYacc bool
Yu Liu76d94462024-10-31 23:32:36 +00001082
1083 makeVarsInfo *CcMakeVarsInfo
Colin Crossc472d572015-03-17 15:06:21 -07001084}
1085
Yu Liu76d94462024-10-31 23:32:36 +00001086func (c *Module) IncrementalSupported() bool {
1087 return c.incremental
1088}
1089
1090var _ blueprint.Incremental = (*Module)(nil)
1091
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001092func (c *Module) AddJSONData(d *map[string]interface{}) {
1093 c.AndroidModuleBase().AddJSONData(d)
1094 (*d)["Cc"] = map[string]interface{}{
1095 "SdkVersion": c.SdkVersion(),
1096 "MinSdkVersion": c.MinSdkVersion(),
1097 "VndkVersion": c.VndkVersion(),
1098 "ProductSpecific": c.ProductSpecific(),
1099 "SocSpecific": c.SocSpecific(),
1100 "DeviceSpecific": c.DeviceSpecific(),
1101 "InProduct": c.InProduct(),
1102 "InVendor": c.InVendor(),
1103 "InRamdisk": c.InRamdisk(),
1104 "InVendorRamdisk": c.InVendorRamdisk(),
1105 "InRecovery": c.InRecovery(),
1106 "VendorAvailable": c.VendorAvailable(),
1107 "ProductAvailable": c.ProductAvailable(),
1108 "RamdiskAvailable": c.RamdiskAvailable(),
1109 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
1110 "RecoveryAvailable": c.RecoveryAvailable(),
1111 "OdmAvailable": c.OdmAvailable(),
1112 "InstallInData": c.InstallInData(),
1113 "InstallInRamdisk": c.InstallInRamdisk(),
1114 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
1115 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
1116 "InstallInRecovery": c.InstallInRecovery(),
1117 "InstallInRoot": c.InstallInRoot(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001118 "IsLlndk": c.IsLlndk(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001119 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
1120 "ApexSdkVersion": c.apexSdkVersion,
Cole Faust96a692b2024-08-08 14:47:51 -07001121 "AidlSrcs": c.hasAidl,
1122 "LexSrcs": c.hasLex,
1123 "ProtoSrcs": c.hasProto,
1124 "RenderscriptSrcs": c.hasRenderscript,
1125 "SyspropSrcs": c.hasSysprop,
1126 "WinMsgSrcs": c.hasWinMsg,
1127 "YaccSrsc": c.hasYacc,
1128 "OnlyCSrcs": !(c.hasAidl || c.hasLex || c.hasProto || c.hasRenderscript || c.hasSysprop || c.hasWinMsg || c.hasYacc),
Yi Kong5786f5c2024-05-28 02:22:34 +09001129 "OptimizeForSize": c.OptimizeForSize(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001130 }
1131}
1132
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001133func (c *Module) SetPreventInstall() {
1134 c.Properties.PreventInstall = true
1135}
1136
1137func (c *Module) SetHideFromMake() {
1138 c.Properties.HideFromMake = true
1139}
1140
Ivan Lozanod7586b62021-04-01 09:49:36 -04001141func (c *Module) HiddenFromMake() bool {
1142 return c.Properties.HideFromMake
1143}
1144
Cole Fauste8a87832024-09-11 11:35:46 -07001145func (c *Module) RequiredModuleNames(ctx android.ConfigurableEvaluatorContext) []string {
Cole Faust43ddd082024-06-17 12:32:40 -07001146 required := android.CopyOf(c.ModuleBase.RequiredModuleNames(ctx))
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001147 if c.ImageVariation().Variation == android.CoreVariation {
1148 required = append(required, c.Properties.Target.Platform.Required...)
1149 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1150 } else if c.InRecovery() {
1151 required = append(required, c.Properties.Target.Recovery.Required...)
1152 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1153 }
1154 return android.FirstUniqueStrings(required)
1155}
1156
Ivan Lozano52767be2019-10-18 14:49:46 -07001157func (c *Module) Toc() android.OptionalPath {
1158 if c.linker != nil {
1159 if library, ok := c.linker.(libraryInterface); ok {
1160 return library.toc()
1161 }
1162 }
1163 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1164}
1165
1166func (c *Module) ApiLevel() string {
1167 if c.linker != nil {
1168 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001169 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001170 }
1171 }
1172 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1173}
1174
1175func (c *Module) Static() bool {
1176 if c.linker != nil {
1177 if library, ok := c.linker.(libraryInterface); ok {
1178 return library.static()
1179 }
1180 }
1181 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1182}
1183
1184func (c *Module) Shared() bool {
1185 if c.linker != nil {
1186 if library, ok := c.linker.(libraryInterface); ok {
1187 return library.shared()
1188 }
1189 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001190
Ivan Lozano52767be2019-10-18 14:49:46 -07001191 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1192}
1193
1194func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001195 if c.stl != nil {
1196 return c.stl.Properties.SelectedStl
1197 }
1198 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001199}
1200
Ivan Lozano52767be2019-10-18 14:49:46 -07001201func (c *Module) StubDecorator() bool {
1202 if _, ok := c.linker.(*stubDecorator); ok {
1203 return true
1204 }
1205 return false
1206}
1207
Yi Kong5786f5c2024-05-28 02:22:34 +09001208func (c *Module) OptimizeForSize() bool {
1209 return Bool(c.Properties.Optimize_for_size)
1210}
1211
Ivan Lozano52767be2019-10-18 14:49:46 -07001212func (c *Module) SdkVersion() string {
1213 return String(c.Properties.Sdk_version)
1214}
1215
Artur Satayev480e25b2020-04-27 18:53:18 +01001216func (c *Module) MinSdkVersion() string {
1217 return String(c.Properties.Min_sdk_version)
1218}
1219
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001220func (c *Module) SetSdkVersion(s string) {
1221 c.Properties.Sdk_version = StringPtr(s)
1222}
1223
1224func (c *Module) SetMinSdkVersion(s string) {
1225 c.Properties.Min_sdk_version = StringPtr(s)
1226}
1227
1228func (c *Module) SetStl(s string) {
1229 if c.stl != nil {
1230 c.stl.Properties.Stl = StringPtr(s)
1231 }
1232}
1233
1234func (c *Module) IsCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001235 if linker, ok := c.linker.(*objectLinker); ok {
1236 return linker.isCrt()
1237 }
1238 return false
1239}
1240
Jiyong Park5df7bd32021-08-25 16:18:46 +09001241func (c *Module) SplitPerApiLevel() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001242 return CanUseSdk(c) && c.IsCrt()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001243}
1244
Colin Crossc511bc52020-04-07 16:50:32 +00001245func (c *Module) AlwaysSdk() bool {
1246 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1247}
1248
Ivan Lozano183a3212019-10-18 14:18:45 -07001249func (c *Module) CcLibrary() bool {
1250 if c.linker != nil {
1251 if _, ok := c.linker.(*libraryDecorator); ok {
1252 return true
1253 }
Colin Crossd48fe732020-09-23 20:37:24 -07001254 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1255 return true
1256 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001257 }
1258 return false
1259}
1260
1261func (c *Module) CcLibraryInterface() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001262 if c.library != nil {
Ivan Lozano183a3212019-10-18 14:18:45 -07001263 return true
1264 }
1265 return false
1266}
1267
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001268func (c *Module) RlibStd() bool {
1269 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1270}
1271
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001272func (c *Module) RustLibraryInterface() bool {
1273 return false
1274}
1275
Ivan Lozano0a468a42024-05-13 21:03:34 -04001276func (c *Module) CrateName() string {
1277 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1278}
1279
1280func (c *Module) ExportedCrateLinkDirs() []string {
1281 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1282}
1283
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001284func (c *Module) IsFuzzModule() bool {
1285 if _, ok := c.compiler.(*fuzzBinary); ok {
1286 return true
1287 }
1288 return false
1289}
1290
1291func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1292 return c.FuzzModule
1293}
1294
1295func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1296 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1297 return fuzzer.fuzzPackagedModule
1298 }
1299 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1300}
1301
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001302func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001303 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1304 return fuzzer.sharedLibraries
1305 }
1306 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1307}
1308
Ivan Lozano2b262972019-11-21 12:30:50 -08001309func (c *Module) NonCcVariants() bool {
1310 return false
1311}
1312
Ivan Lozano183a3212019-10-18 14:18:45 -07001313func (c *Module) SetStatic() {
1314 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001315 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001316 library.setStatic()
1317 return
1318 }
1319 }
1320 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1321}
1322
1323func (c *Module) SetShared() {
1324 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001325 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001326 library.setShared()
1327 return
1328 }
1329 }
1330 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1331}
1332
1333func (c *Module) BuildStaticVariant() bool {
1334 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001335 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001336 return library.buildStatic()
1337 }
1338 }
1339 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1340}
1341
1342func (c *Module) BuildSharedVariant() bool {
1343 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001344 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001345 return library.buildShared()
1346 }
1347 }
1348 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1349}
1350
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001351func (c *Module) BuildRlibVariant() bool {
1352 // cc modules can never build rlib variants
1353 return false
1354}
1355
Ivan Lozano183a3212019-10-18 14:18:45 -07001356func (c *Module) Module() android.Module {
1357 return c
1358}
1359
Jiyong Parkc20eee32018-09-05 22:36:17 +09001360func (c *Module) OutputFile() android.OptionalPath {
1361 return c.outputFile
1362}
1363
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001364func (c *Module) CoverageFiles() android.Paths {
1365 if c.linker != nil {
1366 if library, ok := c.linker.(libraryInterface); ok {
1367 return library.objs().coverageFiles
1368 }
1369 }
1370 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1371}
1372
Ivan Lozano183a3212019-10-18 14:18:45 -07001373var _ LinkableInterface = (*Module)(nil)
1374
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001375func (c *Module) VersionedInterface() VersionedInterface {
1376 if c.library != nil {
1377 return c.library
1378 }
1379 return nil
1380}
1381
Jiyong Park719b4462019-01-13 00:39:51 +09001382func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001383 if c.linker != nil {
1384 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001385 }
1386 return nil
1387}
1388
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001389func (c *Module) CoverageOutputFile() android.OptionalPath {
1390 if c.linker != nil {
1391 return c.linker.coverageOutputFilePath()
1392 }
1393 return android.OptionalPath{}
1394}
1395
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001396func (c *Module) RelativeInstallPath() string {
1397 if c.installer != nil {
1398 return c.installer.relativeInstallPath()
1399 }
1400 return ""
1401}
1402
Jooyung Han344d5432019-08-23 11:17:39 +09001403func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001404 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001405}
1406
Colin Cross36242852017-06-23 15:06:31 -07001407func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001408 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001409 for _, generator := range c.generators {
1410 c.AddProperties(generator.GeneratorProps()...)
1411 }
Colin Crossca860ac2016-01-04 14:34:37 -08001412 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001413 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001414 }
1415 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001416 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001417 }
1418 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001419 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001420 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001421 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001422 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001423 }
Colin Cross16b23492016-01-06 14:41:07 -08001424 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001425 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001426 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001427 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001428 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001429 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001430 if c.fuzzer != nil {
1431 c.AddProperties(c.fuzzer.props()...)
1432 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001433 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001434 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001435 }
Stephen Craneba090d12017-05-09 15:44:35 -07001436 if c.lto != nil {
1437 c.AddProperties(c.lto.props()...)
1438 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001439 if c.afdo != nil {
1440 c.AddProperties(c.afdo.props()...)
1441 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001442 if c.orderfile != nil {
1443 c.AddProperties(c.orderfile.props()...)
1444 }
Colin Crossca860ac2016-01-04 14:34:37 -08001445 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001446 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001447 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001448 // Allow test-only on libraries that are not cc_test_library
1449 if c.library != nil && !c.testLibrary() {
1450 c.AddProperties(&c.sourceProperties)
1451 }
Colin Crossc472d572015-03-17 15:06:21 -07001452
Colin Cross36242852017-06-23 15:06:31 -07001453 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001454 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001455 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001456
Colin Cross36242852017-06-23 15:06:31 -07001457 return c
Colin Crossc472d572015-03-17 15:06:21 -07001458}
1459
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001460// UseVndk() returns true if this module is built against VNDK.
1461// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001462func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001463 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001464}
1465
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001466func CanUseSdk(c LinkableInterface) bool {
1467 return c.Module().Target().Os == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001468 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001469}
1470
1471func (c *Module) UseSdk() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001472 if CanUseSdk(c) {
Colin Cross1348ce32020-10-01 13:37:16 -07001473 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001474 }
1475 return false
1476}
1477
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001478func (c *Module) isCoverageVariant() bool {
1479 return c.coverage.Properties.IsCoverageVariant
1480}
1481
Colin Cross95f1ca02020-10-29 20:47:22 -07001482func (c *Module) IsNdk(config android.Config) bool {
1483 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001484}
1485
Colin Cross127bb8b2020-12-16 16:46:01 -08001486func (c *Module) IsLlndk() bool {
1487 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001488}
1489
Colin Cross1f3f1302021-04-26 18:37:44 -07001490func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001491 lib := moduleVersionedInterface(m)
1492 return lib != nil && (lib.HasLLNDKStubs() || lib.HasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001493}
1494
Colin Cross5271fea2021-04-27 13:06:04 -07001495func (m *Module) NeedsVendorPublicLibraryVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001496 lib := moduleVersionedInterface(m)
1497 return lib != nil && (lib.HasVendorPublicLibrary())
Colin Cross5271fea2021-04-27 13:06:04 -07001498}
1499
1500// IsVendorPublicLibrary returns true for vendor public libraries.
1501func (c *Module) IsVendorPublicLibrary() bool {
1502 return c.VendorProperties.IsVendorPublicLibrary
1503}
1504
Ivan Lozanof1868af2022-04-12 13:08:36 -04001505func (c *Module) IsVndkPrebuiltLibrary() bool {
1506 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1507 return true
1508 }
1509 return false
1510}
1511
1512func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1513 return c.Properties.SdkAndPlatformVariantVisibleToMake
1514}
1515
Ivan Lozanod7586b62021-04-01 09:49:36 -04001516func (c *Module) HasLlndkStubs() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001517 lib := moduleVersionedInterface(c)
1518 return lib != nil && lib.HasLLNDKStubs()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001519}
1520
1521func (c *Module) StubsVersion() string {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001522 if lib, ok := c.linker.(VersionedInterface); ok {
1523 return lib.StubsVersion()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001524 }
1525 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1526}
1527
Colin Cross127bb8b2020-12-16 16:46:01 -08001528// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1529// and does not set llndk.vendor_available: false.
1530func (c *Module) isImplementationForLLNDKPublic() bool {
1531 library, _ := c.library.(*libraryDecorator)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001532 return library != nil && library.HasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001533 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001534}
1535
Colin Cross3513fb12024-01-24 14:44:47 -08001536func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001537 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001538 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001539 }
1540 return false
1541}
1542
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001543func (c *Module) isOrderfileCompile() bool {
1544 if orderfile := c.orderfile; orderfile != nil {
1545 return orderfile.Properties.OrderfileLoad
1546 }
1547 return false
1548}
1549
Yi Kongc702ebd2022-08-19 16:02:45 +08001550func (c *Module) isCfi() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001551 return c.sanitize.isSanitizerEnabled(cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001552}
1553
Yi Konged79fa32023-06-04 17:15:42 +09001554func (c *Module) isFuzzer() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001555 return c.sanitize.isSanitizerEnabled(Fuzzer)
Yi Konged79fa32023-06-04 17:15:42 +09001556}
1557
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001558func (c *Module) isNDKStubLibrary() bool {
1559 if _, ok := c.compiler.(*stubDecorator); ok {
1560 return true
1561 }
1562 return false
1563}
1564
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001565func (c *Module) SubName() string {
1566 return c.Properties.SubName
1567}
1568
Jiyong Park25fc6a92018-11-18 18:02:45 +09001569func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001570 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001571 return lib.BuildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001572 }
1573 return false
1574}
1575
1576func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001577 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001578 return lib.HasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001579 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001580 return false
1581}
1582
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00001583func (c *Module) RustApexExclude() bool {
1584 return false
1585}
1586
Alan Stokes73feba32022-11-14 12:21:24 +00001587func (c *Module) IsStubsImplementationRequired() bool {
1588 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001589 return lib.IsStubsImplementationRequired()
Alan Stokes73feba32022-11-14 12:21:24 +00001590 }
1591 return false
1592}
1593
Colin Cross0477b422020-10-13 18:43:54 -07001594// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1595// the implementation. If it is an implementation library it returns its own name.
1596func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1597 name := ctx.OtherModuleName(c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001598 if versioned, ok := c.linker.(VersionedInterface); ok {
1599 name = versioned.ImplementationModuleName(name)
Colin Cross0477b422020-10-13 18:43:54 -07001600 }
1601 return name
1602}
1603
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001604// Similar to ImplementationModuleNameByCtx, but uses the Make variant of the module
Martin Stjernholm2856c662020-12-02 15:03:42 +00001605// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1606// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1607// under the premise that the prebuilt module overrides its source counterpart
1608// if it is exposed to Make).
Yu Liu0a37d422025-02-13 02:05:00 +00001609func (c *Module) ImplementationModuleNameForMake() string {
Martin Stjernholm2856c662020-12-02 15:03:42 +00001610 name := c.BaseModuleName()
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001611 if versioned, ok := c.linker.(VersionedInterface); ok {
1612 name = versioned.ImplementationModuleName(name)
Martin Stjernholm2856c662020-12-02 15:03:42 +00001613 }
1614 return name
1615}
1616
Jiyong Park7d55b612021-06-11 17:22:09 +09001617func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001618 return Bool(c.Properties.Bootstrap)
1619}
1620
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001621func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001622 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1623 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1624 return false
1625 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001626 return c.linker != nil && c.linker.nativeCoverage()
1627}
1628
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001629func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001630 if p, ok := c.linker.(SnapshotInterface); ok {
1631 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001632 }
1633 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001634}
1635
Jiyong Parkf1194352019-02-25 11:05:47 +09001636func isBionic(name string) bool {
1637 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001638 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001639 return true
1640 }
1641 return false
1642}
1643
Martin Stjernholm279de572019-09-10 23:18:20 +01001644func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001645 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001646 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001647 }
1648 return isBionic(name)
1649}
1650
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001651func (c *Module) isCfiAssemblySupportEnabled() bool {
1652 return c.sanitize != nil &&
1653 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1654}
1655
Inseob Kim800d1142021-06-14 12:03:51 +09001656func (c *Module) InstallInRoot() bool {
1657 return c.installer != nil && c.installer.installInRoot()
1658}
1659
Colin Crossca860ac2016-01-04 14:34:37 -08001660type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001661 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001662 moduleContextImpl
1663}
1664
Colin Cross37047f12016-12-13 17:06:13 -08001665type depsContext struct {
1666 android.BottomUpMutatorContext
1667 moduleContextImpl
1668}
1669
Colin Crossca860ac2016-01-04 14:34:37 -08001670type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001671 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001672 moduleContextImpl
1673}
1674
1675type moduleContextImpl struct {
1676 mod *Module
1677 ctx BaseModuleContext
1678}
1679
Colin Crossb98c8b02016-07-29 13:44:28 -07001680func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001681 return ctx.mod.toolchain(ctx.ctx)
1682}
1683
1684func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001685 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001686}
1687
1688func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001689 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001690}
1691
Colin Cross6a730042024-12-05 13:53:43 -08001692func (ctx *moduleContextImpl) staticLibrary() bool {
1693 return ctx.mod.staticLibrary()
1694}
1695
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001696func (ctx *moduleContextImpl) testBinary() bool {
1697 return ctx.mod.testBinary()
1698}
1699
Yi Kong56fc1b62022-09-06 16:24:00 +08001700func (ctx *moduleContextImpl) testLibrary() bool {
1701 return ctx.mod.testLibrary()
1702}
1703
Jiyong Park1d1119f2019-07-29 21:27:18 +09001704func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001705 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001706}
1707
Inseob Kim7f283f42020-06-01 21:53:49 +09001708func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001709 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001710}
1711
Inseob Kim1042d292020-06-01 23:23:05 +09001712func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001713 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001714}
1715
Yi Kong5786f5c2024-05-28 02:22:34 +09001716func (ctx *moduleContextImpl) optimizeForSize() bool {
1717 return ctx.mod.OptimizeForSize()
1718}
1719
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001720func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001721 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001722}
1723
1724func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001725 if ctx.ctx.Device() {
Justin Yun732aa6a2018-03-23 17:43:47 +09001726 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001727 }
1728 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001729}
1730
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001731func MinSdkVersion(mod VersionedLinkableInterface, ctxIsForPlatform bool, device bool,
1732 platformSdkVersion string) string {
1733
1734 ver := mod.MinSdkVersion()
1735 if ver == "apex_inherit" && !ctxIsForPlatform {
1736 ver = mod.ApexSdkVersion().String()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001737 }
1738 if ver == "apex_inherit" || ver == "" {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001739 ver = mod.SdkVersion()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001740 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001741
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001742 if device {
Jooyung Hanaa2d3f52024-11-09 02:41:06 +00001743 // When building for vendor/product, use the latest _stable_ API as "current".
1744 // This is passed to clang/aidl compilers so that compiled/generated code works
1745 // with the system.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001746 if (mod.InVendor() || mod.InProduct()) && (ver == "" || ver == "current") {
1747 ver = platformSdkVersion
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001748 }
1749 }
1750
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001751 // For crt objects, the meaning of min_sdk_version is very different from other types of
1752 // module. For them, min_sdk_version defines the oldest version that the build system will
1753 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1754 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1755 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001756 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1757 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1758 // support such an old version. The version is set to the later version in case when the
1759 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1760 // it's for an APEX.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001761 if mod.IsCrt() && !mod.IsSdkVariant() {
1762 if ctxIsForPlatform {
Jiyong Park5df7bd32021-08-25 16:18:46 +09001763 ver = strconv.Itoa(android.FutureApiLevelInt)
1764 } else { // for apex
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001765 ver = mod.ApexSdkVersion().String()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001766 if ver == "" { // in case when min_sdk_version was not set by the APEX
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001767 ver = mod.SdkVersion()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001768 }
1769 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001770 }
1771
Jiyong Parkb35a8192020-08-10 15:59:36 +09001772 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001773 sdkVersionInt, err := strconv.Atoi(mod.SdkVersion())
Jiyong Parkb35a8192020-08-10 15:59:36 +09001774 minSdkVersionInt, err2 := strconv.Atoi(ver)
1775 if err == nil && err2 == nil {
1776 if sdkVersionInt < minSdkVersionInt {
1777 return strconv.Itoa(sdkVersionInt)
1778 }
1779 }
1780 return ver
1781}
1782
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001783func (ctx *moduleContextImpl) minSdkVersion() string {
1784 platformSdkVersion := ""
1785 if ctx.ctx.Device() {
1786 platformSdkVersion = ctx.ctx.Config().PlatformSdkVersion().String()
1787 }
1788 return MinSdkVersion(ctx.mod, CtxIsForPlatform(ctx.ctx), ctx.ctx.Device(), platformSdkVersion)
1789}
1790
Jiyong Parkb35a8192020-08-10 15:59:36 +09001791func (ctx *moduleContextImpl) isSdkVariant() bool {
1792 return ctx.mod.IsSdkVariant()
1793}
1794
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001795func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001796 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001797}
Justin Yun8effde42017-06-23 19:24:43 +09001798
Kiyoung Kimaa394802024-01-08 12:55:45 +09001799func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1800 return ctx.mod.InVendorOrProduct()
1801}
1802
Colin Cross95f1ca02020-10-29 20:47:22 -07001803func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1804 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001805}
1806
Colin Cross127bb8b2020-12-16 16:46:01 -08001807func (ctx *moduleContextImpl) IsLlndk() bool {
1808 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001809}
1810
Colin Cross127bb8b2020-12-16 16:46:01 -08001811func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1812 return ctx.mod.isImplementationForLLNDKPublic()
1813}
1814
Colin Cross3513fb12024-01-24 14:44:47 -08001815func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1816 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001817}
1818
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001819func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1820 return ctx.mod.isOrderfileCompile()
1821}
1822
Yi Kongc702ebd2022-08-19 16:02:45 +08001823func (ctx *moduleContextImpl) isCfi() bool {
1824 return ctx.mod.isCfi()
1825}
1826
Yi Konged79fa32023-06-04 17:15:42 +09001827func (ctx *moduleContextImpl) isFuzzer() bool {
1828 return ctx.mod.isFuzzer()
1829}
1830
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001831func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1832 return ctx.mod.isNDKStubLibrary()
1833}
1834
Colin Cross5271fea2021-04-27 13:06:04 -07001835func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1836 return ctx.mod.IsVendorPublicLibrary()
1837}
1838
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001839func (ctx *moduleContextImpl) selectedStl() string {
1840 if stl := ctx.mod.stl; stl != nil {
1841 return stl.Properties.SelectedStl
1842 }
1843 return ""
1844}
1845
Ivan Lozanobd721262018-11-27 14:33:03 -08001846func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1847 return ctx.mod.linker.useClangLld(actx)
1848}
1849
Colin Crossce75d2c2016-10-06 16:12:58 -07001850func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001851 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001852}
1853
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001854func CtxIsForPlatform(ctx android.BaseModuleContext) bool {
1855 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crossff694a82023-12-13 15:54:49 -08001856 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001857}
1858
Colin Crosse07f2312020-08-13 11:24:56 -07001859func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001860 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1861 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001862}
1863
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001864func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001865 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001866}
1867
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001868func (ctx *moduleContextImpl) nativeCoverage() bool {
1869 return ctx.mod.nativeCoverage()
1870}
1871
Colin Cross95b07f22020-12-16 11:06:50 -08001872func (ctx *moduleContextImpl) isPreventInstall() bool {
1873 return ctx.mod.Properties.PreventInstall
1874}
1875
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001876func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1877 shared := &ctx.mod.sharedFlags
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001878 if shared.FlagsMap == nil {
1879 shared.NumSharedFlags = 0
1880 shared.FlagsMap = make(map[string]string)
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001881 }
1882 return shared
1883}
1884
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001885func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1886 return ctx.mod.isCfiAssemblySupportEnabled()
1887}
1888
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001889func (ctx *moduleContextImpl) notInPlatform() bool {
1890 return ctx.mod.NotInPlatform()
1891}
1892
Yu Liu76d94462024-10-31 23:32:36 +00001893func (ctx *moduleContextImpl) getOrCreateMakeVarsInfo() *CcMakeVarsInfo {
1894 if ctx.mod.makeVarsInfo == nil {
1895 ctx.mod.makeVarsInfo = &CcMakeVarsInfo{}
1896 }
1897 return ctx.mod.makeVarsInfo
1898}
1899
Colin Cross635c3b02016-05-18 15:37:25 -07001900func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001901 return &Module{
1902 hod: hod,
1903 multilib: multilib,
1904 }
1905}
1906
Colin Cross635c3b02016-05-18 15:37:25 -07001907func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001908 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001909 module.features = []feature{
1910 &tidyFeature{},
1911 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001912 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001913 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001914 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001915 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001916 module.sabi = &sabi{}
Stephen Craneba090d12017-05-09 15:44:35 -07001917 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001918 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001919 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001920 return module
1921}
1922
Colin Crossce75d2c2016-10-06 16:12:58 -07001923func (c *Module) Prebuilt() *android.Prebuilt {
1924 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1925 return p.prebuilt()
1926 }
1927 return nil
1928}
1929
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001930func (c *Module) IsPrebuilt() bool {
1931 return c.Prebuilt() != nil
1932}
1933
Colin Crossce75d2c2016-10-06 16:12:58 -07001934func (c *Module) Name() string {
1935 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001936 if p, ok := c.linker.(interface {
1937 Name(string) string
1938 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001939 name = p.Name(name)
1940 }
1941 return name
1942}
1943
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001944func (c *Module) Multilib() string {
1945 return c.Arch().ArchType.Multilib
1946}
1947
1948func (c *Module) ApexSdkVersion() android.ApiLevel {
1949 return c.apexSdkVersion
1950}
1951
Alex Light3d673592019-01-18 14:37:31 -08001952func (c *Module) Symlinks() []string {
1953 if p, ok := c.installer.(interface {
1954 symlinkList() []string
1955 }); ok {
1956 return p.symlinkList()
1957 }
1958 return nil
1959}
1960
Chris Parsons216e10a2020-07-09 17:12:52 -04001961func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001962 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001963 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001964 }); ok {
1965 return p.dataPaths()
1966 }
1967 return nil
1968}
1969
Ivan Lozanof1868af2022-04-12 13:08:36 -04001970func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001971 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1972 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001973 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001974 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001975 if c.ProductSpecific() {
1976 // If the module is product specific with 'product_specific: true',
1977 // do not add a name suffix because it is a base module.
1978 return ""
1979 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001980 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001981 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001982 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001983 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001984 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001985 // add version suffix only if the module is using different vndk version than the
1986 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001987 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001988 }
1989 return nameSuffix
1990}
1991
Ivan Lozanof1868af2022-04-12 13:08:36 -04001992func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1993 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001994
1995 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001996 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001997 }
1998
Colin Cross127bb8b2020-12-16 16:46:01 -08001999 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09002000 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09002001 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
2002 // added for product variant only when we have vendor and product variants with core
2003 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04002004 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07002005 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04002006 subName += vendorPublicLibrarySuffix
2007 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09002008 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
2009 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04002010 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08002011 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04002012 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002013 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04002014 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07002015 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04002016 subName += RecoverySuffix
2017 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
2018 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07002019 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04002020 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07002021 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00002022 } else if c.IsStubs() && c.IsSdkVariant() {
2023 // Public API surface (NDK)
2024 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
2025 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09002026 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04002027
2028 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05002029}
2030
Sam Delmerico75dbca22023-04-20 13:13:25 +00002031func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
2032 ctx := &moduleContext{
2033 ModuleContext: actx,
2034 moduleContextImpl: moduleContextImpl{
2035 mod: c,
2036 },
2037 }
2038 ctx.ctx = ctx
2039 return ctx
2040}
2041
Spandan Das20fce2d2023-04-12 17:21:39 +00002042// TODO (b/277651159): Remove this allowlist
2043var (
2044 skipStubLibraryMultipleApexViolation = map[string]bool{
2045 "libclang_rt.asan": true,
2046 "libclang_rt.hwasan": true,
2047 // runtime apex
2048 "libc": true,
2049 "libc_hwasan": true,
2050 "libdl_android": true,
2051 "libm": true,
2052 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00002053 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00002054 // art apex
Martin Stjernholm75598032024-07-12 18:47:26 +01002055 // TODO(b/234351700): Remove this when com.android.art.debug is gone.
Spandan Das20fce2d2023-04-12 17:21:39 +00002056 "libandroidio": true,
2057 "libdexfile": true,
Martin Stjernholm75598032024-07-12 18:47:26 +01002058 "libdexfiled": true, // com.android.art.debug only
Spandan Das20fce2d2023-04-12 17:21:39 +00002059 "libnativebridge": true,
2060 "libnativehelper": true,
2061 "libnativeloader": true,
2062 "libsigchain": true,
2063 }
2064)
2065
2066// Returns true if a stub library could be installed in multiple apexes
2067func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
2068 // If this is not an apex variant, no check necessary
Colin Cross2dcbca62024-11-20 14:55:14 -08002069 if info, ok := android.ModuleProvider(ctx, android.ApexInfoProvider); !ok || info.IsForPlatform() {
Spandan Das20fce2d2023-04-12 17:21:39 +00002070 return false
2071 }
2072 // If this is not a stub library, no check necessary
2073 if !c.HasStubsVariants() {
2074 return false
2075 }
2076 // Skip the allowlist
2077 // Use BaseModuleName so that this matches prebuilts.
2078 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
2079 return false
2080 }
2081
Spandan Das20fce2d2023-04-12 17:21:39 +00002082 // Stub libraries should not have more than one apex_available
Colin Crossaf4c8562024-11-20 15:07:58 -08002083 apexAvailable := android.FirstUniqueStrings(c.ApexAvailable())
2084 if len(apexAvailable) > 1 {
Spandan Das20fce2d2023-04-12 17:21:39 +00002085 return true
2086 }
2087 // Stub libraries should not use the wildcard
Colin Crossaf4c8562024-11-20 15:07:58 -08002088 if apexAvailable[0] == android.AvailableToAnyApex {
Spandan Das20fce2d2023-04-12 17:21:39 +00002089 return true
2090 }
2091 // Default: no violation
2092 return false
2093}
2094
Chris Parsons8d6e4332021-02-22 16:13:50 -05002095func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002096 ctx := moduleContextFromAndroidModuleContext(actx, c)
2097
Inseob Kim37e0bb02024-04-29 15:54:44 +09002098 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
2099 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
2100 Logtags: c.logtagsPaths,
2101 })
2102
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002103 // If Test_only is set on a module in bp file, respect the setting, otherwise
2104 // see if is a known test module type.
2105 testOnly := c.testModule || c.testLibrary()
2106 if c.sourceProperties.Test_only != nil {
2107 testOnly = Bool(c.sourceProperties.Test_only)
2108 }
2109 // Keep before any early returns.
2110 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2111 TestOnly: testOnly,
2112 TopLevelTarget: c.testModule,
2113 })
2114
Ivan Lozanof1868af2022-04-12 13:08:36 -04002115 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002116 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002117 if !apexInfo.IsForPlatform() {
2118 c.hideApexVariantFromMake = true
2119 }
2120
Chris Parsonseefc9e62021-04-02 17:36:47 -04002121 c.makeLinkType = GetMakeLinkType(actx, c)
2122
Colin Crossf18e1102017-11-16 14:33:08 -08002123 deps := c.depsToPaths(ctx)
2124 if ctx.Failed() {
2125 return
2126 }
2127
Joe Onorato37f900c2023-07-18 16:58:16 -07002128 for _, generator := range c.generators {
2129 gen := generator.GeneratorSources(ctx)
2130 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2131 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2132 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2133 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2134 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2135 if len(deps.Objs.objFiles) == 0 {
2136 // If we are reusuing object files (which happens when we're a shared library and we're
2137 // reusing our static variant's object files), then skip adding the actual source files,
2138 // because we already have the object for it.
2139 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2140 }
2141 }
2142
2143 if ctx.Failed() {
2144 return
2145 }
2146
Spandan Das20fce2d2023-04-12 17:21:39 +00002147 if c.stubLibraryMultipleApexViolation(actx) {
2148 actx.PropertyErrorf("apex_available",
2149 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2150 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002151 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2152 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002153 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2154 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002155 }
2156
Colin Crossca860ac2016-01-04 14:34:37 -08002157 flags := Flags{
2158 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002159 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002160 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002161 for _, generator := range c.generators {
2162 flags = generator.GeneratorFlags(ctx, flags, deps)
2163 }
Colin Crossca860ac2016-01-04 14:34:37 -08002164 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002165 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002166 }
2167 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002168 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002169 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002170 if c.stl != nil {
2171 flags = c.stl.flags(ctx, flags)
2172 }
Colin Cross16b23492016-01-06 14:41:07 -08002173 if c.sanitize != nil {
2174 flags = c.sanitize.flags(ctx, flags)
2175 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002176 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002177 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002178 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002179 if c.fuzzer != nil {
2180 flags = c.fuzzer.flags(ctx, flags)
2181 }
Stephen Craneba090d12017-05-09 15:44:35 -07002182 if c.lto != nil {
2183 flags = c.lto.flags(ctx, flags)
2184 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002185 if c.afdo != nil {
2186 flags = c.afdo.flags(ctx, flags)
2187 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002188 if c.orderfile != nil {
2189 flags = c.orderfile.flags(ctx, flags)
2190 }
Colin Crossca860ac2016-01-04 14:34:37 -08002191 for _, feature := range c.features {
2192 flags = feature.flags(ctx, flags)
2193 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002194 if ctx.Failed() {
2195 return
2196 }
2197
Colin Cross4af21ed2019-11-04 09:37:55 -08002198 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2199 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2200 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002201
Colin Cross4af21ed2019-11-04 09:37:55 -08002202 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002203
2204 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002205 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002206 }
2207 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002208 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002209 }
2210
Colin Cross3e5e7782022-06-17 22:17:05 +00002211 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2212
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002213 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002214 // We need access to all the flags seen by a source file.
2215 if c.sabi != nil {
2216 flags = c.sabi.flags(ctx, flags)
2217 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002218
Colin Cross4af21ed2019-11-04 09:37:55 -08002219 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002220
Joe Onorato37f900c2023-07-18 16:58:16 -07002221 for _, generator := range c.generators {
2222 generator.GeneratorBuildActions(ctx, flags, deps)
2223 }
2224
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002225 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002226 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002227 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002228 if ctx.Failed() {
2229 return
2230 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002231 }
2232
Colin Crossca860ac2016-01-04 14:34:37 -08002233 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002234 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002235 if ctx.Failed() {
2236 return
2237 }
Colin Cross635c3b02016-05-18 15:37:25 -07002238 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002239
Chris Parsons94a0bba2021-06-04 15:03:47 -04002240 c.maybeUnhideFromMake()
Colin Crossb614cd42024-10-11 12:52:21 -07002241
2242 android.SetProvider(ctx, ImplementationDepInfoProvider, &ImplementationDepInfo{
2243 ImplementationDeps: depset.New(depset.PREORDER, deps.directImplementationDeps, deps.transitiveImplementationDeps),
2244 })
Colin Crossce75d2c2016-10-06 16:12:58 -07002245 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002246
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002247 if Bool(c.Properties.Cmake_snapshot_supported) {
2248 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2249 }
2250
Chris Parsons94a0bba2021-06-04 15:03:47 -04002251 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002252
2253 if c.linker != nil {
2254 moduleInfoJSON := ctx.ModuleInfoJSON()
2255 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2256 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2257 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2258 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2259 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2260
2261 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2262 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2263 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2264 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2265
2266 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2267 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2268 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2269 moduleInfoJSON.SubName += ".cfi"
2270 }
2271 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2272 moduleInfoJSON.SubName += ".hwasan"
2273 }
2274 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2275 moduleInfoJSON.SubName += ".scs"
2276 }
2277 }
2278 moduleInfoJSON.SubName += c.Properties.SubName
2279
2280 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2281 moduleInfoJSON.Uninstallable = true
2282 }
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002283 }
Wei Lia1aa2972024-06-21 13:08:51 -07002284
2285 buildComplianceMetadataInfo(ctx, c, deps)
mrziwangabdb2932024-06-18 12:43:41 -07002286
Cole Faust96a692b2024-08-08 14:47:51 -07002287 if b, ok := c.compiler.(*baseCompiler); ok {
2288 c.hasAidl = b.hasSrcExt(ctx, ".aidl")
2289 c.hasLex = b.hasSrcExt(ctx, ".l") || b.hasSrcExt(ctx, ".ll")
2290 c.hasProto = b.hasSrcExt(ctx, ".proto")
2291 c.hasRenderscript = b.hasSrcExt(ctx, ".rscript") || b.hasSrcExt(ctx, ".fs")
2292 c.hasSysprop = b.hasSrcExt(ctx, ".sysprop")
2293 c.hasWinMsg = b.hasSrcExt(ctx, ".mc")
2294 c.hasYacc = b.hasSrcExt(ctx, ".y") || b.hasSrcExt(ctx, ".yy")
2295 }
2296
Yu Liuec7043d2024-11-05 18:22:20 +00002297 ccObjectInfo := CcObjectInfo{
Yu Liu4f825132024-12-18 00:35:39 +00002298 KytheFiles: objs.kytheFiles,
Yu Liuec7043d2024-11-05 18:22:20 +00002299 }
2300 if !ctx.Config().KatiEnabled() || !android.ShouldSkipAndroidMkProcessing(ctx, c) {
Yu Liu4f825132024-12-18 00:35:39 +00002301 ccObjectInfo.ObjFiles = objs.objFiles
2302 ccObjectInfo.TidyFiles = objs.tidyFiles
Yu Liuec7043d2024-11-05 18:22:20 +00002303 }
Yu Liu4f825132024-12-18 00:35:39 +00002304 if len(ccObjectInfo.KytheFiles)+len(ccObjectInfo.ObjFiles)+len(ccObjectInfo.TidyFiles) > 0 {
Yu Liuec7043d2024-11-05 18:22:20 +00002305 android.SetProvider(ctx, CcObjectInfoProvider, ccObjectInfo)
2306 }
2307
Yu Liuf6f85492025-01-13 21:02:36 +00002308 linkableInfo := CreateCommonLinkableInfo(ctx, c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002309 if lib, ok := c.linker.(VersionedInterface); ok {
2310 linkableInfo.StubsVersion = lib.StubsVersion()
Yu Liu8024b922024-12-20 23:31:32 +00002311 }
2312 if c.linker != nil {
2313 if library, ok := c.linker.(libraryInterface); ok {
2314 linkableInfo.Static = library.static()
Yu Liu8a8d5b42025-01-07 00:48:08 +00002315 linkableInfo.Shared = library.shared()
Yu Liu8024b922024-12-20 23:31:32 +00002316 linkableInfo.CoverageFiles = library.objs().coverageFiles
2317 linkableInfo.SAbiDumpFiles = library.objs().sAbiDumpFiles
2318 }
2319 }
2320 android.SetProvider(ctx, LinkableInfoProvider, linkableInfo)
Yu Liu986d98c2024-11-12 00:28:11 +00002321
Yu Liu323d77a2024-12-16 23:13:57 +00002322 ccInfo := CcInfo{
Yu Liu323d77a2024-12-16 23:13:57 +00002323 IsPrebuilt: c.IsPrebuilt(),
2324 CmakeSnapshotSupported: proptools.Bool(c.Properties.Cmake_snapshot_supported),
Yu Liu68a70b72025-01-08 22:54:44 +00002325 HasLlndkStubs: c.HasLlndkStubs(),
Yu Liu0a37d422025-02-13 02:05:00 +00002326 DataPaths: c.DataPaths(),
Yu Liu323d77a2024-12-16 23:13:57 +00002327 }
2328 if c.compiler != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002329 cflags := c.compiler.baseCompilerProps().Cflags
Yu Liu323d77a2024-12-16 23:13:57 +00002330 ccInfo.CompilerInfo = &CompilerInfo{
2331 Srcs: c.compiler.(CompiledInterface).Srcs(),
Cole Faustc9b88c92025-02-06 17:58:26 -08002332 Cflags: cflags.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002333 AidlInterfaceInfo: AidlInterfaceInfo{
2334 Sources: c.compiler.baseCompilerProps().AidlInterface.Sources,
2335 AidlRoot: c.compiler.baseCompilerProps().AidlInterface.AidlRoot,
2336 Lang: c.compiler.baseCompilerProps().AidlInterface.Lang,
2337 Flags: c.compiler.baseCompilerProps().AidlInterface.Flags,
2338 },
2339 }
2340 switch decorator := c.compiler.(type) {
2341 case *libraryDecorator:
2342 ccInfo.CompilerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002343 ExportIncludeDirs: decorator.flagExporter.Properties.Export_include_dirs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002344 }
2345 }
2346 }
2347 if c.linker != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002348 baseLinkerProps := c.linker.baseLinkerProps()
Yu Liu323d77a2024-12-16 23:13:57 +00002349 ccInfo.LinkerInfo = &LinkerInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002350 WholeStaticLibs: baseLinkerProps.Whole_static_libs.GetOrDefault(ctx, nil),
2351 StaticLibs: baseLinkerProps.Static_libs.GetOrDefault(ctx, nil),
2352 SharedLibs: baseLinkerProps.Shared_libs.GetOrDefault(ctx, nil),
2353 HeaderLibs: baseLinkerProps.Header_libs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002354 }
2355 switch decorator := c.linker.(type) {
2356 case *binaryDecorator:
2357 ccInfo.LinkerInfo.BinaryDecoratorInfo = &BinaryDecoratorInfo{}
2358 case *libraryDecorator:
Yu Liu116610a2025-01-06 21:54:48 +00002359 ccInfo.LinkerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
2360 InjectBsslHash: Bool(c.linker.(*libraryDecorator).Properties.Inject_bssl_hash),
Yu Liu95cef3a2025-02-25 00:54:20 +00002361 NdkSysrootPath: c.linker.(*libraryDecorator).ndkSysrootPath,
Yu Liu116610a2025-01-06 21:54:48 +00002362 }
Yu Liu323d77a2024-12-16 23:13:57 +00002363 case *testBinary:
2364 ccInfo.LinkerInfo.TestBinaryInfo = &TestBinaryInfo{
2365 Gtest: decorator.testDecorator.gtest(),
2366 }
2367 case *benchmarkDecorator:
2368 ccInfo.LinkerInfo.BenchmarkDecoratorInfo = &BenchmarkDecoratorInfo{}
2369 case *objectLinker:
Yu Liu95cef3a2025-02-25 00:54:20 +00002370 ccInfo.LinkerInfo.ObjectLinkerInfo = &ObjectLinkerInfo{
2371 NdkSysrootPath: c.linker.(*objectLinker).ndkSysrootPath,
2372 }
Yu Liu8a8d5b42025-01-07 00:48:08 +00002373 case *stubDecorator:
2374 ccInfo.LinkerInfo.StubDecoratorInfo = &StubDecoratorInfo{}
Yu Liu323d77a2024-12-16 23:13:57 +00002375 }
Yu Liu8024b922024-12-20 23:31:32 +00002376
2377 if s, ok := c.linker.(SnapshotInterface); ok {
2378 ccInfo.SnapshotInfo = &SnapshotInfo{
2379 SnapshotAndroidMkSuffix: s.SnapshotAndroidMkSuffix(),
2380 }
Yu Liuffe86322024-12-18 18:53:12 +00002381 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002382 if v, ok := c.linker.(VersionedInterface); ok {
2383 name := v.ImplementationModuleName(ctx.OtherModuleName(c))
Yu Liu68a70b72025-01-08 22:54:44 +00002384 ccInfo.LinkerInfo.ImplementationModuleName = &name
2385 }
Yu Liuffe86322024-12-18 18:53:12 +00002386 }
Yu Liu8a8d5b42025-01-07 00:48:08 +00002387 if c.library != nil {
2388 ccInfo.LibraryInfo = &LibraryInfo{
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002389 BuildStubs: c.library.BuildStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002390 }
2391 }
Yu Liu2a815b62025-02-21 20:46:25 +00002392 if c.installer != nil {
2393 ccInfo.InstallerInfo = &InstallerInfo{}
2394 if installer, ok := c.installer.(*stubDecorator); ok {
2395 ccInfo.InstallerInfo.StubDecoratorInfo = &StubDecoratorInfo{
2396 HasAbiDump: installer.hasAbiDump,
2397 AbiDumpPath: installer.abiDumpPath,
2398 AbiDiffPaths: installer.abiDiffPaths,
Yu Liu95cef3a2025-02-25 00:54:20 +00002399 InstallPath: installer.installPath,
Yu Liu2a815b62025-02-21 20:46:25 +00002400 }
2401 }
2402 }
Yu Liu8024b922024-12-20 23:31:32 +00002403 android.SetProvider(ctx, CcInfoProvider, &ccInfo)
Yu Liub1bfa9d2024-12-05 18:57:51 +00002404
mrziwangabdb2932024-06-18 12:43:41 -07002405 c.setOutputFiles(ctx)
Yu Liu76d94462024-10-31 23:32:36 +00002406
2407 if c.makeVarsInfo != nil {
2408 android.SetProvider(ctx, CcMakeVarsInfoProvider, c.makeVarsInfo)
2409 }
mrziwangabdb2932024-06-18 12:43:41 -07002410}
2411
Yu Liuf6f85492025-01-13 21:02:36 +00002412func CreateCommonLinkableInfo(ctx android.ModuleContext, mod VersionedLinkableInterface) *LinkableInfo {
Yu Liu0a37d422025-02-13 02:05:00 +00002413 info := &LinkableInfo{
Yu Liu8024b922024-12-20 23:31:32 +00002414 StaticExecutable: mod.StaticExecutable(),
2415 HasStubsVariants: mod.HasStubsVariants(),
2416 OutputFile: mod.OutputFile(),
2417 UnstrippedOutputFile: mod.UnstrippedOutputFile(),
Yu Liuf6f85492025-01-13 21:02:36 +00002418 CoverageOutputFile: mod.CoverageOutputFile(),
2419 Partition: mod.Partition(),
Yu Liu8024b922024-12-20 23:31:32 +00002420 IsStubs: mod.IsStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002421 CcLibrary: mod.CcLibrary(),
Yu Liu8024b922024-12-20 23:31:32 +00002422 CcLibraryInterface: mod.CcLibraryInterface(),
2423 RustLibraryInterface: mod.RustLibraryInterface(),
Yu Liu8024b922024-12-20 23:31:32 +00002424 IsLlndk: mod.IsLlndk(),
Yu Liuf6f85492025-01-13 21:02:36 +00002425 IsNdk: mod.IsNdk(ctx.Config()),
Yu Liu8024b922024-12-20 23:31:32 +00002426 HasNonSystemVariants: mod.HasNonSystemVariants(),
2427 SubName: mod.SubName(),
2428 InVendorOrProduct: mod.InVendorOrProduct(),
2429 InRamdisk: mod.InRamdisk(),
2430 OnlyInRamdisk: mod.OnlyInRamdisk(),
2431 InVendorRamdisk: mod.InVendorRamdisk(),
2432 OnlyInVendorRamdisk: mod.OnlyInVendorRamdisk(),
2433 InRecovery: mod.InRecovery(),
2434 OnlyInRecovery: mod.OnlyInRecovery(),
Yu Liu367827f2025-02-15 00:18:33 +00002435 InVendor: mod.InVendor(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002436 Installable: mod.Installable(),
Yu Liu97880e12025-01-07 19:03:34 +00002437 RelativeInstallPath: mod.RelativeInstallPath(),
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002438 // TODO(b/362509506): remove this once all apex_exclude uses are switched to stubs.
Yu Liu0a37d422025-02-13 02:05:00 +00002439 RustApexExclude: mod.RustApexExclude(),
2440 Bootstrap: mod.Bootstrap(),
2441 Multilib: mod.Multilib(),
2442 ImplementationModuleNameForMake: mod.ImplementationModuleNameForMake(),
2443 Symlinks: mod.Symlinks(),
Yu Liu8024b922024-12-20 23:31:32 +00002444 }
Yu Liu8024b922024-12-20 23:31:32 +00002445
Yu Liu367827f2025-02-15 00:18:33 +00002446 vi := mod.VersionedInterface()
2447 if vi != nil {
2448 info.IsStubsImplementationRequired = vi.IsStubsImplementationRequired()
2449 info.APIListCoverageXMLPath = vi.GetAPIListCoverageXMLPath()
Yu Liuec7043d2024-11-05 18:22:20 +00002450 }
Yu Liu367827f2025-02-15 00:18:33 +00002451
Yu Liu119d38c2025-02-25 22:25:11 +00002452 if !mod.PreventInstall() && fuzz.IsValid(ctx, mod.FuzzModuleStruct()) && mod.IsFuzzModule() {
2453 info.FuzzSharedLibraries = mod.FuzzSharedLibraries()
2454 fm := mod.FuzzPackagedModule()
2455 fuzz.SetFuzzPackagedModuleInfo(ctx, &fm)
2456 }
2457
Yu Liu367827f2025-02-15 00:18:33 +00002458 return info
Yu Liuec7043d2024-11-05 18:22:20 +00002459}
2460
mrziwangabdb2932024-06-18 12:43:41 -07002461func (c *Module) setOutputFiles(ctx ModuleContext) {
2462 if c.outputFile.Valid() {
2463 ctx.SetOutputFiles(android.Paths{c.outputFile.Path()}, "")
2464 } else {
2465 ctx.SetOutputFiles(android.Paths{}, "")
2466 }
2467 if c.linker != nil {
2468 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), "unstripped")
2469 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), "stripped_all")
Cole Faustd143f3e2025-02-24 16:18:18 -08002470 defaultDistFiles := c.linker.defaultDistFiles()
2471 if len(defaultDistFiles) > 0 {
2472 ctx.SetOutputFiles(defaultDistFiles, android.DefaultDistTag)
2473 }
mrziwangabdb2932024-06-18 12:43:41 -07002474 }
Wei Lia1aa2972024-06-21 13:08:51 -07002475}
2476
2477func buildComplianceMetadataInfo(ctx ModuleContext, c *Module, deps PathDeps) {
2478 // Dump metadata that can not be done in android/compliance-metadata.go
2479 complianceMetadataInfo := ctx.ComplianceMetadataInfo()
Wei Li8ede4f72025-01-15 21:24:22 -08002480 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.IS_STATIC_LIB, strconv.FormatBool(ctx.static() || ctx.ModuleType() == "cc_object"))
Wei Lia1aa2972024-06-21 13:08:51 -07002481 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.BUILT_FILES, c.outputFile.String())
2482
2483 // Static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002484 staticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(false))
Wei Lia1aa2972024-06-21 13:08:51 -07002485 staticDepNames := make([]string, 0, len(staticDeps))
2486 for _, dep := range staticDeps {
2487 staticDepNames = append(staticDepNames, dep.Name())
2488 }
Wei Li8ede4f72025-01-15 21:24:22 -08002489 // Process CrtBegin and CrtEnd as static libs
Yu Liu727204c2025-01-23 20:58:32 +00002490 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Wei Li8ede4f72025-01-15 21:24:22 -08002491 depName := ctx.OtherModuleName(dep)
2492 depTag := ctx.OtherModuleDependencyTag(dep)
2493 switch depTag {
2494 case CrtBeginDepTag:
2495 staticDepNames = append(staticDepNames, depName)
2496 case CrtEndDepTag:
2497 staticDepNames = append(staticDepNames, depName)
2498 }
2499 })
Wei Lia1aa2972024-06-21 13:08:51 -07002500
Wei Li8ede4f72025-01-15 21:24:22 -08002501 staticDepPaths := make([]string, 0, len(deps.StaticLibs)+len(deps.CrtBegin)+len(deps.CrtEnd))
Wei Lia1aa2972024-06-21 13:08:51 -07002502 for _, dep := range deps.StaticLibs {
2503 staticDepPaths = append(staticDepPaths, dep.String())
2504 }
Wei Li8ede4f72025-01-15 21:24:22 -08002505 for _, dep := range deps.CrtBegin {
2506 staticDepPaths = append(staticDepPaths, dep.String())
2507 }
2508 for _, dep := range deps.CrtEnd {
2509 staticDepPaths = append(staticDepPaths, dep.String())
2510 }
Wei Lia1aa2972024-06-21 13:08:51 -07002511 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
2512 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEP_FILES, android.FirstUniqueStrings(staticDepPaths))
2513
2514 // Whole static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002515 wholeStaticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(true))
Wei Lia1aa2972024-06-21 13:08:51 -07002516 wholeStaticDepNames := make([]string, 0, len(wholeStaticDeps))
2517 for _, dep := range wholeStaticDeps {
2518 wholeStaticDepNames = append(wholeStaticDepNames, dep.Name())
2519 }
2520
2521 wholeStaticDepPaths := make([]string, 0, len(deps.WholeStaticLibs))
2522 for _, dep := range deps.WholeStaticLibs {
2523 wholeStaticDepPaths = append(wholeStaticDepPaths, dep.String())
2524 }
2525 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEPS, android.FirstUniqueStrings(wholeStaticDepNames))
2526 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEP_FILES, android.FirstUniqueStrings(wholeStaticDepPaths))
Wei Li8ede4f72025-01-15 21:24:22 -08002527
2528 // Header libs
2529 headerLibDeps := ctx.GetDirectDepsProxyWithTag(HeaderDepTag())
2530 headerLibDepNames := make([]string, 0, len(headerLibDeps))
2531 for _, dep := range headerLibDeps {
2532 headerLibDepNames = append(headerLibDepNames, dep.Name())
2533 }
2534 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.HEADER_LIBS, android.FirstUniqueStrings(headerLibDepNames))
Chris Parsons94a0bba2021-06-04 15:03:47 -04002535}
2536
2537func (c *Module) maybeUnhideFromMake() {
2538 // If a lib is directly included in any of the APEXes or is not available to the
2539 // platform (which is often the case when the stub is provided as a prebuilt),
2540 // unhide the stubs variant having the latest version gets visible to make. In
2541 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2542 // force anything in the make world to link against the stubs library. (unless it
2543 // is explicitly referenced via .bootstrap suffix or the module is marked with
2544 // 'bootstrap: true').
2545 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002546 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002547 c.IsStubs() && !c.InVendorRamdisk() {
2548 c.Properties.HideFromMake = false // unhide
2549 // Note: this is still non-installable
2550 }
2551}
2552
Colin Cross8ff10582023-12-07 13:10:56 -08002553// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2554// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002555func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002556 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002557 // If the module has been specifically configure to not be installed then
2558 // hide from make as otherwise it will break when running inside make
2559 // as the output path to install will not be specified. Not all uninstallable
2560 // modules can be hidden from make as some are needed for resolving make side
2561 // dependencies.
2562 c.HideFromMake()
Spandan Das034af2c2024-10-30 21:45:09 +00002563 c.SkipInstall()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002564 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002565 c.SkipInstall()
2566 }
2567
2568 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2569 // to allow using the outputs in a genrule.
2570 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002571 c.installer.install(ctx, c.outputFile.Path())
2572 if ctx.Failed() {
2573 return
Colin Crossca860ac2016-01-04 14:34:37 -08002574 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002575 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002576}
2577
Colin Cross0ea8ba82019-06-06 14:33:29 -07002578func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002579 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002580 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002581 }
Colin Crossca860ac2016-01-04 14:34:37 -08002582 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002583}
2584
Colin Crossca860ac2016-01-04 14:34:37 -08002585func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002586 for _, generator := range c.generators {
2587 generator.GeneratorInit(ctx)
2588 }
Colin Crossca860ac2016-01-04 14:34:37 -08002589 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002590 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002591 }
Colin Crossca860ac2016-01-04 14:34:37 -08002592 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002593 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002594 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002595 if c.stl != nil {
2596 c.stl.begin(ctx)
2597 }
Colin Cross16b23492016-01-06 14:41:07 -08002598 if c.sanitize != nil {
2599 c.sanitize.begin(ctx)
2600 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002601 if c.coverage != nil {
2602 c.coverage.begin(ctx)
2603 }
Yi Kong9723e332023-12-04 14:52:53 +09002604 if c.afdo != nil {
2605 c.afdo.begin(ctx)
2606 }
Stephen Craneba090d12017-05-09 15:44:35 -07002607 if c.lto != nil {
2608 c.lto.begin(ctx)
2609 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002610 if c.orderfile != nil {
2611 c.orderfile.begin(ctx)
2612 }
Dan Albert92fe7402020-07-15 13:33:30 -07002613 if ctx.useSdk() && c.IsSdkVariant() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002614 version, err := NativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002615 if err != nil {
2616 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002617 c.Properties.Sdk_version = nil
2618 } else {
2619 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002620 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002621 }
Colin Crossca860ac2016-01-04 14:34:37 -08002622}
2623
Colin Cross37047f12016-12-13 17:06:13 -08002624func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002625 deps := Deps{}
2626
Joe Onorato37f900c2023-07-18 16:58:16 -07002627 for _, generator := range c.generators {
2628 deps = generator.GeneratorDeps(ctx, deps)
2629 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002630 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002631 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002632 }
2633 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002634 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002635 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002636 if c.stl != nil {
2637 deps = c.stl.deps(ctx, deps)
2638 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002639 if c.coverage != nil {
2640 deps = c.coverage.deps(ctx, deps)
2641 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002642
Colin Crossb6715442017-10-24 11:13:31 -07002643 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2644 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2645 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2646 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2647 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2648 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002649 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002650 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002651
Colin Cross516c5452024-10-28 13:45:21 -07002652 if err := checkConflictingExplicitVersions(deps.SharedLibs); err != nil {
2653 ctx.PropertyErrorf("shared_libs", "%s", err.Error())
2654 }
2655
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002656 for _, lib := range deps.ReexportSharedLibHeaders {
2657 if !inList(lib, deps.SharedLibs) {
2658 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2659 }
2660 }
2661
2662 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002663 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2664 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 -07002665 }
2666 }
2667
Colin Cross5950f382016-12-13 12:50:57 -08002668 for _, lib := range deps.ReexportHeaderLibHeaders {
2669 if !inList(lib, deps.HeaderLibs) {
2670 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2671 }
2672 }
2673
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002674 for _, gen := range deps.ReexportGeneratedHeaders {
2675 if !inList(gen, deps.GeneratedHeaders) {
2676 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2677 }
2678 }
2679
Colin Crossc99deeb2016-04-11 15:06:20 -07002680 return deps
2681}
2682
Colin Cross516c5452024-10-28 13:45:21 -07002683func checkConflictingExplicitVersions(libs []string) error {
2684 withoutVersion := func(s string) string {
2685 name, _ := StubsLibNameAndVersion(s)
2686 return name
2687 }
2688 var errs []error
2689 for i, lib := range libs {
2690 libName := withoutVersion(lib)
2691 libsToCompare := libs[i+1:]
2692 j := slices.IndexFunc(libsToCompare, func(s string) bool {
2693 return withoutVersion(s) == libName
2694 })
2695 if j >= 0 {
2696 errs = append(errs, fmt.Errorf("duplicate shared libraries with different explicit versions: %q and %q",
2697 lib, libsToCompare[j]))
2698 }
2699 }
2700 return errors.Join(errs...)
2701}
2702
Dan Albert7e9d2952016-08-04 13:02:36 -07002703func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002704 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002705 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002706 moduleContextImpl: moduleContextImpl{
2707 mod: c,
2708 },
2709 }
2710 ctx.ctx = ctx
2711
Colin Crossca860ac2016-01-04 14:34:37 -08002712 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002713}
2714
Jiyong Park7ed9de32018-10-15 22:25:07 +09002715// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002716func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002717 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2718 version := name[sharp+1:]
2719 libname := name[:sharp]
2720 return libname, version
2721 }
2722 return name, ""
2723}
2724
Dan Albert92fe7402020-07-15 13:33:30 -07002725func GetCrtVariations(ctx android.BottomUpMutatorContext,
2726 m LinkableInterface) []blueprint.Variation {
2727 if ctx.Os() != android.Android {
2728 return nil
2729 }
2730 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002731 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2732 minSdkVersion := m.MinSdkVersion()
2733 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2734 minSdkVersion = m.SdkVersion()
2735 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002736 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2737 if err != nil {
2738 ctx.PropertyErrorf("min_sdk_version", err.Error())
2739 }
Colin Cross363ec762023-01-13 13:45:14 -08002740
2741 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002742 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002743 if apiLevel.LessThan(minApiForArch) {
2744 apiLevel = minApiForArch
2745 }
2746
Dan Albert92fe7402020-07-15 13:33:30 -07002747 return []blueprint.Variation{
2748 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002749 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002750 }
2751 }
2752 return []blueprint.Variation{
2753 {Mutator: "sdk", Variation: ""},
2754 }
2755}
2756
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002757func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2758 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002759
2760 variations = append([]blueprint.Variation(nil), variations...)
2761
Liz Kammer23942242022-04-08 15:41:00 -04002762 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002763 // Version is explicitly specified. i.e. libFoo#30
Colin Crossb614cd42024-10-11 12:52:21 -07002764 if version == "impl" {
2765 version = ""
2766 }
Colin Crosse7257d22020-09-24 09:56:18 -07002767 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002768 if tag, ok := depTag.(libraryDependencyTag); ok {
2769 tag.explicitlyVersioned = true
Colin Crossbd930bc2025-02-03 12:17:42 -08002770 if version == "" {
2771 tag.explicitlyImpl = true
2772 }
Colin Crossafcdce82024-10-22 13:59:33 -07002773 // depTag is an interface that contains a concrete non-pointer struct. That makes the local
2774 // tag variable a copy of the contents of depTag, and updating it doesn't change depTag. Reassign
2775 // the modified copy to depTag.
2776 depTag = tag
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002777 } else {
2778 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2779 }
Colin Crosse7257d22020-09-24 09:56:18 -07002780 }
Colin Crosse7257d22020-09-24 09:56:18 -07002781
Colin Cross0de8a1e2020-09-18 14:15:30 -07002782 if far {
2783 ctx.AddFarVariationDependencies(variations, depTag, name)
2784 } else {
2785 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002786 }
2787}
2788
Kiyoung Kim487689e2022-07-26 09:48:22 +09002789func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2790 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002791 return snapshot
2792 }
2793
2794 return lib
2795}
2796
Kiyoung Kim37693d02024-04-04 09:56:15 +09002797// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002798// of names:
2799//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002800// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002801//
2802// For each of these, it adds the name of the ndk_library module to the list of
2803// variant libs.
2804//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002805// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002806//
2807// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002808//
2809// The caller can then know to add the variantLibs dependencies differently from the
2810// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002811func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002812 variantLibs = []string{}
2813
2814 nonvariantLibs = []string{}
2815 for _, entry := range list {
2816 // strip #version suffix out
2817 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002818 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002819 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002820 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002821 nonvariantLibs = append(nonvariantLibs, entry)
2822 }
2823 }
2824 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002825
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002826}
2827
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002828func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2829 nonVariantLibs := []string{}
2830 variantLibs := []string{}
2831
2832 for _, lib := range libs {
2833 replaceLibName := GetReplaceModuleName(lib, replaceList)
2834 if replaceLibName == lib {
2835 // Do not handle any libs which are not in API imports
2836 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2837 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2838 variantLibs = append(variantLibs, replaceLibName)
2839 } else {
2840 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2841 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002842 }
2843
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002844 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002845}
2846
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002847func (c *Module) shouldUseApiSurface() bool {
2848 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2849 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2850 // LLNDK Variant
2851 return true
2852 }
2853
2854 if c.Properties.IsSdkVariant {
2855 // NDK Variant
2856 return true
2857 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002858 }
2859
2860 return false
2861}
2862
Colin Cross1e676be2016-10-12 14:38:15 -07002863func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002864 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002865 return
2866 }
2867
Colin Cross37047f12016-12-13 17:06:13 -08002868 ctx := &depsContext{
2869 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002870 moduleContextImpl: moduleContextImpl{
2871 mod: c,
2872 },
2873 }
2874 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002875
Colin Crossc99deeb2016-04-11 15:06:20 -07002876 deps := c.deps(ctx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002877
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002878 apiNdkLibs := []string{}
2879 apiLateNdkLibs := []string{}
2880
Yo Chiang219968c2020-09-22 18:45:04 +08002881 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2882
Dan Albert914449f2016-06-17 16:45:24 -07002883 variantNdkLibs := []string{}
2884 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002885 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002886 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2887 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2888 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002889 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002890
Colin Cross32ec36c2016-12-15 07:39:51 -08002891 for _, lib := range deps.HeaderLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002892 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002893 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002894 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002895 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002896
Spandan Das73bcafc2022-08-18 23:26:00 +00002897 if c.isNDKStubLibrary() {
Jiyong Parkf8fab9b2024-09-02 15:24:15 +09002898 variationExists := actx.OtherModuleDependencyVariantExists(nil, lib)
2899 if variationExists {
2900 actx.AddVariationDependencies(nil, depTag, lib)
2901 } else {
2902 // dependencies to ndk_headers fall here as ndk_headers do not have
2903 // any variants.
2904 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
2905 }
Spandan Dasff665182024-09-11 18:48:44 +00002906 } else if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002907 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002908 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002909 } else {
2910 actx.AddVariationDependencies(nil, depTag, lib)
2911 }
2912 }
2913
Dan Albertf1d14c72020-07-30 14:32:55 -07002914 if c.isNDKStubLibrary() {
2915 // NDK stubs depend on their implementation because the ABI dumps are
2916 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002917
Spandan Das8b08aea2023-03-14 19:29:34 +00002918 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2919 c.ImageVariation(),
2920 blueprint.Variation{Mutator: "link", Variation: "shared"},
2921 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002922 }
2923
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002924 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2925 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2926 c.Target().NativeBridge == android.NativeBridgeDisabled {
2927 actx.AddVariationDependencies(
Jihoon Kang47e91842024-06-19 00:51:16 +00002928 []blueprint.Variation{{Mutator: "image", Variation: android.VendorVariation}},
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002929 llndkHeaderLibTag,
2930 deps.LlndkHeaderLibs...)
2931 }
2932
Jiyong Park5d1598f2019-02-25 22:14:17 +09002933 for _, lib := range deps.WholeStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002934 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002935
Jiyong Park5d1598f2019-02-25 22:14:17 +09002936 actx.AddVariationDependencies([]blueprint.Variation{
2937 {Mutator: "link", Variation: "static"},
2938 }, depTag, lib)
2939 }
2940
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002941 for _, lib := range deps.StaticLibs {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002942 // Some dependencies listed in static_libs might actually be rust_ffi rlib variants.
Colin Cross8acea3e2024-12-12 14:53:30 -08002943 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002944
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002945 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002946 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002947 }
Jiyong Parke3867542020-12-03 17:28:25 +09002948 if inList(lib, deps.ExcludeLibsForApex) {
2949 depTag.excludeInApex = true
2950 }
Dan Willemsen59339a22018-07-22 21:18:45 -07002951 actx.AddVariationDependencies([]blueprint.Variation{
2952 {Mutator: "link", Variation: "static"},
2953 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002954 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002955
Jooyung Han75568392020-03-20 04:29:24 +09002956 // staticUnwinderDep is treated as staticDep for Q apexes
2957 // so that native libraries/binaries are linked with static unwinder
2958 // because Q libc doesn't have unwinder APIs
2959 if deps.StaticUnwinderIfLegacy {
Colin Cross8acea3e2024-12-12 14:53:30 -08002960 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002961 actx.AddVariationDependencies([]blueprint.Variation{
2962 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002963 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002964 }
2965
Jiyong Park7ed9de32018-10-15 22:25:07 +09002966 // shared lib names without the #version suffix
2967 var sharedLibNames []string
2968
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002969 for _, lib := range deps.SharedLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002970 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002971 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002972 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002973 }
Jiyong Parke3867542020-12-03 17:28:25 +09002974 if inList(lib, deps.ExcludeLibsForApex) {
2975 depTag.excludeInApex = true
2976 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002977 if inList(lib, deps.ExcludeLibsForNonApex) {
2978 depTag.excludeInNonApex = true
2979 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002980
Jiyong Park73c54ee2019-10-22 20:31:18 +09002981 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002982 sharedLibNames = append(sharedLibNames, name)
2983
Colin Crosse7257d22020-09-24 09:56:18 -07002984 variations := []blueprint.Variation{
2985 {Mutator: "link", Variation: "shared"},
2986 }
Spandan Dasff665182024-09-11 18:48:44 +00002987 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002988 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002989
Colin Crossfe9acfe2021-06-14 16:13:03 -07002990 for _, lib := range deps.LateStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002991 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Colin Crossfe9acfe2021-06-14 16:13:03 -07002992 actx.AddVariationDependencies([]blueprint.Variation{
2993 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002994 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002995 }
2996
Colin Cross3e5e7782022-06-17 22:17:05 +00002997 for _, lib := range deps.UnexportedStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002998 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
Colin Cross3e5e7782022-06-17 22:17:05 +00002999 actx.AddVariationDependencies([]blueprint.Variation{
3000 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09003001 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00003002 }
3003
Jiyong Park7ed9de32018-10-15 22:25:07 +09003004 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09003005 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09003006 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
3007 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
3008 // linking against both the stubs lib and the non-stubs lib at the same time.
3009 continue
3010 }
Colin Cross8acea3e2024-12-12 14:53:30 -08003011 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07003012 variations := []blueprint.Variation{
3013 {Mutator: "link", Variation: "shared"},
3014 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003015 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09003016 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003017
Dan Willemsen59339a22018-07-22 21:18:45 -07003018 actx.AddVariationDependencies([]blueprint.Variation{
3019 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04003020 }, dataLibDepTag, deps.DataLibs...)
3021
Colin Crossc8caa062021-09-24 16:50:14 -07003022 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
3023
Chris Parsons79d66a52020-06-05 17:26:16 -04003024 actx.AddVariationDependencies([]blueprint.Variation{
3025 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07003026 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08003027
Colin Cross68861832016-07-08 10:41:41 -07003028 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003029
3030 for _, gen := range deps.GeneratedHeaders {
3031 depTag := genHeaderDepTag
3032 if inList(gen, deps.ReexportGeneratedHeaders) {
3033 depTag = genHeaderExportDepTag
3034 }
3035 actx.AddDependency(c, depTag, gen)
3036 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003037
Cole Faust65cb40a2024-10-21 15:41:42 -07003038 for _, gen := range deps.DeviceFirstGeneratedHeaders {
3039 depTag := genHeaderDepTag
3040 actx.AddVariationDependencies(ctx.Config().AndroidFirstDeviceTarget.Variations(), depTag, gen)
3041 }
3042
Dan Albert92fe7402020-07-15 13:33:30 -07003043 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07003044 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07003045 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07003046 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09003047 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08003048 }
Colin Crossc465efd2021-06-11 18:00:04 -07003049 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07003050 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09003051 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07003052 }
Dan Willemsena0790e32018-10-12 00:24:23 -07003053 if deps.DynamicLinker != "" {
3054 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07003055 }
Dan Albert914449f2016-06-17 16:45:24 -07003056
3057 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07003058
Colin Cross8acea3e2024-12-12 14:53:30 -08003059 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003060 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003061 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003062 {Mutator: "link", Variation: "shared"},
3063 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003064 actx.AddVariationDependencies([]blueprint.Variation{
3065 {Mutator: "version", Variation: version},
3066 {Mutator: "link", Variation: "shared"},
3067 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07003068
Colin Cross8acea3e2024-12-12 14:53:30 -08003069 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003070 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003071 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003072 {Mutator: "link", Variation: "shared"},
3073 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003074 actx.AddVariationDependencies([]blueprint.Variation{
3075 {Mutator: "version", Variation: version},
3076 {Mutator: "link", Variation: "shared"},
3077 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08003078
Vinh Tran367d89d2023-04-28 11:21:25 -04003079 if len(deps.AidlLibs) > 0 {
3080 actx.AddDependency(
3081 c,
3082 aidlLibraryTag,
3083 deps.AidlLibs...,
3084 )
3085 }
3086
Colin Cross6362e272015-10-29 15:25:03 -07003087}
Colin Cross21b9a242015-03-24 14:15:58 -07003088
Colin Crosse40b4ea2018-10-02 22:25:58 -07003089func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07003090 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07003091 c.beginMutator(ctx)
3092 }
3093}
3094
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003095// Whether a module can link to another module, taking into
3096// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09003097func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07003098 tag blueprint.DependencyTag) {
3099
3100 switch t := tag.(type) {
3101 case dependencyTag:
3102 if t != vndkExtDepTag {
3103 return
3104 }
3105 case libraryDependencyTag:
3106 default:
3107 return
3108 }
3109
Ivan Lozanof9e21722020-12-02 09:00:51 -05003110 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003111 // Host code is not restricted
3112 return
3113 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003114
Ivan Lozano52767be2019-10-18 14:49:46 -07003115 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003116 // Platform code can link to anything
3117 return
3118 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08003119 if from.InRamdisk() {
3120 // Ramdisk code is not NDK
3121 return
3122 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003123 if from.InVendorRamdisk() {
3124 // Vendor ramdisk code is not NDK
3125 return
3126 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003127 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09003128 // Recovery code is not NDK
3129 return
3130 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003131 // Change this to LinkableInterface if Rust gets NDK support, which stubDecorators are for
Colin Cross31076b32020-10-23 17:22:06 -07003132 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07003133 if c.StubDecorator() {
3134 // These aren't real libraries, but are the stub shared libraries that are included in
3135 // the NDK.
3136 return
3137 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003138 }
Logan Chien834b9a62019-01-14 15:39:03 +08003139
Ivan Lozano52767be2019-10-18 14:49:46 -07003140 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08003141 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
3142 // to link to libc++ (non-NDK and without sdk_version).
3143 return
3144 }
3145
Ivan Lozano52767be2019-10-18 14:49:46 -07003146 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003147 // NDK code linking to platform code is never okay.
3148 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003149 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08003150 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003151 }
3152
3153 // At this point we know we have two NDK libraries, but we need to
3154 // check that we're not linking against anything built against a higher
3155 // API level, as it is only valid to link against older or equivalent
3156 // APIs.
3157
Inseob Kim01a28722018-04-11 09:48:45 +09003158 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07003159 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003160 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07003161 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003162 // Current can't be linked against by anything else.
3163 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003164 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09003165 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003166 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003167 if err != nil {
3168 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003169 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003170 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003171 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003172 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003173 if err != nil {
3174 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003175 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003176 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003177 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003178
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003179 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09003180 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003181 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003182 }
3183 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003184 }
Dan Albert202fe492017-12-15 13:56:59 -08003185
3186 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07003187 fromStl := from.SelectedStl()
3188 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08003189 if fromStl == "" || toStl == "" {
3190 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09003191 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08003192 // We can be permissive with the system "STL" since it is only the C++
3193 // ABI layer, but in the future we should make sure that everyone is
3194 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07003195 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08003196 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003197 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
3198 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08003199 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003200}
3201
Jooyung Han479ca172020-10-19 18:51:07 +09003202func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
3203 if c, ok := ctx.Module().(*Module); ok {
3204 ctx.VisitDirectDeps(func(dep android.Module) {
3205 depTag := ctx.OtherModuleDependencyTag(dep)
3206 ccDep, ok := dep.(LinkableInterface)
3207 if ok {
3208 checkLinkType(ctx, c, ccDep, depTag)
3209 }
3210 })
3211 }
3212}
3213
Jiyong Park5fb8c102018-04-09 12:03:06 +09003214// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09003215// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
3216// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003217// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Colin Crossda279cf2024-09-17 14:25:45 -07003218func checkDoubleLoadableLibraries(ctx android.BottomUpMutatorContext) {
Jooyung Hana70f0672019-01-18 15:20:43 +09003219 check := func(child, parent android.Module) bool {
3220 to, ok := child.(*Module)
3221 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09003222 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09003223 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003224
Jooyung Hana70f0672019-01-18 15:20:43 +09003225 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
3226 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09003227 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003228
Jiyong Park0474e1f2021-01-14 14:26:06 +09003229 // These dependencies are not excercised at runtime. Tracking these will give us
3230 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09003231 depTag := ctx.OtherModuleDependencyTag(child)
3232 if IsHeaderDepTag(depTag) {
3233 return false
3234 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09003235 if depTag == staticVariantTag {
3236 return false
3237 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003238 if depTag == StubImplDepTag {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003239 return false
3240 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003241 if depTag == android.RequiredDepTag {
3242 return false
3243 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003244
Justin Yun63e9ec72020-10-29 16:49:43 +09003245 // Even if target lib has no vendor variant, keep checking dependency
3246 // graph in case it depends on vendor_available or product_available
3247 // but not double_loadable transtively.
3248 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003249 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003250 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003251
Jiyong Park0474e1f2021-01-14 14:26:06 +09003252 // The happy path. Keep tracking dependencies until we hit a non double-loadable
3253 // one.
3254 if Bool(to.VendorProperties.Double_loadable) {
3255 return true
3256 }
3257
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09003258 if to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003259 return false
3260 }
3261
Jooyung Hana70f0672019-01-18 15:20:43 +09003262 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3263 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003264 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003265 return false
3266 }
3267 if module, ok := ctx.Module().(*Module); ok {
3268 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003269 if lib.HasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003270 ctx.WalkDeps(check)
3271 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003272 }
3273 }
3274}
3275
Yu Liue4312402023-01-18 09:15:31 -08003276func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3277 // For the dependency from platform to apex, use the latest stubs
3278 apexSdkVersion := android.FutureApiLevel
3279 if !apexInfo.IsForPlatform() {
3280 apexSdkVersion = apexInfo.MinSdkVersion
3281 }
3282
3283 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3284 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3285 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3286 // (b/144430859)
3287 apexSdkVersion = android.FutureApiLevel
3288 }
3289
3290 return apexSdkVersion
3291}
3292
Colin Crossc99deeb2016-04-11 15:06:20 -07003293// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003294func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003295 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003296
Colin Cross0de8a1e2020-09-18 14:15:30 -07003297 var directStaticDeps []StaticLibraryInfo
3298 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003299
Colin Cross0de8a1e2020-09-18 14:15:30 -07003300 reexportExporter := func(exporter FlagExporterInfo) {
3301 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3302 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3303 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3304 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3305 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003306 }
3307
Colin Crossff694a82023-12-13 15:54:49 -08003308 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003309 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003310
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003311 skipModuleList := map[string]bool{}
3312
Yu Liu8024b922024-12-20 23:31:32 +00003313 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003314 depName := ctx.OtherModuleName(dep)
3315 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003316
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003317 if _, ok := skipModuleList[depName]; ok {
3318 // skip this module because original module or API imported module matching with this should be used instead.
3319 return
3320 }
3321
Yu Liu8024b922024-12-20 23:31:32 +00003322 var ccInfo *CcInfo
3323 v, hasCcInfo := android.OtherModuleProvider(ctx, dep, CcInfoProvider)
3324 if hasCcInfo {
3325 ccInfo = v
3326 }
3327 linkableInfo, hasLinkableInfo := android.OtherModuleProvider(ctx, dep, LinkableInfoProvider)
Dan Willemsen47450072021-10-19 20:24:49 -07003328 if depTag == android.DarwinUniversalVariantTag {
Yu Liu8024b922024-12-20 23:31:32 +00003329 if !hasCcInfo {
3330 panic(fmt.Errorf("dep is not a cc module: %s", dep.String()))
3331 }
3332 depPaths.DarwinSecondArchOutput = linkableInfo.OutputFile
Dan Willemsen47450072021-10-19 20:24:49 -07003333 return
3334 }
3335
Vinh Tran367d89d2023-04-28 11:21:25 -04003336 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003337 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003338 depPaths.AidlLibraryInfos = append(
3339 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003340 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003341 )
3342 }
3343 }
3344
Yu Liu8024b922024-12-20 23:31:32 +00003345 if !hasLinkableInfo {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003346 // handling for a few module types that aren't cc Module but that are also supported
Yu Liu8024b922024-12-20 23:31:32 +00003347 genRule, ok := android.OtherModuleProvider(ctx, dep, android.GeneratedSourceInfoProvider)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003348 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003349 case genSourceDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003350 if ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003351 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
Yu Liu8024b922024-12-20 23:31:32 +00003352 genRule.GeneratedSourceFiles...)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003353 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003354 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003355 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003356 // Support exported headers from a generated_sources dependency
3357 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003358 case genHeaderDepTag, genHeaderExportDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003359 if ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003360 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Yu Liu8024b922024-12-20 23:31:32 +00003361 genRule.GeneratedDeps...)
3362 dirs := genRule.GeneratedHeaderDirs
Inseob Kim69378442019-06-03 19:10:47 +09003363 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003364 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003365 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003366 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
Yu Liu8024b922024-12-20 23:31:32 +00003367 genRule.GeneratedSourceFiles...)
3368 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003369 // 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 +09003370 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003371 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003372 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003373 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003374 }
Colin Crosscef792e2021-06-11 18:01:26 -07003375 case CrtBeginDepTag:
3376 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3377 case CrtEndDepTag:
3378 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003379 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003380 return
3381 }
3382
Colin Crossfe17f6f2019-03-28 19:30:56 -07003383 if depTag == android.ProtoPluginDepTag {
3384 return
3385 }
3386
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003387 if depTag == android.RequiredDepTag {
3388 return
3389 }
3390
Yu Liu8024b922024-12-20 23:31:32 +00003391 commonInfo := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey)
3392 if commonInfo.Target.Os != ctx.Os() {
Steven Morelandaaae81f2024-08-27 22:55:48 +00003393 ctx.ModuleErrorf("OS mismatch between %q (%s) and %q (%s)", ctx.ModuleName(), ctx.Os().Name, depName, dep.Target().Os.Name)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003394 return
3395 }
Yu Liu8024b922024-12-20 23:31:32 +00003396 if commonInfo.Target.Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003397 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
Yu Liu8024b922024-12-20 23:31:32 +00003398 ctx.ModuleName(), ctx.Arch().ArchType, depName, commonInfo.Target.Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003399 return
3400 }
3401
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003402 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003403 // Skip reused objects for stub libraries, they use their own stub object file instead.
3404 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3405 // version mutator, so the stubs variant is created from the shared variant that
3406 // already has the reuseObjTag dependency on the static variant.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003407 if !c.library.BuildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003408 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003409 objs := staticAnalogue.ReuseObjects
3410 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003411 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003412 reexportExporter(depExporterInfo)
3413 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003414 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003415 }
3416
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003417 if depTag == llndkHeaderLibTag {
3418 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3419 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3420 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3421 }
3422
Yu Liu8024b922024-12-20 23:31:32 +00003423 linkFile := linkableInfo.OutputFile
Colin Cross6e511a92020-07-27 21:26:48 -07003424
3425 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3426 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003427 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003428 return
3429 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003430
Jiyong Parke3867542020-12-03 17:28:25 +09003431 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3432 return
3433 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003434 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3435 return
3436 }
Jiyong Parke3867542020-12-03 17:28:25 +09003437
Colin Cross313aa542023-12-13 13:47:44 -08003438 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003439
Colin Cross6e511a92020-07-27 21:26:48 -07003440 var ptr *android.Paths
3441 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003442
Colin Cross6e511a92020-07-27 21:26:48 -07003443 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003444
Colin Cross6e511a92020-07-27 21:26:48 -07003445 switch {
3446 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003447 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003448 if !ctx.Config().AllowMissingDependencies() {
3449 ctx.ModuleErrorf("module %q is not a header library", depName)
3450 } else {
3451 ctx.AddMissingDependencies([]string{depName})
3452 }
3453 return
3454 }
Colin Cross6e511a92020-07-27 21:26:48 -07003455 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003456 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003457 if !ctx.Config().AllowMissingDependencies() {
3458 ctx.ModuleErrorf("module %q is not a shared library", depName)
3459 } else {
3460 ctx.AddMissingDependencies([]string{depName})
3461 }
3462 return
3463 }
Jiyong Parke3867542020-12-03 17:28:25 +09003464
Jiyong Park7d55b612021-06-11 17:22:09 +09003465 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3466 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003467
Jiyong Park1ad8e162020-12-01 23:40:09 +09003468 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3469 // linkFile, depFile, and ptr.
3470 if c.IsStubs() {
3471 break
3472 }
3473
Colin Cross0de8a1e2020-09-18 14:15:30 -07003474 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3475 depFile = sharedLibraryInfo.TableOfContents
3476
Colin Crossb614cd42024-10-11 12:52:21 -07003477 if !sharedLibraryInfo.IsStubs {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00003478 // TODO(b/362509506): remove this additional check once all apex_exclude uses are switched to stubs.
3479 if !linkableInfo.RustApexExclude {
3480 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
3481 if info, ok := android.OtherModuleProvider(ctx, dep, ImplementationDepInfoProvider); ok {
3482 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
3483 }
Colin Crossb614cd42024-10-11 12:52:21 -07003484 }
3485 }
3486
Colin Cross6e511a92020-07-27 21:26:48 -07003487 ptr = &depPaths.SharedLibs
3488 switch libDepTag.Order {
3489 case earlyLibraryDependency:
3490 ptr = &depPaths.EarlySharedLibs
3491 depPtr = &depPaths.EarlySharedLibsDeps
3492 case normalLibraryDependency:
3493 ptr = &depPaths.SharedLibs
3494 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003495 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003496 case lateLibraryDependency:
3497 ptr = &depPaths.LateSharedLibs
3498 depPtr = &depPaths.LateSharedLibsDeps
3499 default:
3500 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003501 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003502
Colin Cross6e511a92020-07-27 21:26:48 -07003503 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003504 if linkableInfo.RustLibraryInterface {
3505 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: linkableInfo.CrateName, LinkDirs: linkableInfo.ExportedCrateLinkDirs}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003506 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3507 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3508 if libDepTag.wholeStatic {
3509 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3510 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
Jiyong Park1ad8e162020-12-01 23:40:09 +09003511
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003512 // If whole_static, track this as we want to make sure that in a final linkage for a shared library,
3513 // exported functions from the rust generated staticlib still exported.
3514 if c.CcLibrary() && c.Shared() {
3515 c.WholeRustStaticlib = true
3516 }
Colin Cross6e511a92020-07-27 21:26:48 -07003517 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003518
Colin Cross6e511a92020-07-27 21:26:48 -07003519 } else {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003520 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3521 if !isStaticLib {
3522 if !ctx.Config().AllowMissingDependencies() {
3523 ctx.ModuleErrorf("module %q is not a static library", depName)
3524 } else {
3525 ctx.AddMissingDependencies([]string{depName})
3526 }
3527 return
Inseob Kimeec88e12020-01-22 11:11:29 +09003528 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003529
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003530 // Stubs lib doesn't link to the static lib dependencies. Don't set
3531 // linkFile, depFile, and ptr.
3532 if c.IsStubs() {
3533 break
3534 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003535
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003536 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
3537 if libDepTag.wholeStatic {
3538 ptr = &depPaths.WholeStaticLibs
3539 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3540 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
3541 } else {
3542 // This case normally catches prebuilt static
3543 // libraries, but it can also occur when
3544 // AllowMissingDependencies is on and the
3545 // dependencies has no sources of its own
3546 // but has a whole_static_libs dependency
3547 // on a missing library. We want to depend
3548 // on the .a file so that there is something
3549 // in the dependency tree that contains the
3550 // error rule for the missing transitive
3551 // dependency.
3552 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
3553 }
3554 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3555 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
3556 } else {
3557 switch libDepTag.Order {
3558 case earlyLibraryDependency:
3559 panic(fmt.Errorf("early static libs not supported"))
3560 case normalLibraryDependency:
3561 // static dependencies will be handled separately so they can be ordered
3562 // using transitive dependencies.
3563 ptr = nil
3564 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
3565 case lateLibraryDependency:
3566 ptr = &depPaths.LateStaticLibs
3567 default:
3568 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
3569 }
3570 }
3571
3572 // Collect any exported Rust rlib deps from static libraries which have been included as whole_static_libs
3573 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3574
3575 if libDepTag.unexportedSymbols {
3576 depPaths.LdFlags = append(depPaths.LdFlags,
3577 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3578 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003579 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003580 }
3581
Yu Liu8024b922024-12-20 23:31:32 +00003582 if libDepTag.static() && !libDepTag.wholeStatic && !linkableInfo.RustLibraryInterface {
3583 if !linkableInfo.CcLibraryInterface || !linkableInfo.Static {
Colin Cross6e511a92020-07-27 21:26:48 -07003584 ctx.ModuleErrorf("module %q not a static library", depName)
3585 return
3586 }
Logan Chien43d34c32017-12-20 01:17:32 +08003587
Colin Cross6e511a92020-07-27 21:26:48 -07003588 // When combining coverage files for shared libraries and executables, coverage files
3589 // in static libraries act as if they were whole static libraries. The same goes for
3590 // source based Abi dump files.
Yu Liu8024b922024-12-20 23:31:32 +00003591 if hasCcInfo {
Colin Cross6e511a92020-07-27 21:26:48 -07003592 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003593 linkableInfo.CoverageFiles...)
Colin Cross6e511a92020-07-27 21:26:48 -07003594 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003595 linkableInfo.SAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003596 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003597 // Handle non-CC modules here
3598 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003599 linkableInfo.CoverageFiles...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003600 }
3601 }
3602
Colin Cross6e511a92020-07-27 21:26:48 -07003603 if ptr != nil {
3604 if !linkFile.Valid() {
3605 if !ctx.Config().AllowMissingDependencies() {
3606 ctx.ModuleErrorf("module %q missing output file", depName)
3607 } else {
3608 ctx.AddMissingDependencies([]string{depName})
3609 }
3610 return
3611 }
3612 *ptr = append(*ptr, linkFile.Path())
3613 }
3614
3615 if depPtr != nil {
3616 dep := depFile
3617 if !dep.Valid() {
3618 dep = linkFile
3619 }
3620 *depPtr = append(*depPtr, dep.Path())
3621 }
3622
Colin Cross0de8a1e2020-09-18 14:15:30 -07003623 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3624 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3625 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3626 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003627 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3628
3629 // Only re-export RustRlibDeps for cc static libs
3630 if c.static() {
3631 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3632 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003633
3634 if libDepTag.reexportFlags {
3635 reexportExporter(depExporterInfo)
3636 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3637 // Re-exported shared library headers must be included as well since they can help us with type information
3638 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003639 c.sabi.Properties.ReexportedIncludes = append(
3640 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003641 c.sabi.Properties.ReexportedSystemIncludes = append(
3642 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003643 }
3644
Yu Liu0a37d422025-02-13 02:05:00 +00003645 makeLibName := MakeLibName(ccInfo, linkableInfo, &commonInfo, commonInfo.BaseModuleName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003646 switch {
3647 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003648 c.Properties.AndroidMkHeaderLibs = append(
3649 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003650 case libDepTag.shared():
Colin Cross6e511a92020-07-27 21:26:48 -07003651 // Note: the order of libs in this list is not important because
3652 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003653 c.Properties.AndroidMkSharedLibs = append(
3654 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003655 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003656 if !linkableInfo.RustLibraryInterface {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003657 if libDepTag.wholeStatic {
3658 c.Properties.AndroidMkWholeStaticLibs = append(
3659 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3660 } else {
3661 c.Properties.AndroidMkStaticLibs = append(
3662 c.Properties.AndroidMkStaticLibs, makeLibName)
3663 }
Colin Cross6e511a92020-07-27 21:26:48 -07003664 }
3665 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003666 } else if !c.IsStubs() {
3667 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3668
Colin Cross6e511a92020-07-27 21:26:48 -07003669 switch depTag {
3670 case runtimeDepTag:
3671 c.Properties.AndroidMkRuntimeLibs = append(
Yu Liu0a37d422025-02-13 02:05:00 +00003672 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ccInfo, linkableInfo, &commonInfo,
3673 commonInfo.BaseModuleName)+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003674 case objDepTag:
3675 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3676 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003677 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003678 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003679 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003680 case dynamicLinkerDepTag:
3681 depPaths.DynamicLinker = linkFile
3682 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003683 }
Colin Crossca860ac2016-01-04 14:34:37 -08003684 })
3685
Jeff Gaston294356f2017-09-27 17:05:30 -07003686 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003687 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3688 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3689 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003690
Colin Crossdd84e052017-05-17 13:44:16 -07003691 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003692 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003693 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3694 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003695 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003696 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3697
Jiyong Park74955042019-10-22 20:19:51 +09003698 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3699 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003700 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003701 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003702 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003703 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003704
3705 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003706 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003707 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003708 }
Colin Crossdd84e052017-05-17 13:44:16 -07003709
Colin Crossca860ac2016-01-04 14:34:37 -08003710 return depPaths
3711}
3712
Yu Liuf6f85492025-01-13 21:02:36 +00003713func ShouldUseStubForApex(ctx android.ModuleContext, parent android.Module, dep android.ModuleProxy) bool {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003714 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003715 bootstrap := false
Yu Liue472c1d2025-02-26 20:13:04 +00003716 if android.EqualModules(ctx.Module(), parent) {
Yu Liuf6f85492025-01-13 21:02:36 +00003717 if linkable, ok := parent.(LinkableInterface); !ok {
3718 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3719 } else {
3720 inVendorOrProduct = linkable.InVendorOrProduct()
3721 bootstrap = linkable.Bootstrap()
3722 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003723 } else {
Yu Liuf6f85492025-01-13 21:02:36 +00003724 if linkable, ok := android.OtherModuleProvider(ctx, parent, LinkableInfoProvider); !ok {
3725 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3726 } else {
3727 inVendorOrProduct = linkable.InVendorOrProduct
3728 bootstrap = linkable.Bootstrap
3729 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003730 }
3731
Spandan Das10c41362024-12-03 01:33:09 +00003732 apexInfo, _ := android.OtherModuleProvider(ctx, parent, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003733
3734 useStubs := false
3735
Yu Liu8024b922024-12-20 23:31:32 +00003736 if android.OtherModuleProviderOrDefault(ctx, dep, LinkableInfoProvider).IsStubs && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003737 if !apexInfo.IsForPlatform() {
3738 // For platform libraries, use current version of LLNDK
3739 // If this is for use_vendor apex we will apply the same rules
3740 // of apex sdk enforcement below to choose right version.
3741 useStubs = true
3742 }
3743 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3744 // If not building for APEX or the containing APEX allows the use of
3745 // platform APIs, use stubs only when it is from an APEX (and not from
3746 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3747 // bootstrap modules, always link to non-stub variant
Yu Liu8024b922024-12-20 23:31:32 +00003748 isNotInPlatform := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey).NotInPlatform
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003749
Spandan Dasff665182024-09-11 18:48:44 +00003750 useStubs = isNotInPlatform && !bootstrap
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003751 } else {
Colin Crossea91a172024-11-05 16:14:05 -08003752 // If building for APEX, always use stubs (can be bypassed by depending on <dep>#impl)
3753 useStubs = true
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003754 }
3755
3756 return useStubs
3757}
3758
3759// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3760// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3761// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3762// has different level of updatability. For example, if a library foo in an APEX depends on a
3763// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3764// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3765// same APEX as foo, the non-stub variant of bar is used.
Yu Liuf6f85492025-01-13 21:02:36 +00003766func ChooseStubOrImpl(ctx android.ModuleContext, dep android.ModuleProxy) (SharedLibraryInfo, FlagExporterInfo) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003767 depTag := ctx.OtherModuleDependencyTag(dep)
3768 libDepTag, ok := depTag.(libraryDependencyTag)
3769 if !ok || !libDepTag.shared() {
3770 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3771 }
3772
Colin Cross313aa542023-12-13 13:47:44 -08003773 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3774 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3775 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003776
3777 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003778 // when to use (unspecified) stubs, use the latest one.
Spandan Das10c41362024-12-03 01:33:09 +00003779 if ShouldUseStubForApex(ctx, ctx.Module(), dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003780 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3781 toUse := stubs[len(stubs)-1]
3782 sharedLibraryInfo = toUse.SharedLibraryInfo
3783 depExporterInfo = toUse.FlagExporterInfo
3784 }
3785 }
3786 return sharedLibraryInfo, depExporterInfo
3787}
3788
Colin Cross0de8a1e2020-09-18 14:15:30 -07003789// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3790// to match the topological order of the dependency tree, including any static analogues of
Colin Crossa14fb6a2024-10-23 16:57:06 -07003791// direct shared libraries. It returns the ordered static dependencies, and a depset.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07003792// of the transitive dependencies.
Colin Crossa14fb6a2024-10-23 16:57:06 -07003793func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive depset.DepSet[android.Path]) {
3794 transitiveStaticLibsBuilder := depset.NewBuilder[android.Path](depset.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003795 var staticPaths android.Paths
3796 for _, staticDep := range staticDeps {
3797 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3798 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3799 }
3800 for _, sharedDep := range sharedDeps {
Colin Crossa14fb6a2024-10-23 16:57:06 -07003801 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003802 }
3803 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3804
3805 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3806
3807 // reorder the dependencies based on transitive dependencies
3808 staticPaths = android.FirstUniquePaths(staticPaths)
3809 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3810
3811 if len(orderedStaticPaths) != len(staticPaths) {
3812 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3813 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3814 }
3815
3816 return orderedStaticPaths, transitiveStaticLibs
3817}
3818
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003819// BaseLibName trims known prefixes and suffixes
3820func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003821 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3822 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003823 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003824 return libName
3825}
3826
Yu Liu8024b922024-12-20 23:31:32 +00003827func MakeLibName(ccInfo *CcInfo, linkableInfo *LinkableInfo, commonInfo *android.CommonModuleInfo, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003828 libName := BaseLibName(depName)
Yu Liu8024b922024-12-20 23:31:32 +00003829 isLLndk := ccInfo != nil && linkableInfo.IsLlndk
3830 nonSystemVariantsExist := linkableInfo.HasNonSystemVariants || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003831
Yu Liu8024b922024-12-20 23:31:32 +00003832 if ccInfo != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003833 // Use base module name for snapshots when exporting to Makefile.
Yu Liu8024b922024-12-20 23:31:32 +00003834 if ccInfo.SnapshotInfo != nil {
Yu Liu0a37d422025-02-13 02:05:00 +00003835 return commonInfo.BaseModuleName + ccInfo.SnapshotInfo.SnapshotAndroidMkSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003836 }
3837 }
3838
Yu Liu8024b922024-12-20 23:31:32 +00003839 if linkableInfo.InVendorOrProduct && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003840 // The vendor and product modules in Make will have been renamed to not conflict with the
3841 // core module, so update the dependency name here accordingly.
Yu Liu8024b922024-12-20 23:31:32 +00003842 return libName + linkableInfo.SubName
3843 } else if linkableInfo.InRamdisk && !linkableInfo.OnlyInRamdisk {
Matthew Maurerc6868382021-07-13 14:12:37 -07003844 return libName + RamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003845 } else if linkableInfo.InVendorRamdisk && !linkableInfo.OnlyInVendorRamdisk {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003846 return libName + VendorRamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003847 } else if linkableInfo.InRecovery && !linkableInfo.OnlyInRecovery {
Matthew Maurer460ee942021-02-11 12:31:46 -08003848 return libName + RecoverySuffix
Yu Liu8024b922024-12-20 23:31:32 +00003849 } else if commonInfo.Target.NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003850 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003851 } else {
3852 return libName
3853 }
3854}
3855
Colin Crossca860ac2016-01-04 14:34:37 -08003856func (c *Module) InstallInData() bool {
3857 if c.installer == nil {
3858 return false
3859 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003860 return c.installer.inData()
3861}
3862
3863func (c *Module) InstallInSanitizerDir() bool {
3864 if c.installer == nil {
3865 return false
3866 }
3867 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003868 return true
3869 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003870 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003871}
3872
Yifan Hong1b3348d2020-01-21 15:53:22 -08003873func (c *Module) InstallInRamdisk() bool {
3874 return c.InRamdisk()
3875}
3876
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003877func (c *Module) InstallInVendorRamdisk() bool {
3878 return c.InVendorRamdisk()
3879}
3880
Jiyong Parkf9332f12018-02-01 00:54:12 +09003881func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003882 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003883}
3884
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003885func (c *Module) MakeUninstallable() {
3886 if c.installer == nil {
3887 c.ModuleBase.MakeUninstallable()
3888 return
3889 }
3890 c.installer.makeUninstallable(c)
3891}
3892
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003893func (c *Module) HostToolPath() android.OptionalPath {
3894 if c.installer == nil {
3895 return android.OptionalPath{}
3896 }
3897 return c.installer.hostToolPath()
3898}
3899
Nan Zhangd4e641b2017-07-12 12:55:28 -07003900func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3901 return c.outputFile
3902}
3903
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003904func (c *Module) static() bool {
3905 if static, ok := c.linker.(interface {
3906 static() bool
3907 }); ok {
3908 return static.static()
3909 }
3910 return false
3911}
3912
Colin Cross6a730042024-12-05 13:53:43 -08003913func (c *Module) staticLibrary() bool {
3914 if static, ok := c.linker.(interface {
3915 staticLibrary() bool
3916 }); ok {
3917 return static.staticLibrary()
3918 }
3919 return false
3920}
3921
Jiyong Park379de2f2018-12-19 02:47:14 +09003922func (c *Module) staticBinary() bool {
3923 if static, ok := c.linker.(interface {
3924 staticBinary() bool
3925 }); ok {
3926 return static.staticBinary()
3927 }
3928 return false
3929}
3930
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003931func (c *Module) testBinary() bool {
3932 if test, ok := c.linker.(interface {
3933 testBinary() bool
3934 }); ok {
3935 return test.testBinary()
3936 }
3937 return false
3938}
3939
Jingwen Chen537242c2022-08-24 11:53:27 +00003940func (c *Module) testLibrary() bool {
3941 if test, ok := c.linker.(interface {
3942 testLibrary() bool
3943 }); ok {
3944 return test.testLibrary()
3945 }
3946 return false
3947}
3948
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003949func (c *Module) benchmarkBinary() bool {
3950 if b, ok := c.linker.(interface {
3951 benchmarkBinary() bool
3952 }); ok {
3953 return b.benchmarkBinary()
3954 }
3955 return false
3956}
3957
3958func (c *Module) fuzzBinary() bool {
3959 if f, ok := c.linker.(interface {
3960 fuzzBinary() bool
3961 }); ok {
3962 return f.fuzzBinary()
3963 }
3964 return false
3965}
3966
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003967// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3968func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003969 if h, ok := c.linker.(interface {
3970 header() bool
3971 }); ok {
3972 return h.header()
3973 }
3974 return false
3975}
3976
Ivan Lozanod7586b62021-04-01 09:49:36 -04003977func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003978 if b, ok := c.linker.(interface {
3979 binary() bool
3980 }); ok {
3981 return b.binary()
3982 }
3983 return false
3984}
3985
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003986func (c *Module) ForceDisableSanitizers() {
3987 c.sanitize.Properties.ForceDisable = true
3988}
3989
Justin Yun5e035862021-06-29 20:50:37 +09003990func (c *Module) StaticExecutable() bool {
3991 if b, ok := c.linker.(*binaryDecorator); ok {
3992 return b.static()
3993 }
3994 return false
3995}
3996
Ivan Lozanod7586b62021-04-01 09:49:36 -04003997func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003998 if o, ok := c.linker.(interface {
3999 object() bool
4000 }); ok {
4001 return o.object()
4002 }
4003 return false
4004}
4005
Kiyoung Kim37693d02024-04-04 09:56:15 +09004006func (m *Module) Dylib() bool {
4007 return false
4008}
4009
4010func (m *Module) Rlib() bool {
4011 return false
4012}
4013
Ivan Lozanof9e21722020-12-02 09:00:51 -05004014func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09004015 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08004016 if c.IsLlndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05004017 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09004018 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05004019 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09004020 return "native:product"
4021 }
Jooyung Han38002912019-05-16 04:01:54 +09004022 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08004023 } else if c.InRamdisk() {
4024 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07004025 } else if c.InVendorRamdisk() {
4026 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07004027 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07004028 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05004029 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07004030 return "native:ndk:none:none"
4031 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
4032 //family, link := getNdkStlFamilyAndLinkType(c)
4033 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
4034 } else {
4035 return "native:platform"
4036 }
4037}
4038
Jiyong Park9d452992018-10-03 00:38:19 +09004039// Overrides ApexModule.IsInstallabeToApex()
Colin Cross3a02c7b2024-05-21 13:46:22 -07004040// Only shared/runtime libraries .
Jiyong Park9d452992018-10-03 00:38:19 +09004041func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07004042 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09004043 // Stub libs and prebuilt libs in a versioned SDK are not
4044 // installable to APEX even though they are shared libs.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00004045 return lib.shared() && !lib.BuildStubs()
Jiyong Park9d452992018-10-03 00:38:19 +09004046 }
4047 return false
4048}
4049
Jiyong Parka90ca002019-10-07 15:47:24 +09004050func (c *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +00004051 return android.CheckAvailableForApex(what, c.ApexAvailableFor())
4052}
4053
4054func (c *Module) ApexAvailableFor() []string {
4055 list := c.ApexModuleBase.ApexAvailable()
Jiyong Parka90ca002019-10-07 15:47:24 +09004056 if linker, ok := c.linker.(interface {
Yu Liub73c3a62024-12-10 00:58:06 +00004057 apexAvailable() []string
Jiyong Parka90ca002019-10-07 15:47:24 +09004058 }); ok {
Yu Liub73c3a62024-12-10 00:58:06 +00004059 list = append(list, linker.apexAvailable()...)
Jiyong Parka90ca002019-10-07 15:47:24 +09004060 }
Yu Liub73c3a62024-12-10 00:58:06 +00004061
4062 return android.FirstUniqueStrings(list)
Jiyong Parka90ca002019-10-07 15:47:24 +09004063}
4064
Paul Duffin0cb37b92020-03-04 14:52:46 +00004065func (c *Module) EverInstallable() bool {
4066 return c.installer != nil &&
4067 // Check to see whether the module is actually ever installable.
4068 c.installer.everInstallable()
4069}
4070
Ivan Lozanod7586b62021-04-01 09:49:36 -04004071func (c *Module) PreventInstall() bool {
4072 return c.Properties.PreventInstall
4073}
4074
4075func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07004076 if c.library != nil {
4077 if i := c.library.installable(); i != nil {
4078 return i
4079 }
4080 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04004081 return c.Properties.Installable
4082}
4083
4084func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00004085 ret := c.EverInstallable() &&
4086 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04004087 proptools.BoolDefault(c.Installable(), true) &&
4088 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004089
4090 // The platform variant doesn't need further condition. Apex variants however might not
4091 // be installable because it will likely to be included in the APEX and won't appear
4092 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07004093 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004094 return ret
4095 }
4096
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004097 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09004098}
4099
Logan Chien41eabe62019-04-10 13:33:58 +08004100func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
4101 if c.linker != nil {
4102 if library, ok := c.linker.(*libraryDecorator); ok {
4103 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
4104 }
4105 }
4106}
4107
Jiyong Park45bf82e2020-12-15 22:29:02 +09004108var _ android.ApexModule = (*Module)(nil)
4109
4110// Implements android.ApexModule
Yu Liuf1806032025-02-07 00:23:34 +00004111func (c *Module) GetDepInSameApexChecker() android.DepInSameApexChecker {
4112 return CcDepInSameApexChecker{
4113 Static: c.static(),
4114 HasStubsVariants: c.HasStubsVariants(),
4115 IsLlndk: c.IsLlndk(),
4116 Host: c.Host(),
4117 }
4118}
4119
4120type CcDepInSameApexChecker struct {
4121 Static bool
4122 HasStubsVariants bool
4123 IsLlndk bool
4124 Host bool
4125}
4126
4127func (c CcDepInSameApexChecker) OutgoingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00004128 if depTag == StubImplDepTag {
Colin Crossc1b36442021-05-06 13:42:48 -07004129 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09004130 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09004131 }
Jiyong Park12177fc2021-01-05 14:37:15 +09004132 if depTag == staticVariantTag {
4133 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
4134 // actually mean that the static lib (and its dependencies) are copied into the
4135 // APEX.
4136 return false
4137 }
Colin Cross8acea3e2024-12-12 14:53:30 -08004138
4139 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
Yu Liuf1806032025-02-07 00:23:34 +00004140 if isLibDepTag && c.Static && libDepTag.shared() {
Colin Cross8acea3e2024-12-12 14:53:30 -08004141 // shared_lib dependency from a static lib is considered as crossing
4142 // the APEX boundary because the dependency doesn't actually is
4143 // linked; the dependency is used only during the compilation phase.
4144 return false
4145 }
4146
4147 if isLibDepTag && libDepTag.excludeInApex {
4148 return false
4149 }
4150
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09004151 return true
4152}
4153
Yu Liuf1806032025-02-07 00:23:34 +00004154func (c CcDepInSameApexChecker) IncomingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
4155 if c.Host {
Colin Cross1cea5302024-12-03 16:40:08 -08004156 return false
4157 }
Yu Liuf1806032025-02-07 00:23:34 +00004158 if c.HasStubsVariants {
Colin Crossbd930bc2025-02-03 12:17:42 -08004159 if IsSharedDepTag(depTag) && !IsExplicitImplSharedDepTag(depTag) {
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004160 // dynamic dep to a stubs lib crosses APEX boundary
4161 return false
4162 }
4163 if IsRuntimeDepTag(depTag) {
4164 // runtime dep to a stubs lib also crosses APEX boundary
4165 return false
4166 }
4167 if IsHeaderDepTag(depTag) {
4168 return false
4169 }
4170 }
Yu Liuf1806032025-02-07 00:23:34 +00004171 if c.IsLlndk {
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004172 return false
4173 }
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004174
4175 return true
4176}
4177
Jiyong Park45bf82e2020-12-15 22:29:02 +09004178// Implements android.ApexModule
Yu Liudf0b8392025-02-12 18:27:03 +00004179func (c *Module) MinSdkVersionSupported(ctx android.BaseModuleContext) android.ApiLevel {
Jooyung Han749dc692020-04-15 11:03:39 +09004180 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
4181 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
Yu Liudf0b8392025-02-12 18:27:03 +00004182 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004183 }
Jooyung Han749dc692020-04-15 11:03:39 +09004184 // We don't check for prebuilt modules
4185 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
Yu Liudf0b8392025-02-12 18:27:03 +00004186 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004187 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09004188
Jooyung Han749dc692020-04-15 11:03:39 +09004189 minSdkVersion := c.MinSdkVersion()
4190 if minSdkVersion == "apex_inherit" {
Yu Liudf0b8392025-02-12 18:27:03 +00004191 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004192 }
4193 if minSdkVersion == "" {
4194 // JNI libs within APK-in-APEX fall into here
4195 // Those are okay to set sdk_version instead
4196 // We don't have to check if this is a SDK variant because
4197 // non-SDK variant resets sdk_version, which works too.
4198 minSdkVersion = c.SdkVersion()
4199 }
Yu Liudf0b8392025-02-12 18:27:03 +00004200
Dan Albertc8060532020-07-22 22:32:17 -07004201 if minSdkVersion == "" {
Yu Liudf0b8392025-02-12 18:27:03 +00004202 return android.NoneApiLevel
Dan Albertc8060532020-07-22 22:32:17 -07004203 }
Yu Liudf0b8392025-02-12 18:27:03 +00004204
Dan Albertc8060532020-07-22 22:32:17 -07004205 // Not using nativeApiLevelFromUser because the context here is not
4206 // necessarily a native context.
Yu Liudf0b8392025-02-12 18:27:03 +00004207 ver, err := android.ApiLevelFromUserWithConfig(ctx.Config(), minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09004208 if err != nil {
Yu Liudf0b8392025-02-12 18:27:03 +00004209 return android.NoneApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004210 }
Dan Albertc8060532020-07-22 22:32:17 -07004211
Colin Cross8ca61c12022-10-06 21:00:14 -07004212 // A dependency only needs to support a min_sdk_version at least
4213 // as high as the api level that the architecture was introduced in.
4214 // This allows introducing new architectures in the platform that
4215 // need to be included in apexes that normally require an older
4216 // min_sdk_version.
Yu Liudf0b8392025-02-12 18:27:03 +00004217 if c.Enabled(ctx) {
4218 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
4219 if ver.LessThanOrEqualTo(minApiForArch) {
4220 ver = android.MinApiLevel
4221 }
Colin Cross8ca61c12022-10-06 21:00:14 -07004222 }
4223
Yu Liudf0b8392025-02-12 18:27:03 +00004224 return ver
Jooyung Han749dc692020-04-15 11:03:39 +09004225}
4226
Paul Duffinb5769c12021-05-12 16:16:51 +01004227// Implements android.ApexModule
4228func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4229 // stub libraries and native bridge libraries are always available to platform
4230 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4231}
4232
Inseob Kima1888ce2022-10-04 14:42:02 +09004233func (c *Module) overriddenModules() []string {
4234 if o, ok := c.linker.(overridable); ok {
4235 return o.overriddenModules()
4236 }
4237 return nil
4238}
4239
Liz Kammer35ca77e2021-12-22 15:31:40 -05004240type moduleType int
4241
4242const (
4243 unknownType moduleType = iota
4244 binary
4245 object
4246 fullLibrary
4247 staticLibrary
4248 sharedLibrary
4249 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004250 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004251 ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004252)
4253
4254func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004255 if c.testBinary() {
4256 // testBinary is also a binary, so this comes before the c.Binary()
4257 // conditional. A testBinary has additional implicit dependencies and
4258 // other test-only semantics.
4259 return testBin
4260 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004261 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004262 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004263 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004264 } else if c.testLibrary() {
4265 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4266 // will let them add implicit compile deps on gtest, for example.
4267 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004268 // For now, treat them as regular libraries.
4269 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004270 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004271 static := false
4272 shared := false
4273 if library, ok := c.linker.(*libraryDecorator); ok {
4274 static = library.MutatedProperties.BuildStatic
4275 shared = library.MutatedProperties.BuildShared
4276 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4277 static = library.MutatedProperties.BuildStatic
4278 shared = library.MutatedProperties.BuildShared
4279 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004280 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004281 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004282 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004283 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004284 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004285 return staticLibrary
4286 }
4287 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004288 } else if c.isNDKStubLibrary() {
4289 return ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004290 }
4291 return unknownType
4292}
4293
Colin Crosscfad1192015-11-02 16:43:11 -08004294// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004295type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004296 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004297 android.DefaultsModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004298}
4299
Patrice Arrudac249c712019-03-19 17:00:29 -07004300// cc_defaults provides a set of properties that can be inherited by other cc
4301// modules. A module can use the properties from a cc_defaults using
4302// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4303// merged (when possible) by prepending the default module's values to the
4304// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004305func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004306 return DefaultsFactory()
4307}
4308
Colin Cross36242852017-06-23 15:06:31 -07004309func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004310 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004311
Colin Cross36242852017-06-23 15:06:31 -07004312 module.AddProperties(props...)
4313 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004314 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004315 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004316 &BaseCompilerProperties{},
4317 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004318 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004319 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004320 &StaticProperties{},
4321 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004322 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004323 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004324 &TestLinkerProperties{},
4325 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004326 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004327 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004328 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004329 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004330 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004331 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004332 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004333 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004334 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004335 &SAbiProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004336 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004337 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004338 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004339 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004340 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4341 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004342 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004343 )
Colin Crosscfad1192015-11-02 16:43:11 -08004344
Jooyung Hancc372c52019-09-25 15:18:44 +09004345 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004346
4347 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004348}
4349
Jiyong Park2286afd2020-06-16 21:58:53 +09004350func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004351 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004352}
4353
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004354func kytheExtractAllFactory() android.Singleton {
4355 return &kytheExtractAllSingleton{}
4356}
4357
4358type kytheExtractAllSingleton struct {
4359}
4360
4361func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4362 var xrefTargets android.Paths
Yu Liuec7043d2024-11-05 18:22:20 +00004363 ctx.VisitAllModuleProxies(func(module android.ModuleProxy) {
Yu Liu4f825132024-12-18 00:35:39 +00004364 files := android.OtherModuleProviderOrDefault(ctx, module, CcObjectInfoProvider).KytheFiles
Yu Liuec7043d2024-11-05 18:22:20 +00004365 if len(files) > 0 {
4366 xrefTargets = append(xrefTargets, files...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004367 }
4368 })
4369 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4370 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004371 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004372 }
4373}
4374
Jihoon Kangf78a8902022-09-01 22:47:07 +00004375func (c *Module) Partition() string {
4376 if p, ok := c.installer.(interface {
4377 getPartition() string
4378 }); ok {
4379 return p.getPartition()
4380 }
4381 return ""
4382}
4383
Spandan Das2b6dfb52024-01-19 00:22:22 +00004384type sourceModuleName interface {
4385 sourceModuleName() string
4386}
4387
4388func (c *Module) BaseModuleName() string {
4389 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4390 // if the prebuilt module sets a source_module_name in Android.bp, use that
4391 return smn.sourceModuleName()
4392 }
4393 return c.ModuleBase.BaseModuleName()
4394}
4395
Spandan Dase20c56c2024-07-23 21:34:24 +00004396func (c *Module) stubsSymbolFilePath() android.Path {
4397 if library, ok := c.linker.(*libraryDecorator); ok {
4398 return library.stubsSymbolFilePath
4399 }
4400 return android.OptionalPath{}.Path()
4401}
4402
Colin Cross06a931b2015-10-28 17:23:31 -07004403var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004404var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004405var BoolPtr = proptools.BoolPtr
4406var String = proptools.String
4407var StringPtr = proptools.StringPtr