blob: 4b314cd34ded00845f4444064145aa8b3f4e63f3 [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
Cole Faustd143f3e2025-02-24 16:18:18 -0800757 // Gets a list of files that will be disted when using the dist property without specifying
758 // an output file tag.
759 defaultDistFiles() []android.Path
760
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800761 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000762}
763
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500764// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000765type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500766 sharedLibs []string
767 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
768 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700769 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800770}
771
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500772// installer is the interface for an installer helper object. This helper is responsible for
773// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800774type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700775 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700776 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000777 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800778 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700779 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700780 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900781 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000782 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900783 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800784}
785
Inseob Kima1888ce2022-10-04 14:42:02 +0900786type overridable interface {
787 overriddenModules() []string
788}
789
Colin Cross6e511a92020-07-27 21:26:48 -0700790type libraryDependencyKind int
791
792const (
793 headerLibraryDependency = iota
794 sharedLibraryDependency
795 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400796 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700797)
798
799func (k libraryDependencyKind) String() string {
800 switch k {
801 case headerLibraryDependency:
802 return "headerLibraryDependency"
803 case sharedLibraryDependency:
804 return "sharedLibraryDependency"
805 case staticLibraryDependency:
806 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400807 case rlibLibraryDependency:
808 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700809 default:
810 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
811 }
812}
813
814type libraryDependencyOrder int
815
816const (
817 earlyLibraryDependency = -1
818 normalLibraryDependency = 0
819 lateLibraryDependency = 1
820)
821
822func (o libraryDependencyOrder) String() string {
823 switch o {
824 case earlyLibraryDependency:
825 return "earlyLibraryDependency"
826 case normalLibraryDependency:
827 return "normalLibraryDependency"
828 case lateLibraryDependency:
829 return "lateLibraryDependency"
830 default:
831 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
832 }
833}
834
835// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
836// tags that have a set of predefined tag objects that are reused for each dependency, a
837// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
838// That means that comparing a libraryDependencyTag for equality will only be equal if all
839// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
840// then check individual metadata fields instead.
841type libraryDependencyTag struct {
842 blueprint.BaseDependencyTag
843
844 // These are exported so that fmt.Printf("%#v") can call their String methods.
845 Kind libraryDependencyKind
846 Order libraryDependencyOrder
847
848 wholeStatic bool
849
850 reexportFlags bool
851 explicitlyVersioned bool
Colin Crossbd930bc2025-02-03 12:17:42 -0800852 explicitlyImpl bool
Colin Cross6e511a92020-07-27 21:26:48 -0700853 dataLib bool
854 ndk bool
855
856 staticUnwinder bool
857
858 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900859
Cindy Zhou18417cb2020-12-10 07:12:38 -0800860 // Whether or not this dependency should skip the apex dependency check
861 skipApexAllowedDependenciesCheck bool
862
Jiyong Parke3867542020-12-03 17:28:25 +0900863 // Whether or not this dependency has to be followed for the apex variants
864 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900865 // Whether or not this dependency has to be followed for the non-apex variants
866 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000867
868 // If true, don't automatically export symbols from the static library into a shared library.
869 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700870}
871
872// header returns true if the libraryDependencyTag is tagging a header lib dependency.
873func (d libraryDependencyTag) header() bool {
874 return d.Kind == headerLibraryDependency
875}
876
877// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
878func (d libraryDependencyTag) shared() bool {
879 return d.Kind == sharedLibraryDependency
880}
881
882// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
883func (d libraryDependencyTag) static() bool {
884 return d.Kind == staticLibraryDependency
885}
886
Colin Cross65cb3142021-12-10 23:05:02 +0000887func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
888 if d.shared() {
889 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
890 }
891 return nil
892}
893
894var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
895
Colin Crosse9fe2942020-11-10 18:12:15 -0800896// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
897// binaries or other shared libraries are installed as dependencies.
898func (d libraryDependencyTag) InstallDepNeeded() bool {
899 return d.shared()
900}
901
902var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
903
Yu Liu67a28422024-03-05 00:36:31 +0000904func (d libraryDependencyTag) PropagateAconfigValidation() bool {
905 return d.static()
906}
907
908var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
909
Colin Crosse9fe2942020-11-10 18:12:15 -0800910// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700911// libraryDependencyTag. Each tag object is created globally and reused for multiple
912// dependencies (although since the object contains no references, assigning a tag to a
913// variable and modifying it will not modify the original). Users can compare the tag
914// returned by ctx.OtherModuleDependencyTag against the global original
915type dependencyTag struct {
916 blueprint.BaseDependencyTag
917 name string
918}
919
Colin Crosse9fe2942020-11-10 18:12:15 -0800920// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
921// libraryDependencyTag, but where the dependency needs to be installed when the parent is
922// installed.
923type installDependencyTag struct {
924 blueprint.BaseDependencyTag
925 android.InstallAlwaysNeededDependencyTag
926 name string
927}
928
Colin Crossc99deeb2016-04-11 15:06:20 -0700929var (
Colin Cross6e511a92020-07-27 21:26:48 -0700930 genSourceDepTag = dependencyTag{name: "gen source"}
931 genHeaderDepTag = dependencyTag{name: "gen header"}
932 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
933 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900934 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700935 reuseObjTag = dependencyTag{name: "reuse objects"}
936 staticVariantTag = dependencyTag{name: "static variant"}
937 vndkExtDepTag = dependencyTag{name: "vndk extends"}
938 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700939 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800940 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000941 StubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000942 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500943 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400944 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800945 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700946)
947
Colin Crossbd930bc2025-02-03 12:17:42 -0800948func IsExplicitImplSharedDepTag(depTag blueprint.DependencyTag) bool {
949 ccLibDepTag, ok := depTag.(libraryDependencyTag)
950 return ok && ccLibDepTag.shared() && ccLibDepTag.explicitlyImpl
951}
952
Roland Levillainf89cd092019-07-29 16:22:59 +0100953func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700954 ccLibDepTag, ok := depTag.(libraryDependencyTag)
955 return ok && ccLibDepTag.shared()
956}
957
958func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
959 ccLibDepTag, ok := depTag.(libraryDependencyTag)
960 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100961}
962
Zach Johnson3df4e632020-11-06 11:56:27 -0800963func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
964 ccLibDepTag, ok := depTag.(libraryDependencyTag)
965 return ok && ccLibDepTag.header()
966}
967
Roland Levillainf89cd092019-07-29 16:22:59 +0100968func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800969 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100970}
971
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000972func ExcludeInApexDepTag(depTag blueprint.DependencyTag) bool {
973 ccLibDepTag, ok := depTag.(libraryDependencyTag)
974 return ok && ccLibDepTag.excludeInApex
975}
976
Colin Crossca860ac2016-01-04 14:34:37 -0800977// Module contains the properties and members used by all C/C++ module types, and implements
978// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500979// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
980// interface.
981//
982// To define a C/C++ related module, construct a new Module object and point its delegates to
983// type-specific structs. These delegates will be invoked to register module-specific build
984// statements which may be unique to the module type. For example, module.compiler.compile() should
985// be defined so as to register build statements which are responsible for compiling the module.
986//
987// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
988// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
989// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
990// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800991type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700992 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700993
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700994 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700995 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700996 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700997
Colin Crossca860ac2016-01-04 14:34:37 -0800998 // initialize before calling Init
Yu Liu76d94462024-10-31 23:32:36 +0000999 hod android.HostOrDeviceSupported
1000 multilib android.Multilib
1001 testModule bool
1002 incremental bool
Colin Crossc472d572015-03-17 15:06:21 -07001003
Paul Duffina0843f62019-12-13 19:50:38 +00001004 // Allowable SdkMemberTypes of this module type.
1005 sdkMemberTypes []android.SdkMemberType
1006
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001007 // decorator delegates, initialize before calling Init
1008 // these may contain module-specific implementations, and effectively allow for custom
1009 // type-specific logic. These members may reference different objects or the same object.
1010 // Functions of these decorators will be invoked to initialize and register type-specific
1011 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -08001012 generators []Generator
1013 compiler compiler
1014 linker linker
1015 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001016
Spandan Dase12d2522023-09-12 21:42:31 +00001017 features []feature
1018 stl *stl
1019 sanitize *sanitize
1020 coverage *coverage
1021 fuzzer *fuzzer
1022 sabi *sabi
Spandan Dase12d2522023-09-12 21:42:31 +00001023 lto *lto
1024 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001025 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -08001026
Colin Cross31076b32020-10-23 17:22:06 -07001027 library libraryInterface
1028
Colin Cross635c3b02016-05-18 15:37:25 -07001029 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -08001030
Colin Crossb98c8b02016-07-29 13:44:28 -07001031 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -07001032
Yu Liue70976d2024-10-15 20:45:35 +00001033 subAndroidMkOnce map[subAndroidMkProviderInfoProducer]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001034
1035 // Flags used to compile this module
1036 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -07001037
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001038 // Shared flags among build rules of this module
1039 sharedFlags SharedFlags
1040
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001041 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -07001042 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +09001043
1044 makeLinkType string
Jooyung Han75568392020-03-20 04:29:24 +09001045
1046 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -07001047 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07001048
1049 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -08001050
Inseob Kim37e0bb02024-04-29 15:54:44 +09001051 logtagsPaths android.Paths
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001052
1053 WholeRustStaticlib bool
Cole Faust96a692b2024-08-08 14:47:51 -07001054
1055 hasAidl bool
1056 hasLex bool
1057 hasProto bool
1058 hasRenderscript bool
1059 hasSysprop bool
1060 hasWinMsg bool
1061 hasYacc bool
Yu Liu76d94462024-10-31 23:32:36 +00001062
1063 makeVarsInfo *CcMakeVarsInfo
Colin Crossc472d572015-03-17 15:06:21 -07001064}
1065
Yu Liu76d94462024-10-31 23:32:36 +00001066func (c *Module) IncrementalSupported() bool {
1067 return c.incremental
1068}
1069
1070var _ blueprint.Incremental = (*Module)(nil)
1071
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001072func (c *Module) AddJSONData(d *map[string]interface{}) {
1073 c.AndroidModuleBase().AddJSONData(d)
1074 (*d)["Cc"] = map[string]interface{}{
1075 "SdkVersion": c.SdkVersion(),
1076 "MinSdkVersion": c.MinSdkVersion(),
1077 "VndkVersion": c.VndkVersion(),
1078 "ProductSpecific": c.ProductSpecific(),
1079 "SocSpecific": c.SocSpecific(),
1080 "DeviceSpecific": c.DeviceSpecific(),
1081 "InProduct": c.InProduct(),
1082 "InVendor": c.InVendor(),
1083 "InRamdisk": c.InRamdisk(),
1084 "InVendorRamdisk": c.InVendorRamdisk(),
1085 "InRecovery": c.InRecovery(),
1086 "VendorAvailable": c.VendorAvailable(),
1087 "ProductAvailable": c.ProductAvailable(),
1088 "RamdiskAvailable": c.RamdiskAvailable(),
1089 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
1090 "RecoveryAvailable": c.RecoveryAvailable(),
1091 "OdmAvailable": c.OdmAvailable(),
1092 "InstallInData": c.InstallInData(),
1093 "InstallInRamdisk": c.InstallInRamdisk(),
1094 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
1095 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
1096 "InstallInRecovery": c.InstallInRecovery(),
1097 "InstallInRoot": c.InstallInRoot(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001098 "IsLlndk": c.IsLlndk(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001099 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
1100 "ApexSdkVersion": c.apexSdkVersion,
Cole Faust96a692b2024-08-08 14:47:51 -07001101 "AidlSrcs": c.hasAidl,
1102 "LexSrcs": c.hasLex,
1103 "ProtoSrcs": c.hasProto,
1104 "RenderscriptSrcs": c.hasRenderscript,
1105 "SyspropSrcs": c.hasSysprop,
1106 "WinMsgSrcs": c.hasWinMsg,
1107 "YaccSrsc": c.hasYacc,
1108 "OnlyCSrcs": !(c.hasAidl || c.hasLex || c.hasProto || c.hasRenderscript || c.hasSysprop || c.hasWinMsg || c.hasYacc),
Yi Kong5786f5c2024-05-28 02:22:34 +09001109 "OptimizeForSize": c.OptimizeForSize(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001110 }
1111}
1112
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001113func (c *Module) SetPreventInstall() {
1114 c.Properties.PreventInstall = true
1115}
1116
1117func (c *Module) SetHideFromMake() {
1118 c.Properties.HideFromMake = true
1119}
1120
Ivan Lozanod7586b62021-04-01 09:49:36 -04001121func (c *Module) HiddenFromMake() bool {
1122 return c.Properties.HideFromMake
1123}
1124
Cole Fauste8a87832024-09-11 11:35:46 -07001125func (c *Module) RequiredModuleNames(ctx android.ConfigurableEvaluatorContext) []string {
Cole Faust43ddd082024-06-17 12:32:40 -07001126 required := android.CopyOf(c.ModuleBase.RequiredModuleNames(ctx))
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001127 if c.ImageVariation().Variation == android.CoreVariation {
1128 required = append(required, c.Properties.Target.Platform.Required...)
1129 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1130 } else if c.InRecovery() {
1131 required = append(required, c.Properties.Target.Recovery.Required...)
1132 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1133 }
1134 return android.FirstUniqueStrings(required)
1135}
1136
Ivan Lozano52767be2019-10-18 14:49:46 -07001137func (c *Module) Toc() android.OptionalPath {
1138 if c.linker != nil {
1139 if library, ok := c.linker.(libraryInterface); ok {
1140 return library.toc()
1141 }
1142 }
1143 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1144}
1145
1146func (c *Module) ApiLevel() string {
1147 if c.linker != nil {
1148 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001149 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001150 }
1151 }
1152 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1153}
1154
1155func (c *Module) Static() bool {
1156 if c.linker != nil {
1157 if library, ok := c.linker.(libraryInterface); ok {
1158 return library.static()
1159 }
1160 }
1161 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1162}
1163
1164func (c *Module) Shared() bool {
1165 if c.linker != nil {
1166 if library, ok := c.linker.(libraryInterface); ok {
1167 return library.shared()
1168 }
1169 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001170
Ivan Lozano52767be2019-10-18 14:49:46 -07001171 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1172}
1173
1174func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001175 if c.stl != nil {
1176 return c.stl.Properties.SelectedStl
1177 }
1178 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001179}
1180
Ivan Lozano52767be2019-10-18 14:49:46 -07001181func (c *Module) StubDecorator() bool {
1182 if _, ok := c.linker.(*stubDecorator); ok {
1183 return true
1184 }
1185 return false
1186}
1187
Yi Kong5786f5c2024-05-28 02:22:34 +09001188func (c *Module) OptimizeForSize() bool {
1189 return Bool(c.Properties.Optimize_for_size)
1190}
1191
Ivan Lozano52767be2019-10-18 14:49:46 -07001192func (c *Module) SdkVersion() string {
1193 return String(c.Properties.Sdk_version)
1194}
1195
Artur Satayev480e25b2020-04-27 18:53:18 +01001196func (c *Module) MinSdkVersion() string {
1197 return String(c.Properties.Min_sdk_version)
1198}
1199
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001200func (c *Module) SetSdkVersion(s string) {
1201 c.Properties.Sdk_version = StringPtr(s)
1202}
1203
1204func (c *Module) SetMinSdkVersion(s string) {
1205 c.Properties.Min_sdk_version = StringPtr(s)
1206}
1207
1208func (c *Module) SetStl(s string) {
1209 if c.stl != nil {
1210 c.stl.Properties.Stl = StringPtr(s)
1211 }
1212}
1213
1214func (c *Module) IsCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001215 if linker, ok := c.linker.(*objectLinker); ok {
1216 return linker.isCrt()
1217 }
1218 return false
1219}
1220
Jiyong Park5df7bd32021-08-25 16:18:46 +09001221func (c *Module) SplitPerApiLevel() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001222 return CanUseSdk(c) && c.IsCrt()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001223}
1224
Colin Crossc511bc52020-04-07 16:50:32 +00001225func (c *Module) AlwaysSdk() bool {
1226 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1227}
1228
Ivan Lozano183a3212019-10-18 14:18:45 -07001229func (c *Module) CcLibrary() bool {
1230 if c.linker != nil {
1231 if _, ok := c.linker.(*libraryDecorator); ok {
1232 return true
1233 }
Colin Crossd48fe732020-09-23 20:37:24 -07001234 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1235 return true
1236 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001237 }
1238 return false
1239}
1240
1241func (c *Module) CcLibraryInterface() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001242 if c.library != nil {
Ivan Lozano183a3212019-10-18 14:18:45 -07001243 return true
1244 }
1245 return false
1246}
1247
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001248func (c *Module) RlibStd() bool {
1249 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1250}
1251
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001252func (c *Module) RustLibraryInterface() bool {
1253 return false
1254}
1255
Ivan Lozano0a468a42024-05-13 21:03:34 -04001256func (c *Module) CrateName() string {
1257 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1258}
1259
1260func (c *Module) ExportedCrateLinkDirs() []string {
1261 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1262}
1263
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001264func (c *Module) IsFuzzModule() bool {
1265 if _, ok := c.compiler.(*fuzzBinary); ok {
1266 return true
1267 }
1268 return false
1269}
1270
1271func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1272 return c.FuzzModule
1273}
1274
1275func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1276 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1277 return fuzzer.fuzzPackagedModule
1278 }
1279 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1280}
1281
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001282func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001283 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1284 return fuzzer.sharedLibraries
1285 }
1286 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1287}
1288
Ivan Lozano2b262972019-11-21 12:30:50 -08001289func (c *Module) NonCcVariants() bool {
1290 return false
1291}
1292
Ivan Lozano183a3212019-10-18 14:18:45 -07001293func (c *Module) SetStatic() {
1294 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001295 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001296 library.setStatic()
1297 return
1298 }
1299 }
1300 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1301}
1302
1303func (c *Module) SetShared() {
1304 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001305 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001306 library.setShared()
1307 return
1308 }
1309 }
1310 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1311}
1312
1313func (c *Module) BuildStaticVariant() bool {
1314 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001315 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001316 return library.buildStatic()
1317 }
1318 }
1319 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1320}
1321
1322func (c *Module) BuildSharedVariant() bool {
1323 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001324 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001325 return library.buildShared()
1326 }
1327 }
1328 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1329}
1330
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001331func (c *Module) BuildRlibVariant() bool {
1332 // cc modules can never build rlib variants
1333 return false
1334}
1335
Ivan Lozano183a3212019-10-18 14:18:45 -07001336func (c *Module) Module() android.Module {
1337 return c
1338}
1339
Jiyong Parkc20eee32018-09-05 22:36:17 +09001340func (c *Module) OutputFile() android.OptionalPath {
1341 return c.outputFile
1342}
1343
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001344func (c *Module) CoverageFiles() android.Paths {
1345 if c.linker != nil {
1346 if library, ok := c.linker.(libraryInterface); ok {
1347 return library.objs().coverageFiles
1348 }
1349 }
1350 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1351}
1352
Ivan Lozano183a3212019-10-18 14:18:45 -07001353var _ LinkableInterface = (*Module)(nil)
1354
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001355func (c *Module) VersionedInterface() VersionedInterface {
1356 if c.library != nil {
1357 return c.library
1358 }
1359 return nil
1360}
1361
Jiyong Park719b4462019-01-13 00:39:51 +09001362func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001363 if c.linker != nil {
1364 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001365 }
1366 return nil
1367}
1368
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001369func (c *Module) CoverageOutputFile() android.OptionalPath {
1370 if c.linker != nil {
1371 return c.linker.coverageOutputFilePath()
1372 }
1373 return android.OptionalPath{}
1374}
1375
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001376func (c *Module) RelativeInstallPath() string {
1377 if c.installer != nil {
1378 return c.installer.relativeInstallPath()
1379 }
1380 return ""
1381}
1382
Jooyung Han344d5432019-08-23 11:17:39 +09001383func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001384 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001385}
1386
Colin Cross36242852017-06-23 15:06:31 -07001387func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001388 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001389 for _, generator := range c.generators {
1390 c.AddProperties(generator.GeneratorProps()...)
1391 }
Colin Crossca860ac2016-01-04 14:34:37 -08001392 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001393 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001394 }
1395 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001396 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001397 }
1398 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001399 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001400 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001401 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001402 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001403 }
Colin Cross16b23492016-01-06 14:41:07 -08001404 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001405 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001406 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001407 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001408 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001409 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001410 if c.fuzzer != nil {
1411 c.AddProperties(c.fuzzer.props()...)
1412 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001413 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001414 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001415 }
Stephen Craneba090d12017-05-09 15:44:35 -07001416 if c.lto != nil {
1417 c.AddProperties(c.lto.props()...)
1418 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001419 if c.afdo != nil {
1420 c.AddProperties(c.afdo.props()...)
1421 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001422 if c.orderfile != nil {
1423 c.AddProperties(c.orderfile.props()...)
1424 }
Colin Crossca860ac2016-01-04 14:34:37 -08001425 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001426 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001427 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001428 // Allow test-only on libraries that are not cc_test_library
1429 if c.library != nil && !c.testLibrary() {
1430 c.AddProperties(&c.sourceProperties)
1431 }
Colin Crossc472d572015-03-17 15:06:21 -07001432
Colin Cross36242852017-06-23 15:06:31 -07001433 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001434 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001435 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001436
Colin Cross36242852017-06-23 15:06:31 -07001437 return c
Colin Crossc472d572015-03-17 15:06:21 -07001438}
1439
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001440// UseVndk() returns true if this module is built against VNDK.
1441// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001442func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001443 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001444}
1445
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001446func CanUseSdk(c LinkableInterface) bool {
1447 return c.Module().Target().Os == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001448 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001449}
1450
1451func (c *Module) UseSdk() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001452 if CanUseSdk(c) {
Colin Cross1348ce32020-10-01 13:37:16 -07001453 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001454 }
1455 return false
1456}
1457
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001458func (c *Module) isCoverageVariant() bool {
1459 return c.coverage.Properties.IsCoverageVariant
1460}
1461
Colin Cross95f1ca02020-10-29 20:47:22 -07001462func (c *Module) IsNdk(config android.Config) bool {
1463 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001464}
1465
Colin Cross127bb8b2020-12-16 16:46:01 -08001466func (c *Module) IsLlndk() bool {
1467 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001468}
1469
Colin Cross1f3f1302021-04-26 18:37:44 -07001470func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001471 lib := moduleVersionedInterface(m)
1472 return lib != nil && (lib.HasLLNDKStubs() || lib.HasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001473}
1474
Colin Cross5271fea2021-04-27 13:06:04 -07001475func (m *Module) NeedsVendorPublicLibraryVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001476 lib := moduleVersionedInterface(m)
1477 return lib != nil && (lib.HasVendorPublicLibrary())
Colin Cross5271fea2021-04-27 13:06:04 -07001478}
1479
1480// IsVendorPublicLibrary returns true for vendor public libraries.
1481func (c *Module) IsVendorPublicLibrary() bool {
1482 return c.VendorProperties.IsVendorPublicLibrary
1483}
1484
Ivan Lozanof1868af2022-04-12 13:08:36 -04001485func (c *Module) IsVndkPrebuiltLibrary() bool {
1486 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1487 return true
1488 }
1489 return false
1490}
1491
1492func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1493 return c.Properties.SdkAndPlatformVariantVisibleToMake
1494}
1495
Ivan Lozanod7586b62021-04-01 09:49:36 -04001496func (c *Module) HasLlndkStubs() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001497 lib := moduleVersionedInterface(c)
1498 return lib != nil && lib.HasLLNDKStubs()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001499}
1500
1501func (c *Module) StubsVersion() string {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001502 if lib, ok := c.linker.(VersionedInterface); ok {
1503 return lib.StubsVersion()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001504 }
1505 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1506}
1507
Colin Cross127bb8b2020-12-16 16:46:01 -08001508// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1509// and does not set llndk.vendor_available: false.
1510func (c *Module) isImplementationForLLNDKPublic() bool {
1511 library, _ := c.library.(*libraryDecorator)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001512 return library != nil && library.HasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001513 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001514}
1515
Colin Cross3513fb12024-01-24 14:44:47 -08001516func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001517 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001518 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001519 }
1520 return false
1521}
1522
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001523func (c *Module) isOrderfileCompile() bool {
1524 if orderfile := c.orderfile; orderfile != nil {
1525 return orderfile.Properties.OrderfileLoad
1526 }
1527 return false
1528}
1529
Yi Kongc702ebd2022-08-19 16:02:45 +08001530func (c *Module) isCfi() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001531 return c.sanitize.isSanitizerEnabled(cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001532}
1533
Yi Konged79fa32023-06-04 17:15:42 +09001534func (c *Module) isFuzzer() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001535 return c.sanitize.isSanitizerEnabled(Fuzzer)
Yi Konged79fa32023-06-04 17:15:42 +09001536}
1537
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001538func (c *Module) isNDKStubLibrary() bool {
1539 if _, ok := c.compiler.(*stubDecorator); ok {
1540 return true
1541 }
1542 return false
1543}
1544
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001545func (c *Module) SubName() string {
1546 return c.Properties.SubName
1547}
1548
Jiyong Park25fc6a92018-11-18 18:02:45 +09001549func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001550 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001551 return lib.BuildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001552 }
1553 return false
1554}
1555
1556func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001557 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001558 return lib.HasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001559 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001560 return false
1561}
1562
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00001563func (c *Module) RustApexExclude() bool {
1564 return false
1565}
1566
Alan Stokes73feba32022-11-14 12:21:24 +00001567func (c *Module) IsStubsImplementationRequired() bool {
1568 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001569 return lib.IsStubsImplementationRequired()
Alan Stokes73feba32022-11-14 12:21:24 +00001570 }
1571 return false
1572}
1573
Colin Cross0477b422020-10-13 18:43:54 -07001574// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1575// the implementation. If it is an implementation library it returns its own name.
1576func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1577 name := ctx.OtherModuleName(c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001578 if versioned, ok := c.linker.(VersionedInterface); ok {
1579 name = versioned.ImplementationModuleName(name)
Colin Cross0477b422020-10-13 18:43:54 -07001580 }
1581 return name
1582}
1583
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001584// Similar to ImplementationModuleNameByCtx, but uses the Make variant of the module
Martin Stjernholm2856c662020-12-02 15:03:42 +00001585// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1586// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1587// under the premise that the prebuilt module overrides its source counterpart
1588// if it is exposed to Make).
Yu Liu0a37d422025-02-13 02:05:00 +00001589func (c *Module) ImplementationModuleNameForMake() string {
Martin Stjernholm2856c662020-12-02 15:03:42 +00001590 name := c.BaseModuleName()
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001591 if versioned, ok := c.linker.(VersionedInterface); ok {
1592 name = versioned.ImplementationModuleName(name)
Martin Stjernholm2856c662020-12-02 15:03:42 +00001593 }
1594 return name
1595}
1596
Jiyong Park7d55b612021-06-11 17:22:09 +09001597func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001598 return Bool(c.Properties.Bootstrap)
1599}
1600
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001601func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001602 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1603 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1604 return false
1605 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001606 return c.linker != nil && c.linker.nativeCoverage()
1607}
1608
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001609func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001610 if p, ok := c.linker.(SnapshotInterface); ok {
1611 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001612 }
1613 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001614}
1615
Jiyong Parkf1194352019-02-25 11:05:47 +09001616func isBionic(name string) bool {
1617 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001618 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001619 return true
1620 }
1621 return false
1622}
1623
Martin Stjernholm279de572019-09-10 23:18:20 +01001624func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001625 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001626 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001627 }
1628 return isBionic(name)
1629}
1630
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001631func (c *Module) isCfiAssemblySupportEnabled() bool {
1632 return c.sanitize != nil &&
1633 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1634}
1635
Inseob Kim800d1142021-06-14 12:03:51 +09001636func (c *Module) InstallInRoot() bool {
1637 return c.installer != nil && c.installer.installInRoot()
1638}
1639
Colin Crossca860ac2016-01-04 14:34:37 -08001640type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001641 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001642 moduleContextImpl
1643}
1644
Colin Cross37047f12016-12-13 17:06:13 -08001645type depsContext struct {
1646 android.BottomUpMutatorContext
1647 moduleContextImpl
1648}
1649
Colin Crossca860ac2016-01-04 14:34:37 -08001650type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001651 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001652 moduleContextImpl
1653}
1654
1655type moduleContextImpl struct {
1656 mod *Module
1657 ctx BaseModuleContext
1658}
1659
Colin Crossb98c8b02016-07-29 13:44:28 -07001660func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001661 return ctx.mod.toolchain(ctx.ctx)
1662}
1663
1664func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001665 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001666}
1667
1668func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001669 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001670}
1671
Colin Cross6a730042024-12-05 13:53:43 -08001672func (ctx *moduleContextImpl) staticLibrary() bool {
1673 return ctx.mod.staticLibrary()
1674}
1675
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001676func (ctx *moduleContextImpl) testBinary() bool {
1677 return ctx.mod.testBinary()
1678}
1679
Yi Kong56fc1b62022-09-06 16:24:00 +08001680func (ctx *moduleContextImpl) testLibrary() bool {
1681 return ctx.mod.testLibrary()
1682}
1683
Jiyong Park1d1119f2019-07-29 21:27:18 +09001684func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001685 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001686}
1687
Inseob Kim7f283f42020-06-01 21:53:49 +09001688func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001689 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001690}
1691
Inseob Kim1042d292020-06-01 23:23:05 +09001692func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001693 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001694}
1695
Yi Kong5786f5c2024-05-28 02:22:34 +09001696func (ctx *moduleContextImpl) optimizeForSize() bool {
1697 return ctx.mod.OptimizeForSize()
1698}
1699
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001700func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001701 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001702}
1703
1704func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001705 if ctx.ctx.Device() {
Justin Yun732aa6a2018-03-23 17:43:47 +09001706 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001707 }
1708 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001709}
1710
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001711func MinSdkVersion(mod VersionedLinkableInterface, ctxIsForPlatform bool, device bool,
1712 platformSdkVersion string) string {
1713
1714 ver := mod.MinSdkVersion()
1715 if ver == "apex_inherit" && !ctxIsForPlatform {
1716 ver = mod.ApexSdkVersion().String()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001717 }
1718 if ver == "apex_inherit" || ver == "" {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001719 ver = mod.SdkVersion()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001720 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001721
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001722 if device {
Jooyung Hanaa2d3f52024-11-09 02:41:06 +00001723 // When building for vendor/product, use the latest _stable_ API as "current".
1724 // This is passed to clang/aidl compilers so that compiled/generated code works
1725 // with the system.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001726 if (mod.InVendor() || mod.InProduct()) && (ver == "" || ver == "current") {
1727 ver = platformSdkVersion
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001728 }
1729 }
1730
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001731 // For crt objects, the meaning of min_sdk_version is very different from other types of
1732 // module. For them, min_sdk_version defines the oldest version that the build system will
1733 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1734 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1735 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001736 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1737 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1738 // support such an old version. The version is set to the later version in case when the
1739 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1740 // it's for an APEX.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001741 if mod.IsCrt() && !mod.IsSdkVariant() {
1742 if ctxIsForPlatform {
Jiyong Park5df7bd32021-08-25 16:18:46 +09001743 ver = strconv.Itoa(android.FutureApiLevelInt)
1744 } else { // for apex
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001745 ver = mod.ApexSdkVersion().String()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001746 if ver == "" { // in case when min_sdk_version was not set by the APEX
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001747 ver = mod.SdkVersion()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001748 }
1749 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001750 }
1751
Jiyong Parkb35a8192020-08-10 15:59:36 +09001752 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001753 sdkVersionInt, err := strconv.Atoi(mod.SdkVersion())
Jiyong Parkb35a8192020-08-10 15:59:36 +09001754 minSdkVersionInt, err2 := strconv.Atoi(ver)
1755 if err == nil && err2 == nil {
1756 if sdkVersionInt < minSdkVersionInt {
1757 return strconv.Itoa(sdkVersionInt)
1758 }
1759 }
1760 return ver
1761}
1762
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001763func (ctx *moduleContextImpl) minSdkVersion() string {
1764 platformSdkVersion := ""
1765 if ctx.ctx.Device() {
1766 platformSdkVersion = ctx.ctx.Config().PlatformSdkVersion().String()
1767 }
1768 return MinSdkVersion(ctx.mod, CtxIsForPlatform(ctx.ctx), ctx.ctx.Device(), platformSdkVersion)
1769}
1770
Jiyong Parkb35a8192020-08-10 15:59:36 +09001771func (ctx *moduleContextImpl) isSdkVariant() bool {
1772 return ctx.mod.IsSdkVariant()
1773}
1774
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001775func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001776 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001777}
Justin Yun8effde42017-06-23 19:24:43 +09001778
Kiyoung Kimaa394802024-01-08 12:55:45 +09001779func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1780 return ctx.mod.InVendorOrProduct()
1781}
1782
Colin Cross95f1ca02020-10-29 20:47:22 -07001783func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1784 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001785}
1786
Colin Cross127bb8b2020-12-16 16:46:01 -08001787func (ctx *moduleContextImpl) IsLlndk() bool {
1788 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001789}
1790
Colin Cross127bb8b2020-12-16 16:46:01 -08001791func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1792 return ctx.mod.isImplementationForLLNDKPublic()
1793}
1794
Colin Cross3513fb12024-01-24 14:44:47 -08001795func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1796 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001797}
1798
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001799func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1800 return ctx.mod.isOrderfileCompile()
1801}
1802
Yi Kongc702ebd2022-08-19 16:02:45 +08001803func (ctx *moduleContextImpl) isCfi() bool {
1804 return ctx.mod.isCfi()
1805}
1806
Yi Konged79fa32023-06-04 17:15:42 +09001807func (ctx *moduleContextImpl) isFuzzer() bool {
1808 return ctx.mod.isFuzzer()
1809}
1810
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001811func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1812 return ctx.mod.isNDKStubLibrary()
1813}
1814
Colin Cross5271fea2021-04-27 13:06:04 -07001815func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1816 return ctx.mod.IsVendorPublicLibrary()
1817}
1818
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001819func (ctx *moduleContextImpl) selectedStl() string {
1820 if stl := ctx.mod.stl; stl != nil {
1821 return stl.Properties.SelectedStl
1822 }
1823 return ""
1824}
1825
Ivan Lozanobd721262018-11-27 14:33:03 -08001826func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1827 return ctx.mod.linker.useClangLld(actx)
1828}
1829
Colin Crossce75d2c2016-10-06 16:12:58 -07001830func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001831 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001832}
1833
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001834func CtxIsForPlatform(ctx android.BaseModuleContext) bool {
1835 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crossff694a82023-12-13 15:54:49 -08001836 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001837}
1838
Colin Crosse07f2312020-08-13 11:24:56 -07001839func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001840 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1841 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001842}
1843
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001844func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001845 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001846}
1847
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001848func (ctx *moduleContextImpl) nativeCoverage() bool {
1849 return ctx.mod.nativeCoverage()
1850}
1851
Colin Cross95b07f22020-12-16 11:06:50 -08001852func (ctx *moduleContextImpl) isPreventInstall() bool {
1853 return ctx.mod.Properties.PreventInstall
1854}
1855
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001856func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1857 shared := &ctx.mod.sharedFlags
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001858 if shared.FlagsMap == nil {
1859 shared.NumSharedFlags = 0
1860 shared.FlagsMap = make(map[string]string)
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001861 }
1862 return shared
1863}
1864
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001865func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1866 return ctx.mod.isCfiAssemblySupportEnabled()
1867}
1868
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001869func (ctx *moduleContextImpl) notInPlatform() bool {
1870 return ctx.mod.NotInPlatform()
1871}
1872
Yu Liu76d94462024-10-31 23:32:36 +00001873func (ctx *moduleContextImpl) getOrCreateMakeVarsInfo() *CcMakeVarsInfo {
1874 if ctx.mod.makeVarsInfo == nil {
1875 ctx.mod.makeVarsInfo = &CcMakeVarsInfo{}
1876 }
1877 return ctx.mod.makeVarsInfo
1878}
1879
Colin Cross635c3b02016-05-18 15:37:25 -07001880func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001881 return &Module{
1882 hod: hod,
1883 multilib: multilib,
1884 }
1885}
1886
Colin Cross635c3b02016-05-18 15:37:25 -07001887func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001888 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001889 module.features = []feature{
1890 &tidyFeature{},
1891 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001892 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001893 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001894 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001895 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001896 module.sabi = &sabi{}
Stephen Craneba090d12017-05-09 15:44:35 -07001897 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001898 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001899 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001900 return module
1901}
1902
Colin Crossce75d2c2016-10-06 16:12:58 -07001903func (c *Module) Prebuilt() *android.Prebuilt {
1904 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1905 return p.prebuilt()
1906 }
1907 return nil
1908}
1909
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001910func (c *Module) IsPrebuilt() bool {
1911 return c.Prebuilt() != nil
1912}
1913
Colin Crossce75d2c2016-10-06 16:12:58 -07001914func (c *Module) Name() string {
1915 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001916 if p, ok := c.linker.(interface {
1917 Name(string) string
1918 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001919 name = p.Name(name)
1920 }
1921 return name
1922}
1923
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001924func (c *Module) Multilib() string {
1925 return c.Arch().ArchType.Multilib
1926}
1927
1928func (c *Module) ApexSdkVersion() android.ApiLevel {
1929 return c.apexSdkVersion
1930}
1931
Alex Light3d673592019-01-18 14:37:31 -08001932func (c *Module) Symlinks() []string {
1933 if p, ok := c.installer.(interface {
1934 symlinkList() []string
1935 }); ok {
1936 return p.symlinkList()
1937 }
1938 return nil
1939}
1940
Chris Parsons216e10a2020-07-09 17:12:52 -04001941func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001942 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001943 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001944 }); ok {
1945 return p.dataPaths()
1946 }
1947 return nil
1948}
1949
Ivan Lozanof1868af2022-04-12 13:08:36 -04001950func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001951 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1952 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001953 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001954 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001955 if c.ProductSpecific() {
1956 // If the module is product specific with 'product_specific: true',
1957 // do not add a name suffix because it is a base module.
1958 return ""
1959 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001960 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001961 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001962 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001963 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001964 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001965 // add version suffix only if the module is using different vndk version than the
1966 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001967 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001968 }
1969 return nameSuffix
1970}
1971
Ivan Lozanof1868af2022-04-12 13:08:36 -04001972func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1973 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001974
1975 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001976 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001977 }
1978
Colin Cross127bb8b2020-12-16 16:46:01 -08001979 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001980 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001981 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1982 // added for product variant only when we have vendor and product variants with core
1983 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001984 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001985 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001986 subName += vendorPublicLibrarySuffix
1987 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001988 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1989 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001990 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001991 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001992 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001993 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001994 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001995 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001996 subName += RecoverySuffix
1997 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1998 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001999 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04002000 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07002001 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00002002 } else if c.IsStubs() && c.IsSdkVariant() {
2003 // Public API surface (NDK)
2004 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
2005 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09002006 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04002007
2008 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05002009}
2010
Sam Delmerico75dbca22023-04-20 13:13:25 +00002011func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
2012 ctx := &moduleContext{
2013 ModuleContext: actx,
2014 moduleContextImpl: moduleContextImpl{
2015 mod: c,
2016 },
2017 }
2018 ctx.ctx = ctx
2019 return ctx
2020}
2021
Spandan Das20fce2d2023-04-12 17:21:39 +00002022// TODO (b/277651159): Remove this allowlist
2023var (
2024 skipStubLibraryMultipleApexViolation = map[string]bool{
2025 "libclang_rt.asan": true,
2026 "libclang_rt.hwasan": true,
2027 // runtime apex
2028 "libc": true,
2029 "libc_hwasan": true,
2030 "libdl_android": true,
2031 "libm": true,
2032 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00002033 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00002034 // art apex
Martin Stjernholm75598032024-07-12 18:47:26 +01002035 // TODO(b/234351700): Remove this when com.android.art.debug is gone.
Spandan Das20fce2d2023-04-12 17:21:39 +00002036 "libandroidio": true,
2037 "libdexfile": true,
Martin Stjernholm75598032024-07-12 18:47:26 +01002038 "libdexfiled": true, // com.android.art.debug only
Spandan Das20fce2d2023-04-12 17:21:39 +00002039 "libnativebridge": true,
2040 "libnativehelper": true,
2041 "libnativeloader": true,
2042 "libsigchain": true,
2043 }
2044)
2045
2046// Returns true if a stub library could be installed in multiple apexes
2047func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
2048 // If this is not an apex variant, no check necessary
Colin Cross2dcbca62024-11-20 14:55:14 -08002049 if info, ok := android.ModuleProvider(ctx, android.ApexInfoProvider); !ok || info.IsForPlatform() {
Spandan Das20fce2d2023-04-12 17:21:39 +00002050 return false
2051 }
2052 // If this is not a stub library, no check necessary
2053 if !c.HasStubsVariants() {
2054 return false
2055 }
2056 // Skip the allowlist
2057 // Use BaseModuleName so that this matches prebuilts.
2058 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
2059 return false
2060 }
2061
Spandan Das20fce2d2023-04-12 17:21:39 +00002062 // Stub libraries should not have more than one apex_available
Colin Crossaf4c8562024-11-20 15:07:58 -08002063 apexAvailable := android.FirstUniqueStrings(c.ApexAvailable())
2064 if len(apexAvailable) > 1 {
Spandan Das20fce2d2023-04-12 17:21:39 +00002065 return true
2066 }
2067 // Stub libraries should not use the wildcard
Colin Crossaf4c8562024-11-20 15:07:58 -08002068 if apexAvailable[0] == android.AvailableToAnyApex {
Spandan Das20fce2d2023-04-12 17:21:39 +00002069 return true
2070 }
2071 // Default: no violation
2072 return false
2073}
2074
Chris Parsons8d6e4332021-02-22 16:13:50 -05002075func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002076 ctx := moduleContextFromAndroidModuleContext(actx, c)
2077
Inseob Kim37e0bb02024-04-29 15:54:44 +09002078 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
2079 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
2080 Logtags: c.logtagsPaths,
2081 })
2082
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002083 // If Test_only is set on a module in bp file, respect the setting, otherwise
2084 // see if is a known test module type.
2085 testOnly := c.testModule || c.testLibrary()
2086 if c.sourceProperties.Test_only != nil {
2087 testOnly = Bool(c.sourceProperties.Test_only)
2088 }
2089 // Keep before any early returns.
2090 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2091 TestOnly: testOnly,
2092 TopLevelTarget: c.testModule,
2093 })
2094
Ivan Lozanof1868af2022-04-12 13:08:36 -04002095 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002096 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002097 if !apexInfo.IsForPlatform() {
2098 c.hideApexVariantFromMake = true
2099 }
2100
Chris Parsonseefc9e62021-04-02 17:36:47 -04002101 c.makeLinkType = GetMakeLinkType(actx, c)
2102
Colin Crossf18e1102017-11-16 14:33:08 -08002103 deps := c.depsToPaths(ctx)
2104 if ctx.Failed() {
2105 return
2106 }
2107
Joe Onorato37f900c2023-07-18 16:58:16 -07002108 for _, generator := range c.generators {
2109 gen := generator.GeneratorSources(ctx)
2110 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2111 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2112 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2113 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2114 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2115 if len(deps.Objs.objFiles) == 0 {
2116 // If we are reusuing object files (which happens when we're a shared library and we're
2117 // reusing our static variant's object files), then skip adding the actual source files,
2118 // because we already have the object for it.
2119 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2120 }
2121 }
2122
2123 if ctx.Failed() {
2124 return
2125 }
2126
Spandan Das20fce2d2023-04-12 17:21:39 +00002127 if c.stubLibraryMultipleApexViolation(actx) {
2128 actx.PropertyErrorf("apex_available",
2129 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2130 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002131 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2132 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002133 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2134 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002135 }
2136
Colin Crossca860ac2016-01-04 14:34:37 -08002137 flags := Flags{
2138 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002139 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002140 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002141 for _, generator := range c.generators {
2142 flags = generator.GeneratorFlags(ctx, flags, deps)
2143 }
Colin Crossca860ac2016-01-04 14:34:37 -08002144 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002145 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002146 }
2147 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002148 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002149 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002150 if c.stl != nil {
2151 flags = c.stl.flags(ctx, flags)
2152 }
Colin Cross16b23492016-01-06 14:41:07 -08002153 if c.sanitize != nil {
2154 flags = c.sanitize.flags(ctx, flags)
2155 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002156 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002157 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002158 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002159 if c.fuzzer != nil {
2160 flags = c.fuzzer.flags(ctx, flags)
2161 }
Stephen Craneba090d12017-05-09 15:44:35 -07002162 if c.lto != nil {
2163 flags = c.lto.flags(ctx, flags)
2164 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002165 if c.afdo != nil {
2166 flags = c.afdo.flags(ctx, flags)
2167 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002168 if c.orderfile != nil {
2169 flags = c.orderfile.flags(ctx, flags)
2170 }
Colin Crossca860ac2016-01-04 14:34:37 -08002171 for _, feature := range c.features {
2172 flags = feature.flags(ctx, flags)
2173 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002174 if ctx.Failed() {
2175 return
2176 }
2177
Colin Cross4af21ed2019-11-04 09:37:55 -08002178 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2179 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2180 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002181
Colin Cross4af21ed2019-11-04 09:37:55 -08002182 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002183
2184 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002185 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002186 }
2187 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002188 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002189 }
2190
Colin Cross3e5e7782022-06-17 22:17:05 +00002191 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2192
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002193 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002194 // We need access to all the flags seen by a source file.
2195 if c.sabi != nil {
2196 flags = c.sabi.flags(ctx, flags)
2197 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002198
Colin Cross4af21ed2019-11-04 09:37:55 -08002199 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002200
Joe Onorato37f900c2023-07-18 16:58:16 -07002201 for _, generator := range c.generators {
2202 generator.GeneratorBuildActions(ctx, flags, deps)
2203 }
2204
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002205 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002206 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002207 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002208 if ctx.Failed() {
2209 return
2210 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002211 }
2212
Colin Crossca860ac2016-01-04 14:34:37 -08002213 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002214 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002215 if ctx.Failed() {
2216 return
2217 }
Colin Cross635c3b02016-05-18 15:37:25 -07002218 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002219
Chris Parsons94a0bba2021-06-04 15:03:47 -04002220 c.maybeUnhideFromMake()
Colin Crossb614cd42024-10-11 12:52:21 -07002221
2222 android.SetProvider(ctx, ImplementationDepInfoProvider, &ImplementationDepInfo{
2223 ImplementationDeps: depset.New(depset.PREORDER, deps.directImplementationDeps, deps.transitiveImplementationDeps),
2224 })
Colin Crossce75d2c2016-10-06 16:12:58 -07002225 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002226
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002227 if Bool(c.Properties.Cmake_snapshot_supported) {
2228 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2229 }
2230
Chris Parsons94a0bba2021-06-04 15:03:47 -04002231 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002232
2233 if c.linker != nil {
2234 moduleInfoJSON := ctx.ModuleInfoJSON()
2235 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2236 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2237 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2238 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2239 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2240
2241 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2242 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2243 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2244 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2245
2246 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2247 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2248 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2249 moduleInfoJSON.SubName += ".cfi"
2250 }
2251 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2252 moduleInfoJSON.SubName += ".hwasan"
2253 }
2254 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2255 moduleInfoJSON.SubName += ".scs"
2256 }
2257 }
2258 moduleInfoJSON.SubName += c.Properties.SubName
2259
2260 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2261 moduleInfoJSON.Uninstallable = true
2262 }
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002263 }
Wei Lia1aa2972024-06-21 13:08:51 -07002264
2265 buildComplianceMetadataInfo(ctx, c, deps)
mrziwangabdb2932024-06-18 12:43:41 -07002266
Cole Faust96a692b2024-08-08 14:47:51 -07002267 if b, ok := c.compiler.(*baseCompiler); ok {
2268 c.hasAidl = b.hasSrcExt(ctx, ".aidl")
2269 c.hasLex = b.hasSrcExt(ctx, ".l") || b.hasSrcExt(ctx, ".ll")
2270 c.hasProto = b.hasSrcExt(ctx, ".proto")
2271 c.hasRenderscript = b.hasSrcExt(ctx, ".rscript") || b.hasSrcExt(ctx, ".fs")
2272 c.hasSysprop = b.hasSrcExt(ctx, ".sysprop")
2273 c.hasWinMsg = b.hasSrcExt(ctx, ".mc")
2274 c.hasYacc = b.hasSrcExt(ctx, ".y") || b.hasSrcExt(ctx, ".yy")
2275 }
2276
Yu Liuec7043d2024-11-05 18:22:20 +00002277 ccObjectInfo := CcObjectInfo{
Yu Liu4f825132024-12-18 00:35:39 +00002278 KytheFiles: objs.kytheFiles,
Yu Liuec7043d2024-11-05 18:22:20 +00002279 }
2280 if !ctx.Config().KatiEnabled() || !android.ShouldSkipAndroidMkProcessing(ctx, c) {
Yu Liu4f825132024-12-18 00:35:39 +00002281 ccObjectInfo.ObjFiles = objs.objFiles
2282 ccObjectInfo.TidyFiles = objs.tidyFiles
Yu Liuec7043d2024-11-05 18:22:20 +00002283 }
Yu Liu4f825132024-12-18 00:35:39 +00002284 if len(ccObjectInfo.KytheFiles)+len(ccObjectInfo.ObjFiles)+len(ccObjectInfo.TidyFiles) > 0 {
Yu Liuec7043d2024-11-05 18:22:20 +00002285 android.SetProvider(ctx, CcObjectInfoProvider, ccObjectInfo)
2286 }
2287
Yu Liuf6f85492025-01-13 21:02:36 +00002288 linkableInfo := CreateCommonLinkableInfo(ctx, c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002289 if lib, ok := c.linker.(VersionedInterface); ok {
2290 linkableInfo.StubsVersion = lib.StubsVersion()
Yu Liu8024b922024-12-20 23:31:32 +00002291 }
2292 if c.linker != nil {
2293 if library, ok := c.linker.(libraryInterface); ok {
2294 linkableInfo.Static = library.static()
Yu Liu8a8d5b42025-01-07 00:48:08 +00002295 linkableInfo.Shared = library.shared()
Yu Liu8024b922024-12-20 23:31:32 +00002296 linkableInfo.CoverageFiles = library.objs().coverageFiles
2297 linkableInfo.SAbiDumpFiles = library.objs().sAbiDumpFiles
2298 }
2299 }
2300 android.SetProvider(ctx, LinkableInfoProvider, linkableInfo)
Yu Liu986d98c2024-11-12 00:28:11 +00002301
Yu Liu323d77a2024-12-16 23:13:57 +00002302 ccInfo := CcInfo{
Yu Liu323d77a2024-12-16 23:13:57 +00002303 IsPrebuilt: c.IsPrebuilt(),
2304 CmakeSnapshotSupported: proptools.Bool(c.Properties.Cmake_snapshot_supported),
Yu Liu68a70b72025-01-08 22:54:44 +00002305 HasLlndkStubs: c.HasLlndkStubs(),
Yu Liu0a37d422025-02-13 02:05:00 +00002306 DataPaths: c.DataPaths(),
Yu Liu323d77a2024-12-16 23:13:57 +00002307 }
2308 if c.compiler != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002309 cflags := c.compiler.baseCompilerProps().Cflags
Yu Liu323d77a2024-12-16 23:13:57 +00002310 ccInfo.CompilerInfo = &CompilerInfo{
2311 Srcs: c.compiler.(CompiledInterface).Srcs(),
Cole Faustc9b88c92025-02-06 17:58:26 -08002312 Cflags: cflags.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002313 AidlInterfaceInfo: AidlInterfaceInfo{
2314 Sources: c.compiler.baseCompilerProps().AidlInterface.Sources,
2315 AidlRoot: c.compiler.baseCompilerProps().AidlInterface.AidlRoot,
2316 Lang: c.compiler.baseCompilerProps().AidlInterface.Lang,
2317 Flags: c.compiler.baseCompilerProps().AidlInterface.Flags,
2318 },
2319 }
2320 switch decorator := c.compiler.(type) {
2321 case *libraryDecorator:
2322 ccInfo.CompilerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002323 ExportIncludeDirs: decorator.flagExporter.Properties.Export_include_dirs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002324 }
2325 }
2326 }
2327 if c.linker != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002328 baseLinkerProps := c.linker.baseLinkerProps()
Yu Liu323d77a2024-12-16 23:13:57 +00002329 ccInfo.LinkerInfo = &LinkerInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002330 WholeStaticLibs: baseLinkerProps.Whole_static_libs.GetOrDefault(ctx, nil),
2331 StaticLibs: baseLinkerProps.Static_libs.GetOrDefault(ctx, nil),
2332 SharedLibs: baseLinkerProps.Shared_libs.GetOrDefault(ctx, nil),
2333 HeaderLibs: baseLinkerProps.Header_libs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002334 }
2335 switch decorator := c.linker.(type) {
2336 case *binaryDecorator:
2337 ccInfo.LinkerInfo.BinaryDecoratorInfo = &BinaryDecoratorInfo{}
2338 case *libraryDecorator:
Yu Liu116610a2025-01-06 21:54:48 +00002339 ccInfo.LinkerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
2340 InjectBsslHash: Bool(c.linker.(*libraryDecorator).Properties.Inject_bssl_hash),
2341 }
Yu Liu323d77a2024-12-16 23:13:57 +00002342 case *testBinary:
2343 ccInfo.LinkerInfo.TestBinaryInfo = &TestBinaryInfo{
2344 Gtest: decorator.testDecorator.gtest(),
2345 }
2346 case *benchmarkDecorator:
2347 ccInfo.LinkerInfo.BenchmarkDecoratorInfo = &BenchmarkDecoratorInfo{}
2348 case *objectLinker:
2349 ccInfo.LinkerInfo.ObjectLinkerInfo = &ObjectLinkerInfo{}
Yu Liu8a8d5b42025-01-07 00:48:08 +00002350 case *stubDecorator:
2351 ccInfo.LinkerInfo.StubDecoratorInfo = &StubDecoratorInfo{}
Yu Liu323d77a2024-12-16 23:13:57 +00002352 }
Yu Liu8024b922024-12-20 23:31:32 +00002353
2354 if s, ok := c.linker.(SnapshotInterface); ok {
2355 ccInfo.SnapshotInfo = &SnapshotInfo{
2356 SnapshotAndroidMkSuffix: s.SnapshotAndroidMkSuffix(),
2357 }
Yu Liuffe86322024-12-18 18:53:12 +00002358 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002359 if v, ok := c.linker.(VersionedInterface); ok {
2360 name := v.ImplementationModuleName(ctx.OtherModuleName(c))
Yu Liu68a70b72025-01-08 22:54:44 +00002361 ccInfo.LinkerInfo.ImplementationModuleName = &name
2362 }
Yu Liuffe86322024-12-18 18:53:12 +00002363 }
Yu Liu8a8d5b42025-01-07 00:48:08 +00002364 if c.library != nil {
2365 ccInfo.LibraryInfo = &LibraryInfo{
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002366 BuildStubs: c.library.BuildStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002367 }
2368 }
Yu Liu8024b922024-12-20 23:31:32 +00002369 android.SetProvider(ctx, CcInfoProvider, &ccInfo)
Yu Liub1bfa9d2024-12-05 18:57:51 +00002370
mrziwangabdb2932024-06-18 12:43:41 -07002371 c.setOutputFiles(ctx)
Yu Liu76d94462024-10-31 23:32:36 +00002372
2373 if c.makeVarsInfo != nil {
2374 android.SetProvider(ctx, CcMakeVarsInfoProvider, c.makeVarsInfo)
2375 }
mrziwangabdb2932024-06-18 12:43:41 -07002376}
2377
Yu Liuf6f85492025-01-13 21:02:36 +00002378func CreateCommonLinkableInfo(ctx android.ModuleContext, mod VersionedLinkableInterface) *LinkableInfo {
Yu Liu0a37d422025-02-13 02:05:00 +00002379 info := &LinkableInfo{
Yu Liu8024b922024-12-20 23:31:32 +00002380 StaticExecutable: mod.StaticExecutable(),
2381 HasStubsVariants: mod.HasStubsVariants(),
2382 OutputFile: mod.OutputFile(),
2383 UnstrippedOutputFile: mod.UnstrippedOutputFile(),
Yu Liuf6f85492025-01-13 21:02:36 +00002384 CoverageOutputFile: mod.CoverageOutputFile(),
2385 Partition: mod.Partition(),
Yu Liu8024b922024-12-20 23:31:32 +00002386 IsStubs: mod.IsStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002387 CcLibrary: mod.CcLibrary(),
Yu Liu8024b922024-12-20 23:31:32 +00002388 CcLibraryInterface: mod.CcLibraryInterface(),
2389 RustLibraryInterface: mod.RustLibraryInterface(),
Yu Liu8024b922024-12-20 23:31:32 +00002390 IsLlndk: mod.IsLlndk(),
Yu Liuf6f85492025-01-13 21:02:36 +00002391 IsNdk: mod.IsNdk(ctx.Config()),
Yu Liu8024b922024-12-20 23:31:32 +00002392 HasNonSystemVariants: mod.HasNonSystemVariants(),
2393 SubName: mod.SubName(),
2394 InVendorOrProduct: mod.InVendorOrProduct(),
2395 InRamdisk: mod.InRamdisk(),
2396 OnlyInRamdisk: mod.OnlyInRamdisk(),
2397 InVendorRamdisk: mod.InVendorRamdisk(),
2398 OnlyInVendorRamdisk: mod.OnlyInVendorRamdisk(),
2399 InRecovery: mod.InRecovery(),
2400 OnlyInRecovery: mod.OnlyInRecovery(),
Yu Liu367827f2025-02-15 00:18:33 +00002401 InVendor: mod.InVendor(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002402 Installable: mod.Installable(),
Yu Liu97880e12025-01-07 19:03:34 +00002403 RelativeInstallPath: mod.RelativeInstallPath(),
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002404 // TODO(b/362509506): remove this once all apex_exclude uses are switched to stubs.
Yu Liu0a37d422025-02-13 02:05:00 +00002405 RustApexExclude: mod.RustApexExclude(),
2406 Bootstrap: mod.Bootstrap(),
2407 Multilib: mod.Multilib(),
2408 ImplementationModuleNameForMake: mod.ImplementationModuleNameForMake(),
2409 Symlinks: mod.Symlinks(),
Yu Liu8024b922024-12-20 23:31:32 +00002410 }
Yu Liu8024b922024-12-20 23:31:32 +00002411
Yu Liu367827f2025-02-15 00:18:33 +00002412 vi := mod.VersionedInterface()
2413 if vi != nil {
2414 info.IsStubsImplementationRequired = vi.IsStubsImplementationRequired()
2415 info.APIListCoverageXMLPath = vi.GetAPIListCoverageXMLPath()
Yu Liuec7043d2024-11-05 18:22:20 +00002416 }
Yu Liu367827f2025-02-15 00:18:33 +00002417
2418 return info
Yu Liuec7043d2024-11-05 18:22:20 +00002419}
2420
mrziwangabdb2932024-06-18 12:43:41 -07002421func (c *Module) setOutputFiles(ctx ModuleContext) {
2422 if c.outputFile.Valid() {
2423 ctx.SetOutputFiles(android.Paths{c.outputFile.Path()}, "")
2424 } else {
2425 ctx.SetOutputFiles(android.Paths{}, "")
2426 }
2427 if c.linker != nil {
2428 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), "unstripped")
2429 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), "stripped_all")
Cole Faustd143f3e2025-02-24 16:18:18 -08002430 defaultDistFiles := c.linker.defaultDistFiles()
2431 if len(defaultDistFiles) > 0 {
2432 ctx.SetOutputFiles(defaultDistFiles, android.DefaultDistTag)
2433 }
mrziwangabdb2932024-06-18 12:43:41 -07002434 }
Wei Lia1aa2972024-06-21 13:08:51 -07002435}
2436
2437func buildComplianceMetadataInfo(ctx ModuleContext, c *Module, deps PathDeps) {
2438 // Dump metadata that can not be done in android/compliance-metadata.go
2439 complianceMetadataInfo := ctx.ComplianceMetadataInfo()
Wei Li8ede4f72025-01-15 21:24:22 -08002440 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.IS_STATIC_LIB, strconv.FormatBool(ctx.static() || ctx.ModuleType() == "cc_object"))
Wei Lia1aa2972024-06-21 13:08:51 -07002441 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.BUILT_FILES, c.outputFile.String())
2442
2443 // Static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002444 staticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(false))
Wei Lia1aa2972024-06-21 13:08:51 -07002445 staticDepNames := make([]string, 0, len(staticDeps))
2446 for _, dep := range staticDeps {
2447 staticDepNames = append(staticDepNames, dep.Name())
2448 }
Wei Li8ede4f72025-01-15 21:24:22 -08002449 // Process CrtBegin and CrtEnd as static libs
Yu Liu727204c2025-01-23 20:58:32 +00002450 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Wei Li8ede4f72025-01-15 21:24:22 -08002451 depName := ctx.OtherModuleName(dep)
2452 depTag := ctx.OtherModuleDependencyTag(dep)
2453 switch depTag {
2454 case CrtBeginDepTag:
2455 staticDepNames = append(staticDepNames, depName)
2456 case CrtEndDepTag:
2457 staticDepNames = append(staticDepNames, depName)
2458 }
2459 })
Wei Lia1aa2972024-06-21 13:08:51 -07002460
Wei Li8ede4f72025-01-15 21:24:22 -08002461 staticDepPaths := make([]string, 0, len(deps.StaticLibs)+len(deps.CrtBegin)+len(deps.CrtEnd))
Wei Lia1aa2972024-06-21 13:08:51 -07002462 for _, dep := range deps.StaticLibs {
2463 staticDepPaths = append(staticDepPaths, dep.String())
2464 }
Wei Li8ede4f72025-01-15 21:24:22 -08002465 for _, dep := range deps.CrtBegin {
2466 staticDepPaths = append(staticDepPaths, dep.String())
2467 }
2468 for _, dep := range deps.CrtEnd {
2469 staticDepPaths = append(staticDepPaths, dep.String())
2470 }
Wei Lia1aa2972024-06-21 13:08:51 -07002471 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
2472 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEP_FILES, android.FirstUniqueStrings(staticDepPaths))
2473
2474 // Whole static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002475 wholeStaticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(true))
Wei Lia1aa2972024-06-21 13:08:51 -07002476 wholeStaticDepNames := make([]string, 0, len(wholeStaticDeps))
2477 for _, dep := range wholeStaticDeps {
2478 wholeStaticDepNames = append(wholeStaticDepNames, dep.Name())
2479 }
2480
2481 wholeStaticDepPaths := make([]string, 0, len(deps.WholeStaticLibs))
2482 for _, dep := range deps.WholeStaticLibs {
2483 wholeStaticDepPaths = append(wholeStaticDepPaths, dep.String())
2484 }
2485 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEPS, android.FirstUniqueStrings(wholeStaticDepNames))
2486 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEP_FILES, android.FirstUniqueStrings(wholeStaticDepPaths))
Wei Li8ede4f72025-01-15 21:24:22 -08002487
2488 // Header libs
2489 headerLibDeps := ctx.GetDirectDepsProxyWithTag(HeaderDepTag())
2490 headerLibDepNames := make([]string, 0, len(headerLibDeps))
2491 for _, dep := range headerLibDeps {
2492 headerLibDepNames = append(headerLibDepNames, dep.Name())
2493 }
2494 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.HEADER_LIBS, android.FirstUniqueStrings(headerLibDepNames))
Chris Parsons94a0bba2021-06-04 15:03:47 -04002495}
2496
2497func (c *Module) maybeUnhideFromMake() {
2498 // If a lib is directly included in any of the APEXes or is not available to the
2499 // platform (which is often the case when the stub is provided as a prebuilt),
2500 // unhide the stubs variant having the latest version gets visible to make. In
2501 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2502 // force anything in the make world to link against the stubs library. (unless it
2503 // is explicitly referenced via .bootstrap suffix or the module is marked with
2504 // 'bootstrap: true').
2505 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002506 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002507 c.IsStubs() && !c.InVendorRamdisk() {
2508 c.Properties.HideFromMake = false // unhide
2509 // Note: this is still non-installable
2510 }
2511}
2512
Colin Cross8ff10582023-12-07 13:10:56 -08002513// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2514// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002515func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002516 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002517 // If the module has been specifically configure to not be installed then
2518 // hide from make as otherwise it will break when running inside make
2519 // as the output path to install will not be specified. Not all uninstallable
2520 // modules can be hidden from make as some are needed for resolving make side
2521 // dependencies.
2522 c.HideFromMake()
Spandan Das034af2c2024-10-30 21:45:09 +00002523 c.SkipInstall()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002524 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002525 c.SkipInstall()
2526 }
2527
2528 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2529 // to allow using the outputs in a genrule.
2530 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002531 c.installer.install(ctx, c.outputFile.Path())
2532 if ctx.Failed() {
2533 return
Colin Crossca860ac2016-01-04 14:34:37 -08002534 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002535 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002536}
2537
Colin Cross0ea8ba82019-06-06 14:33:29 -07002538func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002539 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002540 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002541 }
Colin Crossca860ac2016-01-04 14:34:37 -08002542 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002543}
2544
Colin Crossca860ac2016-01-04 14:34:37 -08002545func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002546 for _, generator := range c.generators {
2547 generator.GeneratorInit(ctx)
2548 }
Colin Crossca860ac2016-01-04 14:34:37 -08002549 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002550 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002551 }
Colin Crossca860ac2016-01-04 14:34:37 -08002552 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002553 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002554 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002555 if c.stl != nil {
2556 c.stl.begin(ctx)
2557 }
Colin Cross16b23492016-01-06 14:41:07 -08002558 if c.sanitize != nil {
2559 c.sanitize.begin(ctx)
2560 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002561 if c.coverage != nil {
2562 c.coverage.begin(ctx)
2563 }
Yi Kong9723e332023-12-04 14:52:53 +09002564 if c.afdo != nil {
2565 c.afdo.begin(ctx)
2566 }
Stephen Craneba090d12017-05-09 15:44:35 -07002567 if c.lto != nil {
2568 c.lto.begin(ctx)
2569 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002570 if c.orderfile != nil {
2571 c.orderfile.begin(ctx)
2572 }
Dan Albert92fe7402020-07-15 13:33:30 -07002573 if ctx.useSdk() && c.IsSdkVariant() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002574 version, err := NativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002575 if err != nil {
2576 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002577 c.Properties.Sdk_version = nil
2578 } else {
2579 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002580 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002581 }
Colin Crossca860ac2016-01-04 14:34:37 -08002582}
2583
Colin Cross37047f12016-12-13 17:06:13 -08002584func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002585 deps := Deps{}
2586
Joe Onorato37f900c2023-07-18 16:58:16 -07002587 for _, generator := range c.generators {
2588 deps = generator.GeneratorDeps(ctx, deps)
2589 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002590 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002591 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002592 }
2593 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002594 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002595 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002596 if c.stl != nil {
2597 deps = c.stl.deps(ctx, deps)
2598 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002599 if c.coverage != nil {
2600 deps = c.coverage.deps(ctx, deps)
2601 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002602
Colin Crossb6715442017-10-24 11:13:31 -07002603 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2604 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2605 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2606 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2607 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2608 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002609 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002610 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002611
Colin Cross516c5452024-10-28 13:45:21 -07002612 if err := checkConflictingExplicitVersions(deps.SharedLibs); err != nil {
2613 ctx.PropertyErrorf("shared_libs", "%s", err.Error())
2614 }
2615
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002616 for _, lib := range deps.ReexportSharedLibHeaders {
2617 if !inList(lib, deps.SharedLibs) {
2618 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2619 }
2620 }
2621
2622 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002623 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2624 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 -07002625 }
2626 }
2627
Colin Cross5950f382016-12-13 12:50:57 -08002628 for _, lib := range deps.ReexportHeaderLibHeaders {
2629 if !inList(lib, deps.HeaderLibs) {
2630 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2631 }
2632 }
2633
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002634 for _, gen := range deps.ReexportGeneratedHeaders {
2635 if !inList(gen, deps.GeneratedHeaders) {
2636 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2637 }
2638 }
2639
Colin Crossc99deeb2016-04-11 15:06:20 -07002640 return deps
2641}
2642
Colin Cross516c5452024-10-28 13:45:21 -07002643func checkConflictingExplicitVersions(libs []string) error {
2644 withoutVersion := func(s string) string {
2645 name, _ := StubsLibNameAndVersion(s)
2646 return name
2647 }
2648 var errs []error
2649 for i, lib := range libs {
2650 libName := withoutVersion(lib)
2651 libsToCompare := libs[i+1:]
2652 j := slices.IndexFunc(libsToCompare, func(s string) bool {
2653 return withoutVersion(s) == libName
2654 })
2655 if j >= 0 {
2656 errs = append(errs, fmt.Errorf("duplicate shared libraries with different explicit versions: %q and %q",
2657 lib, libsToCompare[j]))
2658 }
2659 }
2660 return errors.Join(errs...)
2661}
2662
Dan Albert7e9d2952016-08-04 13:02:36 -07002663func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002664 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002665 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002666 moduleContextImpl: moduleContextImpl{
2667 mod: c,
2668 },
2669 }
2670 ctx.ctx = ctx
2671
Colin Crossca860ac2016-01-04 14:34:37 -08002672 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002673}
2674
Jiyong Park7ed9de32018-10-15 22:25:07 +09002675// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002676func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002677 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2678 version := name[sharp+1:]
2679 libname := name[:sharp]
2680 return libname, version
2681 }
2682 return name, ""
2683}
2684
Dan Albert92fe7402020-07-15 13:33:30 -07002685func GetCrtVariations(ctx android.BottomUpMutatorContext,
2686 m LinkableInterface) []blueprint.Variation {
2687 if ctx.Os() != android.Android {
2688 return nil
2689 }
2690 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002691 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2692 minSdkVersion := m.MinSdkVersion()
2693 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2694 minSdkVersion = m.SdkVersion()
2695 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002696 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2697 if err != nil {
2698 ctx.PropertyErrorf("min_sdk_version", err.Error())
2699 }
Colin Cross363ec762023-01-13 13:45:14 -08002700
2701 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002702 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002703 if apiLevel.LessThan(minApiForArch) {
2704 apiLevel = minApiForArch
2705 }
2706
Dan Albert92fe7402020-07-15 13:33:30 -07002707 return []blueprint.Variation{
2708 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002709 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002710 }
2711 }
2712 return []blueprint.Variation{
2713 {Mutator: "sdk", Variation: ""},
2714 }
2715}
2716
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002717func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2718 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002719
2720 variations = append([]blueprint.Variation(nil), variations...)
2721
Liz Kammer23942242022-04-08 15:41:00 -04002722 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002723 // Version is explicitly specified. i.e. libFoo#30
Colin Crossb614cd42024-10-11 12:52:21 -07002724 if version == "impl" {
2725 version = ""
2726 }
Colin Crosse7257d22020-09-24 09:56:18 -07002727 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002728 if tag, ok := depTag.(libraryDependencyTag); ok {
2729 tag.explicitlyVersioned = true
Colin Crossbd930bc2025-02-03 12:17:42 -08002730 if version == "" {
2731 tag.explicitlyImpl = true
2732 }
Colin Crossafcdce82024-10-22 13:59:33 -07002733 // depTag is an interface that contains a concrete non-pointer struct. That makes the local
2734 // tag variable a copy of the contents of depTag, and updating it doesn't change depTag. Reassign
2735 // the modified copy to depTag.
2736 depTag = tag
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002737 } else {
2738 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2739 }
Colin Crosse7257d22020-09-24 09:56:18 -07002740 }
Colin Crosse7257d22020-09-24 09:56:18 -07002741
Colin Cross0de8a1e2020-09-18 14:15:30 -07002742 if far {
2743 ctx.AddFarVariationDependencies(variations, depTag, name)
2744 } else {
2745 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002746 }
2747}
2748
Kiyoung Kim487689e2022-07-26 09:48:22 +09002749func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2750 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002751 return snapshot
2752 }
2753
2754 return lib
2755}
2756
Kiyoung Kim37693d02024-04-04 09:56:15 +09002757// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002758// of names:
2759//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002760// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002761//
2762// For each of these, it adds the name of the ndk_library module to the list of
2763// variant libs.
2764//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002765// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002766//
2767// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002768//
2769// The caller can then know to add the variantLibs dependencies differently from the
2770// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002771func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002772 variantLibs = []string{}
2773
2774 nonvariantLibs = []string{}
2775 for _, entry := range list {
2776 // strip #version suffix out
2777 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002778 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002779 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002780 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002781 nonvariantLibs = append(nonvariantLibs, entry)
2782 }
2783 }
2784 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002785
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002786}
2787
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002788func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2789 nonVariantLibs := []string{}
2790 variantLibs := []string{}
2791
2792 for _, lib := range libs {
2793 replaceLibName := GetReplaceModuleName(lib, replaceList)
2794 if replaceLibName == lib {
2795 // Do not handle any libs which are not in API imports
2796 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2797 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2798 variantLibs = append(variantLibs, replaceLibName)
2799 } else {
2800 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2801 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002802 }
2803
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002804 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002805}
2806
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002807func (c *Module) shouldUseApiSurface() bool {
2808 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2809 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2810 // LLNDK Variant
2811 return true
2812 }
2813
2814 if c.Properties.IsSdkVariant {
2815 // NDK Variant
2816 return true
2817 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002818 }
2819
2820 return false
2821}
2822
Colin Cross1e676be2016-10-12 14:38:15 -07002823func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002824 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002825 return
2826 }
2827
Colin Cross37047f12016-12-13 17:06:13 -08002828 ctx := &depsContext{
2829 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002830 moduleContextImpl: moduleContextImpl{
2831 mod: c,
2832 },
2833 }
2834 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002835
Colin Crossc99deeb2016-04-11 15:06:20 -07002836 deps := c.deps(ctx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002837
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002838 apiNdkLibs := []string{}
2839 apiLateNdkLibs := []string{}
2840
Yo Chiang219968c2020-09-22 18:45:04 +08002841 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2842
Dan Albert914449f2016-06-17 16:45:24 -07002843 variantNdkLibs := []string{}
2844 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002845 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002846 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2847 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2848 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002849 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002850
Colin Cross32ec36c2016-12-15 07:39:51 -08002851 for _, lib := range deps.HeaderLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002852 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002853 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002854 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002855 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002856
Spandan Das73bcafc2022-08-18 23:26:00 +00002857 if c.isNDKStubLibrary() {
Jiyong Parkf8fab9b2024-09-02 15:24:15 +09002858 variationExists := actx.OtherModuleDependencyVariantExists(nil, lib)
2859 if variationExists {
2860 actx.AddVariationDependencies(nil, depTag, lib)
2861 } else {
2862 // dependencies to ndk_headers fall here as ndk_headers do not have
2863 // any variants.
2864 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
2865 }
Spandan Dasff665182024-09-11 18:48:44 +00002866 } else if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002867 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002868 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002869 } else {
2870 actx.AddVariationDependencies(nil, depTag, lib)
2871 }
2872 }
2873
Dan Albertf1d14c72020-07-30 14:32:55 -07002874 if c.isNDKStubLibrary() {
2875 // NDK stubs depend on their implementation because the ABI dumps are
2876 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002877
Spandan Das8b08aea2023-03-14 19:29:34 +00002878 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2879 c.ImageVariation(),
2880 blueprint.Variation{Mutator: "link", Variation: "shared"},
2881 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002882 }
2883
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002884 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2885 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2886 c.Target().NativeBridge == android.NativeBridgeDisabled {
2887 actx.AddVariationDependencies(
Jihoon Kang47e91842024-06-19 00:51:16 +00002888 []blueprint.Variation{{Mutator: "image", Variation: android.VendorVariation}},
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002889 llndkHeaderLibTag,
2890 deps.LlndkHeaderLibs...)
2891 }
2892
Jiyong Park5d1598f2019-02-25 22:14:17 +09002893 for _, lib := range deps.WholeStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002894 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002895
Jiyong Park5d1598f2019-02-25 22:14:17 +09002896 actx.AddVariationDependencies([]blueprint.Variation{
2897 {Mutator: "link", Variation: "static"},
2898 }, depTag, lib)
2899 }
2900
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002901 for _, lib := range deps.StaticLibs {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002902 // Some dependencies listed in static_libs might actually be rust_ffi rlib variants.
Colin Cross8acea3e2024-12-12 14:53:30 -08002903 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002904
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002905 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002906 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002907 }
Jiyong Parke3867542020-12-03 17:28:25 +09002908 if inList(lib, deps.ExcludeLibsForApex) {
2909 depTag.excludeInApex = true
2910 }
Dan Willemsen59339a22018-07-22 21:18:45 -07002911 actx.AddVariationDependencies([]blueprint.Variation{
2912 {Mutator: "link", Variation: "static"},
2913 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002914 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002915
Jooyung Han75568392020-03-20 04:29:24 +09002916 // staticUnwinderDep is treated as staticDep for Q apexes
2917 // so that native libraries/binaries are linked with static unwinder
2918 // because Q libc doesn't have unwinder APIs
2919 if deps.StaticUnwinderIfLegacy {
Colin Cross8acea3e2024-12-12 14:53:30 -08002920 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002921 actx.AddVariationDependencies([]blueprint.Variation{
2922 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002923 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002924 }
2925
Jiyong Park7ed9de32018-10-15 22:25:07 +09002926 // shared lib names without the #version suffix
2927 var sharedLibNames []string
2928
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002929 for _, lib := range deps.SharedLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002930 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002931 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002932 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002933 }
Jiyong Parke3867542020-12-03 17:28:25 +09002934 if inList(lib, deps.ExcludeLibsForApex) {
2935 depTag.excludeInApex = true
2936 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002937 if inList(lib, deps.ExcludeLibsForNonApex) {
2938 depTag.excludeInNonApex = true
2939 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002940
Jiyong Park73c54ee2019-10-22 20:31:18 +09002941 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002942 sharedLibNames = append(sharedLibNames, name)
2943
Colin Crosse7257d22020-09-24 09:56:18 -07002944 variations := []blueprint.Variation{
2945 {Mutator: "link", Variation: "shared"},
2946 }
Spandan Dasff665182024-09-11 18:48:44 +00002947 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002948 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002949
Colin Crossfe9acfe2021-06-14 16:13:03 -07002950 for _, lib := range deps.LateStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002951 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Colin Crossfe9acfe2021-06-14 16:13:03 -07002952 actx.AddVariationDependencies([]blueprint.Variation{
2953 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002954 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002955 }
2956
Colin Cross3e5e7782022-06-17 22:17:05 +00002957 for _, lib := range deps.UnexportedStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002958 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
Colin Cross3e5e7782022-06-17 22:17:05 +00002959 actx.AddVariationDependencies([]blueprint.Variation{
2960 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002961 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002962 }
2963
Jiyong Park7ed9de32018-10-15 22:25:07 +09002964 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002965 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002966 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2967 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2968 // linking against both the stubs lib and the non-stubs lib at the same time.
2969 continue
2970 }
Colin Cross8acea3e2024-12-12 14:53:30 -08002971 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002972 variations := []blueprint.Variation{
2973 {Mutator: "link", Variation: "shared"},
2974 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002975 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002976 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002977
Dan Willemsen59339a22018-07-22 21:18:45 -07002978 actx.AddVariationDependencies([]blueprint.Variation{
2979 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002980 }, dataLibDepTag, deps.DataLibs...)
2981
Colin Crossc8caa062021-09-24 16:50:14 -07002982 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2983
Chris Parsons79d66a52020-06-05 17:26:16 -04002984 actx.AddVariationDependencies([]blueprint.Variation{
2985 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002986 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002987
Colin Cross68861832016-07-08 10:41:41 -07002988 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002989
2990 for _, gen := range deps.GeneratedHeaders {
2991 depTag := genHeaderDepTag
2992 if inList(gen, deps.ReexportGeneratedHeaders) {
2993 depTag = genHeaderExportDepTag
2994 }
2995 actx.AddDependency(c, depTag, gen)
2996 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002997
Cole Faust65cb40a2024-10-21 15:41:42 -07002998 for _, gen := range deps.DeviceFirstGeneratedHeaders {
2999 depTag := genHeaderDepTag
3000 actx.AddVariationDependencies(ctx.Config().AndroidFirstDeviceTarget.Variations(), depTag, gen)
3001 }
3002
Dan Albert92fe7402020-07-15 13:33:30 -07003003 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07003004 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07003005 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07003006 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09003007 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08003008 }
Colin Crossc465efd2021-06-11 18:00:04 -07003009 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07003010 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09003011 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07003012 }
Dan Willemsena0790e32018-10-12 00:24:23 -07003013 if deps.DynamicLinker != "" {
3014 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07003015 }
Dan Albert914449f2016-06-17 16:45:24 -07003016
3017 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07003018
Colin Cross8acea3e2024-12-12 14:53:30 -08003019 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003020 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003021 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003022 {Mutator: "link", Variation: "shared"},
3023 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003024 actx.AddVariationDependencies([]blueprint.Variation{
3025 {Mutator: "version", Variation: version},
3026 {Mutator: "link", Variation: "shared"},
3027 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07003028
Colin Cross8acea3e2024-12-12 14:53:30 -08003029 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003030 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003031 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003032 {Mutator: "link", Variation: "shared"},
3033 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003034 actx.AddVariationDependencies([]blueprint.Variation{
3035 {Mutator: "version", Variation: version},
3036 {Mutator: "link", Variation: "shared"},
3037 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08003038
Vinh Tran367d89d2023-04-28 11:21:25 -04003039 if len(deps.AidlLibs) > 0 {
3040 actx.AddDependency(
3041 c,
3042 aidlLibraryTag,
3043 deps.AidlLibs...,
3044 )
3045 }
3046
Colin Cross6362e272015-10-29 15:25:03 -07003047}
Colin Cross21b9a242015-03-24 14:15:58 -07003048
Colin Crosse40b4ea2018-10-02 22:25:58 -07003049func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07003050 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07003051 c.beginMutator(ctx)
3052 }
3053}
3054
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003055// Whether a module can link to another module, taking into
3056// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09003057func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07003058 tag blueprint.DependencyTag) {
3059
3060 switch t := tag.(type) {
3061 case dependencyTag:
3062 if t != vndkExtDepTag {
3063 return
3064 }
3065 case libraryDependencyTag:
3066 default:
3067 return
3068 }
3069
Ivan Lozanof9e21722020-12-02 09:00:51 -05003070 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003071 // Host code is not restricted
3072 return
3073 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003074
Ivan Lozano52767be2019-10-18 14:49:46 -07003075 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003076 // Platform code can link to anything
3077 return
3078 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08003079 if from.InRamdisk() {
3080 // Ramdisk code is not NDK
3081 return
3082 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003083 if from.InVendorRamdisk() {
3084 // Vendor ramdisk code is not NDK
3085 return
3086 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003087 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09003088 // Recovery code is not NDK
3089 return
3090 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003091 // Change this to LinkableInterface if Rust gets NDK support, which stubDecorators are for
Colin Cross31076b32020-10-23 17:22:06 -07003092 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07003093 if c.StubDecorator() {
3094 // These aren't real libraries, but are the stub shared libraries that are included in
3095 // the NDK.
3096 return
3097 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003098 }
Logan Chien834b9a62019-01-14 15:39:03 +08003099
Ivan Lozano52767be2019-10-18 14:49:46 -07003100 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08003101 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
3102 // to link to libc++ (non-NDK and without sdk_version).
3103 return
3104 }
3105
Ivan Lozano52767be2019-10-18 14:49:46 -07003106 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003107 // NDK code linking to platform code is never okay.
3108 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003109 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08003110 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003111 }
3112
3113 // At this point we know we have two NDK libraries, but we need to
3114 // check that we're not linking against anything built against a higher
3115 // API level, as it is only valid to link against older or equivalent
3116 // APIs.
3117
Inseob Kim01a28722018-04-11 09:48:45 +09003118 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07003119 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003120 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07003121 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003122 // Current can't be linked against by anything else.
3123 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003124 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09003125 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003126 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003127 if err != nil {
3128 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003129 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003130 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003131 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003132 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003133 if err != nil {
3134 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003135 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003136 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003137 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003138
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003139 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09003140 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003141 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003142 }
3143 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003144 }
Dan Albert202fe492017-12-15 13:56:59 -08003145
3146 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07003147 fromStl := from.SelectedStl()
3148 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08003149 if fromStl == "" || toStl == "" {
3150 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09003151 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08003152 // We can be permissive with the system "STL" since it is only the C++
3153 // ABI layer, but in the future we should make sure that everyone is
3154 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07003155 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08003156 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003157 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
3158 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08003159 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003160}
3161
Jooyung Han479ca172020-10-19 18:51:07 +09003162func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
3163 if c, ok := ctx.Module().(*Module); ok {
3164 ctx.VisitDirectDeps(func(dep android.Module) {
3165 depTag := ctx.OtherModuleDependencyTag(dep)
3166 ccDep, ok := dep.(LinkableInterface)
3167 if ok {
3168 checkLinkType(ctx, c, ccDep, depTag)
3169 }
3170 })
3171 }
3172}
3173
Jiyong Park5fb8c102018-04-09 12:03:06 +09003174// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09003175// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
3176// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003177// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Colin Crossda279cf2024-09-17 14:25:45 -07003178func checkDoubleLoadableLibraries(ctx android.BottomUpMutatorContext) {
Jooyung Hana70f0672019-01-18 15:20:43 +09003179 check := func(child, parent android.Module) bool {
3180 to, ok := child.(*Module)
3181 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09003182 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09003183 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003184
Jooyung Hana70f0672019-01-18 15:20:43 +09003185 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
3186 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09003187 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003188
Jiyong Park0474e1f2021-01-14 14:26:06 +09003189 // These dependencies are not excercised at runtime. Tracking these will give us
3190 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09003191 depTag := ctx.OtherModuleDependencyTag(child)
3192 if IsHeaderDepTag(depTag) {
3193 return false
3194 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09003195 if depTag == staticVariantTag {
3196 return false
3197 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003198 if depTag == StubImplDepTag {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003199 return false
3200 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003201 if depTag == android.RequiredDepTag {
3202 return false
3203 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003204
Justin Yun63e9ec72020-10-29 16:49:43 +09003205 // Even if target lib has no vendor variant, keep checking dependency
3206 // graph in case it depends on vendor_available or product_available
3207 // but not double_loadable transtively.
3208 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003209 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003210 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003211
Jiyong Park0474e1f2021-01-14 14:26:06 +09003212 // The happy path. Keep tracking dependencies until we hit a non double-loadable
3213 // one.
3214 if Bool(to.VendorProperties.Double_loadable) {
3215 return true
3216 }
3217
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09003218 if to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003219 return false
3220 }
3221
Jooyung Hana70f0672019-01-18 15:20:43 +09003222 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3223 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003224 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003225 return false
3226 }
3227 if module, ok := ctx.Module().(*Module); ok {
3228 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003229 if lib.HasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003230 ctx.WalkDeps(check)
3231 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003232 }
3233 }
3234}
3235
Yu Liue4312402023-01-18 09:15:31 -08003236func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3237 // For the dependency from platform to apex, use the latest stubs
3238 apexSdkVersion := android.FutureApiLevel
3239 if !apexInfo.IsForPlatform() {
3240 apexSdkVersion = apexInfo.MinSdkVersion
3241 }
3242
3243 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3244 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3245 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3246 // (b/144430859)
3247 apexSdkVersion = android.FutureApiLevel
3248 }
3249
3250 return apexSdkVersion
3251}
3252
Colin Crossc99deeb2016-04-11 15:06:20 -07003253// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003254func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003255 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003256
Colin Cross0de8a1e2020-09-18 14:15:30 -07003257 var directStaticDeps []StaticLibraryInfo
3258 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003259
Colin Cross0de8a1e2020-09-18 14:15:30 -07003260 reexportExporter := func(exporter FlagExporterInfo) {
3261 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3262 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3263 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3264 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3265 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003266 }
3267
Colin Crossff694a82023-12-13 15:54:49 -08003268 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003269 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003270
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003271 skipModuleList := map[string]bool{}
3272
Yu Liu8024b922024-12-20 23:31:32 +00003273 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003274 depName := ctx.OtherModuleName(dep)
3275 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003276
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003277 if _, ok := skipModuleList[depName]; ok {
3278 // skip this module because original module or API imported module matching with this should be used instead.
3279 return
3280 }
3281
Yu Liu8024b922024-12-20 23:31:32 +00003282 var ccInfo *CcInfo
3283 v, hasCcInfo := android.OtherModuleProvider(ctx, dep, CcInfoProvider)
3284 if hasCcInfo {
3285 ccInfo = v
3286 }
3287 linkableInfo, hasLinkableInfo := android.OtherModuleProvider(ctx, dep, LinkableInfoProvider)
Dan Willemsen47450072021-10-19 20:24:49 -07003288 if depTag == android.DarwinUniversalVariantTag {
Yu Liu8024b922024-12-20 23:31:32 +00003289 if !hasCcInfo {
3290 panic(fmt.Errorf("dep is not a cc module: %s", dep.String()))
3291 }
3292 depPaths.DarwinSecondArchOutput = linkableInfo.OutputFile
Dan Willemsen47450072021-10-19 20:24:49 -07003293 return
3294 }
3295
Vinh Tran367d89d2023-04-28 11:21:25 -04003296 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003297 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003298 depPaths.AidlLibraryInfos = append(
3299 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003300 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003301 )
3302 }
3303 }
3304
Yu Liu8024b922024-12-20 23:31:32 +00003305 if !hasLinkableInfo {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003306 // handling for a few module types that aren't cc Module but that are also supported
Yu Liu8024b922024-12-20 23:31:32 +00003307 genRule, ok := android.OtherModuleProvider(ctx, dep, android.GeneratedSourceInfoProvider)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003308 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003309 case genSourceDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003310 if ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003311 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
Yu Liu8024b922024-12-20 23:31:32 +00003312 genRule.GeneratedSourceFiles...)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003313 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003314 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003315 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003316 // Support exported headers from a generated_sources dependency
3317 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003318 case genHeaderDepTag, genHeaderExportDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003319 if ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003320 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Yu Liu8024b922024-12-20 23:31:32 +00003321 genRule.GeneratedDeps...)
3322 dirs := genRule.GeneratedHeaderDirs
Inseob Kim69378442019-06-03 19:10:47 +09003323 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003324 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003325 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003326 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
Yu Liu8024b922024-12-20 23:31:32 +00003327 genRule.GeneratedSourceFiles...)
3328 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003329 // 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 +09003330 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003331 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003332 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003333 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003334 }
Colin Crosscef792e2021-06-11 18:01:26 -07003335 case CrtBeginDepTag:
3336 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3337 case CrtEndDepTag:
3338 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003339 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003340 return
3341 }
3342
Colin Crossfe17f6f2019-03-28 19:30:56 -07003343 if depTag == android.ProtoPluginDepTag {
3344 return
3345 }
3346
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003347 if depTag == android.RequiredDepTag {
3348 return
3349 }
3350
Yu Liu8024b922024-12-20 23:31:32 +00003351 commonInfo := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey)
3352 if commonInfo.Target.Os != ctx.Os() {
Steven Morelandaaae81f2024-08-27 22:55:48 +00003353 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 -07003354 return
3355 }
Yu Liu8024b922024-12-20 23:31:32 +00003356 if commonInfo.Target.Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003357 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
Yu Liu8024b922024-12-20 23:31:32 +00003358 ctx.ModuleName(), ctx.Arch().ArchType, depName, commonInfo.Target.Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003359 return
3360 }
3361
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003362 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003363 // Skip reused objects for stub libraries, they use their own stub object file instead.
3364 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3365 // version mutator, so the stubs variant is created from the shared variant that
3366 // already has the reuseObjTag dependency on the static variant.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003367 if !c.library.BuildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003368 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003369 objs := staticAnalogue.ReuseObjects
3370 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003371 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003372 reexportExporter(depExporterInfo)
3373 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003374 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003375 }
3376
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003377 if depTag == llndkHeaderLibTag {
3378 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3379 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3380 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3381 }
3382
Yu Liu8024b922024-12-20 23:31:32 +00003383 linkFile := linkableInfo.OutputFile
Colin Cross6e511a92020-07-27 21:26:48 -07003384
3385 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3386 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003387 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003388 return
3389 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003390
Jiyong Parke3867542020-12-03 17:28:25 +09003391 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3392 return
3393 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003394 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3395 return
3396 }
Jiyong Parke3867542020-12-03 17:28:25 +09003397
Colin Cross313aa542023-12-13 13:47:44 -08003398 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003399
Colin Cross6e511a92020-07-27 21:26:48 -07003400 var ptr *android.Paths
3401 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003402
Colin Cross6e511a92020-07-27 21:26:48 -07003403 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003404
Colin Cross6e511a92020-07-27 21:26:48 -07003405 switch {
3406 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003407 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003408 if !ctx.Config().AllowMissingDependencies() {
3409 ctx.ModuleErrorf("module %q is not a header library", depName)
3410 } else {
3411 ctx.AddMissingDependencies([]string{depName})
3412 }
3413 return
3414 }
Colin Cross6e511a92020-07-27 21:26:48 -07003415 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003416 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003417 if !ctx.Config().AllowMissingDependencies() {
3418 ctx.ModuleErrorf("module %q is not a shared library", depName)
3419 } else {
3420 ctx.AddMissingDependencies([]string{depName})
3421 }
3422 return
3423 }
Jiyong Parke3867542020-12-03 17:28:25 +09003424
Jiyong Park7d55b612021-06-11 17:22:09 +09003425 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3426 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003427
Jiyong Park1ad8e162020-12-01 23:40:09 +09003428 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3429 // linkFile, depFile, and ptr.
3430 if c.IsStubs() {
3431 break
3432 }
3433
Colin Cross0de8a1e2020-09-18 14:15:30 -07003434 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3435 depFile = sharedLibraryInfo.TableOfContents
3436
Colin Crossb614cd42024-10-11 12:52:21 -07003437 if !sharedLibraryInfo.IsStubs {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00003438 // TODO(b/362509506): remove this additional check once all apex_exclude uses are switched to stubs.
3439 if !linkableInfo.RustApexExclude {
3440 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
3441 if info, ok := android.OtherModuleProvider(ctx, dep, ImplementationDepInfoProvider); ok {
3442 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
3443 }
Colin Crossb614cd42024-10-11 12:52:21 -07003444 }
3445 }
3446
Colin Cross6e511a92020-07-27 21:26:48 -07003447 ptr = &depPaths.SharedLibs
3448 switch libDepTag.Order {
3449 case earlyLibraryDependency:
3450 ptr = &depPaths.EarlySharedLibs
3451 depPtr = &depPaths.EarlySharedLibsDeps
3452 case normalLibraryDependency:
3453 ptr = &depPaths.SharedLibs
3454 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003455 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003456 case lateLibraryDependency:
3457 ptr = &depPaths.LateSharedLibs
3458 depPtr = &depPaths.LateSharedLibsDeps
3459 default:
3460 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003461 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003462
Colin Cross6e511a92020-07-27 21:26:48 -07003463 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003464 if linkableInfo.RustLibraryInterface {
3465 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: linkableInfo.CrateName, LinkDirs: linkableInfo.ExportedCrateLinkDirs}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003466 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3467 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3468 if libDepTag.wholeStatic {
3469 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3470 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
Jiyong Park1ad8e162020-12-01 23:40:09 +09003471
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003472 // If whole_static, track this as we want to make sure that in a final linkage for a shared library,
3473 // exported functions from the rust generated staticlib still exported.
3474 if c.CcLibrary() && c.Shared() {
3475 c.WholeRustStaticlib = true
3476 }
Colin Cross6e511a92020-07-27 21:26:48 -07003477 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003478
Colin Cross6e511a92020-07-27 21:26:48 -07003479 } else {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003480 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3481 if !isStaticLib {
3482 if !ctx.Config().AllowMissingDependencies() {
3483 ctx.ModuleErrorf("module %q is not a static library", depName)
3484 } else {
3485 ctx.AddMissingDependencies([]string{depName})
3486 }
3487 return
Inseob Kimeec88e12020-01-22 11:11:29 +09003488 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003489
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003490 // Stubs lib doesn't link to the static lib dependencies. Don't set
3491 // linkFile, depFile, and ptr.
3492 if c.IsStubs() {
3493 break
3494 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003495
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003496 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
3497 if libDepTag.wholeStatic {
3498 ptr = &depPaths.WholeStaticLibs
3499 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3500 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
3501 } else {
3502 // This case normally catches prebuilt static
3503 // libraries, but it can also occur when
3504 // AllowMissingDependencies is on and the
3505 // dependencies has no sources of its own
3506 // but has a whole_static_libs dependency
3507 // on a missing library. We want to depend
3508 // on the .a file so that there is something
3509 // in the dependency tree that contains the
3510 // error rule for the missing transitive
3511 // dependency.
3512 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
3513 }
3514 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3515 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
3516 } else {
3517 switch libDepTag.Order {
3518 case earlyLibraryDependency:
3519 panic(fmt.Errorf("early static libs not supported"))
3520 case normalLibraryDependency:
3521 // static dependencies will be handled separately so they can be ordered
3522 // using transitive dependencies.
3523 ptr = nil
3524 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
3525 case lateLibraryDependency:
3526 ptr = &depPaths.LateStaticLibs
3527 default:
3528 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
3529 }
3530 }
3531
3532 // Collect any exported Rust rlib deps from static libraries which have been included as whole_static_libs
3533 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3534
3535 if libDepTag.unexportedSymbols {
3536 depPaths.LdFlags = append(depPaths.LdFlags,
3537 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3538 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003539 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003540 }
3541
Yu Liu8024b922024-12-20 23:31:32 +00003542 if libDepTag.static() && !libDepTag.wholeStatic && !linkableInfo.RustLibraryInterface {
3543 if !linkableInfo.CcLibraryInterface || !linkableInfo.Static {
Colin Cross6e511a92020-07-27 21:26:48 -07003544 ctx.ModuleErrorf("module %q not a static library", depName)
3545 return
3546 }
Logan Chien43d34c32017-12-20 01:17:32 +08003547
Colin Cross6e511a92020-07-27 21:26:48 -07003548 // When combining coverage files for shared libraries and executables, coverage files
3549 // in static libraries act as if they were whole static libraries. The same goes for
3550 // source based Abi dump files.
Yu Liu8024b922024-12-20 23:31:32 +00003551 if hasCcInfo {
Colin Cross6e511a92020-07-27 21:26:48 -07003552 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003553 linkableInfo.CoverageFiles...)
Colin Cross6e511a92020-07-27 21:26:48 -07003554 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003555 linkableInfo.SAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003556 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003557 // Handle non-CC modules here
3558 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003559 linkableInfo.CoverageFiles...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003560 }
3561 }
3562
Colin Cross6e511a92020-07-27 21:26:48 -07003563 if ptr != nil {
3564 if !linkFile.Valid() {
3565 if !ctx.Config().AllowMissingDependencies() {
3566 ctx.ModuleErrorf("module %q missing output file", depName)
3567 } else {
3568 ctx.AddMissingDependencies([]string{depName})
3569 }
3570 return
3571 }
3572 *ptr = append(*ptr, linkFile.Path())
3573 }
3574
3575 if depPtr != nil {
3576 dep := depFile
3577 if !dep.Valid() {
3578 dep = linkFile
3579 }
3580 *depPtr = append(*depPtr, dep.Path())
3581 }
3582
Colin Cross0de8a1e2020-09-18 14:15:30 -07003583 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3584 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3585 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3586 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003587 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3588
3589 // Only re-export RustRlibDeps for cc static libs
3590 if c.static() {
3591 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3592 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003593
3594 if libDepTag.reexportFlags {
3595 reexportExporter(depExporterInfo)
3596 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3597 // Re-exported shared library headers must be included as well since they can help us with type information
3598 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003599 c.sabi.Properties.ReexportedIncludes = append(
3600 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003601 c.sabi.Properties.ReexportedSystemIncludes = append(
3602 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003603 }
3604
Yu Liu0a37d422025-02-13 02:05:00 +00003605 makeLibName := MakeLibName(ccInfo, linkableInfo, &commonInfo, commonInfo.BaseModuleName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003606 switch {
3607 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003608 c.Properties.AndroidMkHeaderLibs = append(
3609 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003610 case libDepTag.shared():
Colin Cross6e511a92020-07-27 21:26:48 -07003611 // Note: the order of libs in this list is not important because
3612 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003613 c.Properties.AndroidMkSharedLibs = append(
3614 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003615 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003616 if !linkableInfo.RustLibraryInterface {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003617 if libDepTag.wholeStatic {
3618 c.Properties.AndroidMkWholeStaticLibs = append(
3619 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3620 } else {
3621 c.Properties.AndroidMkStaticLibs = append(
3622 c.Properties.AndroidMkStaticLibs, makeLibName)
3623 }
Colin Cross6e511a92020-07-27 21:26:48 -07003624 }
3625 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003626 } else if !c.IsStubs() {
3627 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3628
Colin Cross6e511a92020-07-27 21:26:48 -07003629 switch depTag {
3630 case runtimeDepTag:
3631 c.Properties.AndroidMkRuntimeLibs = append(
Yu Liu0a37d422025-02-13 02:05:00 +00003632 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ccInfo, linkableInfo, &commonInfo,
3633 commonInfo.BaseModuleName)+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003634 case objDepTag:
3635 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3636 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003637 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003638 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003639 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003640 case dynamicLinkerDepTag:
3641 depPaths.DynamicLinker = linkFile
3642 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003643 }
Colin Crossca860ac2016-01-04 14:34:37 -08003644 })
3645
Jeff Gaston294356f2017-09-27 17:05:30 -07003646 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003647 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3648 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3649 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003650
Colin Crossdd84e052017-05-17 13:44:16 -07003651 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003652 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003653 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3654 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003655 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003656 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3657
Jiyong Park74955042019-10-22 20:19:51 +09003658 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3659 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003660 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003661 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003662 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003663 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003664
3665 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003666 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003667 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003668 }
Colin Crossdd84e052017-05-17 13:44:16 -07003669
Colin Crossca860ac2016-01-04 14:34:37 -08003670 return depPaths
3671}
3672
Yu Liuf6f85492025-01-13 21:02:36 +00003673func ShouldUseStubForApex(ctx android.ModuleContext, parent android.Module, dep android.ModuleProxy) bool {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003674 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003675 bootstrap := false
Yu Liuf6f85492025-01-13 21:02:36 +00003676 if ctx.EqualModules(ctx.Module(), parent) {
3677 if linkable, ok := parent.(LinkableInterface); !ok {
3678 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3679 } else {
3680 inVendorOrProduct = linkable.InVendorOrProduct()
3681 bootstrap = linkable.Bootstrap()
3682 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003683 } else {
Yu Liuf6f85492025-01-13 21:02:36 +00003684 if linkable, ok := android.OtherModuleProvider(ctx, parent, LinkableInfoProvider); !ok {
3685 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3686 } else {
3687 inVendorOrProduct = linkable.InVendorOrProduct
3688 bootstrap = linkable.Bootstrap
3689 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003690 }
3691
Spandan Das10c41362024-12-03 01:33:09 +00003692 apexInfo, _ := android.OtherModuleProvider(ctx, parent, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003693
3694 useStubs := false
3695
Yu Liu8024b922024-12-20 23:31:32 +00003696 if android.OtherModuleProviderOrDefault(ctx, dep, LinkableInfoProvider).IsStubs && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003697 if !apexInfo.IsForPlatform() {
3698 // For platform libraries, use current version of LLNDK
3699 // If this is for use_vendor apex we will apply the same rules
3700 // of apex sdk enforcement below to choose right version.
3701 useStubs = true
3702 }
3703 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3704 // If not building for APEX or the containing APEX allows the use of
3705 // platform APIs, use stubs only when it is from an APEX (and not from
3706 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3707 // bootstrap modules, always link to non-stub variant
Yu Liu8024b922024-12-20 23:31:32 +00003708 isNotInPlatform := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey).NotInPlatform
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003709
Spandan Dasff665182024-09-11 18:48:44 +00003710 useStubs = isNotInPlatform && !bootstrap
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003711 } else {
Colin Crossea91a172024-11-05 16:14:05 -08003712 // If building for APEX, always use stubs (can be bypassed by depending on <dep>#impl)
3713 useStubs = true
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003714 }
3715
3716 return useStubs
3717}
3718
3719// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3720// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3721// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3722// has different level of updatability. For example, if a library foo in an APEX depends on a
3723// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3724// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3725// same APEX as foo, the non-stub variant of bar is used.
Yu Liuf6f85492025-01-13 21:02:36 +00003726func ChooseStubOrImpl(ctx android.ModuleContext, dep android.ModuleProxy) (SharedLibraryInfo, FlagExporterInfo) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003727 depTag := ctx.OtherModuleDependencyTag(dep)
3728 libDepTag, ok := depTag.(libraryDependencyTag)
3729 if !ok || !libDepTag.shared() {
3730 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3731 }
3732
Colin Cross313aa542023-12-13 13:47:44 -08003733 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3734 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3735 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003736
3737 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003738 // when to use (unspecified) stubs, use the latest one.
Spandan Das10c41362024-12-03 01:33:09 +00003739 if ShouldUseStubForApex(ctx, ctx.Module(), dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003740 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3741 toUse := stubs[len(stubs)-1]
3742 sharedLibraryInfo = toUse.SharedLibraryInfo
3743 depExporterInfo = toUse.FlagExporterInfo
3744 }
3745 }
3746 return sharedLibraryInfo, depExporterInfo
3747}
3748
Colin Cross0de8a1e2020-09-18 14:15:30 -07003749// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3750// to match the topological order of the dependency tree, including any static analogues of
Colin Crossa14fb6a2024-10-23 16:57:06 -07003751// direct shared libraries. It returns the ordered static dependencies, and a depset.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07003752// of the transitive dependencies.
Colin Crossa14fb6a2024-10-23 16:57:06 -07003753func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive depset.DepSet[android.Path]) {
3754 transitiveStaticLibsBuilder := depset.NewBuilder[android.Path](depset.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003755 var staticPaths android.Paths
3756 for _, staticDep := range staticDeps {
3757 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3758 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3759 }
3760 for _, sharedDep := range sharedDeps {
Colin Crossa14fb6a2024-10-23 16:57:06 -07003761 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003762 }
3763 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3764
3765 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3766
3767 // reorder the dependencies based on transitive dependencies
3768 staticPaths = android.FirstUniquePaths(staticPaths)
3769 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3770
3771 if len(orderedStaticPaths) != len(staticPaths) {
3772 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3773 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3774 }
3775
3776 return orderedStaticPaths, transitiveStaticLibs
3777}
3778
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003779// BaseLibName trims known prefixes and suffixes
3780func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003781 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3782 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003783 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003784 return libName
3785}
3786
Yu Liu8024b922024-12-20 23:31:32 +00003787func MakeLibName(ccInfo *CcInfo, linkableInfo *LinkableInfo, commonInfo *android.CommonModuleInfo, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003788 libName := BaseLibName(depName)
Yu Liu8024b922024-12-20 23:31:32 +00003789 isLLndk := ccInfo != nil && linkableInfo.IsLlndk
3790 nonSystemVariantsExist := linkableInfo.HasNonSystemVariants || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003791
Yu Liu8024b922024-12-20 23:31:32 +00003792 if ccInfo != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003793 // Use base module name for snapshots when exporting to Makefile.
Yu Liu8024b922024-12-20 23:31:32 +00003794 if ccInfo.SnapshotInfo != nil {
Yu Liu0a37d422025-02-13 02:05:00 +00003795 return commonInfo.BaseModuleName + ccInfo.SnapshotInfo.SnapshotAndroidMkSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003796 }
3797 }
3798
Yu Liu8024b922024-12-20 23:31:32 +00003799 if linkableInfo.InVendorOrProduct && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003800 // The vendor and product modules in Make will have been renamed to not conflict with the
3801 // core module, so update the dependency name here accordingly.
Yu Liu8024b922024-12-20 23:31:32 +00003802 return libName + linkableInfo.SubName
3803 } else if linkableInfo.InRamdisk && !linkableInfo.OnlyInRamdisk {
Matthew Maurerc6868382021-07-13 14:12:37 -07003804 return libName + RamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003805 } else if linkableInfo.InVendorRamdisk && !linkableInfo.OnlyInVendorRamdisk {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003806 return libName + VendorRamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003807 } else if linkableInfo.InRecovery && !linkableInfo.OnlyInRecovery {
Matthew Maurer460ee942021-02-11 12:31:46 -08003808 return libName + RecoverySuffix
Yu Liu8024b922024-12-20 23:31:32 +00003809 } else if commonInfo.Target.NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003810 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003811 } else {
3812 return libName
3813 }
3814}
3815
Colin Crossca860ac2016-01-04 14:34:37 -08003816func (c *Module) InstallInData() bool {
3817 if c.installer == nil {
3818 return false
3819 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003820 return c.installer.inData()
3821}
3822
3823func (c *Module) InstallInSanitizerDir() bool {
3824 if c.installer == nil {
3825 return false
3826 }
3827 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003828 return true
3829 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003830 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003831}
3832
Yifan Hong1b3348d2020-01-21 15:53:22 -08003833func (c *Module) InstallInRamdisk() bool {
3834 return c.InRamdisk()
3835}
3836
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003837func (c *Module) InstallInVendorRamdisk() bool {
3838 return c.InVendorRamdisk()
3839}
3840
Jiyong Parkf9332f12018-02-01 00:54:12 +09003841func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003842 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003843}
3844
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003845func (c *Module) MakeUninstallable() {
3846 if c.installer == nil {
3847 c.ModuleBase.MakeUninstallable()
3848 return
3849 }
3850 c.installer.makeUninstallable(c)
3851}
3852
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003853func (c *Module) HostToolPath() android.OptionalPath {
3854 if c.installer == nil {
3855 return android.OptionalPath{}
3856 }
3857 return c.installer.hostToolPath()
3858}
3859
Nan Zhangd4e641b2017-07-12 12:55:28 -07003860func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3861 return c.outputFile
3862}
3863
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003864func (c *Module) static() bool {
3865 if static, ok := c.linker.(interface {
3866 static() bool
3867 }); ok {
3868 return static.static()
3869 }
3870 return false
3871}
3872
Colin Cross6a730042024-12-05 13:53:43 -08003873func (c *Module) staticLibrary() bool {
3874 if static, ok := c.linker.(interface {
3875 staticLibrary() bool
3876 }); ok {
3877 return static.staticLibrary()
3878 }
3879 return false
3880}
3881
Jiyong Park379de2f2018-12-19 02:47:14 +09003882func (c *Module) staticBinary() bool {
3883 if static, ok := c.linker.(interface {
3884 staticBinary() bool
3885 }); ok {
3886 return static.staticBinary()
3887 }
3888 return false
3889}
3890
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003891func (c *Module) testBinary() bool {
3892 if test, ok := c.linker.(interface {
3893 testBinary() bool
3894 }); ok {
3895 return test.testBinary()
3896 }
3897 return false
3898}
3899
Jingwen Chen537242c2022-08-24 11:53:27 +00003900func (c *Module) testLibrary() bool {
3901 if test, ok := c.linker.(interface {
3902 testLibrary() bool
3903 }); ok {
3904 return test.testLibrary()
3905 }
3906 return false
3907}
3908
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003909func (c *Module) benchmarkBinary() bool {
3910 if b, ok := c.linker.(interface {
3911 benchmarkBinary() bool
3912 }); ok {
3913 return b.benchmarkBinary()
3914 }
3915 return false
3916}
3917
3918func (c *Module) fuzzBinary() bool {
3919 if f, ok := c.linker.(interface {
3920 fuzzBinary() bool
3921 }); ok {
3922 return f.fuzzBinary()
3923 }
3924 return false
3925}
3926
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003927// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3928func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003929 if h, ok := c.linker.(interface {
3930 header() bool
3931 }); ok {
3932 return h.header()
3933 }
3934 return false
3935}
3936
Ivan Lozanod7586b62021-04-01 09:49:36 -04003937func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003938 if b, ok := c.linker.(interface {
3939 binary() bool
3940 }); ok {
3941 return b.binary()
3942 }
3943 return false
3944}
3945
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003946func (c *Module) ForceDisableSanitizers() {
3947 c.sanitize.Properties.ForceDisable = true
3948}
3949
Justin Yun5e035862021-06-29 20:50:37 +09003950func (c *Module) StaticExecutable() bool {
3951 if b, ok := c.linker.(*binaryDecorator); ok {
3952 return b.static()
3953 }
3954 return false
3955}
3956
Ivan Lozanod7586b62021-04-01 09:49:36 -04003957func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003958 if o, ok := c.linker.(interface {
3959 object() bool
3960 }); ok {
3961 return o.object()
3962 }
3963 return false
3964}
3965
Kiyoung Kim37693d02024-04-04 09:56:15 +09003966func (m *Module) Dylib() bool {
3967 return false
3968}
3969
3970func (m *Module) Rlib() bool {
3971 return false
3972}
3973
Ivan Lozanof9e21722020-12-02 09:00:51 -05003974func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003975 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003976 if c.IsLlndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003977 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003978 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003979 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003980 return "native:product"
3981 }
Jooyung Han38002912019-05-16 04:01:54 +09003982 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003983 } else if c.InRamdisk() {
3984 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003985 } else if c.InVendorRamdisk() {
3986 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003987 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003988 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003989 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003990 return "native:ndk:none:none"
3991 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3992 //family, link := getNdkStlFamilyAndLinkType(c)
3993 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
3994 } else {
3995 return "native:platform"
3996 }
3997}
3998
Jiyong Park9d452992018-10-03 00:38:19 +09003999// Overrides ApexModule.IsInstallabeToApex()
Colin Cross3a02c7b2024-05-21 13:46:22 -07004000// Only shared/runtime libraries .
Jiyong Park9d452992018-10-03 00:38:19 +09004001func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07004002 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09004003 // Stub libs and prebuilt libs in a versioned SDK are not
4004 // installable to APEX even though they are shared libs.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00004005 return lib.shared() && !lib.BuildStubs()
Jiyong Park9d452992018-10-03 00:38:19 +09004006 }
4007 return false
4008}
4009
Jiyong Parka90ca002019-10-07 15:47:24 +09004010func (c *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +00004011 return android.CheckAvailableForApex(what, c.ApexAvailableFor())
4012}
4013
4014func (c *Module) ApexAvailableFor() []string {
4015 list := c.ApexModuleBase.ApexAvailable()
Jiyong Parka90ca002019-10-07 15:47:24 +09004016 if linker, ok := c.linker.(interface {
Yu Liub73c3a62024-12-10 00:58:06 +00004017 apexAvailable() []string
Jiyong Parka90ca002019-10-07 15:47:24 +09004018 }); ok {
Yu Liub73c3a62024-12-10 00:58:06 +00004019 list = append(list, linker.apexAvailable()...)
Jiyong Parka90ca002019-10-07 15:47:24 +09004020 }
Yu Liub73c3a62024-12-10 00:58:06 +00004021
4022 return android.FirstUniqueStrings(list)
Jiyong Parka90ca002019-10-07 15:47:24 +09004023}
4024
Paul Duffin0cb37b92020-03-04 14:52:46 +00004025func (c *Module) EverInstallable() bool {
4026 return c.installer != nil &&
4027 // Check to see whether the module is actually ever installable.
4028 c.installer.everInstallable()
4029}
4030
Ivan Lozanod7586b62021-04-01 09:49:36 -04004031func (c *Module) PreventInstall() bool {
4032 return c.Properties.PreventInstall
4033}
4034
4035func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07004036 if c.library != nil {
4037 if i := c.library.installable(); i != nil {
4038 return i
4039 }
4040 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04004041 return c.Properties.Installable
4042}
4043
4044func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00004045 ret := c.EverInstallable() &&
4046 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04004047 proptools.BoolDefault(c.Installable(), true) &&
4048 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004049
4050 // The platform variant doesn't need further condition. Apex variants however might not
4051 // be installable because it will likely to be included in the APEX and won't appear
4052 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07004053 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004054 return ret
4055 }
4056
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004057 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09004058}
4059
Logan Chien41eabe62019-04-10 13:33:58 +08004060func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
4061 if c.linker != nil {
4062 if library, ok := c.linker.(*libraryDecorator); ok {
4063 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
4064 }
4065 }
4066}
4067
Jiyong Park45bf82e2020-12-15 22:29:02 +09004068var _ android.ApexModule = (*Module)(nil)
4069
4070// Implements android.ApexModule
Yu Liuf1806032025-02-07 00:23:34 +00004071func (c *Module) GetDepInSameApexChecker() android.DepInSameApexChecker {
4072 return CcDepInSameApexChecker{
4073 Static: c.static(),
4074 HasStubsVariants: c.HasStubsVariants(),
4075 IsLlndk: c.IsLlndk(),
4076 Host: c.Host(),
4077 }
4078}
4079
4080type CcDepInSameApexChecker struct {
4081 Static bool
4082 HasStubsVariants bool
4083 IsLlndk bool
4084 Host bool
4085}
4086
4087func (c CcDepInSameApexChecker) OutgoingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00004088 if depTag == StubImplDepTag {
Colin Crossc1b36442021-05-06 13:42:48 -07004089 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09004090 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09004091 }
Jiyong Park12177fc2021-01-05 14:37:15 +09004092 if depTag == staticVariantTag {
4093 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
4094 // actually mean that the static lib (and its dependencies) are copied into the
4095 // APEX.
4096 return false
4097 }
Colin Cross8acea3e2024-12-12 14:53:30 -08004098
4099 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
Yu Liuf1806032025-02-07 00:23:34 +00004100 if isLibDepTag && c.Static && libDepTag.shared() {
Colin Cross8acea3e2024-12-12 14:53:30 -08004101 // shared_lib dependency from a static lib is considered as crossing
4102 // the APEX boundary because the dependency doesn't actually is
4103 // linked; the dependency is used only during the compilation phase.
4104 return false
4105 }
4106
4107 if isLibDepTag && libDepTag.excludeInApex {
4108 return false
4109 }
4110
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09004111 return true
4112}
4113
Yu Liuf1806032025-02-07 00:23:34 +00004114func (c CcDepInSameApexChecker) IncomingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
4115 if c.Host {
Colin Cross1cea5302024-12-03 16:40:08 -08004116 return false
4117 }
Yu Liuf1806032025-02-07 00:23:34 +00004118 if c.HasStubsVariants {
Colin Crossbd930bc2025-02-03 12:17:42 -08004119 if IsSharedDepTag(depTag) && !IsExplicitImplSharedDepTag(depTag) {
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004120 // dynamic dep to a stubs lib crosses APEX boundary
4121 return false
4122 }
4123 if IsRuntimeDepTag(depTag) {
4124 // runtime dep to a stubs lib also crosses APEX boundary
4125 return false
4126 }
4127 if IsHeaderDepTag(depTag) {
4128 return false
4129 }
4130 }
Yu Liuf1806032025-02-07 00:23:34 +00004131 if c.IsLlndk {
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004132 return false
4133 }
Colin Crossf7bbd2f2024-12-05 13:57:10 -08004134
4135 return true
4136}
4137
Jiyong Park45bf82e2020-12-15 22:29:02 +09004138// Implements android.ApexModule
Yu Liudf0b8392025-02-12 18:27:03 +00004139func (c *Module) MinSdkVersionSupported(ctx android.BaseModuleContext) android.ApiLevel {
Jooyung Han749dc692020-04-15 11:03:39 +09004140 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
4141 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
Yu Liudf0b8392025-02-12 18:27:03 +00004142 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004143 }
Jooyung Han749dc692020-04-15 11:03:39 +09004144 // We don't check for prebuilt modules
4145 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
Yu Liudf0b8392025-02-12 18:27:03 +00004146 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004147 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09004148
Jooyung Han749dc692020-04-15 11:03:39 +09004149 minSdkVersion := c.MinSdkVersion()
4150 if minSdkVersion == "apex_inherit" {
Yu Liudf0b8392025-02-12 18:27:03 +00004151 return android.MinApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004152 }
4153 if minSdkVersion == "" {
4154 // JNI libs within APK-in-APEX fall into here
4155 // Those are okay to set sdk_version instead
4156 // We don't have to check if this is a SDK variant because
4157 // non-SDK variant resets sdk_version, which works too.
4158 minSdkVersion = c.SdkVersion()
4159 }
Yu Liudf0b8392025-02-12 18:27:03 +00004160
Dan Albertc8060532020-07-22 22:32:17 -07004161 if minSdkVersion == "" {
Yu Liudf0b8392025-02-12 18:27:03 +00004162 return android.NoneApiLevel
Dan Albertc8060532020-07-22 22:32:17 -07004163 }
Yu Liudf0b8392025-02-12 18:27:03 +00004164
Dan Albertc8060532020-07-22 22:32:17 -07004165 // Not using nativeApiLevelFromUser because the context here is not
4166 // necessarily a native context.
Yu Liudf0b8392025-02-12 18:27:03 +00004167 ver, err := android.ApiLevelFromUserWithConfig(ctx.Config(), minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09004168 if err != nil {
Yu Liudf0b8392025-02-12 18:27:03 +00004169 return android.NoneApiLevel
Jooyung Han749dc692020-04-15 11:03:39 +09004170 }
Dan Albertc8060532020-07-22 22:32:17 -07004171
Colin Cross8ca61c12022-10-06 21:00:14 -07004172 // A dependency only needs to support a min_sdk_version at least
4173 // as high as the api level that the architecture was introduced in.
4174 // This allows introducing new architectures in the platform that
4175 // need to be included in apexes that normally require an older
4176 // min_sdk_version.
Yu Liudf0b8392025-02-12 18:27:03 +00004177 if c.Enabled(ctx) {
4178 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
4179 if ver.LessThanOrEqualTo(minApiForArch) {
4180 ver = android.MinApiLevel
4181 }
Colin Cross8ca61c12022-10-06 21:00:14 -07004182 }
4183
Yu Liudf0b8392025-02-12 18:27:03 +00004184 return ver
Jooyung Han749dc692020-04-15 11:03:39 +09004185}
4186
Paul Duffinb5769c12021-05-12 16:16:51 +01004187// Implements android.ApexModule
4188func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4189 // stub libraries and native bridge libraries are always available to platform
4190 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4191}
4192
Inseob Kima1888ce2022-10-04 14:42:02 +09004193func (c *Module) overriddenModules() []string {
4194 if o, ok := c.linker.(overridable); ok {
4195 return o.overriddenModules()
4196 }
4197 return nil
4198}
4199
Liz Kammer35ca77e2021-12-22 15:31:40 -05004200type moduleType int
4201
4202const (
4203 unknownType moduleType = iota
4204 binary
4205 object
4206 fullLibrary
4207 staticLibrary
4208 sharedLibrary
4209 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004210 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004211 ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004212)
4213
4214func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004215 if c.testBinary() {
4216 // testBinary is also a binary, so this comes before the c.Binary()
4217 // conditional. A testBinary has additional implicit dependencies and
4218 // other test-only semantics.
4219 return testBin
4220 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004221 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004222 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004223 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004224 } else if c.testLibrary() {
4225 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4226 // will let them add implicit compile deps on gtest, for example.
4227 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004228 // For now, treat them as regular libraries.
4229 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004230 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004231 static := false
4232 shared := false
4233 if library, ok := c.linker.(*libraryDecorator); ok {
4234 static = library.MutatedProperties.BuildStatic
4235 shared = library.MutatedProperties.BuildShared
4236 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4237 static = library.MutatedProperties.BuildStatic
4238 shared = library.MutatedProperties.BuildShared
4239 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004240 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004241 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004242 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004243 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004244 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004245 return staticLibrary
4246 }
4247 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004248 } else if c.isNDKStubLibrary() {
4249 return ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004250 }
4251 return unknownType
4252}
4253
Colin Crosscfad1192015-11-02 16:43:11 -08004254// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004255type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004256 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004257 android.DefaultsModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004258}
4259
Patrice Arrudac249c712019-03-19 17:00:29 -07004260// cc_defaults provides a set of properties that can be inherited by other cc
4261// modules. A module can use the properties from a cc_defaults using
4262// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4263// merged (when possible) by prepending the default module's values to the
4264// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004265func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004266 return DefaultsFactory()
4267}
4268
Colin Cross36242852017-06-23 15:06:31 -07004269func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004270 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004271
Colin Cross36242852017-06-23 15:06:31 -07004272 module.AddProperties(props...)
4273 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004274 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004275 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004276 &BaseCompilerProperties{},
4277 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004278 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004279 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004280 &StaticProperties{},
4281 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004282 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004283 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004284 &TestLinkerProperties{},
4285 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004286 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004287 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004288 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004289 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004290 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004291 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004292 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004293 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004294 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004295 &SAbiProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004296 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004297 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004298 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004299 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004300 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4301 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004302 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004303 )
Colin Crosscfad1192015-11-02 16:43:11 -08004304
Jooyung Hancc372c52019-09-25 15:18:44 +09004305 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004306
4307 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004308}
4309
Jiyong Park2286afd2020-06-16 21:58:53 +09004310func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004311 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004312}
4313
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004314func kytheExtractAllFactory() android.Singleton {
4315 return &kytheExtractAllSingleton{}
4316}
4317
4318type kytheExtractAllSingleton struct {
4319}
4320
4321func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4322 var xrefTargets android.Paths
Yu Liuec7043d2024-11-05 18:22:20 +00004323 ctx.VisitAllModuleProxies(func(module android.ModuleProxy) {
Yu Liu4f825132024-12-18 00:35:39 +00004324 files := android.OtherModuleProviderOrDefault(ctx, module, CcObjectInfoProvider).KytheFiles
Yu Liuec7043d2024-11-05 18:22:20 +00004325 if len(files) > 0 {
4326 xrefTargets = append(xrefTargets, files...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004327 }
4328 })
4329 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4330 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004331 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004332 }
4333}
4334
Jihoon Kangf78a8902022-09-01 22:47:07 +00004335func (c *Module) Partition() string {
4336 if p, ok := c.installer.(interface {
4337 getPartition() string
4338 }); ok {
4339 return p.getPartition()
4340 }
4341 return ""
4342}
4343
Spandan Das2b6dfb52024-01-19 00:22:22 +00004344type sourceModuleName interface {
4345 sourceModuleName() string
4346}
4347
4348func (c *Module) BaseModuleName() string {
4349 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4350 // if the prebuilt module sets a source_module_name in Android.bp, use that
4351 return smn.sourceModuleName()
4352 }
4353 return c.ModuleBase.BaseModuleName()
4354}
4355
Spandan Dase20c56c2024-07-23 21:34:24 +00004356func (c *Module) stubsSymbolFilePath() android.Path {
4357 if library, ok := c.linker.(*libraryDecorator); ok {
4358 return library.stubsSymbolFilePath
4359 }
4360 return android.OptionalPath{}.Path()
4361}
4362
Colin Cross06a931b2015-10-28 17:23:31 -07004363var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004364var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004365var BoolPtr = proptools.BoolPtr
4366var String = proptools.String
4367var StringPtr = proptools.StringPtr