blob: 0e70d48efced687969b1af8eeb3008bec5fd62d4 [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 Liu323d77a2024-12-16 23:13:57 +000096}
Yu Liuffe86322024-12-18 18:53:12 +000097
Yu Liu8024b922024-12-20 23:31:32 +000098type SnapshotInfo struct {
99 SnapshotAndroidMkSuffix string
Yu Liuffe86322024-12-18 18:53:12 +0000100}
101
Yu Liu323d77a2024-12-16 23:13:57 +0000102type TestBinaryInfo struct {
103 Gtest bool
104}
105type BenchmarkDecoratorInfo struct{}
Yu Liu8a8d5b42025-01-07 00:48:08 +0000106
107type StubDecoratorInfo struct{}
108
Yu Liu323d77a2024-12-16 23:13:57 +0000109type ObjectLinkerInfo struct{}
110
Yu Liu8a8d5b42025-01-07 00:48:08 +0000111type LibraryInfo struct {
112 BuildStubs bool
113}
114
Yu Liub1bfa9d2024-12-05 18:57:51 +0000115// Common info about the cc module.
116type CcInfo struct {
Yu Liu323d77a2024-12-16 23:13:57 +0000117 IsPrebuilt bool
118 CmakeSnapshotSupported bool
Yu Liu68a70b72025-01-08 22:54:44 +0000119 HasLlndkStubs bool
Yu Liu0a37d422025-02-13 02:05:00 +0000120 DataPaths []android.DataPath
Yu Liu323d77a2024-12-16 23:13:57 +0000121 CompilerInfo *CompilerInfo
122 LinkerInfo *LinkerInfo
Yu Liu8024b922024-12-20 23:31:32 +0000123 SnapshotInfo *SnapshotInfo
Yu Liu8a8d5b42025-01-07 00:48:08 +0000124 LibraryInfo *LibraryInfo
Yu Liub1bfa9d2024-12-05 18:57:51 +0000125}
126
Yu Liu8024b922024-12-20 23:31:32 +0000127var CcInfoProvider = blueprint.NewProvider[*CcInfo]()
Yu Liub1bfa9d2024-12-05 18:57:51 +0000128
Yu Liu986d98c2024-11-12 00:28:11 +0000129type LinkableInfo struct {
130 // StaticExecutable returns true if this is a binary module with "static_executable: true".
Yu Liu8024b922024-12-20 23:31:32 +0000131 StaticExecutable bool
132 Static bool
133 Shared bool
134 HasStubsVariants bool
135 StubsVersion string
136 IsStubs bool
137 UnstrippedOutputFile android.Path
138 OutputFile android.OptionalPath
139 CoverageFiles android.Paths
Yu Liuf6f85492025-01-13 21:02:36 +0000140 // CoverageOutputFile returns the output archive of gcno coverage information files.
141 CoverageOutputFile android.OptionalPath
142 SAbiDumpFiles android.Paths
143 // Partition returns the partition string for this module.
144 Partition string
Yu Liu8a8d5b42025-01-07 00:48:08 +0000145 CcLibrary bool
Yu Liu8024b922024-12-20 23:31:32 +0000146 CcLibraryInterface bool
147 RustLibraryInterface bool
148 // CrateName returns the crateName for a Rust library
149 CrateName string
150 // DepFlags returns a slice of Rustc string flags
151 ExportedCrateLinkDirs []string
Yu Liu0a37d422025-02-13 02:05:00 +0000152 HasNonSystemVariants bool
153 IsLlndk bool
Yu Liuf6f85492025-01-13 21:02:36 +0000154 // True if the library is in the configs known NDK list.
155 IsNdk bool
156 InVendorOrProduct bool
Yu Liu8024b922024-12-20 23:31:32 +0000157 // SubName returns the modules SubName, used for image and NDK/SDK variations.
158 SubName string
159 InRamdisk bool
160 OnlyInRamdisk bool
161 InVendorRamdisk bool
162 OnlyInVendorRamdisk bool
163 InRecovery bool
164 OnlyInRecovery bool
Yu Liu367827f2025-02-15 00:18:33 +0000165 InVendor bool
Yu Liu8a8d5b42025-01-07 00:48:08 +0000166 Installable *bool
Yu Liu97880e12025-01-07 19:03:34 +0000167 // RelativeInstallPath returns the relative install path for this module.
168 RelativeInstallPath string
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000169 // TODO(b/362509506): remove this once all apex_exclude uses are switched to stubs.
170 RustApexExclude bool
Yu Liuf6f85492025-01-13 21:02:36 +0000171 // Bootstrap tests if this module is allowed to use non-APEX version of libraries.
Yu Liu0a37d422025-02-13 02:05:00 +0000172 Bootstrap bool
173 Multilib string
174 ImplementationModuleNameForMake string
175 IsStubsImplementationRequired bool
176 // Symlinks returns a list of symlinks that should be created for this module.
Yu Liu367827f2025-02-15 00:18:33 +0000177 Symlinks []string
178 APIListCoverageXMLPath android.ModuleOutPath
Yu Liu986d98c2024-11-12 00:28:11 +0000179}
180
Yu Liu8024b922024-12-20 23:31:32 +0000181var LinkableInfoProvider = blueprint.NewProvider[*LinkableInfo]()
Yu Liu986d98c2024-11-12 00:28:11 +0000182
Colin Cross463a90e2015-06-17 14:20:06 -0700183func init() {
Paul Duffin036e7002019-12-19 19:16:28 +0000184 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -0700185
Inseob Kim3b244062023-07-11 13:31:36 +0900186 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +0000187 pctx.Import("android/soong/cc/config")
188}
189
190func RegisterCCBuildComponents(ctx android.RegistrationContext) {
191 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
192
193 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossac57a6c2024-06-26 13:09:53 -0700194 ctx.Transition("sdk", &sdkTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700195 ctx.BottomUp("llndk", llndkMutator)
Colin Cross767819f2024-05-22 14:22:34 -0700196 ctx.Transition("link", &linkageTransitionMutator{})
Colin Crossadd04a82024-05-22 09:57:59 -0700197 ctx.Transition("version", &versionTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700198 ctx.BottomUp("begin", BeginMutator)
Colin Cross1e676be2016-10-12 14:38:15 -0700199 })
Colin Cross16b23492016-01-06 14:41:07 -0800200
Paul Duffin036e7002019-12-19 19:16:28 +0000201 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -0400202 for _, san := range Sanitizers {
203 san.registerMutators(ctx)
204 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800205
Colin Cross8a962802024-10-09 15:29:27 -0700206 ctx.BottomUp("sanitize_runtime_deps", sanitizerRuntimeDepsMutator)
207 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator)
Ivan Lozano30c5db22018-02-21 15:49:20 -0800208
Colin Cross597bad62024-10-08 15:10:55 -0700209 ctx.Transition("fuzz", &fuzzTransitionMutator{})
Cory Barkera1da26f2022-06-07 20:12:06 +0000210
Colin Crossf5f4ad32024-01-19 15:41:48 -0800211 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -0700212
Colin Crossd38feb02024-01-23 16:38:06 -0800213 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +0800214
Colin Cross33e0c812024-01-23 16:36:07 -0800215 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000216
Colin Cross6ac83a82024-01-23 11:23:10 -0800217 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +0900218
Colin Cross8a962802024-10-09 15:29:27 -0700219 ctx.BottomUp("check_linktype", checkLinkTypeMutator)
220 ctx.BottomUp("double_loadable", checkDoubleLoadableLibraries)
Colin Cross1e676be2016-10-12 14:38:15 -0700221 })
Colin Crossb98c8b02016-07-29 13:44:28 -0700222
Colin Cross91ae5ec2024-10-01 14:03:40 -0700223 ctx.PostApexMutators(func(ctx android.RegisterMutatorsContext) {
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800224 // sabi mutator needs to be run after apex mutator finishes.
Colin Cross91ae5ec2024-10-01 14:03:40 -0700225 ctx.Transition("sabi", &sabiTransitionMutator{})
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800226 })
227
LaMont Jones0c10e4d2023-05-16 00:58:37 +0000228 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -0700229}
230
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500231// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
232// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
233// edges to these modules.
234// This object is constructed in DepsMutator, by calling to various module delegates to set
235// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
236// dependencies.
237// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
238// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800239type Deps struct {
240 SharedLibs, LateSharedLibs []string
241 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800242 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800243 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700244
Colin Cross3e5e7782022-06-17 22:17:05 +0000245 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
246 // prevent automatically exporting symbols.
247 UnexportedStaticLibs []string
248
Chris Parsons79d66a52020-06-05 17:26:16 -0400249 // Used for data dependencies adjacent to tests
250 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700251 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400252
Yo Chiang219968c2020-09-22 18:45:04 +0800253 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
254 SystemSharedLibs []string
255
Vinh Tran367d89d2023-04-28 11:21:25 -0400256 // Used by DepMutator to pass aidl_library modules to aidl compiler
257 AidlLibs []string
258
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500259 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800260 StaticUnwinderIfLegacy bool
261
Colin Cross5950f382016-12-13 12:50:57 -0800262 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700263
Colin Cross81413472016-04-11 14:37:39 -0700264 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700265
Cole Faust65cb40a2024-10-21 15:41:42 -0700266 GeneratedSources []string
267 GeneratedHeaders []string
268 DeviceFirstGeneratedHeaders []string
269 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700270
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700271 ReexportGeneratedHeaders []string
272
Colin Crossc465efd2021-06-11 18:00:04 -0700273 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700274
275 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700276 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900277
278 // List of libs that need to be excluded for APEX variant
279 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900280 // List of libs that need to be excluded for non-APEX variant
281 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800282
283 // LLNDK headers for the ABI checker to check LLNDK implementation library.
284 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
Colin Cross1e954b62024-09-13 13:50:00 -0700285 // The core variant cannot depend on the vendor variant because of the order of imageTransitionMutator.Split().
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800286 // Instead, the LLNDK implementation depends on the LLNDK header libs.
287 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700288}
289
Ivan Lozano0a468a42024-05-13 21:03:34 -0400290// A struct which to collect flags for rlib dependencies
291type RustRlibDep struct {
292 LibPath android.Path // path to the rlib
293 LinkDirs []string // flags required for dependency (e.g. -L flags)
294 CrateName string // crateNames associated with rlibDeps
295}
296
297func EqRustRlibDeps(a RustRlibDep, b RustRlibDep) bool {
298 return a.LibPath == b.LibPath
299}
300
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500301// PathDeps is a struct containing file paths to dependencies of a module.
302// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
303// It's used to construct flags for various build statements (such as for compiling and linking).
304// It is then passed to module decorator functions responsible for registering build statements
305// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800306type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700307 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900308 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700309 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900310 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700311 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700312 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400313 // Paths and crateNames for RustStaticLib dependencies
314 RustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700315
Colin Cross0de8a1e2020-09-18 14:15:30 -0700316 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossa14fb6a2024-10-23 16:57:06 -0700317 TranstiveStaticLibrariesForOrdering depset.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700318
Colin Cross26c34ed2016-09-30 17:10:16 -0700319 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100320 Objs Objects
321 // Paths to .o files in dependencies that provide them. Note that these lists
322 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800323 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700324 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700325
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100326 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
327 // the libs from all whole_static_lib dependencies.
328 WholeStaticLibsFromPrebuilts android.Paths
329
Colin Cross26c34ed2016-09-30 17:10:16 -0700330 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700331 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900332 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700333
Inseob Kimd110f872019-12-06 13:15:38 +0900334 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000335 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900336 IncludeDirs android.Paths
337 SystemIncludeDirs android.Paths
338 ReexportedDirs android.Paths
339 ReexportedSystemDirs android.Paths
340 ReexportedFlags []string
341 ReexportedGeneratedHeaders android.Paths
342 ReexportedDeps android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400343 ReexportedRustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700344
Colin Cross26c34ed2016-09-30 17:10:16 -0700345 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700346 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700347
Dan Willemsena0790e32018-10-12 00:24:23 -0700348 // Path to the dynamic linker binary
349 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700350
351 // For Darwin builds, the path to the second architecture's output that should
352 // be combined with this architectures's output into a FAT MachO file.
353 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400354
355 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
356 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800357
358 // LLNDK headers for the ABI checker to check LLNDK implementation library.
359 LlndkIncludeDirs android.Paths
360 LlndkSystemIncludeDirs android.Paths
Colin Crossb614cd42024-10-11 12:52:21 -0700361
362 directImplementationDeps android.Paths
363 transitiveImplementationDeps []depset.DepSet[android.Path]
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700364}
365
Colin Cross4af21ed2019-11-04 09:37:55 -0800366// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
367// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
368// command line so they can be overridden by the local module flags).
369type LocalOrGlobalFlags struct {
370 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700371 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800372 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700373 CFlags []string // Flags that apply to C and C++ source files
374 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
375 ConlyFlags []string // Flags that apply to C source files
376 CppFlags []string // Flags that apply to C++ source files
377 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700378 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800379}
380
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500381// Flags contains various types of command line flags (and settings) for use in building build
382// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800383type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500384 // Local flags (which individual modules are responsible for). These may override global flags.
385 Local LocalOrGlobalFlags
386 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700387 Global LocalOrGlobalFlags
388 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800389
390 aidlFlags []string // Flags that apply to aidl source files
391 rsFlags []string // Flags that apply to renderscript source files
392 libFlags []string // Flags to add libraries early to the link order
393 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
394 TidyFlags []string // Flags that apply to clang-tidy
395 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700396
Colin Crossc3199482017-03-30 15:03:04 -0700397 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800398 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700399 SystemIncludeFlags []string
400
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800401 Toolchain config.Toolchain
402 Tidy bool // True if ninja .tidy rules should be generated.
403 NeedTidyFiles bool // True if module link should depend on .tidy files
404 GcovCoverage bool // True if coverage files should be generated.
405 SAbiDump bool // True if header abi dumps should be generated.
406 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
kellyhungd62ea302024-05-19 21:16:07 +0800407 ClangVerify bool // If true, append cflags "-Xclang -verify" and append "&& touch $out" to the clang command line.
Colin Crossca860ac2016-01-04 14:34:37 -0800408
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500409 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800410 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500411 // The target-device system path to the dynamic linker.
412 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800413
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700414 CFlagsDeps android.Paths // Files depended on by compiler flags
415 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800416
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500417 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700418 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800419
Colin Cross19878da2019-03-28 14:45:07 -0700420 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700421 protoC bool // Whether to use C instead of C++
422 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700423
424 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200425 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700426}
427
Colin Crossca860ac2016-01-04 14:34:37 -0800428// Properties used to compile all C or C++ modules
429type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700430 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800431 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700432
Yi Kong5786f5c2024-05-28 02:22:34 +0900433 // Aggresively trade performance for smaller binary size.
434 // This should only be used for on-device binaries that are rarely executed and not
435 // performance critical.
436 Optimize_for_size *bool `android:"arch_variant"`
437
Jiyong Parkb35a8192020-08-10 15:59:36 +0900438 // The API level that this module is built against. The APIs of this API level will be
439 // visible at build time, but use of any APIs newer than min_sdk_version will render the
440 // module unloadable on older devices. In the future it will be possible to weakly-link new
441 // APIs, making the behavior match Java: such modules will load on older devices, but
442 // calling new APIs on devices that do not support them will result in a crash.
443 //
444 // This property has the same behavior as sdk_version does for Java modules. For those
445 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
446 // does for Java code.
447 //
448 // In addition, setting this property causes two variants to be built, one for the platform
449 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800450 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700451
Jiyong Parkb35a8192020-08-10 15:59:36 +0900452 // Minimum OS API level supported by this C or C++ module. This property becomes the value
453 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
454 // this property is also used to ensure that the min_sdk_version of the containing module is
455 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
456 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
457 // min_sdk_version of the containing APEX. When the module
458 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900459 Min_sdk_version *string
460
Colin Crossc511bc52020-04-07 16:50:32 +0000461 // If true, always create an sdk variant and don't create a platform variant.
462 Sdk_variant_only *bool
463
Colin Cross4297f402024-11-20 15:20:09 -0800464 AndroidMkSharedLibs []string `blueprint:"mutated"`
465 AndroidMkStaticLibs []string `blueprint:"mutated"`
466 AndroidMkRlibs []string `blueprint:"mutated"`
467 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
468 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
469 AndroidMkHeaderLibs []string `blueprint:"mutated"`
470 HideFromMake bool `blueprint:"mutated"`
471 PreventInstall bool `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700472
Yo Chiang219968c2020-09-22 18:45:04 +0800473 // Set by DepsMutator.
474 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
475
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900476 // The name of the image this module is built for
477 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200478
479 // The VNDK version this module is built against. If empty, the module is not
480 // build against the VNDK.
481 VndkVersion string `blueprint:"mutated"`
482
483 // Suffix for the name of Android.mk entries generated by this module
484 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800485
486 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
487 // file
Inseob Kim37e0bb02024-04-29 15:54:44 +0900488 Logtags []string `android:"path"`
Jiyong Parkf9332f12018-02-01 00:54:12 +0900489
Yifan Hong39143a92020-10-26 12:43:12 -0700490 // Make this module available when building for ramdisk.
491 // On device without a dedicated recovery partition, the module is only
492 // available after switching root into
493 // /first_stage_ramdisk. To expose the module before switching root, install
494 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800495 Ramdisk_available *bool
496
Yifan Hong39143a92020-10-26 12:43:12 -0700497 // Make this module available when building for vendor ramdisk.
498 // On device without a dedicated recovery partition, the module is only
499 // available after switching root into
500 // /first_stage_ramdisk. To expose the module before switching root, install
501 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700502 Vendor_ramdisk_available *bool
503
Jiyong Parkf9332f12018-02-01 00:54:12 +0900504 // Make this module available when building for recovery
505 Recovery_available *bool
506
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200507 // Used by imageMutator, set by ImageMutatorBegin()
Jihoon Kang47e91842024-06-19 00:51:16 +0000508 VendorVariantNeeded bool `blueprint:"mutated"`
509 ProductVariantNeeded bool `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200510 CoreVariantNeeded bool `blueprint:"mutated"`
511 RamdiskVariantNeeded bool `blueprint:"mutated"`
512 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
513 RecoveryVariantNeeded bool `blueprint:"mutated"`
514
515 // A list of variations for the "image" mutator of the form
516 //<image name> '.' <version char>, for example, 'vendor.S'
517 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900518
519 // Allows this module to use non-APEX version of libraries. Useful
520 // for building binaries that are started before APEXes are activated.
521 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900522
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000523 // Allows this module to be included in CMake release snapshots to be built outside of Android
524 // build system and source tree.
525 Cmake_snapshot_supported *bool
526
Colin Cross1bc94122021-10-28 13:25:54 -0700527 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000528
529 // Set by factories of module types that can only be referenced from variants compiled against
530 // the SDK.
531 AlwaysSdk bool `blueprint:"mutated"`
532
533 // Variant is an SDK variant created by sdkMutator
534 IsSdkVariant bool `blueprint:"mutated"`
535 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
536 // variant to have a ".sdk" suffix.
537 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700538
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800539 Target struct {
540 Platform struct {
541 // List of modules required by the core variant.
542 Required []string `android:"arch_variant"`
543
544 // List of modules not required by the core variant.
545 Exclude_required []string `android:"arch_variant"`
546 } `android:"arch_variant"`
547
548 Recovery struct {
549 // List of modules required by the recovery variant.
550 Required []string `android:"arch_variant"`
551
552 // List of modules not required by the recovery variant.
553 Exclude_required []string `android:"arch_variant"`
554 } `android:"arch_variant"`
555 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700556}
557
558type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900559 // whether this module should be allowed to be directly depended by other
560 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900561 // If set to true, two variants will be built separately, one like
562 // normal, and the other limited to the set of libraries and headers
563 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700564 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900565 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700566 // so it shouldn't have any unversioned runtime dependencies, or
567 // make assumptions about the system that may not be true in the
568 // future.
569 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900570 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900571 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900572 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900573 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900574 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700575 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
576 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900577
Justin Yunebcf0c52021-01-08 18:00:19 +0900578 // This is the same as the "vendor_available" except that the install path
579 // of the vendor variant is /odm or /vendor/odm.
580 // By replacing "vendor_available: true" with "odm_available: true", the
581 // module will install its vendor variant to the /odm partition or /vendor/odm.
582 // As the modules with "odm_available: true" still create the vendor variants,
583 // they can link to the other vendor modules as the vendor_available modules do.
584 // Also, the vendor modules can link to odm_available modules.
585 //
586 // It may not be used for VNDK modules.
587 Odm_available *bool
588
Justin Yun63e9ec72020-10-29 16:49:43 +0900589 // whether this module should be allowed to be directly depended by other
590 // modules with `product_specific: true` or `product_available: true`.
591 // If set to true, an additional product variant will be built separately
592 // that is limited to the set of libraries and headers that are exposed to
593 // /product modules.
594 //
595 // The product variant may be used with a different (newer) /system,
596 // so it shouldn't have any unversioned runtime dependencies, or
597 // make assumptions about the system that may not be true in the
598 // future.
599 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900600 // If set to false, this module becomes inaccessible from /product modules.
601 //
602 // Different from the 'vendor_available' property, the modules with
603 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
604 // library without 'product_available' may not be depended on by any other
605 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900606 //
607 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
608 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
609 Product_available *bool
610
Jiyong Park5fb8c102018-04-09 12:03:06 +0900611 // whether this module is capable of being loaded with other instance
612 // (possibly an older version) of the same module in the same process.
613 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
614 // can be double loaded in a vendor process if the library is also a
615 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
616 // explicitly marked as `double_loadable: true` by the owner, or the dependency
617 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
618 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800619
620 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
621 IsLLNDK bool `blueprint:"mutated"`
622
Colin Cross5271fea2021-04-27 13:06:04 -0700623 // IsVendorPublicLibrary is set for the core and product variants of a library that has
624 // vendor_public_library stubs.
625 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800626}
627
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500628// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
629// to understanding details about the type of the current module.
630// For example, one might call these functions to determine whether the current module is a static
631// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800632type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800633 static() bool
634 staticBinary() bool
Colin Cross6a730042024-12-05 13:53:43 -0800635 staticLibrary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700636 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800637 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900638 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900639 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900640 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700641 toolchain() config.Toolchain
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700642 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800643 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900644 minSdkVersion() string
645 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700646 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700647 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800648 IsLlndk() bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800649 isImplementationForLLNDKPublic() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700650 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900651 inProduct() bool
652 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800653 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700654 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900655 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900656 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700657 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700658 baseModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800659 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000660 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800661 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900662 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800663 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800664 useClangLld(actx ModuleContext) bool
Colin Crosse07f2312020-08-13 11:24:56 -0700665 apexVariationName() string
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900666 bootstrap() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700667 nativeCoverage() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800668 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800669 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800670 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800671 notInPlatform() bool
Yi Kong5786f5c2024-05-28 02:22:34 +0900672 optimizeForSize() bool
Yu Liu76d94462024-10-31 23:32:36 +0000673 getOrCreateMakeVarsInfo() *CcMakeVarsInfo
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800674}
675
676type SharedFlags struct {
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000677 NumSharedFlags int
678 FlagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800679}
680
681type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700682 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800683 ModuleContextIntf
684}
685
686type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700687 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800688 ModuleContextIntf
689}
690
Colin Cross37047f12016-12-13 17:06:13 -0800691type DepsContext interface {
692 android.BottomUpMutatorContext
693 ModuleContextIntf
694}
695
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500696// feature represents additional (optional) steps to building cc-related modules, such as invocation
697// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800698type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800699 flags(ctx ModuleContext, flags Flags) Flags
700 props() []interface{}
701}
702
Joe Onorato37f900c2023-07-18 16:58:16 -0700703// Information returned from Generator about the source code it's generating
704type GeneratedSource struct {
705 IncludeDirs android.Paths
706 Sources android.Paths
707 Headers android.Paths
708 ReexportedDirs android.Paths
709}
710
711// generator allows injection of generated code
712type Generator interface {
713 GeneratorProps() []interface{}
714 GeneratorInit(ctx BaseModuleContext)
715 GeneratorDeps(ctx DepsContext, deps Deps) Deps
716 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
717 GeneratorSources(ctx ModuleContext) GeneratedSource
718 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
719}
720
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500721// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500722// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800723type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700724 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800725 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800726 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700727 compilerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000728 baseCompilerProps() BaseCompilerProperties
Colin Cross42742b82016-08-01 13:20:05 -0700729
Colin Cross76fada02016-07-27 10:31:13 -0700730 appendCflags([]string)
731 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700732 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800733}
734
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500735// linker is the interface for a linker decorator object. Individual module types can provide
736// their own implementation for this decorator, and thus specify custom logic regarding build
737// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800738type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700739 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800740 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700741 linkerFlags(ctx ModuleContext, flags Flags) Flags
742 linkerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000743 baseLinkerProps() BaseLinkerProperties
Ivan Lozanobd721262018-11-27 14:33:03 -0800744 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700745
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700746 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700747 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900748 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800749 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700750
751 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900752 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000753
754 // Get the deps that have been explicitly specified in the properties.
Cole Fauste8a87832024-09-11 11:35:46 -0700755 linkerSpecifiedDeps(ctx android.ConfigurableEvaluatorContext, module *Module, specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800756
757 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000758}
759
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500760// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000761type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500762 sharedLibs []string
763 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
764 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700765 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800766}
767
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500768// installer is the interface for an installer helper object. This helper is responsible for
769// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800770type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700771 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700772 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000773 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800774 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700775 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700776 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900777 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000778 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900779 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800780}
781
Inseob Kima1888ce2022-10-04 14:42:02 +0900782type overridable interface {
783 overriddenModules() []string
784}
785
Colin Cross6e511a92020-07-27 21:26:48 -0700786type libraryDependencyKind int
787
788const (
789 headerLibraryDependency = iota
790 sharedLibraryDependency
791 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400792 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700793)
794
795func (k libraryDependencyKind) String() string {
796 switch k {
797 case headerLibraryDependency:
798 return "headerLibraryDependency"
799 case sharedLibraryDependency:
800 return "sharedLibraryDependency"
801 case staticLibraryDependency:
802 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400803 case rlibLibraryDependency:
804 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700805 default:
806 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
807 }
808}
809
810type libraryDependencyOrder int
811
812const (
813 earlyLibraryDependency = -1
814 normalLibraryDependency = 0
815 lateLibraryDependency = 1
816)
817
818func (o libraryDependencyOrder) String() string {
819 switch o {
820 case earlyLibraryDependency:
821 return "earlyLibraryDependency"
822 case normalLibraryDependency:
823 return "normalLibraryDependency"
824 case lateLibraryDependency:
825 return "lateLibraryDependency"
826 default:
827 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
828 }
829}
830
831// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
832// tags that have a set of predefined tag objects that are reused for each dependency, a
833// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
834// That means that comparing a libraryDependencyTag for equality will only be equal if all
835// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
836// then check individual metadata fields instead.
837type libraryDependencyTag struct {
838 blueprint.BaseDependencyTag
839
840 // These are exported so that fmt.Printf("%#v") can call their String methods.
841 Kind libraryDependencyKind
842 Order libraryDependencyOrder
843
844 wholeStatic bool
845
846 reexportFlags bool
847 explicitlyVersioned bool
Colin Crossbd930bc2025-02-03 12:17:42 -0800848 explicitlyImpl bool
Colin Cross6e511a92020-07-27 21:26:48 -0700849 dataLib bool
850 ndk bool
851
852 staticUnwinder bool
853
854 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900855
Cindy Zhou18417cb2020-12-10 07:12:38 -0800856 // Whether or not this dependency should skip the apex dependency check
857 skipApexAllowedDependenciesCheck bool
858
Jiyong Parke3867542020-12-03 17:28:25 +0900859 // Whether or not this dependency has to be followed for the apex variants
860 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900861 // Whether or not this dependency has to be followed for the non-apex variants
862 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000863
864 // If true, don't automatically export symbols from the static library into a shared library.
865 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700866}
867
868// header returns true if the libraryDependencyTag is tagging a header lib dependency.
869func (d libraryDependencyTag) header() bool {
870 return d.Kind == headerLibraryDependency
871}
872
873// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
874func (d libraryDependencyTag) shared() bool {
875 return d.Kind == sharedLibraryDependency
876}
877
878// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
879func (d libraryDependencyTag) static() bool {
880 return d.Kind == staticLibraryDependency
881}
882
Colin Cross65cb3142021-12-10 23:05:02 +0000883func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
884 if d.shared() {
885 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
886 }
887 return nil
888}
889
890var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
891
Colin Crosse9fe2942020-11-10 18:12:15 -0800892// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
893// binaries or other shared libraries are installed as dependencies.
894func (d libraryDependencyTag) InstallDepNeeded() bool {
895 return d.shared()
896}
897
898var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
899
Yu Liu67a28422024-03-05 00:36:31 +0000900func (d libraryDependencyTag) PropagateAconfigValidation() bool {
901 return d.static()
902}
903
904var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
905
Colin Crosse9fe2942020-11-10 18:12:15 -0800906// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700907// libraryDependencyTag. Each tag object is created globally and reused for multiple
908// dependencies (although since the object contains no references, assigning a tag to a
909// variable and modifying it will not modify the original). Users can compare the tag
910// returned by ctx.OtherModuleDependencyTag against the global original
911type dependencyTag struct {
912 blueprint.BaseDependencyTag
913 name string
914}
915
Colin Crosse9fe2942020-11-10 18:12:15 -0800916// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
917// libraryDependencyTag, but where the dependency needs to be installed when the parent is
918// installed.
919type installDependencyTag struct {
920 blueprint.BaseDependencyTag
921 android.InstallAlwaysNeededDependencyTag
922 name string
923}
924
Colin Crossc99deeb2016-04-11 15:06:20 -0700925var (
Colin Cross6e511a92020-07-27 21:26:48 -0700926 genSourceDepTag = dependencyTag{name: "gen source"}
927 genHeaderDepTag = dependencyTag{name: "gen header"}
928 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
929 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900930 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700931 reuseObjTag = dependencyTag{name: "reuse objects"}
932 staticVariantTag = dependencyTag{name: "static variant"}
933 vndkExtDepTag = dependencyTag{name: "vndk extends"}
934 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700935 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800936 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000937 StubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000938 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500939 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400940 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800941 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700942)
943
Colin Crossbd930bc2025-02-03 12:17:42 -0800944func IsExplicitImplSharedDepTag(depTag blueprint.DependencyTag) bool {
945 ccLibDepTag, ok := depTag.(libraryDependencyTag)
946 return ok && ccLibDepTag.shared() && ccLibDepTag.explicitlyImpl
947}
948
Roland Levillainf89cd092019-07-29 16:22:59 +0100949func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700950 ccLibDepTag, ok := depTag.(libraryDependencyTag)
951 return ok && ccLibDepTag.shared()
952}
953
954func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
955 ccLibDepTag, ok := depTag.(libraryDependencyTag)
956 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100957}
958
Zach Johnson3df4e632020-11-06 11:56:27 -0800959func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
960 ccLibDepTag, ok := depTag.(libraryDependencyTag)
961 return ok && ccLibDepTag.header()
962}
963
Roland Levillainf89cd092019-07-29 16:22:59 +0100964func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800965 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100966}
967
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000968func ExcludeInApexDepTag(depTag blueprint.DependencyTag) bool {
969 ccLibDepTag, ok := depTag.(libraryDependencyTag)
970 return ok && ccLibDepTag.excludeInApex
971}
972
Colin Crossca860ac2016-01-04 14:34:37 -0800973// Module contains the properties and members used by all C/C++ module types, and implements
974// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500975// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
976// interface.
977//
978// To define a C/C++ related module, construct a new Module object and point its delegates to
979// type-specific structs. These delegates will be invoked to register module-specific build
980// statements which may be unique to the module type. For example, module.compiler.compile() should
981// be defined so as to register build statements which are responsible for compiling the module.
982//
983// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
984// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
985// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
986// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800987type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700988 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700989
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700990 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700991 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700992 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700993
Colin Crossca860ac2016-01-04 14:34:37 -0800994 // initialize before calling Init
Yu Liu76d94462024-10-31 23:32:36 +0000995 hod android.HostOrDeviceSupported
996 multilib android.Multilib
997 testModule bool
998 incremental bool
Colin Crossc472d572015-03-17 15:06:21 -0700999
Paul Duffina0843f62019-12-13 19:50:38 +00001000 // Allowable SdkMemberTypes of this module type.
1001 sdkMemberTypes []android.SdkMemberType
1002
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001003 // decorator delegates, initialize before calling Init
1004 // these may contain module-specific implementations, and effectively allow for custom
1005 // type-specific logic. These members may reference different objects or the same object.
1006 // Functions of these decorators will be invoked to initialize and register type-specific
1007 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -08001008 generators []Generator
1009 compiler compiler
1010 linker linker
1011 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001012
Spandan Dase12d2522023-09-12 21:42:31 +00001013 features []feature
1014 stl *stl
1015 sanitize *sanitize
1016 coverage *coverage
1017 fuzzer *fuzzer
1018 sabi *sabi
Spandan Dase12d2522023-09-12 21:42:31 +00001019 lto *lto
1020 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001021 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -08001022
Colin Cross31076b32020-10-23 17:22:06 -07001023 library libraryInterface
1024
Colin Cross635c3b02016-05-18 15:37:25 -07001025 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -08001026
Colin Crossb98c8b02016-07-29 13:44:28 -07001027 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -07001028
Yu Liue70976d2024-10-15 20:45:35 +00001029 subAndroidMkOnce map[subAndroidMkProviderInfoProducer]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001030
1031 // Flags used to compile this module
1032 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -07001033
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001034 // Shared flags among build rules of this module
1035 sharedFlags SharedFlags
1036
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001037 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -07001038 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +09001039
1040 makeLinkType string
Jooyung Han75568392020-03-20 04:29:24 +09001041
1042 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -07001043 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07001044
1045 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -08001046
Inseob Kim37e0bb02024-04-29 15:54:44 +09001047 logtagsPaths android.Paths
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001048
1049 WholeRustStaticlib bool
Cole Faust96a692b2024-08-08 14:47:51 -07001050
1051 hasAidl bool
1052 hasLex bool
1053 hasProto bool
1054 hasRenderscript bool
1055 hasSysprop bool
1056 hasWinMsg bool
1057 hasYacc bool
Yu Liu76d94462024-10-31 23:32:36 +00001058
1059 makeVarsInfo *CcMakeVarsInfo
Colin Crossc472d572015-03-17 15:06:21 -07001060}
1061
Yu Liu76d94462024-10-31 23:32:36 +00001062func (c *Module) IncrementalSupported() bool {
1063 return c.incremental
1064}
1065
1066var _ blueprint.Incremental = (*Module)(nil)
1067
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001068func (c *Module) AddJSONData(d *map[string]interface{}) {
1069 c.AndroidModuleBase().AddJSONData(d)
1070 (*d)["Cc"] = map[string]interface{}{
1071 "SdkVersion": c.SdkVersion(),
1072 "MinSdkVersion": c.MinSdkVersion(),
1073 "VndkVersion": c.VndkVersion(),
1074 "ProductSpecific": c.ProductSpecific(),
1075 "SocSpecific": c.SocSpecific(),
1076 "DeviceSpecific": c.DeviceSpecific(),
1077 "InProduct": c.InProduct(),
1078 "InVendor": c.InVendor(),
1079 "InRamdisk": c.InRamdisk(),
1080 "InVendorRamdisk": c.InVendorRamdisk(),
1081 "InRecovery": c.InRecovery(),
1082 "VendorAvailable": c.VendorAvailable(),
1083 "ProductAvailable": c.ProductAvailable(),
1084 "RamdiskAvailable": c.RamdiskAvailable(),
1085 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
1086 "RecoveryAvailable": c.RecoveryAvailable(),
1087 "OdmAvailable": c.OdmAvailable(),
1088 "InstallInData": c.InstallInData(),
1089 "InstallInRamdisk": c.InstallInRamdisk(),
1090 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
1091 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
1092 "InstallInRecovery": c.InstallInRecovery(),
1093 "InstallInRoot": c.InstallInRoot(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001094 "IsLlndk": c.IsLlndk(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001095 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
1096 "ApexSdkVersion": c.apexSdkVersion,
Cole Faust96a692b2024-08-08 14:47:51 -07001097 "AidlSrcs": c.hasAidl,
1098 "LexSrcs": c.hasLex,
1099 "ProtoSrcs": c.hasProto,
1100 "RenderscriptSrcs": c.hasRenderscript,
1101 "SyspropSrcs": c.hasSysprop,
1102 "WinMsgSrcs": c.hasWinMsg,
1103 "YaccSrsc": c.hasYacc,
1104 "OnlyCSrcs": !(c.hasAidl || c.hasLex || c.hasProto || c.hasRenderscript || c.hasSysprop || c.hasWinMsg || c.hasYacc),
Yi Kong5786f5c2024-05-28 02:22:34 +09001105 "OptimizeForSize": c.OptimizeForSize(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001106 }
1107}
1108
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001109func (c *Module) SetPreventInstall() {
1110 c.Properties.PreventInstall = true
1111}
1112
1113func (c *Module) SetHideFromMake() {
1114 c.Properties.HideFromMake = true
1115}
1116
Ivan Lozanod7586b62021-04-01 09:49:36 -04001117func (c *Module) HiddenFromMake() bool {
1118 return c.Properties.HideFromMake
1119}
1120
Cole Fauste8a87832024-09-11 11:35:46 -07001121func (c *Module) RequiredModuleNames(ctx android.ConfigurableEvaluatorContext) []string {
Cole Faust43ddd082024-06-17 12:32:40 -07001122 required := android.CopyOf(c.ModuleBase.RequiredModuleNames(ctx))
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001123 if c.ImageVariation().Variation == android.CoreVariation {
1124 required = append(required, c.Properties.Target.Platform.Required...)
1125 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1126 } else if c.InRecovery() {
1127 required = append(required, c.Properties.Target.Recovery.Required...)
1128 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1129 }
1130 return android.FirstUniqueStrings(required)
1131}
1132
Ivan Lozano52767be2019-10-18 14:49:46 -07001133func (c *Module) Toc() android.OptionalPath {
1134 if c.linker != nil {
1135 if library, ok := c.linker.(libraryInterface); ok {
1136 return library.toc()
1137 }
1138 }
1139 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1140}
1141
1142func (c *Module) ApiLevel() string {
1143 if c.linker != nil {
1144 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001145 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001146 }
1147 }
1148 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1149}
1150
1151func (c *Module) Static() bool {
1152 if c.linker != nil {
1153 if library, ok := c.linker.(libraryInterface); ok {
1154 return library.static()
1155 }
1156 }
1157 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1158}
1159
1160func (c *Module) Shared() bool {
1161 if c.linker != nil {
1162 if library, ok := c.linker.(libraryInterface); ok {
1163 return library.shared()
1164 }
1165 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001166
Ivan Lozano52767be2019-10-18 14:49:46 -07001167 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1168}
1169
1170func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001171 if c.stl != nil {
1172 return c.stl.Properties.SelectedStl
1173 }
1174 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001175}
1176
Ivan Lozano52767be2019-10-18 14:49:46 -07001177func (c *Module) StubDecorator() bool {
1178 if _, ok := c.linker.(*stubDecorator); ok {
1179 return true
1180 }
1181 return false
1182}
1183
Yi Kong5786f5c2024-05-28 02:22:34 +09001184func (c *Module) OptimizeForSize() bool {
1185 return Bool(c.Properties.Optimize_for_size)
1186}
1187
Ivan Lozano52767be2019-10-18 14:49:46 -07001188func (c *Module) SdkVersion() string {
1189 return String(c.Properties.Sdk_version)
1190}
1191
Artur Satayev480e25b2020-04-27 18:53:18 +01001192func (c *Module) MinSdkVersion() string {
1193 return String(c.Properties.Min_sdk_version)
1194}
1195
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001196func (c *Module) SetSdkVersion(s string) {
1197 c.Properties.Sdk_version = StringPtr(s)
1198}
1199
1200func (c *Module) SetMinSdkVersion(s string) {
1201 c.Properties.Min_sdk_version = StringPtr(s)
1202}
1203
1204func (c *Module) SetStl(s string) {
1205 if c.stl != nil {
1206 c.stl.Properties.Stl = StringPtr(s)
1207 }
1208}
1209
1210func (c *Module) IsCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001211 if linker, ok := c.linker.(*objectLinker); ok {
1212 return linker.isCrt()
1213 }
1214 return false
1215}
1216
Jiyong Park5df7bd32021-08-25 16:18:46 +09001217func (c *Module) SplitPerApiLevel() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001218 return CanUseSdk(c) && c.IsCrt()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001219}
1220
Colin Crossc511bc52020-04-07 16:50:32 +00001221func (c *Module) AlwaysSdk() bool {
1222 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1223}
1224
Ivan Lozano183a3212019-10-18 14:18:45 -07001225func (c *Module) CcLibrary() bool {
1226 if c.linker != nil {
1227 if _, ok := c.linker.(*libraryDecorator); ok {
1228 return true
1229 }
Colin Crossd48fe732020-09-23 20:37:24 -07001230 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1231 return true
1232 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001233 }
1234 return false
1235}
1236
1237func (c *Module) CcLibraryInterface() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001238 if c.library != nil {
Ivan Lozano183a3212019-10-18 14:18:45 -07001239 return true
1240 }
1241 return false
1242}
1243
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001244func (c *Module) RlibStd() bool {
1245 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1246}
1247
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001248func (c *Module) RustLibraryInterface() bool {
1249 return false
1250}
1251
Ivan Lozano0a468a42024-05-13 21:03:34 -04001252func (c *Module) CrateName() string {
1253 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1254}
1255
1256func (c *Module) ExportedCrateLinkDirs() []string {
1257 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1258}
1259
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001260func (c *Module) IsFuzzModule() bool {
1261 if _, ok := c.compiler.(*fuzzBinary); ok {
1262 return true
1263 }
1264 return false
1265}
1266
1267func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1268 return c.FuzzModule
1269}
1270
1271func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1272 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1273 return fuzzer.fuzzPackagedModule
1274 }
1275 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1276}
1277
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001278func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001279 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1280 return fuzzer.sharedLibraries
1281 }
1282 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1283}
1284
Ivan Lozano2b262972019-11-21 12:30:50 -08001285func (c *Module) NonCcVariants() bool {
1286 return false
1287}
1288
Ivan Lozano183a3212019-10-18 14:18:45 -07001289func (c *Module) SetStatic() {
1290 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001291 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001292 library.setStatic()
1293 return
1294 }
1295 }
1296 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1297}
1298
1299func (c *Module) SetShared() {
1300 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001301 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001302 library.setShared()
1303 return
1304 }
1305 }
1306 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1307}
1308
1309func (c *Module) BuildStaticVariant() bool {
1310 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001311 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001312 return library.buildStatic()
1313 }
1314 }
1315 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1316}
1317
1318func (c *Module) BuildSharedVariant() bool {
1319 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001320 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001321 return library.buildShared()
1322 }
1323 }
1324 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1325}
1326
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001327func (c *Module) BuildRlibVariant() bool {
1328 // cc modules can never build rlib variants
1329 return false
1330}
1331
Ivan Lozano183a3212019-10-18 14:18:45 -07001332func (c *Module) Module() android.Module {
1333 return c
1334}
1335
Jiyong Parkc20eee32018-09-05 22:36:17 +09001336func (c *Module) OutputFile() android.OptionalPath {
1337 return c.outputFile
1338}
1339
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001340func (c *Module) CoverageFiles() android.Paths {
1341 if c.linker != nil {
1342 if library, ok := c.linker.(libraryInterface); ok {
1343 return library.objs().coverageFiles
1344 }
1345 }
1346 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1347}
1348
Ivan Lozano183a3212019-10-18 14:18:45 -07001349var _ LinkableInterface = (*Module)(nil)
1350
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001351func (c *Module) VersionedInterface() VersionedInterface {
1352 if c.library != nil {
1353 return c.library
1354 }
1355 return nil
1356}
1357
Jiyong Park719b4462019-01-13 00:39:51 +09001358func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001359 if c.linker != nil {
1360 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001361 }
1362 return nil
1363}
1364
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001365func (c *Module) CoverageOutputFile() android.OptionalPath {
1366 if c.linker != nil {
1367 return c.linker.coverageOutputFilePath()
1368 }
1369 return android.OptionalPath{}
1370}
1371
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001372func (c *Module) RelativeInstallPath() string {
1373 if c.installer != nil {
1374 return c.installer.relativeInstallPath()
1375 }
1376 return ""
1377}
1378
Jooyung Han344d5432019-08-23 11:17:39 +09001379func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001380 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001381}
1382
Colin Cross36242852017-06-23 15:06:31 -07001383func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001384 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001385 for _, generator := range c.generators {
1386 c.AddProperties(generator.GeneratorProps()...)
1387 }
Colin Crossca860ac2016-01-04 14:34:37 -08001388 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001389 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001390 }
1391 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001392 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001393 }
1394 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001395 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001396 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001397 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001398 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001399 }
Colin Cross16b23492016-01-06 14:41:07 -08001400 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001401 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001402 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001403 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001404 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001405 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001406 if c.fuzzer != nil {
1407 c.AddProperties(c.fuzzer.props()...)
1408 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001409 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001410 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001411 }
Stephen Craneba090d12017-05-09 15:44:35 -07001412 if c.lto != nil {
1413 c.AddProperties(c.lto.props()...)
1414 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001415 if c.afdo != nil {
1416 c.AddProperties(c.afdo.props()...)
1417 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001418 if c.orderfile != nil {
1419 c.AddProperties(c.orderfile.props()...)
1420 }
Colin Crossca860ac2016-01-04 14:34:37 -08001421 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001422 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001423 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001424 // Allow test-only on libraries that are not cc_test_library
1425 if c.library != nil && !c.testLibrary() {
1426 c.AddProperties(&c.sourceProperties)
1427 }
Colin Crossc472d572015-03-17 15:06:21 -07001428
Colin Cross36242852017-06-23 15:06:31 -07001429 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001430 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001431 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001432
Colin Cross36242852017-06-23 15:06:31 -07001433 return c
Colin Crossc472d572015-03-17 15:06:21 -07001434}
1435
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001436// UseVndk() returns true if this module is built against VNDK.
1437// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001438func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001439 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001440}
1441
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001442func CanUseSdk(c LinkableInterface) bool {
1443 return c.Module().Target().Os == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001444 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001445}
1446
1447func (c *Module) UseSdk() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001448 if CanUseSdk(c) {
Colin Cross1348ce32020-10-01 13:37:16 -07001449 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001450 }
1451 return false
1452}
1453
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001454func (c *Module) isCoverageVariant() bool {
1455 return c.coverage.Properties.IsCoverageVariant
1456}
1457
Colin Cross95f1ca02020-10-29 20:47:22 -07001458func (c *Module) IsNdk(config android.Config) bool {
1459 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001460}
1461
Colin Cross127bb8b2020-12-16 16:46:01 -08001462func (c *Module) IsLlndk() bool {
1463 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001464}
1465
Colin Cross1f3f1302021-04-26 18:37:44 -07001466func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001467 lib := moduleVersionedInterface(m)
1468 return lib != nil && (lib.HasLLNDKStubs() || lib.HasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001469}
1470
Colin Cross5271fea2021-04-27 13:06:04 -07001471func (m *Module) NeedsVendorPublicLibraryVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001472 lib := moduleVersionedInterface(m)
1473 return lib != nil && (lib.HasVendorPublicLibrary())
Colin Cross5271fea2021-04-27 13:06:04 -07001474}
1475
1476// IsVendorPublicLibrary returns true for vendor public libraries.
1477func (c *Module) IsVendorPublicLibrary() bool {
1478 return c.VendorProperties.IsVendorPublicLibrary
1479}
1480
Ivan Lozanof1868af2022-04-12 13:08:36 -04001481func (c *Module) IsVndkPrebuiltLibrary() bool {
1482 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1483 return true
1484 }
1485 return false
1486}
1487
1488func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1489 return c.Properties.SdkAndPlatformVariantVisibleToMake
1490}
1491
Ivan Lozanod7586b62021-04-01 09:49:36 -04001492func (c *Module) HasLlndkStubs() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001493 lib := moduleVersionedInterface(c)
1494 return lib != nil && lib.HasLLNDKStubs()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001495}
1496
1497func (c *Module) StubsVersion() string {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001498 if lib, ok := c.linker.(VersionedInterface); ok {
1499 return lib.StubsVersion()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001500 }
1501 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1502}
1503
Colin Cross127bb8b2020-12-16 16:46:01 -08001504// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1505// and does not set llndk.vendor_available: false.
1506func (c *Module) isImplementationForLLNDKPublic() bool {
1507 library, _ := c.library.(*libraryDecorator)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001508 return library != nil && library.HasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001509 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001510}
1511
Colin Cross3513fb12024-01-24 14:44:47 -08001512func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001513 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001514 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001515 }
1516 return false
1517}
1518
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001519func (c *Module) isOrderfileCompile() bool {
1520 if orderfile := c.orderfile; orderfile != nil {
1521 return orderfile.Properties.OrderfileLoad
1522 }
1523 return false
1524}
1525
Yi Kongc702ebd2022-08-19 16:02:45 +08001526func (c *Module) isCfi() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001527 return c.sanitize.isSanitizerEnabled(cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001528}
1529
Yi Konged79fa32023-06-04 17:15:42 +09001530func (c *Module) isFuzzer() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001531 return c.sanitize.isSanitizerEnabled(Fuzzer)
Yi Konged79fa32023-06-04 17:15:42 +09001532}
1533
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001534func (c *Module) isNDKStubLibrary() bool {
1535 if _, ok := c.compiler.(*stubDecorator); ok {
1536 return true
1537 }
1538 return false
1539}
1540
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001541func (c *Module) SubName() string {
1542 return c.Properties.SubName
1543}
1544
Jiyong Park25fc6a92018-11-18 18:02:45 +09001545func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001546 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001547 return lib.BuildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001548 }
1549 return false
1550}
1551
1552func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001553 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001554 return lib.HasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001555 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001556 return false
1557}
1558
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00001559func (c *Module) RustApexExclude() bool {
1560 return false
1561}
1562
Alan Stokes73feba32022-11-14 12:21:24 +00001563func (c *Module) IsStubsImplementationRequired() bool {
1564 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001565 return lib.IsStubsImplementationRequired()
Alan Stokes73feba32022-11-14 12:21:24 +00001566 }
1567 return false
1568}
1569
Colin Cross0477b422020-10-13 18:43:54 -07001570// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1571// the implementation. If it is an implementation library it returns its own name.
1572func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1573 name := ctx.OtherModuleName(c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001574 if versioned, ok := c.linker.(VersionedInterface); ok {
1575 name = versioned.ImplementationModuleName(name)
Colin Cross0477b422020-10-13 18:43:54 -07001576 }
1577 return name
1578}
1579
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001580// Similar to ImplementationModuleNameByCtx, but uses the Make variant of the module
Martin Stjernholm2856c662020-12-02 15:03:42 +00001581// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1582// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1583// under the premise that the prebuilt module overrides its source counterpart
1584// if it is exposed to Make).
Yu Liu0a37d422025-02-13 02:05:00 +00001585func (c *Module) ImplementationModuleNameForMake() string {
Martin Stjernholm2856c662020-12-02 15:03:42 +00001586 name := c.BaseModuleName()
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001587 if versioned, ok := c.linker.(VersionedInterface); ok {
1588 name = versioned.ImplementationModuleName(name)
Martin Stjernholm2856c662020-12-02 15:03:42 +00001589 }
1590 return name
1591}
1592
Jiyong Park7d55b612021-06-11 17:22:09 +09001593func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001594 return Bool(c.Properties.Bootstrap)
1595}
1596
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001597func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001598 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1599 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1600 return false
1601 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001602 return c.linker != nil && c.linker.nativeCoverage()
1603}
1604
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001605func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001606 if p, ok := c.linker.(SnapshotInterface); ok {
1607 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001608 }
1609 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001610}
1611
Jiyong Parkf1194352019-02-25 11:05:47 +09001612func isBionic(name string) bool {
1613 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001614 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001615 return true
1616 }
1617 return false
1618}
1619
Martin Stjernholm279de572019-09-10 23:18:20 +01001620func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001621 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001622 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001623 }
1624 return isBionic(name)
1625}
1626
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001627func (c *Module) isCfiAssemblySupportEnabled() bool {
1628 return c.sanitize != nil &&
1629 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1630}
1631
Inseob Kim800d1142021-06-14 12:03:51 +09001632func (c *Module) InstallInRoot() bool {
1633 return c.installer != nil && c.installer.installInRoot()
1634}
1635
Colin Crossca860ac2016-01-04 14:34:37 -08001636type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001637 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001638 moduleContextImpl
1639}
1640
Colin Cross37047f12016-12-13 17:06:13 -08001641type depsContext struct {
1642 android.BottomUpMutatorContext
1643 moduleContextImpl
1644}
1645
Colin Crossca860ac2016-01-04 14:34:37 -08001646type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001647 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001648 moduleContextImpl
1649}
1650
1651type moduleContextImpl struct {
1652 mod *Module
1653 ctx BaseModuleContext
1654}
1655
Colin Crossb98c8b02016-07-29 13:44:28 -07001656func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001657 return ctx.mod.toolchain(ctx.ctx)
1658}
1659
1660func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001661 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001662}
1663
1664func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001665 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001666}
1667
Colin Cross6a730042024-12-05 13:53:43 -08001668func (ctx *moduleContextImpl) staticLibrary() bool {
1669 return ctx.mod.staticLibrary()
1670}
1671
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001672func (ctx *moduleContextImpl) testBinary() bool {
1673 return ctx.mod.testBinary()
1674}
1675
Yi Kong56fc1b62022-09-06 16:24:00 +08001676func (ctx *moduleContextImpl) testLibrary() bool {
1677 return ctx.mod.testLibrary()
1678}
1679
Jiyong Park1d1119f2019-07-29 21:27:18 +09001680func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001681 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001682}
1683
Inseob Kim7f283f42020-06-01 21:53:49 +09001684func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001685 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001686}
1687
Inseob Kim1042d292020-06-01 23:23:05 +09001688func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001689 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001690}
1691
Yi Kong5786f5c2024-05-28 02:22:34 +09001692func (ctx *moduleContextImpl) optimizeForSize() bool {
1693 return ctx.mod.OptimizeForSize()
1694}
1695
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001696func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001697 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001698}
1699
1700func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001701 if ctx.ctx.Device() {
Justin Yun732aa6a2018-03-23 17:43:47 +09001702 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001703 }
1704 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001705}
1706
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001707func MinSdkVersion(mod VersionedLinkableInterface, ctxIsForPlatform bool, device bool,
1708 platformSdkVersion string) string {
1709
1710 ver := mod.MinSdkVersion()
1711 if ver == "apex_inherit" && !ctxIsForPlatform {
1712 ver = mod.ApexSdkVersion().String()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001713 }
1714 if ver == "apex_inherit" || ver == "" {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001715 ver = mod.SdkVersion()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001716 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001717
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001718 if device {
Jooyung Hanaa2d3f52024-11-09 02:41:06 +00001719 // When building for vendor/product, use the latest _stable_ API as "current".
1720 // This is passed to clang/aidl compilers so that compiled/generated code works
1721 // with the system.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001722 if (mod.InVendor() || mod.InProduct()) && (ver == "" || ver == "current") {
1723 ver = platformSdkVersion
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001724 }
1725 }
1726
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001727 // For crt objects, the meaning of min_sdk_version is very different from other types of
1728 // module. For them, min_sdk_version defines the oldest version that the build system will
1729 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1730 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1731 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001732 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1733 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1734 // support such an old version. The version is set to the later version in case when the
1735 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1736 // it's for an APEX.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001737 if mod.IsCrt() && !mod.IsSdkVariant() {
1738 if ctxIsForPlatform {
Jiyong Park5df7bd32021-08-25 16:18:46 +09001739 ver = strconv.Itoa(android.FutureApiLevelInt)
1740 } else { // for apex
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001741 ver = mod.ApexSdkVersion().String()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001742 if ver == "" { // in case when min_sdk_version was not set by the APEX
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001743 ver = mod.SdkVersion()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001744 }
1745 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001746 }
1747
Jiyong Parkb35a8192020-08-10 15:59:36 +09001748 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001749 sdkVersionInt, err := strconv.Atoi(mod.SdkVersion())
Jiyong Parkb35a8192020-08-10 15:59:36 +09001750 minSdkVersionInt, err2 := strconv.Atoi(ver)
1751 if err == nil && err2 == nil {
1752 if sdkVersionInt < minSdkVersionInt {
1753 return strconv.Itoa(sdkVersionInt)
1754 }
1755 }
1756 return ver
1757}
1758
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001759func (ctx *moduleContextImpl) minSdkVersion() string {
1760 platformSdkVersion := ""
1761 if ctx.ctx.Device() {
1762 platformSdkVersion = ctx.ctx.Config().PlatformSdkVersion().String()
1763 }
1764 return MinSdkVersion(ctx.mod, CtxIsForPlatform(ctx.ctx), ctx.ctx.Device(), platformSdkVersion)
1765}
1766
Jiyong Parkb35a8192020-08-10 15:59:36 +09001767func (ctx *moduleContextImpl) isSdkVariant() bool {
1768 return ctx.mod.IsSdkVariant()
1769}
1770
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001771func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001772 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001773}
Justin Yun8effde42017-06-23 19:24:43 +09001774
Kiyoung Kimaa394802024-01-08 12:55:45 +09001775func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1776 return ctx.mod.InVendorOrProduct()
1777}
1778
Colin Cross95f1ca02020-10-29 20:47:22 -07001779func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1780 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001781}
1782
Colin Cross127bb8b2020-12-16 16:46:01 -08001783func (ctx *moduleContextImpl) IsLlndk() bool {
1784 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001785}
1786
Colin Cross127bb8b2020-12-16 16:46:01 -08001787func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1788 return ctx.mod.isImplementationForLLNDKPublic()
1789}
1790
Colin Cross3513fb12024-01-24 14:44:47 -08001791func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1792 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001793}
1794
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001795func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1796 return ctx.mod.isOrderfileCompile()
1797}
1798
Yi Kongc702ebd2022-08-19 16:02:45 +08001799func (ctx *moduleContextImpl) isCfi() bool {
1800 return ctx.mod.isCfi()
1801}
1802
Yi Konged79fa32023-06-04 17:15:42 +09001803func (ctx *moduleContextImpl) isFuzzer() bool {
1804 return ctx.mod.isFuzzer()
1805}
1806
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001807func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1808 return ctx.mod.isNDKStubLibrary()
1809}
1810
Colin Cross5271fea2021-04-27 13:06:04 -07001811func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1812 return ctx.mod.IsVendorPublicLibrary()
1813}
1814
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001815func (ctx *moduleContextImpl) selectedStl() string {
1816 if stl := ctx.mod.stl; stl != nil {
1817 return stl.Properties.SelectedStl
1818 }
1819 return ""
1820}
1821
Ivan Lozanobd721262018-11-27 14:33:03 -08001822func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1823 return ctx.mod.linker.useClangLld(actx)
1824}
1825
Colin Crossce75d2c2016-10-06 16:12:58 -07001826func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001827 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001828}
1829
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001830func CtxIsForPlatform(ctx android.BaseModuleContext) bool {
1831 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crossff694a82023-12-13 15:54:49 -08001832 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001833}
1834
Colin Crosse07f2312020-08-13 11:24:56 -07001835func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001836 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1837 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001838}
1839
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001840func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001841 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001842}
1843
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001844func (ctx *moduleContextImpl) nativeCoverage() bool {
1845 return ctx.mod.nativeCoverage()
1846}
1847
Colin Cross95b07f22020-12-16 11:06:50 -08001848func (ctx *moduleContextImpl) isPreventInstall() bool {
1849 return ctx.mod.Properties.PreventInstall
1850}
1851
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001852func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1853 shared := &ctx.mod.sharedFlags
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001854 if shared.FlagsMap == nil {
1855 shared.NumSharedFlags = 0
1856 shared.FlagsMap = make(map[string]string)
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001857 }
1858 return shared
1859}
1860
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001861func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1862 return ctx.mod.isCfiAssemblySupportEnabled()
1863}
1864
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001865func (ctx *moduleContextImpl) notInPlatform() bool {
1866 return ctx.mod.NotInPlatform()
1867}
1868
Yu Liu76d94462024-10-31 23:32:36 +00001869func (ctx *moduleContextImpl) getOrCreateMakeVarsInfo() *CcMakeVarsInfo {
1870 if ctx.mod.makeVarsInfo == nil {
1871 ctx.mod.makeVarsInfo = &CcMakeVarsInfo{}
1872 }
1873 return ctx.mod.makeVarsInfo
1874}
1875
Colin Cross635c3b02016-05-18 15:37:25 -07001876func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001877 return &Module{
1878 hod: hod,
1879 multilib: multilib,
1880 }
1881}
1882
Colin Cross635c3b02016-05-18 15:37:25 -07001883func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001884 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001885 module.features = []feature{
1886 &tidyFeature{},
1887 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001888 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001889 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001890 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001891 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001892 module.sabi = &sabi{}
Stephen Craneba090d12017-05-09 15:44:35 -07001893 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001894 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001895 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001896 return module
1897}
1898
Colin Crossce75d2c2016-10-06 16:12:58 -07001899func (c *Module) Prebuilt() *android.Prebuilt {
1900 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1901 return p.prebuilt()
1902 }
1903 return nil
1904}
1905
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001906func (c *Module) IsPrebuilt() bool {
1907 return c.Prebuilt() != nil
1908}
1909
Colin Crossce75d2c2016-10-06 16:12:58 -07001910func (c *Module) Name() string {
1911 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001912 if p, ok := c.linker.(interface {
1913 Name(string) string
1914 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001915 name = p.Name(name)
1916 }
1917 return name
1918}
1919
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001920func (c *Module) Multilib() string {
1921 return c.Arch().ArchType.Multilib
1922}
1923
1924func (c *Module) ApexSdkVersion() android.ApiLevel {
1925 return c.apexSdkVersion
1926}
1927
Alex Light3d673592019-01-18 14:37:31 -08001928func (c *Module) Symlinks() []string {
1929 if p, ok := c.installer.(interface {
1930 symlinkList() []string
1931 }); ok {
1932 return p.symlinkList()
1933 }
1934 return nil
1935}
1936
Chris Parsons216e10a2020-07-09 17:12:52 -04001937func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001938 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001939 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001940 }); ok {
1941 return p.dataPaths()
1942 }
1943 return nil
1944}
1945
Ivan Lozanof1868af2022-04-12 13:08:36 -04001946func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001947 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1948 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001949 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001950 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001951 if c.ProductSpecific() {
1952 // If the module is product specific with 'product_specific: true',
1953 // do not add a name suffix because it is a base module.
1954 return ""
1955 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001956 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001957 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001958 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001959 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001960 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001961 // add version suffix only if the module is using different vndk version than the
1962 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001963 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001964 }
1965 return nameSuffix
1966}
1967
Ivan Lozanof1868af2022-04-12 13:08:36 -04001968func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1969 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001970
1971 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001972 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001973 }
1974
Colin Cross127bb8b2020-12-16 16:46:01 -08001975 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001976 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001977 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1978 // added for product variant only when we have vendor and product variants with core
1979 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001980 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001981 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001982 subName += vendorPublicLibrarySuffix
1983 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001984 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1985 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001986 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001987 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001988 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001989 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001990 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001991 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001992 subName += RecoverySuffix
1993 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1994 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001995 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001996 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001997 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001998 } else if c.IsStubs() && c.IsSdkVariant() {
1999 // Public API surface (NDK)
2000 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
2001 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09002002 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04002003
2004 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05002005}
2006
Sam Delmerico75dbca22023-04-20 13:13:25 +00002007func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
2008 ctx := &moduleContext{
2009 ModuleContext: actx,
2010 moduleContextImpl: moduleContextImpl{
2011 mod: c,
2012 },
2013 }
2014 ctx.ctx = ctx
2015 return ctx
2016}
2017
Spandan Das20fce2d2023-04-12 17:21:39 +00002018// TODO (b/277651159): Remove this allowlist
2019var (
2020 skipStubLibraryMultipleApexViolation = map[string]bool{
2021 "libclang_rt.asan": true,
2022 "libclang_rt.hwasan": true,
2023 // runtime apex
2024 "libc": true,
2025 "libc_hwasan": true,
2026 "libdl_android": true,
2027 "libm": true,
2028 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00002029 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00002030 // art apex
Martin Stjernholm75598032024-07-12 18:47:26 +01002031 // TODO(b/234351700): Remove this when com.android.art.debug is gone.
Spandan Das20fce2d2023-04-12 17:21:39 +00002032 "libandroidio": true,
2033 "libdexfile": true,
Martin Stjernholm75598032024-07-12 18:47:26 +01002034 "libdexfiled": true, // com.android.art.debug only
Spandan Das20fce2d2023-04-12 17:21:39 +00002035 "libnativebridge": true,
2036 "libnativehelper": true,
2037 "libnativeloader": true,
2038 "libsigchain": true,
2039 }
2040)
2041
2042// Returns true if a stub library could be installed in multiple apexes
2043func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
2044 // If this is not an apex variant, no check necessary
Colin Cross2dcbca62024-11-20 14:55:14 -08002045 if info, ok := android.ModuleProvider(ctx, android.ApexInfoProvider); !ok || info.IsForPlatform() {
Spandan Das20fce2d2023-04-12 17:21:39 +00002046 return false
2047 }
2048 // If this is not a stub library, no check necessary
2049 if !c.HasStubsVariants() {
2050 return false
2051 }
2052 // Skip the allowlist
2053 // Use BaseModuleName so that this matches prebuilts.
2054 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
2055 return false
2056 }
2057
Spandan Das20fce2d2023-04-12 17:21:39 +00002058 // Stub libraries should not have more than one apex_available
Colin Crossaf4c8562024-11-20 15:07:58 -08002059 apexAvailable := android.FirstUniqueStrings(c.ApexAvailable())
2060 if len(apexAvailable) > 1 {
Spandan Das20fce2d2023-04-12 17:21:39 +00002061 return true
2062 }
2063 // Stub libraries should not use the wildcard
Colin Crossaf4c8562024-11-20 15:07:58 -08002064 if apexAvailable[0] == android.AvailableToAnyApex {
Spandan Das20fce2d2023-04-12 17:21:39 +00002065 return true
2066 }
2067 // Default: no violation
2068 return false
2069}
2070
Chris Parsons8d6e4332021-02-22 16:13:50 -05002071func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002072 ctx := moduleContextFromAndroidModuleContext(actx, c)
2073
Inseob Kim37e0bb02024-04-29 15:54:44 +09002074 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
2075 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
2076 Logtags: c.logtagsPaths,
2077 })
2078
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002079 // If Test_only is set on a module in bp file, respect the setting, otherwise
2080 // see if is a known test module type.
2081 testOnly := c.testModule || c.testLibrary()
2082 if c.sourceProperties.Test_only != nil {
2083 testOnly = Bool(c.sourceProperties.Test_only)
2084 }
2085 // Keep before any early returns.
2086 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2087 TestOnly: testOnly,
2088 TopLevelTarget: c.testModule,
2089 })
2090
Ivan Lozanof1868af2022-04-12 13:08:36 -04002091 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002092 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002093 if !apexInfo.IsForPlatform() {
2094 c.hideApexVariantFromMake = true
2095 }
2096
Chris Parsonseefc9e62021-04-02 17:36:47 -04002097 c.makeLinkType = GetMakeLinkType(actx, c)
2098
Colin Crossf18e1102017-11-16 14:33:08 -08002099 deps := c.depsToPaths(ctx)
2100 if ctx.Failed() {
2101 return
2102 }
2103
Joe Onorato37f900c2023-07-18 16:58:16 -07002104 for _, generator := range c.generators {
2105 gen := generator.GeneratorSources(ctx)
2106 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2107 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2108 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2109 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2110 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2111 if len(deps.Objs.objFiles) == 0 {
2112 // If we are reusuing object files (which happens when we're a shared library and we're
2113 // reusing our static variant's object files), then skip adding the actual source files,
2114 // because we already have the object for it.
2115 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2116 }
2117 }
2118
2119 if ctx.Failed() {
2120 return
2121 }
2122
Spandan Das20fce2d2023-04-12 17:21:39 +00002123 if c.stubLibraryMultipleApexViolation(actx) {
2124 actx.PropertyErrorf("apex_available",
2125 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2126 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002127 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2128 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002129 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2130 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002131 }
2132
Colin Crossca860ac2016-01-04 14:34:37 -08002133 flags := Flags{
2134 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002135 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002136 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002137 for _, generator := range c.generators {
2138 flags = generator.GeneratorFlags(ctx, flags, deps)
2139 }
Colin Crossca860ac2016-01-04 14:34:37 -08002140 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002141 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002142 }
2143 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002144 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002145 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002146 if c.stl != nil {
2147 flags = c.stl.flags(ctx, flags)
2148 }
Colin Cross16b23492016-01-06 14:41:07 -08002149 if c.sanitize != nil {
2150 flags = c.sanitize.flags(ctx, flags)
2151 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002152 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002153 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002154 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002155 if c.fuzzer != nil {
2156 flags = c.fuzzer.flags(ctx, flags)
2157 }
Stephen Craneba090d12017-05-09 15:44:35 -07002158 if c.lto != nil {
2159 flags = c.lto.flags(ctx, flags)
2160 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002161 if c.afdo != nil {
2162 flags = c.afdo.flags(ctx, flags)
2163 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002164 if c.orderfile != nil {
2165 flags = c.orderfile.flags(ctx, flags)
2166 }
Colin Crossca860ac2016-01-04 14:34:37 -08002167 for _, feature := range c.features {
2168 flags = feature.flags(ctx, flags)
2169 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002170 if ctx.Failed() {
2171 return
2172 }
2173
Colin Cross4af21ed2019-11-04 09:37:55 -08002174 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2175 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2176 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002177
Colin Cross4af21ed2019-11-04 09:37:55 -08002178 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002179
2180 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002181 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002182 }
2183 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002184 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002185 }
2186
Colin Cross3e5e7782022-06-17 22:17:05 +00002187 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2188
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002189 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002190 // We need access to all the flags seen by a source file.
2191 if c.sabi != nil {
2192 flags = c.sabi.flags(ctx, flags)
2193 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002194
Colin Cross4af21ed2019-11-04 09:37:55 -08002195 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002196
Joe Onorato37f900c2023-07-18 16:58:16 -07002197 for _, generator := range c.generators {
2198 generator.GeneratorBuildActions(ctx, flags, deps)
2199 }
2200
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002201 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002202 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002203 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002204 if ctx.Failed() {
2205 return
2206 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002207 }
2208
Colin Crossca860ac2016-01-04 14:34:37 -08002209 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002210 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002211 if ctx.Failed() {
2212 return
2213 }
Colin Cross635c3b02016-05-18 15:37:25 -07002214 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002215
Chris Parsons94a0bba2021-06-04 15:03:47 -04002216 c.maybeUnhideFromMake()
Colin Crossb614cd42024-10-11 12:52:21 -07002217
2218 android.SetProvider(ctx, ImplementationDepInfoProvider, &ImplementationDepInfo{
2219 ImplementationDeps: depset.New(depset.PREORDER, deps.directImplementationDeps, deps.transitiveImplementationDeps),
2220 })
Colin Crossce75d2c2016-10-06 16:12:58 -07002221 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002222
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002223 if Bool(c.Properties.Cmake_snapshot_supported) {
2224 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2225 }
2226
Chris Parsons94a0bba2021-06-04 15:03:47 -04002227 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002228
2229 if c.linker != nil {
2230 moduleInfoJSON := ctx.ModuleInfoJSON()
2231 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2232 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2233 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2234 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2235 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2236
2237 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2238 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2239 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2240 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2241
2242 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2243 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2244 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2245 moduleInfoJSON.SubName += ".cfi"
2246 }
2247 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2248 moduleInfoJSON.SubName += ".hwasan"
2249 }
2250 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2251 moduleInfoJSON.SubName += ".scs"
2252 }
2253 }
2254 moduleInfoJSON.SubName += c.Properties.SubName
2255
2256 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2257 moduleInfoJSON.Uninstallable = true
2258 }
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002259 }
Wei Lia1aa2972024-06-21 13:08:51 -07002260
2261 buildComplianceMetadataInfo(ctx, c, deps)
mrziwangabdb2932024-06-18 12:43:41 -07002262
Cole Faust96a692b2024-08-08 14:47:51 -07002263 if b, ok := c.compiler.(*baseCompiler); ok {
2264 c.hasAidl = b.hasSrcExt(ctx, ".aidl")
2265 c.hasLex = b.hasSrcExt(ctx, ".l") || b.hasSrcExt(ctx, ".ll")
2266 c.hasProto = b.hasSrcExt(ctx, ".proto")
2267 c.hasRenderscript = b.hasSrcExt(ctx, ".rscript") || b.hasSrcExt(ctx, ".fs")
2268 c.hasSysprop = b.hasSrcExt(ctx, ".sysprop")
2269 c.hasWinMsg = b.hasSrcExt(ctx, ".mc")
2270 c.hasYacc = b.hasSrcExt(ctx, ".y") || b.hasSrcExt(ctx, ".yy")
2271 }
2272
Yu Liuec7043d2024-11-05 18:22:20 +00002273 ccObjectInfo := CcObjectInfo{
Yu Liu4f825132024-12-18 00:35:39 +00002274 KytheFiles: objs.kytheFiles,
Yu Liuec7043d2024-11-05 18:22:20 +00002275 }
2276 if !ctx.Config().KatiEnabled() || !android.ShouldSkipAndroidMkProcessing(ctx, c) {
Yu Liu4f825132024-12-18 00:35:39 +00002277 ccObjectInfo.ObjFiles = objs.objFiles
2278 ccObjectInfo.TidyFiles = objs.tidyFiles
Yu Liuec7043d2024-11-05 18:22:20 +00002279 }
Yu Liu4f825132024-12-18 00:35:39 +00002280 if len(ccObjectInfo.KytheFiles)+len(ccObjectInfo.ObjFiles)+len(ccObjectInfo.TidyFiles) > 0 {
Yu Liuec7043d2024-11-05 18:22:20 +00002281 android.SetProvider(ctx, CcObjectInfoProvider, ccObjectInfo)
2282 }
2283
Yu Liuf6f85492025-01-13 21:02:36 +00002284 linkableInfo := CreateCommonLinkableInfo(ctx, c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002285 if lib, ok := c.linker.(VersionedInterface); ok {
2286 linkableInfo.StubsVersion = lib.StubsVersion()
Yu Liu8024b922024-12-20 23:31:32 +00002287 }
2288 if c.linker != nil {
2289 if library, ok := c.linker.(libraryInterface); ok {
2290 linkableInfo.Static = library.static()
Yu Liu8a8d5b42025-01-07 00:48:08 +00002291 linkableInfo.Shared = library.shared()
Yu Liu8024b922024-12-20 23:31:32 +00002292 linkableInfo.CoverageFiles = library.objs().coverageFiles
2293 linkableInfo.SAbiDumpFiles = library.objs().sAbiDumpFiles
2294 }
2295 }
2296 android.SetProvider(ctx, LinkableInfoProvider, linkableInfo)
Yu Liu986d98c2024-11-12 00:28:11 +00002297
Yu Liu323d77a2024-12-16 23:13:57 +00002298 ccInfo := CcInfo{
Yu Liu323d77a2024-12-16 23:13:57 +00002299 IsPrebuilt: c.IsPrebuilt(),
2300 CmakeSnapshotSupported: proptools.Bool(c.Properties.Cmake_snapshot_supported),
Yu Liu68a70b72025-01-08 22:54:44 +00002301 HasLlndkStubs: c.HasLlndkStubs(),
Yu Liu0a37d422025-02-13 02:05:00 +00002302 DataPaths: c.DataPaths(),
Yu Liu323d77a2024-12-16 23:13:57 +00002303 }
2304 if c.compiler != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002305 cflags := c.compiler.baseCompilerProps().Cflags
Yu Liu323d77a2024-12-16 23:13:57 +00002306 ccInfo.CompilerInfo = &CompilerInfo{
2307 Srcs: c.compiler.(CompiledInterface).Srcs(),
Cole Faustc9b88c92025-02-06 17:58:26 -08002308 Cflags: cflags.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002309 AidlInterfaceInfo: AidlInterfaceInfo{
2310 Sources: c.compiler.baseCompilerProps().AidlInterface.Sources,
2311 AidlRoot: c.compiler.baseCompilerProps().AidlInterface.AidlRoot,
2312 Lang: c.compiler.baseCompilerProps().AidlInterface.Lang,
2313 Flags: c.compiler.baseCompilerProps().AidlInterface.Flags,
2314 },
2315 }
2316 switch decorator := c.compiler.(type) {
2317 case *libraryDecorator:
2318 ccInfo.CompilerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002319 ExportIncludeDirs: decorator.flagExporter.Properties.Export_include_dirs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002320 }
2321 }
2322 }
2323 if c.linker != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002324 baseLinkerProps := c.linker.baseLinkerProps()
Yu Liu323d77a2024-12-16 23:13:57 +00002325 ccInfo.LinkerInfo = &LinkerInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002326 WholeStaticLibs: baseLinkerProps.Whole_static_libs.GetOrDefault(ctx, nil),
2327 StaticLibs: baseLinkerProps.Static_libs.GetOrDefault(ctx, nil),
2328 SharedLibs: baseLinkerProps.Shared_libs.GetOrDefault(ctx, nil),
2329 HeaderLibs: baseLinkerProps.Header_libs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002330 }
2331 switch decorator := c.linker.(type) {
2332 case *binaryDecorator:
2333 ccInfo.LinkerInfo.BinaryDecoratorInfo = &BinaryDecoratorInfo{}
2334 case *libraryDecorator:
Yu Liu116610a2025-01-06 21:54:48 +00002335 ccInfo.LinkerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
2336 InjectBsslHash: Bool(c.linker.(*libraryDecorator).Properties.Inject_bssl_hash),
2337 }
Yu Liu323d77a2024-12-16 23:13:57 +00002338 case *testBinary:
2339 ccInfo.LinkerInfo.TestBinaryInfo = &TestBinaryInfo{
2340 Gtest: decorator.testDecorator.gtest(),
2341 }
2342 case *benchmarkDecorator:
2343 ccInfo.LinkerInfo.BenchmarkDecoratorInfo = &BenchmarkDecoratorInfo{}
2344 case *objectLinker:
2345 ccInfo.LinkerInfo.ObjectLinkerInfo = &ObjectLinkerInfo{}
Yu Liu8a8d5b42025-01-07 00:48:08 +00002346 case *stubDecorator:
2347 ccInfo.LinkerInfo.StubDecoratorInfo = &StubDecoratorInfo{}
Yu Liu323d77a2024-12-16 23:13:57 +00002348 }
Yu Liu8024b922024-12-20 23:31:32 +00002349
2350 if s, ok := c.linker.(SnapshotInterface); ok {
2351 ccInfo.SnapshotInfo = &SnapshotInfo{
2352 SnapshotAndroidMkSuffix: s.SnapshotAndroidMkSuffix(),
2353 }
Yu Liuffe86322024-12-18 18:53:12 +00002354 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002355 if v, ok := c.linker.(VersionedInterface); ok {
2356 name := v.ImplementationModuleName(ctx.OtherModuleName(c))
Yu Liu68a70b72025-01-08 22:54:44 +00002357 ccInfo.LinkerInfo.ImplementationModuleName = &name
2358 }
Yu Liuffe86322024-12-18 18:53:12 +00002359 }
Yu Liu8a8d5b42025-01-07 00:48:08 +00002360 if c.library != nil {
2361 ccInfo.LibraryInfo = &LibraryInfo{
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002362 BuildStubs: c.library.BuildStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002363 }
2364 }
Yu Liu8024b922024-12-20 23:31:32 +00002365 android.SetProvider(ctx, CcInfoProvider, &ccInfo)
Yu Liub1bfa9d2024-12-05 18:57:51 +00002366
mrziwangabdb2932024-06-18 12:43:41 -07002367 c.setOutputFiles(ctx)
Yu Liu76d94462024-10-31 23:32:36 +00002368
2369 if c.makeVarsInfo != nil {
2370 android.SetProvider(ctx, CcMakeVarsInfoProvider, c.makeVarsInfo)
2371 }
mrziwangabdb2932024-06-18 12:43:41 -07002372}
2373
Yu Liuf6f85492025-01-13 21:02:36 +00002374func CreateCommonLinkableInfo(ctx android.ModuleContext, mod VersionedLinkableInterface) *LinkableInfo {
Yu Liu0a37d422025-02-13 02:05:00 +00002375 info := &LinkableInfo{
Yu Liu8024b922024-12-20 23:31:32 +00002376 StaticExecutable: mod.StaticExecutable(),
2377 HasStubsVariants: mod.HasStubsVariants(),
2378 OutputFile: mod.OutputFile(),
2379 UnstrippedOutputFile: mod.UnstrippedOutputFile(),
Yu Liuf6f85492025-01-13 21:02:36 +00002380 CoverageOutputFile: mod.CoverageOutputFile(),
2381 Partition: mod.Partition(),
Yu Liu8024b922024-12-20 23:31:32 +00002382 IsStubs: mod.IsStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002383 CcLibrary: mod.CcLibrary(),
Yu Liu8024b922024-12-20 23:31:32 +00002384 CcLibraryInterface: mod.CcLibraryInterface(),
2385 RustLibraryInterface: mod.RustLibraryInterface(),
Yu Liu8024b922024-12-20 23:31:32 +00002386 IsLlndk: mod.IsLlndk(),
Yu Liuf6f85492025-01-13 21:02:36 +00002387 IsNdk: mod.IsNdk(ctx.Config()),
Yu Liu8024b922024-12-20 23:31:32 +00002388 HasNonSystemVariants: mod.HasNonSystemVariants(),
2389 SubName: mod.SubName(),
2390 InVendorOrProduct: mod.InVendorOrProduct(),
2391 InRamdisk: mod.InRamdisk(),
2392 OnlyInRamdisk: mod.OnlyInRamdisk(),
2393 InVendorRamdisk: mod.InVendorRamdisk(),
2394 OnlyInVendorRamdisk: mod.OnlyInVendorRamdisk(),
2395 InRecovery: mod.InRecovery(),
2396 OnlyInRecovery: mod.OnlyInRecovery(),
Yu Liu367827f2025-02-15 00:18:33 +00002397 InVendor: mod.InVendor(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002398 Installable: mod.Installable(),
Yu Liu97880e12025-01-07 19:03:34 +00002399 RelativeInstallPath: mod.RelativeInstallPath(),
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002400 // TODO(b/362509506): remove this once all apex_exclude uses are switched to stubs.
Yu Liu0a37d422025-02-13 02:05:00 +00002401 RustApexExclude: mod.RustApexExclude(),
2402 Bootstrap: mod.Bootstrap(),
2403 Multilib: mod.Multilib(),
2404 ImplementationModuleNameForMake: mod.ImplementationModuleNameForMake(),
2405 Symlinks: mod.Symlinks(),
Yu Liu8024b922024-12-20 23:31:32 +00002406 }
Yu Liu8024b922024-12-20 23:31:32 +00002407
Yu Liu367827f2025-02-15 00:18:33 +00002408 vi := mod.VersionedInterface()
2409 if vi != nil {
2410 info.IsStubsImplementationRequired = vi.IsStubsImplementationRequired()
2411 info.APIListCoverageXMLPath = vi.GetAPIListCoverageXMLPath()
Yu Liuec7043d2024-11-05 18:22:20 +00002412 }
Yu Liu367827f2025-02-15 00:18:33 +00002413
2414 return info
Yu Liuec7043d2024-11-05 18:22:20 +00002415}
2416
mrziwangabdb2932024-06-18 12:43:41 -07002417func (c *Module) setOutputFiles(ctx ModuleContext) {
2418 if c.outputFile.Valid() {
2419 ctx.SetOutputFiles(android.Paths{c.outputFile.Path()}, "")
2420 } else {
2421 ctx.SetOutputFiles(android.Paths{}, "")
2422 }
2423 if c.linker != nil {
2424 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), "unstripped")
2425 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), "stripped_all")
2426 }
Wei Lia1aa2972024-06-21 13:08:51 -07002427}
2428
2429func buildComplianceMetadataInfo(ctx ModuleContext, c *Module, deps PathDeps) {
2430 // Dump metadata that can not be done in android/compliance-metadata.go
2431 complianceMetadataInfo := ctx.ComplianceMetadataInfo()
Wei Li8ede4f72025-01-15 21:24:22 -08002432 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.IS_STATIC_LIB, strconv.FormatBool(ctx.static() || ctx.ModuleType() == "cc_object"))
Wei Lia1aa2972024-06-21 13:08:51 -07002433 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.BUILT_FILES, c.outputFile.String())
2434
2435 // Static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002436 staticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(false))
Wei Lia1aa2972024-06-21 13:08:51 -07002437 staticDepNames := make([]string, 0, len(staticDeps))
2438 for _, dep := range staticDeps {
2439 staticDepNames = append(staticDepNames, dep.Name())
2440 }
Wei Li8ede4f72025-01-15 21:24:22 -08002441 // Process CrtBegin and CrtEnd as static libs
Yu Liu727204c2025-01-23 20:58:32 +00002442 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Wei Li8ede4f72025-01-15 21:24:22 -08002443 depName := ctx.OtherModuleName(dep)
2444 depTag := ctx.OtherModuleDependencyTag(dep)
2445 switch depTag {
2446 case CrtBeginDepTag:
2447 staticDepNames = append(staticDepNames, depName)
2448 case CrtEndDepTag:
2449 staticDepNames = append(staticDepNames, depName)
2450 }
2451 })
Wei Lia1aa2972024-06-21 13:08:51 -07002452
Wei Li8ede4f72025-01-15 21:24:22 -08002453 staticDepPaths := make([]string, 0, len(deps.StaticLibs)+len(deps.CrtBegin)+len(deps.CrtEnd))
Wei Lia1aa2972024-06-21 13:08:51 -07002454 for _, dep := range deps.StaticLibs {
2455 staticDepPaths = append(staticDepPaths, dep.String())
2456 }
Wei Li8ede4f72025-01-15 21:24:22 -08002457 for _, dep := range deps.CrtBegin {
2458 staticDepPaths = append(staticDepPaths, dep.String())
2459 }
2460 for _, dep := range deps.CrtEnd {
2461 staticDepPaths = append(staticDepPaths, dep.String())
2462 }
Wei Lia1aa2972024-06-21 13:08:51 -07002463 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
2464 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEP_FILES, android.FirstUniqueStrings(staticDepPaths))
2465
2466 // Whole static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002467 wholeStaticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(true))
Wei Lia1aa2972024-06-21 13:08:51 -07002468 wholeStaticDepNames := make([]string, 0, len(wholeStaticDeps))
2469 for _, dep := range wholeStaticDeps {
2470 wholeStaticDepNames = append(wholeStaticDepNames, dep.Name())
2471 }
2472
2473 wholeStaticDepPaths := make([]string, 0, len(deps.WholeStaticLibs))
2474 for _, dep := range deps.WholeStaticLibs {
2475 wholeStaticDepPaths = append(wholeStaticDepPaths, dep.String())
2476 }
2477 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEPS, android.FirstUniqueStrings(wholeStaticDepNames))
2478 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEP_FILES, android.FirstUniqueStrings(wholeStaticDepPaths))
Wei Li8ede4f72025-01-15 21:24:22 -08002479
2480 // Header libs
2481 headerLibDeps := ctx.GetDirectDepsProxyWithTag(HeaderDepTag())
2482 headerLibDepNames := make([]string, 0, len(headerLibDeps))
2483 for _, dep := range headerLibDeps {
2484 headerLibDepNames = append(headerLibDepNames, dep.Name())
2485 }
2486 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.HEADER_LIBS, android.FirstUniqueStrings(headerLibDepNames))
Chris Parsons94a0bba2021-06-04 15:03:47 -04002487}
2488
2489func (c *Module) maybeUnhideFromMake() {
2490 // If a lib is directly included in any of the APEXes or is not available to the
2491 // platform (which is often the case when the stub is provided as a prebuilt),
2492 // unhide the stubs variant having the latest version gets visible to make. In
2493 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2494 // force anything in the make world to link against the stubs library. (unless it
2495 // is explicitly referenced via .bootstrap suffix or the module is marked with
2496 // 'bootstrap: true').
2497 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002498 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002499 c.IsStubs() && !c.InVendorRamdisk() {
2500 c.Properties.HideFromMake = false // unhide
2501 // Note: this is still non-installable
2502 }
2503}
2504
Colin Cross8ff10582023-12-07 13:10:56 -08002505// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2506// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002507func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002508 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002509 // If the module has been specifically configure to not be installed then
2510 // hide from make as otherwise it will break when running inside make
2511 // as the output path to install will not be specified. Not all uninstallable
2512 // modules can be hidden from make as some are needed for resolving make side
2513 // dependencies.
2514 c.HideFromMake()
Spandan Das034af2c2024-10-30 21:45:09 +00002515 c.SkipInstall()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002516 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002517 c.SkipInstall()
2518 }
2519
2520 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2521 // to allow using the outputs in a genrule.
2522 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002523 c.installer.install(ctx, c.outputFile.Path())
2524 if ctx.Failed() {
2525 return
Colin Crossca860ac2016-01-04 14:34:37 -08002526 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002527 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002528}
2529
Colin Cross0ea8ba82019-06-06 14:33:29 -07002530func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002531 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002532 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002533 }
Colin Crossca860ac2016-01-04 14:34:37 -08002534 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002535}
2536
Colin Crossca860ac2016-01-04 14:34:37 -08002537func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002538 for _, generator := range c.generators {
2539 generator.GeneratorInit(ctx)
2540 }
Colin Crossca860ac2016-01-04 14:34:37 -08002541 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002542 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002543 }
Colin Crossca860ac2016-01-04 14:34:37 -08002544 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002545 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002546 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002547 if c.stl != nil {
2548 c.stl.begin(ctx)
2549 }
Colin Cross16b23492016-01-06 14:41:07 -08002550 if c.sanitize != nil {
2551 c.sanitize.begin(ctx)
2552 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002553 if c.coverage != nil {
2554 c.coverage.begin(ctx)
2555 }
Yi Kong9723e332023-12-04 14:52:53 +09002556 if c.afdo != nil {
2557 c.afdo.begin(ctx)
2558 }
Stephen Craneba090d12017-05-09 15:44:35 -07002559 if c.lto != nil {
2560 c.lto.begin(ctx)
2561 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002562 if c.orderfile != nil {
2563 c.orderfile.begin(ctx)
2564 }
Dan Albert92fe7402020-07-15 13:33:30 -07002565 if ctx.useSdk() && c.IsSdkVariant() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002566 version, err := NativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002567 if err != nil {
2568 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002569 c.Properties.Sdk_version = nil
2570 } else {
2571 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002572 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002573 }
Colin Crossca860ac2016-01-04 14:34:37 -08002574}
2575
Colin Cross37047f12016-12-13 17:06:13 -08002576func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002577 deps := Deps{}
2578
Joe Onorato37f900c2023-07-18 16:58:16 -07002579 for _, generator := range c.generators {
2580 deps = generator.GeneratorDeps(ctx, deps)
2581 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002582 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002583 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002584 }
2585 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002586 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002587 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002588 if c.stl != nil {
2589 deps = c.stl.deps(ctx, deps)
2590 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002591 if c.coverage != nil {
2592 deps = c.coverage.deps(ctx, deps)
2593 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002594
Colin Crossb6715442017-10-24 11:13:31 -07002595 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2596 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2597 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2598 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2599 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2600 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002601 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002602 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002603
Colin Cross516c5452024-10-28 13:45:21 -07002604 if err := checkConflictingExplicitVersions(deps.SharedLibs); err != nil {
2605 ctx.PropertyErrorf("shared_libs", "%s", err.Error())
2606 }
2607
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002608 for _, lib := range deps.ReexportSharedLibHeaders {
2609 if !inList(lib, deps.SharedLibs) {
2610 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2611 }
2612 }
2613
2614 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002615 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2616 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 -07002617 }
2618 }
2619
Colin Cross5950f382016-12-13 12:50:57 -08002620 for _, lib := range deps.ReexportHeaderLibHeaders {
2621 if !inList(lib, deps.HeaderLibs) {
2622 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2623 }
2624 }
2625
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002626 for _, gen := range deps.ReexportGeneratedHeaders {
2627 if !inList(gen, deps.GeneratedHeaders) {
2628 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2629 }
2630 }
2631
Colin Crossc99deeb2016-04-11 15:06:20 -07002632 return deps
2633}
2634
Colin Cross516c5452024-10-28 13:45:21 -07002635func checkConflictingExplicitVersions(libs []string) error {
2636 withoutVersion := func(s string) string {
2637 name, _ := StubsLibNameAndVersion(s)
2638 return name
2639 }
2640 var errs []error
2641 for i, lib := range libs {
2642 libName := withoutVersion(lib)
2643 libsToCompare := libs[i+1:]
2644 j := slices.IndexFunc(libsToCompare, func(s string) bool {
2645 return withoutVersion(s) == libName
2646 })
2647 if j >= 0 {
2648 errs = append(errs, fmt.Errorf("duplicate shared libraries with different explicit versions: %q and %q",
2649 lib, libsToCompare[j]))
2650 }
2651 }
2652 return errors.Join(errs...)
2653}
2654
Dan Albert7e9d2952016-08-04 13:02:36 -07002655func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002656 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002657 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002658 moduleContextImpl: moduleContextImpl{
2659 mod: c,
2660 },
2661 }
2662 ctx.ctx = ctx
2663
Colin Crossca860ac2016-01-04 14:34:37 -08002664 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002665}
2666
Jiyong Park7ed9de32018-10-15 22:25:07 +09002667// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002668func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002669 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2670 version := name[sharp+1:]
2671 libname := name[:sharp]
2672 return libname, version
2673 }
2674 return name, ""
2675}
2676
Dan Albert92fe7402020-07-15 13:33:30 -07002677func GetCrtVariations(ctx android.BottomUpMutatorContext,
2678 m LinkableInterface) []blueprint.Variation {
2679 if ctx.Os() != android.Android {
2680 return nil
2681 }
2682 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002683 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2684 minSdkVersion := m.MinSdkVersion()
2685 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2686 minSdkVersion = m.SdkVersion()
2687 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002688 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2689 if err != nil {
2690 ctx.PropertyErrorf("min_sdk_version", err.Error())
2691 }
Colin Cross363ec762023-01-13 13:45:14 -08002692
2693 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002694 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002695 if apiLevel.LessThan(minApiForArch) {
2696 apiLevel = minApiForArch
2697 }
2698
Dan Albert92fe7402020-07-15 13:33:30 -07002699 return []blueprint.Variation{
2700 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002701 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002702 }
2703 }
2704 return []blueprint.Variation{
2705 {Mutator: "sdk", Variation: ""},
2706 }
2707}
2708
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002709func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2710 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002711
2712 variations = append([]blueprint.Variation(nil), variations...)
2713
Liz Kammer23942242022-04-08 15:41:00 -04002714 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002715 // Version is explicitly specified. i.e. libFoo#30
Colin Crossb614cd42024-10-11 12:52:21 -07002716 if version == "impl" {
2717 version = ""
2718 }
Colin Crosse7257d22020-09-24 09:56:18 -07002719 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002720 if tag, ok := depTag.(libraryDependencyTag); ok {
2721 tag.explicitlyVersioned = true
Colin Crossbd930bc2025-02-03 12:17:42 -08002722 if version == "" {
2723 tag.explicitlyImpl = true
2724 }
Colin Crossafcdce82024-10-22 13:59:33 -07002725 // depTag is an interface that contains a concrete non-pointer struct. That makes the local
2726 // tag variable a copy of the contents of depTag, and updating it doesn't change depTag. Reassign
2727 // the modified copy to depTag.
2728 depTag = tag
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002729 } else {
2730 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2731 }
Colin Crosse7257d22020-09-24 09:56:18 -07002732 }
Colin Crosse7257d22020-09-24 09:56:18 -07002733
Colin Cross0de8a1e2020-09-18 14:15:30 -07002734 if far {
2735 ctx.AddFarVariationDependencies(variations, depTag, name)
2736 } else {
2737 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002738 }
2739}
2740
Kiyoung Kim487689e2022-07-26 09:48:22 +09002741func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2742 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002743 return snapshot
2744 }
2745
2746 return lib
2747}
2748
Kiyoung Kim37693d02024-04-04 09:56:15 +09002749// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002750// of names:
2751//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002752// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002753//
2754// For each of these, it adds the name of the ndk_library module to the list of
2755// variant libs.
2756//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002757// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002758//
2759// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002760//
2761// The caller can then know to add the variantLibs dependencies differently from the
2762// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002763func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002764 variantLibs = []string{}
2765
2766 nonvariantLibs = []string{}
2767 for _, entry := range list {
2768 // strip #version suffix out
2769 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002770 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002771 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002772 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002773 nonvariantLibs = append(nonvariantLibs, entry)
2774 }
2775 }
2776 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002777
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002778}
2779
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002780func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2781 nonVariantLibs := []string{}
2782 variantLibs := []string{}
2783
2784 for _, lib := range libs {
2785 replaceLibName := GetReplaceModuleName(lib, replaceList)
2786 if replaceLibName == lib {
2787 // Do not handle any libs which are not in API imports
2788 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2789 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2790 variantLibs = append(variantLibs, replaceLibName)
2791 } else {
2792 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2793 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002794 }
2795
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002796 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002797}
2798
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002799func (c *Module) shouldUseApiSurface() bool {
2800 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2801 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2802 // LLNDK Variant
2803 return true
2804 }
2805
2806 if c.Properties.IsSdkVariant {
2807 // NDK Variant
2808 return true
2809 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002810 }
2811
2812 return false
2813}
2814
Colin Cross1e676be2016-10-12 14:38:15 -07002815func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002816 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002817 return
2818 }
2819
Colin Cross37047f12016-12-13 17:06:13 -08002820 ctx := &depsContext{
2821 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002822 moduleContextImpl: moduleContextImpl{
2823 mod: c,
2824 },
2825 }
2826 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002827
Colin Crossc99deeb2016-04-11 15:06:20 -07002828 deps := c.deps(ctx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002829
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002830 apiNdkLibs := []string{}
2831 apiLateNdkLibs := []string{}
2832
Yo Chiang219968c2020-09-22 18:45:04 +08002833 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2834
Dan Albert914449f2016-06-17 16:45:24 -07002835 variantNdkLibs := []string{}
2836 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002837 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002838 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2839 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2840 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002841 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002842
Colin Cross32ec36c2016-12-15 07:39:51 -08002843 for _, lib := range deps.HeaderLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002844 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002845 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002846 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002847 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002848
Spandan Das73bcafc2022-08-18 23:26:00 +00002849 if c.isNDKStubLibrary() {
Jiyong Parkf8fab9b2024-09-02 15:24:15 +09002850 variationExists := actx.OtherModuleDependencyVariantExists(nil, lib)
2851 if variationExists {
2852 actx.AddVariationDependencies(nil, depTag, lib)
2853 } else {
2854 // dependencies to ndk_headers fall here as ndk_headers do not have
2855 // any variants.
2856 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
2857 }
Spandan Dasff665182024-09-11 18:48:44 +00002858 } else if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002859 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002860 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002861 } else {
2862 actx.AddVariationDependencies(nil, depTag, lib)
2863 }
2864 }
2865
Dan Albertf1d14c72020-07-30 14:32:55 -07002866 if c.isNDKStubLibrary() {
2867 // NDK stubs depend on their implementation because the ABI dumps are
2868 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002869
Spandan Das8b08aea2023-03-14 19:29:34 +00002870 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2871 c.ImageVariation(),
2872 blueprint.Variation{Mutator: "link", Variation: "shared"},
2873 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002874 }
2875
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002876 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2877 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2878 c.Target().NativeBridge == android.NativeBridgeDisabled {
2879 actx.AddVariationDependencies(
Jihoon Kang47e91842024-06-19 00:51:16 +00002880 []blueprint.Variation{{Mutator: "image", Variation: android.VendorVariation}},
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002881 llndkHeaderLibTag,
2882 deps.LlndkHeaderLibs...)
2883 }
2884
Jiyong Park5d1598f2019-02-25 22:14:17 +09002885 for _, lib := range deps.WholeStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002886 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002887
Jiyong Park5d1598f2019-02-25 22:14:17 +09002888 actx.AddVariationDependencies([]blueprint.Variation{
2889 {Mutator: "link", Variation: "static"},
2890 }, depTag, lib)
2891 }
2892
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002893 for _, lib := range deps.StaticLibs {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002894 // Some dependencies listed in static_libs might actually be rust_ffi rlib variants.
Colin Cross8acea3e2024-12-12 14:53:30 -08002895 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002896
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002897 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002898 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002899 }
Jiyong Parke3867542020-12-03 17:28:25 +09002900 if inList(lib, deps.ExcludeLibsForApex) {
2901 depTag.excludeInApex = true
2902 }
Dan Willemsen59339a22018-07-22 21:18:45 -07002903 actx.AddVariationDependencies([]blueprint.Variation{
2904 {Mutator: "link", Variation: "static"},
2905 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002906 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002907
Jooyung Han75568392020-03-20 04:29:24 +09002908 // staticUnwinderDep is treated as staticDep for Q apexes
2909 // so that native libraries/binaries are linked with static unwinder
2910 // because Q libc doesn't have unwinder APIs
2911 if deps.StaticUnwinderIfLegacy {
Colin Cross8acea3e2024-12-12 14:53:30 -08002912 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002913 actx.AddVariationDependencies([]blueprint.Variation{
2914 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002915 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002916 }
2917
Jiyong Park7ed9de32018-10-15 22:25:07 +09002918 // shared lib names without the #version suffix
2919 var sharedLibNames []string
2920
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002921 for _, lib := range deps.SharedLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002922 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002923 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002924 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002925 }
Jiyong Parke3867542020-12-03 17:28:25 +09002926 if inList(lib, deps.ExcludeLibsForApex) {
2927 depTag.excludeInApex = true
2928 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002929 if inList(lib, deps.ExcludeLibsForNonApex) {
2930 depTag.excludeInNonApex = true
2931 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002932
Jiyong Park73c54ee2019-10-22 20:31:18 +09002933 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002934 sharedLibNames = append(sharedLibNames, name)
2935
Colin Crosse7257d22020-09-24 09:56:18 -07002936 variations := []blueprint.Variation{
2937 {Mutator: "link", Variation: "shared"},
2938 }
Spandan Dasff665182024-09-11 18:48:44 +00002939 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002940 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002941
Colin Crossfe9acfe2021-06-14 16:13:03 -07002942 for _, lib := range deps.LateStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002943 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Colin Crossfe9acfe2021-06-14 16:13:03 -07002944 actx.AddVariationDependencies([]blueprint.Variation{
2945 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002946 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002947 }
2948
Colin Cross3e5e7782022-06-17 22:17:05 +00002949 for _, lib := range deps.UnexportedStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002950 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
Colin Cross3e5e7782022-06-17 22:17:05 +00002951 actx.AddVariationDependencies([]blueprint.Variation{
2952 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002953 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002954 }
2955
Jiyong Park7ed9de32018-10-15 22:25:07 +09002956 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002957 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002958 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2959 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2960 // linking against both the stubs lib and the non-stubs lib at the same time.
2961 continue
2962 }
Colin Cross8acea3e2024-12-12 14:53:30 -08002963 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002964 variations := []blueprint.Variation{
2965 {Mutator: "link", Variation: "shared"},
2966 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002967 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002968 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002969
Dan Willemsen59339a22018-07-22 21:18:45 -07002970 actx.AddVariationDependencies([]blueprint.Variation{
2971 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002972 }, dataLibDepTag, deps.DataLibs...)
2973
Colin Crossc8caa062021-09-24 16:50:14 -07002974 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2975
Chris Parsons79d66a52020-06-05 17:26:16 -04002976 actx.AddVariationDependencies([]blueprint.Variation{
2977 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002978 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002979
Colin Cross68861832016-07-08 10:41:41 -07002980 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002981
2982 for _, gen := range deps.GeneratedHeaders {
2983 depTag := genHeaderDepTag
2984 if inList(gen, deps.ReexportGeneratedHeaders) {
2985 depTag = genHeaderExportDepTag
2986 }
2987 actx.AddDependency(c, depTag, gen)
2988 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002989
Cole Faust65cb40a2024-10-21 15:41:42 -07002990 for _, gen := range deps.DeviceFirstGeneratedHeaders {
2991 depTag := genHeaderDepTag
2992 actx.AddVariationDependencies(ctx.Config().AndroidFirstDeviceTarget.Variations(), depTag, gen)
2993 }
2994
Dan Albert92fe7402020-07-15 13:33:30 -07002995 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002996 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002997 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002998 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002999 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08003000 }
Colin Crossc465efd2021-06-11 18:00:04 -07003001 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07003002 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09003003 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07003004 }
Dan Willemsena0790e32018-10-12 00:24:23 -07003005 if deps.DynamicLinker != "" {
3006 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07003007 }
Dan Albert914449f2016-06-17 16:45:24 -07003008
3009 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07003010
Colin Cross8acea3e2024-12-12 14:53:30 -08003011 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003012 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003013 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003014 {Mutator: "link", Variation: "shared"},
3015 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003016 actx.AddVariationDependencies([]blueprint.Variation{
3017 {Mutator: "version", Variation: version},
3018 {Mutator: "link", Variation: "shared"},
3019 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07003020
Colin Cross8acea3e2024-12-12 14:53:30 -08003021 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003022 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003023 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003024 {Mutator: "link", Variation: "shared"},
3025 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003026 actx.AddVariationDependencies([]blueprint.Variation{
3027 {Mutator: "version", Variation: version},
3028 {Mutator: "link", Variation: "shared"},
3029 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08003030
Vinh Tran367d89d2023-04-28 11:21:25 -04003031 if len(deps.AidlLibs) > 0 {
3032 actx.AddDependency(
3033 c,
3034 aidlLibraryTag,
3035 deps.AidlLibs...,
3036 )
3037 }
3038
Colin Cross6362e272015-10-29 15:25:03 -07003039}
Colin Cross21b9a242015-03-24 14:15:58 -07003040
Colin Crosse40b4ea2018-10-02 22:25:58 -07003041func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07003042 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07003043 c.beginMutator(ctx)
3044 }
3045}
3046
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003047// Whether a module can link to another module, taking into
3048// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09003049func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07003050 tag blueprint.DependencyTag) {
3051
3052 switch t := tag.(type) {
3053 case dependencyTag:
3054 if t != vndkExtDepTag {
3055 return
3056 }
3057 case libraryDependencyTag:
3058 default:
3059 return
3060 }
3061
Ivan Lozanof9e21722020-12-02 09:00:51 -05003062 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003063 // Host code is not restricted
3064 return
3065 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003066
Ivan Lozano52767be2019-10-18 14:49:46 -07003067 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003068 // Platform code can link to anything
3069 return
3070 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08003071 if from.InRamdisk() {
3072 // Ramdisk code is not NDK
3073 return
3074 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003075 if from.InVendorRamdisk() {
3076 // Vendor ramdisk code is not NDK
3077 return
3078 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003079 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09003080 // Recovery code is not NDK
3081 return
3082 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003083 // Change this to LinkableInterface if Rust gets NDK support, which stubDecorators are for
Colin Cross31076b32020-10-23 17:22:06 -07003084 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07003085 if c.StubDecorator() {
3086 // These aren't real libraries, but are the stub shared libraries that are included in
3087 // the NDK.
3088 return
3089 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003090 }
Logan Chien834b9a62019-01-14 15:39:03 +08003091
Ivan Lozano52767be2019-10-18 14:49:46 -07003092 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08003093 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
3094 // to link to libc++ (non-NDK and without sdk_version).
3095 return
3096 }
3097
Ivan Lozano52767be2019-10-18 14:49:46 -07003098 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003099 // NDK code linking to platform code is never okay.
3100 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003101 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08003102 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003103 }
3104
3105 // At this point we know we have two NDK libraries, but we need to
3106 // check that we're not linking against anything built against a higher
3107 // API level, as it is only valid to link against older or equivalent
3108 // APIs.
3109
Inseob Kim01a28722018-04-11 09:48:45 +09003110 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07003111 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003112 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07003113 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003114 // Current can't be linked against by anything else.
3115 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003116 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09003117 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003118 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003119 if err != nil {
3120 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003121 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003122 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003123 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003124 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003125 if err != nil {
3126 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003127 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003128 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003129 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003130
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003131 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09003132 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003133 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003134 }
3135 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003136 }
Dan Albert202fe492017-12-15 13:56:59 -08003137
3138 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07003139 fromStl := from.SelectedStl()
3140 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08003141 if fromStl == "" || toStl == "" {
3142 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09003143 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08003144 // We can be permissive with the system "STL" since it is only the C++
3145 // ABI layer, but in the future we should make sure that everyone is
3146 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07003147 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08003148 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003149 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
3150 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08003151 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003152}
3153
Jooyung Han479ca172020-10-19 18:51:07 +09003154func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
3155 if c, ok := ctx.Module().(*Module); ok {
3156 ctx.VisitDirectDeps(func(dep android.Module) {
3157 depTag := ctx.OtherModuleDependencyTag(dep)
3158 ccDep, ok := dep.(LinkableInterface)
3159 if ok {
3160 checkLinkType(ctx, c, ccDep, depTag)
3161 }
3162 })
3163 }
3164}
3165
Jiyong Park5fb8c102018-04-09 12:03:06 +09003166// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09003167// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
3168// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003169// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Colin Crossda279cf2024-09-17 14:25:45 -07003170func checkDoubleLoadableLibraries(ctx android.BottomUpMutatorContext) {
Jooyung Hana70f0672019-01-18 15:20:43 +09003171 check := func(child, parent android.Module) bool {
3172 to, ok := child.(*Module)
3173 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09003174 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09003175 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003176
Jooyung Hana70f0672019-01-18 15:20:43 +09003177 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
3178 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09003179 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003180
Jiyong Park0474e1f2021-01-14 14:26:06 +09003181 // These dependencies are not excercised at runtime. Tracking these will give us
3182 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09003183 depTag := ctx.OtherModuleDependencyTag(child)
3184 if IsHeaderDepTag(depTag) {
3185 return false
3186 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09003187 if depTag == staticVariantTag {
3188 return false
3189 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003190 if depTag == StubImplDepTag {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003191 return false
3192 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003193 if depTag == android.RequiredDepTag {
3194 return false
3195 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003196
Justin Yun63e9ec72020-10-29 16:49:43 +09003197 // Even if target lib has no vendor variant, keep checking dependency
3198 // graph in case it depends on vendor_available or product_available
3199 // but not double_loadable transtively.
3200 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003201 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003202 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003203
Jiyong Park0474e1f2021-01-14 14:26:06 +09003204 // The happy path. Keep tracking dependencies until we hit a non double-loadable
3205 // one.
3206 if Bool(to.VendorProperties.Double_loadable) {
3207 return true
3208 }
3209
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09003210 if to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003211 return false
3212 }
3213
Jooyung Hana70f0672019-01-18 15:20:43 +09003214 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3215 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003216 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003217 return false
3218 }
3219 if module, ok := ctx.Module().(*Module); ok {
3220 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003221 if lib.HasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003222 ctx.WalkDeps(check)
3223 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003224 }
3225 }
3226}
3227
Yu Liue4312402023-01-18 09:15:31 -08003228func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3229 // For the dependency from platform to apex, use the latest stubs
3230 apexSdkVersion := android.FutureApiLevel
3231 if !apexInfo.IsForPlatform() {
3232 apexSdkVersion = apexInfo.MinSdkVersion
3233 }
3234
3235 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3236 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3237 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3238 // (b/144430859)
3239 apexSdkVersion = android.FutureApiLevel
3240 }
3241
3242 return apexSdkVersion
3243}
3244
Colin Crossc99deeb2016-04-11 15:06:20 -07003245// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003246func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003247 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003248
Colin Cross0de8a1e2020-09-18 14:15:30 -07003249 var directStaticDeps []StaticLibraryInfo
3250 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003251
Colin Cross0de8a1e2020-09-18 14:15:30 -07003252 reexportExporter := func(exporter FlagExporterInfo) {
3253 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3254 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3255 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3256 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3257 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003258 }
3259
Colin Crossff694a82023-12-13 15:54:49 -08003260 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003261 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003262
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003263 skipModuleList := map[string]bool{}
3264
Yu Liu8024b922024-12-20 23:31:32 +00003265 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003266 depName := ctx.OtherModuleName(dep)
3267 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003268
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003269 if _, ok := skipModuleList[depName]; ok {
3270 // skip this module because original module or API imported module matching with this should be used instead.
3271 return
3272 }
3273
Yu Liu8024b922024-12-20 23:31:32 +00003274 var ccInfo *CcInfo
3275 v, hasCcInfo := android.OtherModuleProvider(ctx, dep, CcInfoProvider)
3276 if hasCcInfo {
3277 ccInfo = v
3278 }
3279 linkableInfo, hasLinkableInfo := android.OtherModuleProvider(ctx, dep, LinkableInfoProvider)
Dan Willemsen47450072021-10-19 20:24:49 -07003280 if depTag == android.DarwinUniversalVariantTag {
Yu Liu8024b922024-12-20 23:31:32 +00003281 if !hasCcInfo {
3282 panic(fmt.Errorf("dep is not a cc module: %s", dep.String()))
3283 }
3284 depPaths.DarwinSecondArchOutput = linkableInfo.OutputFile
Dan Willemsen47450072021-10-19 20:24:49 -07003285 return
3286 }
3287
Vinh Tran367d89d2023-04-28 11:21:25 -04003288 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003289 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003290 depPaths.AidlLibraryInfos = append(
3291 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003292 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003293 )
3294 }
3295 }
3296
Yu Liu8024b922024-12-20 23:31:32 +00003297 if !hasLinkableInfo {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003298 // handling for a few module types that aren't cc Module but that are also supported
Yu Liu8024b922024-12-20 23:31:32 +00003299 genRule, ok := android.OtherModuleProvider(ctx, dep, android.GeneratedSourceInfoProvider)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003300 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003301 case genSourceDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003302 if ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003303 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
Yu Liu8024b922024-12-20 23:31:32 +00003304 genRule.GeneratedSourceFiles...)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003305 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003306 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003307 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003308 // Support exported headers from a generated_sources dependency
3309 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003310 case genHeaderDepTag, genHeaderExportDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003311 if ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003312 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Yu Liu8024b922024-12-20 23:31:32 +00003313 genRule.GeneratedDeps...)
3314 dirs := genRule.GeneratedHeaderDirs
Inseob Kim69378442019-06-03 19:10:47 +09003315 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003316 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003317 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003318 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
Yu Liu8024b922024-12-20 23:31:32 +00003319 genRule.GeneratedSourceFiles...)
3320 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003321 // 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 +09003322 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003323 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003324 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003325 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003326 }
Colin Crosscef792e2021-06-11 18:01:26 -07003327 case CrtBeginDepTag:
3328 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3329 case CrtEndDepTag:
3330 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003331 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003332 return
3333 }
3334
Colin Crossfe17f6f2019-03-28 19:30:56 -07003335 if depTag == android.ProtoPluginDepTag {
3336 return
3337 }
3338
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003339 if depTag == android.RequiredDepTag {
3340 return
3341 }
3342
Yu Liu8024b922024-12-20 23:31:32 +00003343 commonInfo := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey)
3344 if commonInfo.Target.Os != ctx.Os() {
Steven Morelandaaae81f2024-08-27 22:55:48 +00003345 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 -07003346 return
3347 }
Yu Liu8024b922024-12-20 23:31:32 +00003348 if commonInfo.Target.Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003349 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
Yu Liu8024b922024-12-20 23:31:32 +00003350 ctx.ModuleName(), ctx.Arch().ArchType, depName, commonInfo.Target.Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003351 return
3352 }
3353
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003354 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003355 // Skip reused objects for stub libraries, they use their own stub object file instead.
3356 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3357 // version mutator, so the stubs variant is created from the shared variant that
3358 // already has the reuseObjTag dependency on the static variant.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003359 if !c.library.BuildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003360 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003361 objs := staticAnalogue.ReuseObjects
3362 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003363 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003364 reexportExporter(depExporterInfo)
3365 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003366 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003367 }
3368
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003369 if depTag == llndkHeaderLibTag {
3370 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3371 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3372 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3373 }
3374
Yu Liu8024b922024-12-20 23:31:32 +00003375 linkFile := linkableInfo.OutputFile
Colin Cross6e511a92020-07-27 21:26:48 -07003376
3377 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3378 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003379 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003380 return
3381 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003382
Jiyong Parke3867542020-12-03 17:28:25 +09003383 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3384 return
3385 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003386 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3387 return
3388 }
Jiyong Parke3867542020-12-03 17:28:25 +09003389
Colin Cross313aa542023-12-13 13:47:44 -08003390 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003391
Colin Cross6e511a92020-07-27 21:26:48 -07003392 var ptr *android.Paths
3393 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003394
Colin Cross6e511a92020-07-27 21:26:48 -07003395 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003396
Colin Cross6e511a92020-07-27 21:26:48 -07003397 switch {
3398 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003399 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003400 if !ctx.Config().AllowMissingDependencies() {
3401 ctx.ModuleErrorf("module %q is not a header library", depName)
3402 } else {
3403 ctx.AddMissingDependencies([]string{depName})
3404 }
3405 return
3406 }
Colin Cross6e511a92020-07-27 21:26:48 -07003407 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003408 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003409 if !ctx.Config().AllowMissingDependencies() {
3410 ctx.ModuleErrorf("module %q is not a shared library", depName)
3411 } else {
3412 ctx.AddMissingDependencies([]string{depName})
3413 }
3414 return
3415 }
Jiyong Parke3867542020-12-03 17:28:25 +09003416
Jiyong Park7d55b612021-06-11 17:22:09 +09003417 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3418 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003419
Jiyong Park1ad8e162020-12-01 23:40:09 +09003420 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3421 // linkFile, depFile, and ptr.
3422 if c.IsStubs() {
3423 break
3424 }
3425
Colin Cross0de8a1e2020-09-18 14:15:30 -07003426 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3427 depFile = sharedLibraryInfo.TableOfContents
3428
Colin Crossb614cd42024-10-11 12:52:21 -07003429 if !sharedLibraryInfo.IsStubs {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00003430 // TODO(b/362509506): remove this additional check once all apex_exclude uses are switched to stubs.
3431 if !linkableInfo.RustApexExclude {
3432 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
3433 if info, ok := android.OtherModuleProvider(ctx, dep, ImplementationDepInfoProvider); ok {
3434 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
3435 }
Colin Crossb614cd42024-10-11 12:52:21 -07003436 }
3437 }
3438
Colin Cross6e511a92020-07-27 21:26:48 -07003439 ptr = &depPaths.SharedLibs
3440 switch libDepTag.Order {
3441 case earlyLibraryDependency:
3442 ptr = &depPaths.EarlySharedLibs
3443 depPtr = &depPaths.EarlySharedLibsDeps
3444 case normalLibraryDependency:
3445 ptr = &depPaths.SharedLibs
3446 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003447 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003448 case lateLibraryDependency:
3449 ptr = &depPaths.LateSharedLibs
3450 depPtr = &depPaths.LateSharedLibsDeps
3451 default:
3452 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003453 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003454
Colin Cross6e511a92020-07-27 21:26:48 -07003455 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003456 if linkableInfo.RustLibraryInterface {
3457 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: linkableInfo.CrateName, LinkDirs: linkableInfo.ExportedCrateLinkDirs}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003458 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3459 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3460 if libDepTag.wholeStatic {
3461 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3462 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
Jiyong Park1ad8e162020-12-01 23:40:09 +09003463
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003464 // If whole_static, track this as we want to make sure that in a final linkage for a shared library,
3465 // exported functions from the rust generated staticlib still exported.
3466 if c.CcLibrary() && c.Shared() {
3467 c.WholeRustStaticlib = true
3468 }
Colin Cross6e511a92020-07-27 21:26:48 -07003469 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003470
Colin Cross6e511a92020-07-27 21:26:48 -07003471 } else {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003472 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3473 if !isStaticLib {
3474 if !ctx.Config().AllowMissingDependencies() {
3475 ctx.ModuleErrorf("module %q is not a static library", depName)
3476 } else {
3477 ctx.AddMissingDependencies([]string{depName})
3478 }
3479 return
Inseob Kimeec88e12020-01-22 11:11:29 +09003480 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003481
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003482 // Stubs lib doesn't link to the static lib dependencies. Don't set
3483 // linkFile, depFile, and ptr.
3484 if c.IsStubs() {
3485 break
3486 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003487
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003488 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
3489 if libDepTag.wholeStatic {
3490 ptr = &depPaths.WholeStaticLibs
3491 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3492 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
3493 } else {
3494 // This case normally catches prebuilt static
3495 // libraries, but it can also occur when
3496 // AllowMissingDependencies is on and the
3497 // dependencies has no sources of its own
3498 // but has a whole_static_libs dependency
3499 // on a missing library. We want to depend
3500 // on the .a file so that there is something
3501 // in the dependency tree that contains the
3502 // error rule for the missing transitive
3503 // dependency.
3504 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
3505 }
3506 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3507 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
3508 } else {
3509 switch libDepTag.Order {
3510 case earlyLibraryDependency:
3511 panic(fmt.Errorf("early static libs not supported"))
3512 case normalLibraryDependency:
3513 // static dependencies will be handled separately so they can be ordered
3514 // using transitive dependencies.
3515 ptr = nil
3516 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
3517 case lateLibraryDependency:
3518 ptr = &depPaths.LateStaticLibs
3519 default:
3520 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
3521 }
3522 }
3523
3524 // Collect any exported Rust rlib deps from static libraries which have been included as whole_static_libs
3525 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3526
3527 if libDepTag.unexportedSymbols {
3528 depPaths.LdFlags = append(depPaths.LdFlags,
3529 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3530 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003531 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003532 }
3533
Yu Liu8024b922024-12-20 23:31:32 +00003534 if libDepTag.static() && !libDepTag.wholeStatic && !linkableInfo.RustLibraryInterface {
3535 if !linkableInfo.CcLibraryInterface || !linkableInfo.Static {
Colin Cross6e511a92020-07-27 21:26:48 -07003536 ctx.ModuleErrorf("module %q not a static library", depName)
3537 return
3538 }
Logan Chien43d34c32017-12-20 01:17:32 +08003539
Colin Cross6e511a92020-07-27 21:26:48 -07003540 // When combining coverage files for shared libraries and executables, coverage files
3541 // in static libraries act as if they were whole static libraries. The same goes for
3542 // source based Abi dump files.
Yu Liu8024b922024-12-20 23:31:32 +00003543 if hasCcInfo {
Colin Cross6e511a92020-07-27 21:26:48 -07003544 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003545 linkableInfo.CoverageFiles...)
Colin Cross6e511a92020-07-27 21:26:48 -07003546 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003547 linkableInfo.SAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003548 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003549 // Handle non-CC modules here
3550 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003551 linkableInfo.CoverageFiles...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003552 }
3553 }
3554
Colin Cross6e511a92020-07-27 21:26:48 -07003555 if ptr != nil {
3556 if !linkFile.Valid() {
3557 if !ctx.Config().AllowMissingDependencies() {
3558 ctx.ModuleErrorf("module %q missing output file", depName)
3559 } else {
3560 ctx.AddMissingDependencies([]string{depName})
3561 }
3562 return
3563 }
3564 *ptr = append(*ptr, linkFile.Path())
3565 }
3566
3567 if depPtr != nil {
3568 dep := depFile
3569 if !dep.Valid() {
3570 dep = linkFile
3571 }
3572 *depPtr = append(*depPtr, dep.Path())
3573 }
3574
Colin Cross0de8a1e2020-09-18 14:15:30 -07003575 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3576 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3577 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3578 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003579 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3580
3581 // Only re-export RustRlibDeps for cc static libs
3582 if c.static() {
3583 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3584 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003585
3586 if libDepTag.reexportFlags {
3587 reexportExporter(depExporterInfo)
3588 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3589 // Re-exported shared library headers must be included as well since they can help us with type information
3590 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003591 c.sabi.Properties.ReexportedIncludes = append(
3592 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003593 c.sabi.Properties.ReexportedSystemIncludes = append(
3594 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003595 }
3596
Yu Liu0a37d422025-02-13 02:05:00 +00003597 makeLibName := MakeLibName(ccInfo, linkableInfo, &commonInfo, commonInfo.BaseModuleName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003598 switch {
3599 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003600 c.Properties.AndroidMkHeaderLibs = append(
3601 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003602 case libDepTag.shared():
Colin Cross6e511a92020-07-27 21:26:48 -07003603 // Note: the order of libs in this list is not important because
3604 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003605 c.Properties.AndroidMkSharedLibs = append(
3606 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003607 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003608 if !linkableInfo.RustLibraryInterface {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003609 if libDepTag.wholeStatic {
3610 c.Properties.AndroidMkWholeStaticLibs = append(
3611 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3612 } else {
3613 c.Properties.AndroidMkStaticLibs = append(
3614 c.Properties.AndroidMkStaticLibs, makeLibName)
3615 }
Colin Cross6e511a92020-07-27 21:26:48 -07003616 }
3617 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003618 } else if !c.IsStubs() {
3619 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3620
Colin Cross6e511a92020-07-27 21:26:48 -07003621 switch depTag {
3622 case runtimeDepTag:
3623 c.Properties.AndroidMkRuntimeLibs = append(
Yu Liu0a37d422025-02-13 02:05:00 +00003624 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ccInfo, linkableInfo, &commonInfo,
3625 commonInfo.BaseModuleName)+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003626 case objDepTag:
3627 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3628 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003629 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003630 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003631 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003632 case dynamicLinkerDepTag:
3633 depPaths.DynamicLinker = linkFile
3634 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003635 }
Colin Crossca860ac2016-01-04 14:34:37 -08003636 })
3637
Jeff Gaston294356f2017-09-27 17:05:30 -07003638 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003639 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3640 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3641 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003642
Colin Crossdd84e052017-05-17 13:44:16 -07003643 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003644 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003645 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3646 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003647 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003648 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3649
Jiyong Park74955042019-10-22 20:19:51 +09003650 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3651 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003652 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003653 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003654 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003655 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003656
3657 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003658 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003659 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003660 }
Colin Crossdd84e052017-05-17 13:44:16 -07003661
Colin Crossca860ac2016-01-04 14:34:37 -08003662 return depPaths
3663}
3664
Yu Liuf6f85492025-01-13 21:02:36 +00003665func ShouldUseStubForApex(ctx android.ModuleContext, parent android.Module, dep android.ModuleProxy) bool {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003666 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003667 bootstrap := false
Yu Liuf6f85492025-01-13 21:02:36 +00003668 if ctx.EqualModules(ctx.Module(), parent) {
3669 if linkable, ok := parent.(LinkableInterface); !ok {
3670 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3671 } else {
3672 inVendorOrProduct = linkable.InVendorOrProduct()
3673 bootstrap = linkable.Bootstrap()
3674 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003675 } else {
Yu Liuf6f85492025-01-13 21:02:36 +00003676 if linkable, ok := android.OtherModuleProvider(ctx, parent, LinkableInfoProvider); !ok {
3677 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3678 } else {
3679 inVendorOrProduct = linkable.InVendorOrProduct
3680 bootstrap = linkable.Bootstrap
3681 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003682 }
3683
Spandan Das10c41362024-12-03 01:33:09 +00003684 apexInfo, _ := android.OtherModuleProvider(ctx, parent, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003685
3686 useStubs := false
3687
Yu Liu8024b922024-12-20 23:31:32 +00003688 if android.OtherModuleProviderOrDefault(ctx, dep, LinkableInfoProvider).IsStubs && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003689 if !apexInfo.IsForPlatform() {
3690 // For platform libraries, use current version of LLNDK
3691 // If this is for use_vendor apex we will apply the same rules
3692 // of apex sdk enforcement below to choose right version.
3693 useStubs = true
3694 }
3695 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3696 // If not building for APEX or the containing APEX allows the use of
3697 // platform APIs, use stubs only when it is from an APEX (and not from
3698 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3699 // bootstrap modules, always link to non-stub variant
Yu Liu8024b922024-12-20 23:31:32 +00003700 isNotInPlatform := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey).NotInPlatform
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003701
Spandan Dasff665182024-09-11 18:48:44 +00003702 useStubs = isNotInPlatform && !bootstrap
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003703 } else {
Colin Crossea91a172024-11-05 16:14:05 -08003704 // If building for APEX, always use stubs (can be bypassed by depending on <dep>#impl)
3705 useStubs = true
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003706 }
3707
3708 return useStubs
3709}
3710
3711// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3712// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3713// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3714// has different level of updatability. For example, if a library foo in an APEX depends on a
3715// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3716// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3717// same APEX as foo, the non-stub variant of bar is used.
Yu Liuf6f85492025-01-13 21:02:36 +00003718func ChooseStubOrImpl(ctx android.ModuleContext, dep android.ModuleProxy) (SharedLibraryInfo, FlagExporterInfo) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003719 depTag := ctx.OtherModuleDependencyTag(dep)
3720 libDepTag, ok := depTag.(libraryDependencyTag)
3721 if !ok || !libDepTag.shared() {
3722 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3723 }
3724
Colin Cross313aa542023-12-13 13:47:44 -08003725 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3726 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3727 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003728
3729 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003730 // when to use (unspecified) stubs, use the latest one.
Spandan Das10c41362024-12-03 01:33:09 +00003731 if ShouldUseStubForApex(ctx, ctx.Module(), dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003732 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3733 toUse := stubs[len(stubs)-1]
3734 sharedLibraryInfo = toUse.SharedLibraryInfo
3735 depExporterInfo = toUse.FlagExporterInfo
3736 }
3737 }
3738 return sharedLibraryInfo, depExporterInfo
3739}
3740
Colin Cross0de8a1e2020-09-18 14:15:30 -07003741// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3742// to match the topological order of the dependency tree, including any static analogues of
Colin Crossa14fb6a2024-10-23 16:57:06 -07003743// direct shared libraries. It returns the ordered static dependencies, and a depset.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07003744// of the transitive dependencies.
Colin Crossa14fb6a2024-10-23 16:57:06 -07003745func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive depset.DepSet[android.Path]) {
3746 transitiveStaticLibsBuilder := depset.NewBuilder[android.Path](depset.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003747 var staticPaths android.Paths
3748 for _, staticDep := range staticDeps {
3749 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3750 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3751 }
3752 for _, sharedDep := range sharedDeps {
Colin Crossa14fb6a2024-10-23 16:57:06 -07003753 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003754 }
3755 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3756
3757 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3758
3759 // reorder the dependencies based on transitive dependencies
3760 staticPaths = android.FirstUniquePaths(staticPaths)
3761 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3762
3763 if len(orderedStaticPaths) != len(staticPaths) {
3764 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3765 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3766 }
3767
3768 return orderedStaticPaths, transitiveStaticLibs
3769}
3770
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003771// BaseLibName trims known prefixes and suffixes
3772func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003773 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3774 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003775 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003776 return libName
3777}
3778
Yu Liu8024b922024-12-20 23:31:32 +00003779func MakeLibName(ccInfo *CcInfo, linkableInfo *LinkableInfo, commonInfo *android.CommonModuleInfo, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003780 libName := BaseLibName(depName)
Yu Liu8024b922024-12-20 23:31:32 +00003781 isLLndk := ccInfo != nil && linkableInfo.IsLlndk
3782 nonSystemVariantsExist := linkableInfo.HasNonSystemVariants || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003783
Yu Liu8024b922024-12-20 23:31:32 +00003784 if ccInfo != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003785 // Use base module name for snapshots when exporting to Makefile.
Yu Liu8024b922024-12-20 23:31:32 +00003786 if ccInfo.SnapshotInfo != nil {
Yu Liu0a37d422025-02-13 02:05:00 +00003787 return commonInfo.BaseModuleName + ccInfo.SnapshotInfo.SnapshotAndroidMkSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003788 }
3789 }
3790
Yu Liu8024b922024-12-20 23:31:32 +00003791 if linkableInfo.InVendorOrProduct && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003792 // The vendor and product modules in Make will have been renamed to not conflict with the
3793 // core module, so update the dependency name here accordingly.
Yu Liu8024b922024-12-20 23:31:32 +00003794 return libName + linkableInfo.SubName
3795 } else if linkableInfo.InRamdisk && !linkableInfo.OnlyInRamdisk {
Matthew Maurerc6868382021-07-13 14:12:37 -07003796 return libName + RamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003797 } else if linkableInfo.InVendorRamdisk && !linkableInfo.OnlyInVendorRamdisk {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003798 return libName + VendorRamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003799 } else if linkableInfo.InRecovery && !linkableInfo.OnlyInRecovery {
Matthew Maurer460ee942021-02-11 12:31:46 -08003800 return libName + RecoverySuffix
Yu Liu8024b922024-12-20 23:31:32 +00003801 } else if commonInfo.Target.NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003802 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003803 } else {
3804 return libName
3805 }
3806}
3807
Colin Crossca860ac2016-01-04 14:34:37 -08003808func (c *Module) InstallInData() bool {
3809 if c.installer == nil {
3810 return false
3811 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003812 return c.installer.inData()
3813}
3814
3815func (c *Module) InstallInSanitizerDir() bool {
3816 if c.installer == nil {
3817 return false
3818 }
3819 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003820 return true
3821 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003822 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003823}
3824
Yifan Hong1b3348d2020-01-21 15:53:22 -08003825func (c *Module) InstallInRamdisk() bool {
3826 return c.InRamdisk()
3827}
3828
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003829func (c *Module) InstallInVendorRamdisk() bool {
3830 return c.InVendorRamdisk()
3831}
3832
Jiyong Parkf9332f12018-02-01 00:54:12 +09003833func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003834 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003835}
3836
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003837func (c *Module) MakeUninstallable() {
3838 if c.installer == nil {
3839 c.ModuleBase.MakeUninstallable()
3840 return
3841 }
3842 c.installer.makeUninstallable(c)
3843}
3844
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003845func (c *Module) HostToolPath() android.OptionalPath {
3846 if c.installer == nil {
3847 return android.OptionalPath{}
3848 }
3849 return c.installer.hostToolPath()
3850}
3851
Nan Zhangd4e641b2017-07-12 12:55:28 -07003852func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3853 return c.outputFile
3854}
3855
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003856func (c *Module) static() bool {
3857 if static, ok := c.linker.(interface {
3858 static() bool
3859 }); ok {
3860 return static.static()
3861 }
3862 return false
3863}
3864
Colin Cross6a730042024-12-05 13:53:43 -08003865func (c *Module) staticLibrary() bool {
3866 if static, ok := c.linker.(interface {
3867 staticLibrary() bool
3868 }); ok {
3869 return static.staticLibrary()
3870 }
3871 return false
3872}
3873
Jiyong Park379de2f2018-12-19 02:47:14 +09003874func (c *Module) staticBinary() bool {
3875 if static, ok := c.linker.(interface {
3876 staticBinary() bool
3877 }); ok {
3878 return static.staticBinary()
3879 }
3880 return false
3881}
3882
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003883func (c *Module) testBinary() bool {
3884 if test, ok := c.linker.(interface {
3885 testBinary() bool
3886 }); ok {
3887 return test.testBinary()
3888 }
3889 return false
3890}
3891
Jingwen Chen537242c2022-08-24 11:53:27 +00003892func (c *Module) testLibrary() bool {
3893 if test, ok := c.linker.(interface {
3894 testLibrary() bool
3895 }); ok {
3896 return test.testLibrary()
3897 }
3898 return false
3899}
3900
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003901func (c *Module) benchmarkBinary() bool {
3902 if b, ok := c.linker.(interface {
3903 benchmarkBinary() bool
3904 }); ok {
3905 return b.benchmarkBinary()
3906 }
3907 return false
3908}
3909
3910func (c *Module) fuzzBinary() bool {
3911 if f, ok := c.linker.(interface {
3912 fuzzBinary() bool
3913 }); ok {
3914 return f.fuzzBinary()
3915 }
3916 return false
3917}
3918
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003919// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3920func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003921 if h, ok := c.linker.(interface {
3922 header() bool
3923 }); ok {
3924 return h.header()
3925 }
3926 return false
3927}
3928
Ivan Lozanod7586b62021-04-01 09:49:36 -04003929func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003930 if b, ok := c.linker.(interface {
3931 binary() bool
3932 }); ok {
3933 return b.binary()
3934 }
3935 return false
3936}
3937
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003938func (c *Module) ForceDisableSanitizers() {
3939 c.sanitize.Properties.ForceDisable = true
3940}
3941
Justin Yun5e035862021-06-29 20:50:37 +09003942func (c *Module) StaticExecutable() bool {
3943 if b, ok := c.linker.(*binaryDecorator); ok {
3944 return b.static()
3945 }
3946 return false
3947}
3948
Ivan Lozanod7586b62021-04-01 09:49:36 -04003949func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003950 if o, ok := c.linker.(interface {
3951 object() bool
3952 }); ok {
3953 return o.object()
3954 }
3955 return false
3956}
3957
Kiyoung Kim37693d02024-04-04 09:56:15 +09003958func (m *Module) Dylib() bool {
3959 return false
3960}
3961
3962func (m *Module) Rlib() bool {
3963 return false
3964}
3965
Ivan Lozanof9e21722020-12-02 09:00:51 -05003966func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003967 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003968 if c.IsLlndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003969 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003970 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003971 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003972 return "native:product"
3973 }
Jooyung Han38002912019-05-16 04:01:54 +09003974 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003975 } else if c.InRamdisk() {
3976 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003977 } else if c.InVendorRamdisk() {
3978 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003979 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003980 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003981 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003982 return "native:ndk:none:none"
3983 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3984 //family, link := getNdkStlFamilyAndLinkType(c)
3985 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
3986 } else {
3987 return "native:platform"
3988 }
3989}
3990
Jiyong Park9d452992018-10-03 00:38:19 +09003991// Overrides ApexModule.IsInstallabeToApex()
Colin Cross3a02c7b2024-05-21 13:46:22 -07003992// Only shared/runtime libraries .
Jiyong Park9d452992018-10-03 00:38:19 +09003993func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003994 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003995 // Stub libs and prebuilt libs in a versioned SDK are not
3996 // installable to APEX even though they are shared libs.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003997 return lib.shared() && !lib.BuildStubs()
Jiyong Park9d452992018-10-03 00:38:19 +09003998 }
3999 return false
4000}
4001
Jiyong Parka90ca002019-10-07 15:47:24 +09004002func (c *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +00004003 return android.CheckAvailableForApex(what, c.ApexAvailableFor())
4004}
4005
4006func (c *Module) ApexAvailableFor() []string {
4007 list := c.ApexModuleBase.ApexAvailable()
Jiyong Parka90ca002019-10-07 15:47:24 +09004008 if linker, ok := c.linker.(interface {
Yu Liub73c3a62024-12-10 00:58:06 +00004009 apexAvailable() []string
Jiyong Parka90ca002019-10-07 15:47:24 +09004010 }); ok {
Yu Liub73c3a62024-12-10 00:58:06 +00004011 list = append(list, linker.apexAvailable()...)
Jiyong Parka90ca002019-10-07 15:47:24 +09004012 }
Yu Liub73c3a62024-12-10 00:58:06 +00004013
4014 return android.FirstUniqueStrings(list)
Jiyong Parka90ca002019-10-07 15:47:24 +09004015}
4016
Paul Duffin0cb37b92020-03-04 14:52:46 +00004017func (c *Module) EverInstallable() bool {
4018 return c.installer != nil &&
4019 // Check to see whether the module is actually ever installable.
4020 c.installer.everInstallable()
4021}
4022
Ivan Lozanod7586b62021-04-01 09:49:36 -04004023func (c *Module) PreventInstall() bool {
4024 return c.Properties.PreventInstall
4025}
4026
4027func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07004028 if c.library != nil {
4029 if i := c.library.installable(); i != nil {
4030 return i
4031 }
4032 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04004033 return c.Properties.Installable
4034}
4035
4036func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00004037 ret := c.EverInstallable() &&
4038 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04004039 proptools.BoolDefault(c.Installable(), true) &&
4040 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004041
4042 // The platform variant doesn't need further condition. Apex variants however might not
4043 // be installable because it will likely to be included in the APEX and won't appear
4044 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07004045 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004046 return ret
4047 }
4048
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004049 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09004050}
4051
Logan Chien41eabe62019-04-10 13:33:58 +08004052func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
4053 if c.linker != nil {
4054 if library, ok := c.linker.(*libraryDecorator); ok {
4055 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
4056 }
4057 }
4058}
4059
Jiyong Park45bf82e2020-12-15 22:29:02 +09004060var _ android.ApexModule = (*Module)(nil)
4061
4062// Implements android.ApexModule
Yu Liuf1806032025-02-07 00:23:34 +00004063func (c *Module) GetDepInSameApexChecker() android.DepInSameApexChecker {
4064 return CcDepInSameApexChecker{
4065 Static: c.static(),
4066 HasStubsVariants: c.HasStubsVariants(),
4067 IsLlndk: c.IsLlndk(),
4068 Host: c.Host(),
4069 }
4070}
4071
4072type CcDepInSameApexChecker struct {
4073 Static bool
4074 HasStubsVariants bool
4075 IsLlndk bool
4076 Host bool
4077}
4078
4079func (c CcDepInSameApexChecker) OutgoingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00004080 if depTag == StubImplDepTag {
Colin Crossc1b36442021-05-06 13:42:48 -07004081 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09004082 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09004083 }
Jiyong Park12177fc2021-01-05 14:37:15 +09004084 if depTag == staticVariantTag {
4085 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
4086 // actually mean that the static lib (and its dependencies) are copied into the
4087 // APEX.
4088 return false
4089 }
Colin Cross8acea3e2024-12-12 14:53:30 -08004090
4091 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
Yu Liuf1806032025-02-07 00:23:34 +00004092 if isLibDepTag && c.Static && libDepTag.shared() {
Colin Cross8acea3e2024-12-12 14:53:30 -08004093 // shared_lib dependency from a static lib is considered as crossing
4094 // the APEX boundary because the dependency doesn't actually is
4095 // linked; the dependency is used only during the compilation phase.
4096 return false
4097 }
4098
4099 if isLibDepTag && libDepTag.excludeInApex {
4100 return false
4101 }
4102
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09004103 return true
4104}
4105
Yu Liuf1806032025-02-07 00:23:34 +00004106func (c CcDepInSameApexChecker) IncomingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
4107 if c.Host {
Colin Cross1cea5302024-12-03 16:40:08 -08004108 return false
4109 }
Yu Liuf1806032025-02-07 00:23:34 +00004110 if c.HasStubsVariants {
Colin Crossbd930bc2025-02-03 12:17:42 -08004111 if IsSharedDepTag(depTag) && !IsExplicitImplSharedDepTag(depTag) {
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004112 // dynamic dep to a stubs lib crosses APEX boundary
4113 return false
4114 }
4115 if IsRuntimeDepTag(depTag) {
4116 // runtime dep to a stubs lib also crosses APEX boundary
4117 return false
4118 }
4119 if IsHeaderDepTag(depTag) {
4120 return false
4121 }
4122 }
Yu Liuf1806032025-02-07 00:23:34 +00004123 if c.IsLlndk {
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004124 return false
4125 }
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004126
4127 return true
4128}
4129
Jiyong Park45bf82e2020-12-15 22:29:02 +09004130// Implements android.ApexModule
Yu Liudf0b8392025-02-12 18:27:03 +00004131func (c *Module) MinSdkVersionSupported(ctx android.BaseModuleContext) android.ApiLevel {
Jooyung Han749dc692020-04-15 11:03:39 +09004132 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
4133 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
Yu Liudf0b8392025-02-12 18:27:03 +00004134 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004135 }
Jooyung Han749dc692020-04-15 11:03:39 +09004136 // We don't check for prebuilt modules
4137 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
Yu Liudf0b8392025-02-12 18:27:03 +00004138 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004139 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09004140
Jooyung Han749dc692020-04-15 11:03:39 +09004141 minSdkVersion := c.MinSdkVersion()
4142 if minSdkVersion == "apex_inherit" {
Yu Liudf0b8392025-02-12 18:27:03 +00004143 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004144 }
4145 if minSdkVersion == "" {
4146 // JNI libs within APK-in-APEX fall into here
4147 // Those are okay to set sdk_version instead
4148 // We don't have to check if this is a SDK variant because
4149 // non-SDK variant resets sdk_version, which works too.
4150 minSdkVersion = c.SdkVersion()
4151 }
Yu Liudf0b8392025-02-12 18:27:03 +00004152
Dan Albertc8060532020-07-22 22:32:17 -07004153 if minSdkVersion == "" {
Yu Liudf0b8392025-02-12 18:27:03 +00004154 return android.NoneApiLevel
Dan Albertc8060532020-07-22 22:32:17 -07004155 }
Yu Liudf0b8392025-02-12 18:27:03 +00004156
Dan Albertc8060532020-07-22 22:32:17 -07004157 // Not using nativeApiLevelFromUser because the context here is not
4158 // necessarily a native context.
Yu Liudf0b8392025-02-12 18:27:03 +00004159 ver, err := android.ApiLevelFromUserWithConfig(ctx.Config(), minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09004160 if err != nil {
Yu Liudf0b8392025-02-12 18:27:03 +00004161 return android.NoneApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004162 }
Dan Albertc8060532020-07-22 22:32:17 -07004163
Colin Cross8ca61c12022-10-06 21:00:14 -07004164 // A dependency only needs to support a min_sdk_version at least
4165 // as high as the api level that the architecture was introduced in.
4166 // This allows introducing new architectures in the platform that
4167 // need to be included in apexes that normally require an older
4168 // min_sdk_version.
Yu Liudf0b8392025-02-12 18:27:03 +00004169 if c.Enabled(ctx) {
4170 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
4171 if ver.LessThanOrEqualTo(minApiForArch) {
4172 ver = android.MinApiLevel
4173 }
Colin Cross8ca61c12022-10-06 21:00:14 -07004174 }
4175
Yu Liudf0b8392025-02-12 18:27:03 +00004176 return ver
Jooyung Han749dc692020-04-15 11:03:39 +09004177}
4178
Paul Duffinb5769c12021-05-12 16:16:51 +01004179// Implements android.ApexModule
4180func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4181 // stub libraries and native bridge libraries are always available to platform
4182 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4183}
4184
Inseob Kima1888ce2022-10-04 14:42:02 +09004185func (c *Module) overriddenModules() []string {
4186 if o, ok := c.linker.(overridable); ok {
4187 return o.overriddenModules()
4188 }
4189 return nil
4190}
4191
Liz Kammer35ca77e2021-12-22 15:31:40 -05004192type moduleType int
4193
4194const (
4195 unknownType moduleType = iota
4196 binary
4197 object
4198 fullLibrary
4199 staticLibrary
4200 sharedLibrary
4201 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004202 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004203 ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004204)
4205
4206func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004207 if c.testBinary() {
4208 // testBinary is also a binary, so this comes before the c.Binary()
4209 // conditional. A testBinary has additional implicit dependencies and
4210 // other test-only semantics.
4211 return testBin
4212 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004213 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004214 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004215 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004216 } else if c.testLibrary() {
4217 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4218 // will let them add implicit compile deps on gtest, for example.
4219 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004220 // For now, treat them as regular libraries.
4221 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004222 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004223 static := false
4224 shared := false
4225 if library, ok := c.linker.(*libraryDecorator); ok {
4226 static = library.MutatedProperties.BuildStatic
4227 shared = library.MutatedProperties.BuildShared
4228 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4229 static = library.MutatedProperties.BuildStatic
4230 shared = library.MutatedProperties.BuildShared
4231 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004232 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004233 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004234 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004235 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004236 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004237 return staticLibrary
4238 }
4239 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004240 } else if c.isNDKStubLibrary() {
4241 return ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004242 }
4243 return unknownType
4244}
4245
Colin Crosscfad1192015-11-02 16:43:11 -08004246// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004247type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004248 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004249 android.DefaultsModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004250}
4251
Patrice Arrudac249c712019-03-19 17:00:29 -07004252// cc_defaults provides a set of properties that can be inherited by other cc
4253// modules. A module can use the properties from a cc_defaults using
4254// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4255// merged (when possible) by prepending the default module's values to the
4256// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004257func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004258 return DefaultsFactory()
4259}
4260
Colin Cross36242852017-06-23 15:06:31 -07004261func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004262 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004263
Colin Cross36242852017-06-23 15:06:31 -07004264 module.AddProperties(props...)
4265 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004266 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004267 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004268 &BaseCompilerProperties{},
4269 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004270 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004271 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004272 &StaticProperties{},
4273 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004274 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004275 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004276 &TestLinkerProperties{},
4277 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004278 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004279 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004280 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004281 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004282 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004283 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004284 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004285 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004286 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004287 &SAbiProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004288 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004289 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004290 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004291 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004292 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4293 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004294 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004295 )
Colin Crosscfad1192015-11-02 16:43:11 -08004296
Jooyung Hancc372c52019-09-25 15:18:44 +09004297 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004298
4299 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004300}
4301
Jiyong Park2286afd2020-06-16 21:58:53 +09004302func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004303 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004304}
4305
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004306func kytheExtractAllFactory() android.Singleton {
4307 return &kytheExtractAllSingleton{}
4308}
4309
4310type kytheExtractAllSingleton struct {
4311}
4312
4313func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4314 var xrefTargets android.Paths
Yu Liuec7043d2024-11-05 18:22:20 +00004315 ctx.VisitAllModuleProxies(func(module android.ModuleProxy) {
Yu Liu4f825132024-12-18 00:35:39 +00004316 files := android.OtherModuleProviderOrDefault(ctx, module, CcObjectInfoProvider).KytheFiles
Yu Liuec7043d2024-11-05 18:22:20 +00004317 if len(files) > 0 {
4318 xrefTargets = append(xrefTargets, files...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004319 }
4320 })
4321 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4322 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004323 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004324 }
4325}
4326
Jihoon Kangf78a8902022-09-01 22:47:07 +00004327func (c *Module) Partition() string {
4328 if p, ok := c.installer.(interface {
4329 getPartition() string
4330 }); ok {
4331 return p.getPartition()
4332 }
4333 return ""
4334}
4335
Spandan Das2b6dfb52024-01-19 00:22:22 +00004336type sourceModuleName interface {
4337 sourceModuleName() string
4338}
4339
4340func (c *Module) BaseModuleName() string {
4341 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4342 // if the prebuilt module sets a source_module_name in Android.bp, use that
4343 return smn.sourceModuleName()
4344 }
4345 return c.ModuleBase.BaseModuleName()
4346}
4347
Spandan Dase20c56c2024-07-23 21:34:24 +00004348func (c *Module) stubsSymbolFilePath() android.Path {
4349 if library, ok := c.linker.(*libraryDecorator); ok {
4350 return library.stubsSymbolFilePath
4351 }
4352 return android.OptionalPath{}.Path()
4353}
4354
Colin Cross06a931b2015-10-28 17:23:31 -07004355var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004356var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004357var BoolPtr = proptools.BoolPtr
4358var String = proptools.String
4359var StringPtr = proptools.StringPtr