blob: 45538b4988200091e2d3bc8f2c1dd9d61d10f4d0 [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 Liu8a8d5b42025-01-07 00:48:08 +0000165 Installable *bool
Yu Liu97880e12025-01-07 19:03:34 +0000166 // RelativeInstallPath returns the relative install path for this module.
167 RelativeInstallPath string
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000168 // TODO(b/362509506): remove this once all apex_exclude uses are switched to stubs.
169 RustApexExclude bool
Yu Liuf6f85492025-01-13 21:02:36 +0000170 // Bootstrap tests if this module is allowed to use non-APEX version of libraries.
Yu Liu0a37d422025-02-13 02:05:00 +0000171 Bootstrap bool
172 Multilib string
173 ImplementationModuleNameForMake string
174 IsStubsImplementationRequired bool
175 // Symlinks returns a list of symlinks that should be created for this module.
176 Symlinks []string
Yu Liu986d98c2024-11-12 00:28:11 +0000177}
178
Yu Liu8024b922024-12-20 23:31:32 +0000179var LinkableInfoProvider = blueprint.NewProvider[*LinkableInfo]()
Yu Liu986d98c2024-11-12 00:28:11 +0000180
Colin Cross463a90e2015-06-17 14:20:06 -0700181func init() {
Paul Duffin036e7002019-12-19 19:16:28 +0000182 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -0700183
Inseob Kim3b244062023-07-11 13:31:36 +0900184 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +0000185 pctx.Import("android/soong/cc/config")
186}
187
188func RegisterCCBuildComponents(ctx android.RegistrationContext) {
189 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
190
191 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossac57a6c2024-06-26 13:09:53 -0700192 ctx.Transition("sdk", &sdkTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700193 ctx.BottomUp("llndk", llndkMutator)
Colin Cross767819f2024-05-22 14:22:34 -0700194 ctx.Transition("link", &linkageTransitionMutator{})
Colin Crossadd04a82024-05-22 09:57:59 -0700195 ctx.Transition("version", &versionTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700196 ctx.BottomUp("begin", BeginMutator)
Colin Cross1e676be2016-10-12 14:38:15 -0700197 })
Colin Cross16b23492016-01-06 14:41:07 -0800198
Paul Duffin036e7002019-12-19 19:16:28 +0000199 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -0400200 for _, san := range Sanitizers {
201 san.registerMutators(ctx)
202 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800203
Colin Cross8a962802024-10-09 15:29:27 -0700204 ctx.BottomUp("sanitize_runtime_deps", sanitizerRuntimeDepsMutator)
205 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator)
Ivan Lozano30c5db22018-02-21 15:49:20 -0800206
Colin Cross597bad62024-10-08 15:10:55 -0700207 ctx.Transition("fuzz", &fuzzTransitionMutator{})
Cory Barkera1da26f2022-06-07 20:12:06 +0000208
Colin Crossf5f4ad32024-01-19 15:41:48 -0800209 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -0700210
Colin Crossd38feb02024-01-23 16:38:06 -0800211 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +0800212
Colin Cross33e0c812024-01-23 16:36:07 -0800213 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000214
Colin Cross6ac83a82024-01-23 11:23:10 -0800215 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +0900216
Colin Cross8a962802024-10-09 15:29:27 -0700217 ctx.BottomUp("check_linktype", checkLinkTypeMutator)
218 ctx.BottomUp("double_loadable", checkDoubleLoadableLibraries)
Colin Cross1e676be2016-10-12 14:38:15 -0700219 })
Colin Crossb98c8b02016-07-29 13:44:28 -0700220
Colin Cross91ae5ec2024-10-01 14:03:40 -0700221 ctx.PostApexMutators(func(ctx android.RegisterMutatorsContext) {
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800222 // sabi mutator needs to be run after apex mutator finishes.
Colin Cross91ae5ec2024-10-01 14:03:40 -0700223 ctx.Transition("sabi", &sabiTransitionMutator{})
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800224 })
225
LaMont Jones0c10e4d2023-05-16 00:58:37 +0000226 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -0700227}
228
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500229// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
230// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
231// edges to these modules.
232// This object is constructed in DepsMutator, by calling to various module delegates to set
233// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
234// dependencies.
235// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
236// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800237type Deps struct {
238 SharedLibs, LateSharedLibs []string
239 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800240 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800241 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700242
Colin Cross3e5e7782022-06-17 22:17:05 +0000243 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
244 // prevent automatically exporting symbols.
245 UnexportedStaticLibs []string
246
Chris Parsons79d66a52020-06-05 17:26:16 -0400247 // Used for data dependencies adjacent to tests
248 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700249 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400250
Yo Chiang219968c2020-09-22 18:45:04 +0800251 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
252 SystemSharedLibs []string
253
Vinh Tran367d89d2023-04-28 11:21:25 -0400254 // Used by DepMutator to pass aidl_library modules to aidl compiler
255 AidlLibs []string
256
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500257 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800258 StaticUnwinderIfLegacy bool
259
Colin Cross5950f382016-12-13 12:50:57 -0800260 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700261
Colin Cross81413472016-04-11 14:37:39 -0700262 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700263
Cole Faust65cb40a2024-10-21 15:41:42 -0700264 GeneratedSources []string
265 GeneratedHeaders []string
266 DeviceFirstGeneratedHeaders []string
267 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700268
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700269 ReexportGeneratedHeaders []string
270
Colin Crossc465efd2021-06-11 18:00:04 -0700271 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700272
273 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700274 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900275
276 // List of libs that need to be excluded for APEX variant
277 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900278 // List of libs that need to be excluded for non-APEX variant
279 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800280
281 // LLNDK headers for the ABI checker to check LLNDK implementation library.
282 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
Colin Cross1e954b62024-09-13 13:50:00 -0700283 // The core variant cannot depend on the vendor variant because of the order of imageTransitionMutator.Split().
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800284 // Instead, the LLNDK implementation depends on the LLNDK header libs.
285 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700286}
287
Ivan Lozano0a468a42024-05-13 21:03:34 -0400288// A struct which to collect flags for rlib dependencies
289type RustRlibDep struct {
290 LibPath android.Path // path to the rlib
291 LinkDirs []string // flags required for dependency (e.g. -L flags)
292 CrateName string // crateNames associated with rlibDeps
293}
294
295func EqRustRlibDeps(a RustRlibDep, b RustRlibDep) bool {
296 return a.LibPath == b.LibPath
297}
298
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500299// PathDeps is a struct containing file paths to dependencies of a module.
300// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
301// It's used to construct flags for various build statements (such as for compiling and linking).
302// It is then passed to module decorator functions responsible for registering build statements
303// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800304type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700305 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900306 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700307 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900308 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700309 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700310 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400311 // Paths and crateNames for RustStaticLib dependencies
312 RustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700313
Colin Cross0de8a1e2020-09-18 14:15:30 -0700314 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossa14fb6a2024-10-23 16:57:06 -0700315 TranstiveStaticLibrariesForOrdering depset.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700316
Colin Cross26c34ed2016-09-30 17:10:16 -0700317 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100318 Objs Objects
319 // Paths to .o files in dependencies that provide them. Note that these lists
320 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800321 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700322 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700323
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100324 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
325 // the libs from all whole_static_lib dependencies.
326 WholeStaticLibsFromPrebuilts android.Paths
327
Colin Cross26c34ed2016-09-30 17:10:16 -0700328 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700329 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900330 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700331
Inseob Kimd110f872019-12-06 13:15:38 +0900332 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000333 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900334 IncludeDirs android.Paths
335 SystemIncludeDirs android.Paths
336 ReexportedDirs android.Paths
337 ReexportedSystemDirs android.Paths
338 ReexportedFlags []string
339 ReexportedGeneratedHeaders android.Paths
340 ReexportedDeps android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400341 ReexportedRustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700342
Colin Cross26c34ed2016-09-30 17:10:16 -0700343 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700344 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700345
Dan Willemsena0790e32018-10-12 00:24:23 -0700346 // Path to the dynamic linker binary
347 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700348
349 // For Darwin builds, the path to the second architecture's output that should
350 // be combined with this architectures's output into a FAT MachO file.
351 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400352
353 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
354 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800355
356 // LLNDK headers for the ABI checker to check LLNDK implementation library.
357 LlndkIncludeDirs android.Paths
358 LlndkSystemIncludeDirs android.Paths
Colin Crossb614cd42024-10-11 12:52:21 -0700359
360 directImplementationDeps android.Paths
361 transitiveImplementationDeps []depset.DepSet[android.Path]
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700362}
363
Colin Cross4af21ed2019-11-04 09:37:55 -0800364// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
365// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
366// command line so they can be overridden by the local module flags).
367type LocalOrGlobalFlags struct {
368 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700369 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800370 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700371 CFlags []string // Flags that apply to C and C++ source files
372 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
373 ConlyFlags []string // Flags that apply to C source files
374 CppFlags []string // Flags that apply to C++ source files
375 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700376 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800377}
378
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500379// Flags contains various types of command line flags (and settings) for use in building build
380// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800381type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500382 // Local flags (which individual modules are responsible for). These may override global flags.
383 Local LocalOrGlobalFlags
384 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700385 Global LocalOrGlobalFlags
386 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800387
388 aidlFlags []string // Flags that apply to aidl source files
389 rsFlags []string // Flags that apply to renderscript source files
390 libFlags []string // Flags to add libraries early to the link order
391 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
392 TidyFlags []string // Flags that apply to clang-tidy
393 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700394
Colin Crossc3199482017-03-30 15:03:04 -0700395 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800396 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700397 SystemIncludeFlags []string
398
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800399 Toolchain config.Toolchain
400 Tidy bool // True if ninja .tidy rules should be generated.
401 NeedTidyFiles bool // True if module link should depend on .tidy files
402 GcovCoverage bool // True if coverage files should be generated.
403 SAbiDump bool // True if header abi dumps should be generated.
404 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
kellyhungd62ea302024-05-19 21:16:07 +0800405 ClangVerify bool // If true, append cflags "-Xclang -verify" and append "&& touch $out" to the clang command line.
Colin Crossca860ac2016-01-04 14:34:37 -0800406
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500407 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800408 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500409 // The target-device system path to the dynamic linker.
410 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800411
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700412 CFlagsDeps android.Paths // Files depended on by compiler flags
413 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800414
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500415 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700416 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800417
Colin Cross19878da2019-03-28 14:45:07 -0700418 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700419 protoC bool // Whether to use C instead of C++
420 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700421
422 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200423 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700424}
425
Colin Crossca860ac2016-01-04 14:34:37 -0800426// Properties used to compile all C or C++ modules
427type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700428 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800429 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700430
Yi Kong5786f5c2024-05-28 02:22:34 +0900431 // Aggresively trade performance for smaller binary size.
432 // This should only be used for on-device binaries that are rarely executed and not
433 // performance critical.
434 Optimize_for_size *bool `android:"arch_variant"`
435
Jiyong Parkb35a8192020-08-10 15:59:36 +0900436 // The API level that this module is built against. The APIs of this API level will be
437 // visible at build time, but use of any APIs newer than min_sdk_version will render the
438 // module unloadable on older devices. In the future it will be possible to weakly-link new
439 // APIs, making the behavior match Java: such modules will load on older devices, but
440 // calling new APIs on devices that do not support them will result in a crash.
441 //
442 // This property has the same behavior as sdk_version does for Java modules. For those
443 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
444 // does for Java code.
445 //
446 // In addition, setting this property causes two variants to be built, one for the platform
447 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800448 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700449
Jiyong Parkb35a8192020-08-10 15:59:36 +0900450 // Minimum OS API level supported by this C or C++ module. This property becomes the value
451 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
452 // this property is also used to ensure that the min_sdk_version of the containing module is
453 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
454 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
455 // min_sdk_version of the containing APEX. When the module
456 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900457 Min_sdk_version *string
458
Colin Crossc511bc52020-04-07 16:50:32 +0000459 // If true, always create an sdk variant and don't create a platform variant.
460 Sdk_variant_only *bool
461
Colin Cross4297f402024-11-20 15:20:09 -0800462 AndroidMkSharedLibs []string `blueprint:"mutated"`
463 AndroidMkStaticLibs []string `blueprint:"mutated"`
464 AndroidMkRlibs []string `blueprint:"mutated"`
465 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
466 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
467 AndroidMkHeaderLibs []string `blueprint:"mutated"`
468 HideFromMake bool `blueprint:"mutated"`
469 PreventInstall bool `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700470
Yo Chiang219968c2020-09-22 18:45:04 +0800471 // Set by DepsMutator.
472 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
473
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900474 // The name of the image this module is built for
475 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200476
477 // The VNDK version this module is built against. If empty, the module is not
478 // build against the VNDK.
479 VndkVersion string `blueprint:"mutated"`
480
481 // Suffix for the name of Android.mk entries generated by this module
482 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800483
484 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
485 // file
Inseob Kim37e0bb02024-04-29 15:54:44 +0900486 Logtags []string `android:"path"`
Jiyong Parkf9332f12018-02-01 00:54:12 +0900487
Yifan Hong39143a92020-10-26 12:43:12 -0700488 // Make this module available when building for ramdisk.
489 // On device without a dedicated recovery partition, the module is only
490 // available after switching root into
491 // /first_stage_ramdisk. To expose the module before switching root, install
492 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800493 Ramdisk_available *bool
494
Yifan Hong39143a92020-10-26 12:43:12 -0700495 // Make this module available when building for vendor ramdisk.
496 // On device without a dedicated recovery partition, the module is only
497 // available after switching root into
498 // /first_stage_ramdisk. To expose the module before switching root, install
499 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700500 Vendor_ramdisk_available *bool
501
Jiyong Parkf9332f12018-02-01 00:54:12 +0900502 // Make this module available when building for recovery
503 Recovery_available *bool
504
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200505 // Used by imageMutator, set by ImageMutatorBegin()
Jihoon Kang47e91842024-06-19 00:51:16 +0000506 VendorVariantNeeded bool `blueprint:"mutated"`
507 ProductVariantNeeded bool `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200508 CoreVariantNeeded bool `blueprint:"mutated"`
509 RamdiskVariantNeeded bool `blueprint:"mutated"`
510 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
511 RecoveryVariantNeeded bool `blueprint:"mutated"`
512
513 // A list of variations for the "image" mutator of the form
514 //<image name> '.' <version char>, for example, 'vendor.S'
515 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900516
517 // Allows this module to use non-APEX version of libraries. Useful
518 // for building binaries that are started before APEXes are activated.
519 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900520
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000521 // Allows this module to be included in CMake release snapshots to be built outside of Android
522 // build system and source tree.
523 Cmake_snapshot_supported *bool
524
Colin Cross1bc94122021-10-28 13:25:54 -0700525 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000526
527 // Set by factories of module types that can only be referenced from variants compiled against
528 // the SDK.
529 AlwaysSdk bool `blueprint:"mutated"`
530
531 // Variant is an SDK variant created by sdkMutator
532 IsSdkVariant bool `blueprint:"mutated"`
533 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
534 // variant to have a ".sdk" suffix.
535 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700536
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800537 Target struct {
538 Platform struct {
539 // List of modules required by the core variant.
540 Required []string `android:"arch_variant"`
541
542 // List of modules not required by the core variant.
543 Exclude_required []string `android:"arch_variant"`
544 } `android:"arch_variant"`
545
546 Recovery struct {
547 // List of modules required by the recovery variant.
548 Required []string `android:"arch_variant"`
549
550 // List of modules not required by the recovery variant.
551 Exclude_required []string `android:"arch_variant"`
552 } `android:"arch_variant"`
553 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700554}
555
556type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900557 // whether this module should be allowed to be directly depended by other
558 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900559 // If set to true, two variants will be built separately, one like
560 // normal, and the other limited to the set of libraries and headers
561 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700562 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900563 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700564 // so it shouldn't have any unversioned runtime dependencies, or
565 // make assumptions about the system that may not be true in the
566 // future.
567 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900568 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900569 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900570 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900571 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900572 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700573 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
574 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900575
Justin Yunebcf0c52021-01-08 18:00:19 +0900576 // This is the same as the "vendor_available" except that the install path
577 // of the vendor variant is /odm or /vendor/odm.
578 // By replacing "vendor_available: true" with "odm_available: true", the
579 // module will install its vendor variant to the /odm partition or /vendor/odm.
580 // As the modules with "odm_available: true" still create the vendor variants,
581 // they can link to the other vendor modules as the vendor_available modules do.
582 // Also, the vendor modules can link to odm_available modules.
583 //
584 // It may not be used for VNDK modules.
585 Odm_available *bool
586
Justin Yun63e9ec72020-10-29 16:49:43 +0900587 // whether this module should be allowed to be directly depended by other
588 // modules with `product_specific: true` or `product_available: true`.
589 // If set to true, an additional product variant will be built separately
590 // that is limited to the set of libraries and headers that are exposed to
591 // /product modules.
592 //
593 // The product variant may be used with a different (newer) /system,
594 // so it shouldn't have any unversioned runtime dependencies, or
595 // make assumptions about the system that may not be true in the
596 // future.
597 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900598 // If set to false, this module becomes inaccessible from /product modules.
599 //
600 // Different from the 'vendor_available' property, the modules with
601 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
602 // library without 'product_available' may not be depended on by any other
603 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900604 //
605 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
606 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
607 Product_available *bool
608
Jiyong Park5fb8c102018-04-09 12:03:06 +0900609 // whether this module is capable of being loaded with other instance
610 // (possibly an older version) of the same module in the same process.
611 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
612 // can be double loaded in a vendor process if the library is also a
613 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
614 // explicitly marked as `double_loadable: true` by the owner, or the dependency
615 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
616 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800617
618 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
619 IsLLNDK bool `blueprint:"mutated"`
620
Colin Cross5271fea2021-04-27 13:06:04 -0700621 // IsVendorPublicLibrary is set for the core and product variants of a library that has
622 // vendor_public_library stubs.
623 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800624}
625
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500626// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
627// to understanding details about the type of the current module.
628// For example, one might call these functions to determine whether the current module is a static
629// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800630type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800631 static() bool
632 staticBinary() bool
Colin Cross6a730042024-12-05 13:53:43 -0800633 staticLibrary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700634 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800635 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900636 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900637 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900638 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700639 toolchain() config.Toolchain
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700640 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800641 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900642 minSdkVersion() string
643 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700644 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700645 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800646 IsLlndk() bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800647 isImplementationForLLNDKPublic() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700648 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900649 inProduct() bool
650 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800651 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700652 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900653 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900654 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700655 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700656 baseModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800657 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000658 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800659 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900660 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800661 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800662 useClangLld(actx ModuleContext) bool
Colin Crosse07f2312020-08-13 11:24:56 -0700663 apexVariationName() string
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900664 bootstrap() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700665 nativeCoverage() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800666 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800667 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800668 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800669 notInPlatform() bool
Yi Kong5786f5c2024-05-28 02:22:34 +0900670 optimizeForSize() bool
Yu Liu76d94462024-10-31 23:32:36 +0000671 getOrCreateMakeVarsInfo() *CcMakeVarsInfo
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800672}
673
674type SharedFlags struct {
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000675 NumSharedFlags int
676 FlagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800677}
678
679type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700680 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800681 ModuleContextIntf
682}
683
684type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700685 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800686 ModuleContextIntf
687}
688
Colin Cross37047f12016-12-13 17:06:13 -0800689type DepsContext interface {
690 android.BottomUpMutatorContext
691 ModuleContextIntf
692}
693
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500694// feature represents additional (optional) steps to building cc-related modules, such as invocation
695// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800696type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800697 flags(ctx ModuleContext, flags Flags) Flags
698 props() []interface{}
699}
700
Joe Onorato37f900c2023-07-18 16:58:16 -0700701// Information returned from Generator about the source code it's generating
702type GeneratedSource struct {
703 IncludeDirs android.Paths
704 Sources android.Paths
705 Headers android.Paths
706 ReexportedDirs android.Paths
707}
708
709// generator allows injection of generated code
710type Generator interface {
711 GeneratorProps() []interface{}
712 GeneratorInit(ctx BaseModuleContext)
713 GeneratorDeps(ctx DepsContext, deps Deps) Deps
714 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
715 GeneratorSources(ctx ModuleContext) GeneratedSource
716 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
717}
718
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500719// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500720// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800721type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700722 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800723 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800724 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700725 compilerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000726 baseCompilerProps() BaseCompilerProperties
Colin Cross42742b82016-08-01 13:20:05 -0700727
Colin Cross76fada02016-07-27 10:31:13 -0700728 appendCflags([]string)
729 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700730 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800731}
732
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500733// linker is the interface for a linker decorator object. Individual module types can provide
734// their own implementation for this decorator, and thus specify custom logic regarding build
735// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800736type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700737 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800738 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700739 linkerFlags(ctx ModuleContext, flags Flags) Flags
740 linkerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000741 baseLinkerProps() BaseLinkerProperties
Ivan Lozanobd721262018-11-27 14:33:03 -0800742 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700743
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700744 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700745 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900746 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800747 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700748
749 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900750 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000751
752 // Get the deps that have been explicitly specified in the properties.
Cole Fauste8a87832024-09-11 11:35:46 -0700753 linkerSpecifiedDeps(ctx android.ConfigurableEvaluatorContext, module *Module, specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800754
755 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000756}
757
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500758// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000759type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500760 sharedLibs []string
761 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
762 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700763 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800764}
765
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500766// installer is the interface for an installer helper object. This helper is responsible for
767// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800768type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700769 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700770 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000771 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800772 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700773 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700774 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900775 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000776 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900777 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800778}
779
Inseob Kima1888ce2022-10-04 14:42:02 +0900780type overridable interface {
781 overriddenModules() []string
782}
783
Colin Cross6e511a92020-07-27 21:26:48 -0700784type libraryDependencyKind int
785
786const (
787 headerLibraryDependency = iota
788 sharedLibraryDependency
789 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400790 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700791)
792
793func (k libraryDependencyKind) String() string {
794 switch k {
795 case headerLibraryDependency:
796 return "headerLibraryDependency"
797 case sharedLibraryDependency:
798 return "sharedLibraryDependency"
799 case staticLibraryDependency:
800 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400801 case rlibLibraryDependency:
802 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700803 default:
804 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
805 }
806}
807
808type libraryDependencyOrder int
809
810const (
811 earlyLibraryDependency = -1
812 normalLibraryDependency = 0
813 lateLibraryDependency = 1
814)
815
816func (o libraryDependencyOrder) String() string {
817 switch o {
818 case earlyLibraryDependency:
819 return "earlyLibraryDependency"
820 case normalLibraryDependency:
821 return "normalLibraryDependency"
822 case lateLibraryDependency:
823 return "lateLibraryDependency"
824 default:
825 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
826 }
827}
828
829// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
830// tags that have a set of predefined tag objects that are reused for each dependency, a
831// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
832// That means that comparing a libraryDependencyTag for equality will only be equal if all
833// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
834// then check individual metadata fields instead.
835type libraryDependencyTag struct {
836 blueprint.BaseDependencyTag
837
838 // These are exported so that fmt.Printf("%#v") can call their String methods.
839 Kind libraryDependencyKind
840 Order libraryDependencyOrder
841
842 wholeStatic bool
843
844 reexportFlags bool
845 explicitlyVersioned bool
Colin Crossbd930bc2025-02-03 12:17:42 -0800846 explicitlyImpl bool
Colin Cross6e511a92020-07-27 21:26:48 -0700847 dataLib bool
848 ndk bool
849
850 staticUnwinder bool
851
852 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900853
Cindy Zhou18417cb2020-12-10 07:12:38 -0800854 // Whether or not this dependency should skip the apex dependency check
855 skipApexAllowedDependenciesCheck bool
856
Jiyong Parke3867542020-12-03 17:28:25 +0900857 // Whether or not this dependency has to be followed for the apex variants
858 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900859 // Whether or not this dependency has to be followed for the non-apex variants
860 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000861
862 // If true, don't automatically export symbols from the static library into a shared library.
863 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700864}
865
866// header returns true if the libraryDependencyTag is tagging a header lib dependency.
867func (d libraryDependencyTag) header() bool {
868 return d.Kind == headerLibraryDependency
869}
870
871// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
872func (d libraryDependencyTag) shared() bool {
873 return d.Kind == sharedLibraryDependency
874}
875
876// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
877func (d libraryDependencyTag) static() bool {
878 return d.Kind == staticLibraryDependency
879}
880
Colin Cross65cb3142021-12-10 23:05:02 +0000881func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
882 if d.shared() {
883 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
884 }
885 return nil
886}
887
888var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
889
Colin Crosse9fe2942020-11-10 18:12:15 -0800890// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
891// binaries or other shared libraries are installed as dependencies.
892func (d libraryDependencyTag) InstallDepNeeded() bool {
893 return d.shared()
894}
895
896var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
897
Yu Liu67a28422024-03-05 00:36:31 +0000898func (d libraryDependencyTag) PropagateAconfigValidation() bool {
899 return d.static()
900}
901
902var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
903
Colin Crosse9fe2942020-11-10 18:12:15 -0800904// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700905// libraryDependencyTag. Each tag object is created globally and reused for multiple
906// dependencies (although since the object contains no references, assigning a tag to a
907// variable and modifying it will not modify the original). Users can compare the tag
908// returned by ctx.OtherModuleDependencyTag against the global original
909type dependencyTag struct {
910 blueprint.BaseDependencyTag
911 name string
912}
913
Colin Crosse9fe2942020-11-10 18:12:15 -0800914// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
915// libraryDependencyTag, but where the dependency needs to be installed when the parent is
916// installed.
917type installDependencyTag struct {
918 blueprint.BaseDependencyTag
919 android.InstallAlwaysNeededDependencyTag
920 name string
921}
922
Colin Crossc99deeb2016-04-11 15:06:20 -0700923var (
Colin Cross6e511a92020-07-27 21:26:48 -0700924 genSourceDepTag = dependencyTag{name: "gen source"}
925 genHeaderDepTag = dependencyTag{name: "gen header"}
926 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
927 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900928 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700929 reuseObjTag = dependencyTag{name: "reuse objects"}
930 staticVariantTag = dependencyTag{name: "static variant"}
931 vndkExtDepTag = dependencyTag{name: "vndk extends"}
932 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700933 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800934 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Ivan Lozano9eaacc82024-10-30 14:28:17 +0000935 StubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000936 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500937 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400938 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800939 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700940)
941
Colin Crossbd930bc2025-02-03 12:17:42 -0800942func IsExplicitImplSharedDepTag(depTag blueprint.DependencyTag) bool {
943 ccLibDepTag, ok := depTag.(libraryDependencyTag)
944 return ok && ccLibDepTag.shared() && ccLibDepTag.explicitlyImpl
945}
946
Roland Levillainf89cd092019-07-29 16:22:59 +0100947func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700948 ccLibDepTag, ok := depTag.(libraryDependencyTag)
949 return ok && ccLibDepTag.shared()
950}
951
952func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
953 ccLibDepTag, ok := depTag.(libraryDependencyTag)
954 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100955}
956
Zach Johnson3df4e632020-11-06 11:56:27 -0800957func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
958 ccLibDepTag, ok := depTag.(libraryDependencyTag)
959 return ok && ccLibDepTag.header()
960}
961
Roland Levillainf89cd092019-07-29 16:22:59 +0100962func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800963 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100964}
965
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +0000966func ExcludeInApexDepTag(depTag blueprint.DependencyTag) bool {
967 ccLibDepTag, ok := depTag.(libraryDependencyTag)
968 return ok && ccLibDepTag.excludeInApex
969}
970
Colin Crossca860ac2016-01-04 14:34:37 -0800971// Module contains the properties and members used by all C/C++ module types, and implements
972// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500973// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
974// interface.
975//
976// To define a C/C++ related module, construct a new Module object and point its delegates to
977// type-specific structs. These delegates will be invoked to register module-specific build
978// statements which may be unique to the module type. For example, module.compiler.compile() should
979// be defined so as to register build statements which are responsible for compiling the module.
980//
981// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
982// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
983// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
984// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800985type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700986 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700987
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700988 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700989 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700990 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700991
Colin Crossca860ac2016-01-04 14:34:37 -0800992 // initialize before calling Init
Yu Liu76d94462024-10-31 23:32:36 +0000993 hod android.HostOrDeviceSupported
994 multilib android.Multilib
995 testModule bool
996 incremental bool
Colin Crossc472d572015-03-17 15:06:21 -0700997
Paul Duffina0843f62019-12-13 19:50:38 +0000998 // Allowable SdkMemberTypes of this module type.
999 sdkMemberTypes []android.SdkMemberType
1000
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001001 // decorator delegates, initialize before calling Init
1002 // these may contain module-specific implementations, and effectively allow for custom
1003 // type-specific logic. These members may reference different objects or the same object.
1004 // Functions of these decorators will be invoked to initialize and register type-specific
1005 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -08001006 generators []Generator
1007 compiler compiler
1008 linker linker
1009 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -05001010
Spandan Dase12d2522023-09-12 21:42:31 +00001011 features []feature
1012 stl *stl
1013 sanitize *sanitize
1014 coverage *coverage
1015 fuzzer *fuzzer
1016 sabi *sabi
Spandan Dase12d2522023-09-12 21:42:31 +00001017 lto *lto
1018 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001019 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -08001020
Colin Cross31076b32020-10-23 17:22:06 -07001021 library libraryInterface
1022
Colin Cross635c3b02016-05-18 15:37:25 -07001023 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -08001024
Colin Crossb98c8b02016-07-29 13:44:28 -07001025 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -07001026
Yu Liue70976d2024-10-15 20:45:35 +00001027 subAndroidMkOnce map[subAndroidMkProviderInfoProducer]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001028
1029 // Flags used to compile this module
1030 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -07001031
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001032 // Shared flags among build rules of this module
1033 sharedFlags SharedFlags
1034
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001035 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -07001036 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +09001037
1038 makeLinkType string
Jooyung Han75568392020-03-20 04:29:24 +09001039
1040 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -07001041 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07001042
1043 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -08001044
Inseob Kim37e0bb02024-04-29 15:54:44 +09001045 logtagsPaths android.Paths
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001046
1047 WholeRustStaticlib bool
Cole Faust96a692b2024-08-08 14:47:51 -07001048
1049 hasAidl bool
1050 hasLex bool
1051 hasProto bool
1052 hasRenderscript bool
1053 hasSysprop bool
1054 hasWinMsg bool
1055 hasYacc bool
Yu Liu76d94462024-10-31 23:32:36 +00001056
1057 makeVarsInfo *CcMakeVarsInfo
Colin Crossc472d572015-03-17 15:06:21 -07001058}
1059
Yu Liu76d94462024-10-31 23:32:36 +00001060func (c *Module) IncrementalSupported() bool {
1061 return c.incremental
1062}
1063
1064var _ blueprint.Incremental = (*Module)(nil)
1065
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001066func (c *Module) AddJSONData(d *map[string]interface{}) {
1067 c.AndroidModuleBase().AddJSONData(d)
1068 (*d)["Cc"] = map[string]interface{}{
1069 "SdkVersion": c.SdkVersion(),
1070 "MinSdkVersion": c.MinSdkVersion(),
1071 "VndkVersion": c.VndkVersion(),
1072 "ProductSpecific": c.ProductSpecific(),
1073 "SocSpecific": c.SocSpecific(),
1074 "DeviceSpecific": c.DeviceSpecific(),
1075 "InProduct": c.InProduct(),
1076 "InVendor": c.InVendor(),
1077 "InRamdisk": c.InRamdisk(),
1078 "InVendorRamdisk": c.InVendorRamdisk(),
1079 "InRecovery": c.InRecovery(),
1080 "VendorAvailable": c.VendorAvailable(),
1081 "ProductAvailable": c.ProductAvailable(),
1082 "RamdiskAvailable": c.RamdiskAvailable(),
1083 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
1084 "RecoveryAvailable": c.RecoveryAvailable(),
1085 "OdmAvailable": c.OdmAvailable(),
1086 "InstallInData": c.InstallInData(),
1087 "InstallInRamdisk": c.InstallInRamdisk(),
1088 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
1089 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
1090 "InstallInRecovery": c.InstallInRecovery(),
1091 "InstallInRoot": c.InstallInRoot(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001092 "IsLlndk": c.IsLlndk(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001093 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
1094 "ApexSdkVersion": c.apexSdkVersion,
Cole Faust96a692b2024-08-08 14:47:51 -07001095 "AidlSrcs": c.hasAidl,
1096 "LexSrcs": c.hasLex,
1097 "ProtoSrcs": c.hasProto,
1098 "RenderscriptSrcs": c.hasRenderscript,
1099 "SyspropSrcs": c.hasSysprop,
1100 "WinMsgSrcs": c.hasWinMsg,
1101 "YaccSrsc": c.hasYacc,
1102 "OnlyCSrcs": !(c.hasAidl || c.hasLex || c.hasProto || c.hasRenderscript || c.hasSysprop || c.hasWinMsg || c.hasYacc),
Yi Kong5786f5c2024-05-28 02:22:34 +09001103 "OptimizeForSize": c.OptimizeForSize(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001104 }
1105}
1106
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001107func (c *Module) SetPreventInstall() {
1108 c.Properties.PreventInstall = true
1109}
1110
1111func (c *Module) SetHideFromMake() {
1112 c.Properties.HideFromMake = true
1113}
1114
Ivan Lozanod7586b62021-04-01 09:49:36 -04001115func (c *Module) HiddenFromMake() bool {
1116 return c.Properties.HideFromMake
1117}
1118
Cole Fauste8a87832024-09-11 11:35:46 -07001119func (c *Module) RequiredModuleNames(ctx android.ConfigurableEvaluatorContext) []string {
Cole Faust43ddd082024-06-17 12:32:40 -07001120 required := android.CopyOf(c.ModuleBase.RequiredModuleNames(ctx))
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001121 if c.ImageVariation().Variation == android.CoreVariation {
1122 required = append(required, c.Properties.Target.Platform.Required...)
1123 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1124 } else if c.InRecovery() {
1125 required = append(required, c.Properties.Target.Recovery.Required...)
1126 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1127 }
1128 return android.FirstUniqueStrings(required)
1129}
1130
Ivan Lozano52767be2019-10-18 14:49:46 -07001131func (c *Module) Toc() android.OptionalPath {
1132 if c.linker != nil {
1133 if library, ok := c.linker.(libraryInterface); ok {
1134 return library.toc()
1135 }
1136 }
1137 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1138}
1139
1140func (c *Module) ApiLevel() string {
1141 if c.linker != nil {
1142 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001143 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001144 }
1145 }
1146 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1147}
1148
1149func (c *Module) Static() bool {
1150 if c.linker != nil {
1151 if library, ok := c.linker.(libraryInterface); ok {
1152 return library.static()
1153 }
1154 }
1155 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1156}
1157
1158func (c *Module) Shared() bool {
1159 if c.linker != nil {
1160 if library, ok := c.linker.(libraryInterface); ok {
1161 return library.shared()
1162 }
1163 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001164
Ivan Lozano52767be2019-10-18 14:49:46 -07001165 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1166}
1167
1168func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001169 if c.stl != nil {
1170 return c.stl.Properties.SelectedStl
1171 }
1172 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001173}
1174
Ivan Lozano52767be2019-10-18 14:49:46 -07001175func (c *Module) StubDecorator() bool {
1176 if _, ok := c.linker.(*stubDecorator); ok {
1177 return true
1178 }
1179 return false
1180}
1181
Yi Kong5786f5c2024-05-28 02:22:34 +09001182func (c *Module) OptimizeForSize() bool {
1183 return Bool(c.Properties.Optimize_for_size)
1184}
1185
Ivan Lozano52767be2019-10-18 14:49:46 -07001186func (c *Module) SdkVersion() string {
1187 return String(c.Properties.Sdk_version)
1188}
1189
Artur Satayev480e25b2020-04-27 18:53:18 +01001190func (c *Module) MinSdkVersion() string {
1191 return String(c.Properties.Min_sdk_version)
1192}
1193
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001194func (c *Module) SetSdkVersion(s string) {
1195 c.Properties.Sdk_version = StringPtr(s)
1196}
1197
1198func (c *Module) SetMinSdkVersion(s string) {
1199 c.Properties.Min_sdk_version = StringPtr(s)
1200}
1201
1202func (c *Module) SetStl(s string) {
1203 if c.stl != nil {
1204 c.stl.Properties.Stl = StringPtr(s)
1205 }
1206}
1207
1208func (c *Module) IsCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001209 if linker, ok := c.linker.(*objectLinker); ok {
1210 return linker.isCrt()
1211 }
1212 return false
1213}
1214
Jiyong Park5df7bd32021-08-25 16:18:46 +09001215func (c *Module) SplitPerApiLevel() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001216 return CanUseSdk(c) && c.IsCrt()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001217}
1218
Colin Crossc511bc52020-04-07 16:50:32 +00001219func (c *Module) AlwaysSdk() bool {
1220 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1221}
1222
Ivan Lozano183a3212019-10-18 14:18:45 -07001223func (c *Module) CcLibrary() bool {
1224 if c.linker != nil {
1225 if _, ok := c.linker.(*libraryDecorator); ok {
1226 return true
1227 }
Colin Crossd48fe732020-09-23 20:37:24 -07001228 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1229 return true
1230 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001231 }
1232 return false
1233}
1234
1235func (c *Module) CcLibraryInterface() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001236 if c.library != nil {
Ivan Lozano183a3212019-10-18 14:18:45 -07001237 return true
1238 }
1239 return false
1240}
1241
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001242func (c *Module) RlibStd() bool {
1243 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1244}
1245
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001246func (c *Module) RustLibraryInterface() bool {
1247 return false
1248}
1249
Ivan Lozano0a468a42024-05-13 21:03:34 -04001250func (c *Module) CrateName() string {
1251 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1252}
1253
1254func (c *Module) ExportedCrateLinkDirs() []string {
1255 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1256}
1257
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001258func (c *Module) IsFuzzModule() bool {
1259 if _, ok := c.compiler.(*fuzzBinary); ok {
1260 return true
1261 }
1262 return false
1263}
1264
1265func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1266 return c.FuzzModule
1267}
1268
1269func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1270 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1271 return fuzzer.fuzzPackagedModule
1272 }
1273 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1274}
1275
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001276func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001277 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1278 return fuzzer.sharedLibraries
1279 }
1280 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1281}
1282
Ivan Lozano2b262972019-11-21 12:30:50 -08001283func (c *Module) NonCcVariants() bool {
1284 return false
1285}
1286
Ivan Lozano183a3212019-10-18 14:18:45 -07001287func (c *Module) SetStatic() {
1288 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001289 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001290 library.setStatic()
1291 return
1292 }
1293 }
1294 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1295}
1296
1297func (c *Module) SetShared() {
1298 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001299 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001300 library.setShared()
1301 return
1302 }
1303 }
1304 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1305}
1306
1307func (c *Module) BuildStaticVariant() bool {
1308 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001309 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001310 return library.buildStatic()
1311 }
1312 }
1313 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1314}
1315
1316func (c *Module) BuildSharedVariant() bool {
1317 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001318 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001319 return library.buildShared()
1320 }
1321 }
1322 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1323}
1324
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001325func (c *Module) BuildRlibVariant() bool {
1326 // cc modules can never build rlib variants
1327 return false
1328}
1329
Ivan Lozano183a3212019-10-18 14:18:45 -07001330func (c *Module) Module() android.Module {
1331 return c
1332}
1333
Jiyong Parkc20eee32018-09-05 22:36:17 +09001334func (c *Module) OutputFile() android.OptionalPath {
1335 return c.outputFile
1336}
1337
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001338func (c *Module) CoverageFiles() android.Paths {
1339 if c.linker != nil {
1340 if library, ok := c.linker.(libraryInterface); ok {
1341 return library.objs().coverageFiles
1342 }
1343 }
1344 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1345}
1346
Ivan Lozano183a3212019-10-18 14:18:45 -07001347var _ LinkableInterface = (*Module)(nil)
1348
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001349func (c *Module) VersionedInterface() VersionedInterface {
1350 if c.library != nil {
1351 return c.library
1352 }
1353 return nil
1354}
1355
Jiyong Park719b4462019-01-13 00:39:51 +09001356func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001357 if c.linker != nil {
1358 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001359 }
1360 return nil
1361}
1362
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001363func (c *Module) CoverageOutputFile() android.OptionalPath {
1364 if c.linker != nil {
1365 return c.linker.coverageOutputFilePath()
1366 }
1367 return android.OptionalPath{}
1368}
1369
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001370func (c *Module) RelativeInstallPath() string {
1371 if c.installer != nil {
1372 return c.installer.relativeInstallPath()
1373 }
1374 return ""
1375}
1376
Jooyung Han344d5432019-08-23 11:17:39 +09001377func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001378 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001379}
1380
Colin Cross36242852017-06-23 15:06:31 -07001381func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001382 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001383 for _, generator := range c.generators {
1384 c.AddProperties(generator.GeneratorProps()...)
1385 }
Colin Crossca860ac2016-01-04 14:34:37 -08001386 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001387 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001388 }
1389 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001390 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001391 }
1392 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001393 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001394 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001395 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001396 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001397 }
Colin Cross16b23492016-01-06 14:41:07 -08001398 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001399 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001400 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001401 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001402 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001403 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001404 if c.fuzzer != nil {
1405 c.AddProperties(c.fuzzer.props()...)
1406 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001407 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001408 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001409 }
Stephen Craneba090d12017-05-09 15:44:35 -07001410 if c.lto != nil {
1411 c.AddProperties(c.lto.props()...)
1412 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001413 if c.afdo != nil {
1414 c.AddProperties(c.afdo.props()...)
1415 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001416 if c.orderfile != nil {
1417 c.AddProperties(c.orderfile.props()...)
1418 }
Colin Crossca860ac2016-01-04 14:34:37 -08001419 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001420 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001421 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001422 // Allow test-only on libraries that are not cc_test_library
1423 if c.library != nil && !c.testLibrary() {
1424 c.AddProperties(&c.sourceProperties)
1425 }
Colin Crossc472d572015-03-17 15:06:21 -07001426
Colin Cross36242852017-06-23 15:06:31 -07001427 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001428 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001429 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001430
Colin Cross36242852017-06-23 15:06:31 -07001431 return c
Colin Crossc472d572015-03-17 15:06:21 -07001432}
1433
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001434// UseVndk() returns true if this module is built against VNDK.
1435// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001436func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001437 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001438}
1439
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001440func CanUseSdk(c LinkableInterface) bool {
1441 return c.Module().Target().Os == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001442 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001443}
1444
1445func (c *Module) UseSdk() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001446 if CanUseSdk(c) {
Colin Cross1348ce32020-10-01 13:37:16 -07001447 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001448 }
1449 return false
1450}
1451
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001452func (c *Module) isCoverageVariant() bool {
1453 return c.coverage.Properties.IsCoverageVariant
1454}
1455
Colin Cross95f1ca02020-10-29 20:47:22 -07001456func (c *Module) IsNdk(config android.Config) bool {
1457 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001458}
1459
Colin Cross127bb8b2020-12-16 16:46:01 -08001460func (c *Module) IsLlndk() bool {
1461 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001462}
1463
Colin Cross1f3f1302021-04-26 18:37:44 -07001464func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001465 lib := moduleVersionedInterface(m)
1466 return lib != nil && (lib.HasLLNDKStubs() || lib.HasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001467}
1468
Colin Cross5271fea2021-04-27 13:06:04 -07001469func (m *Module) NeedsVendorPublicLibraryVariants() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001470 lib := moduleVersionedInterface(m)
1471 return lib != nil && (lib.HasVendorPublicLibrary())
Colin Cross5271fea2021-04-27 13:06:04 -07001472}
1473
1474// IsVendorPublicLibrary returns true for vendor public libraries.
1475func (c *Module) IsVendorPublicLibrary() bool {
1476 return c.VendorProperties.IsVendorPublicLibrary
1477}
1478
Ivan Lozanof1868af2022-04-12 13:08:36 -04001479func (c *Module) IsVndkPrebuiltLibrary() bool {
1480 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1481 return true
1482 }
1483 return false
1484}
1485
1486func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1487 return c.Properties.SdkAndPlatformVariantVisibleToMake
1488}
1489
Ivan Lozanod7586b62021-04-01 09:49:36 -04001490func (c *Module) HasLlndkStubs() bool {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001491 lib := moduleVersionedInterface(c)
1492 return lib != nil && lib.HasLLNDKStubs()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001493}
1494
1495func (c *Module) StubsVersion() string {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001496 if lib, ok := c.linker.(VersionedInterface); ok {
1497 return lib.StubsVersion()
Ivan Lozanod7586b62021-04-01 09:49:36 -04001498 }
1499 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1500}
1501
Colin Cross127bb8b2020-12-16 16:46:01 -08001502// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1503// and does not set llndk.vendor_available: false.
1504func (c *Module) isImplementationForLLNDKPublic() bool {
1505 library, _ := c.library.(*libraryDecorator)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001506 return library != nil && library.HasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001507 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001508}
1509
Colin Cross3513fb12024-01-24 14:44:47 -08001510func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001511 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001512 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001513 }
1514 return false
1515}
1516
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001517func (c *Module) isOrderfileCompile() bool {
1518 if orderfile := c.orderfile; orderfile != nil {
1519 return orderfile.Properties.OrderfileLoad
1520 }
1521 return false
1522}
1523
Yi Kongc702ebd2022-08-19 16:02:45 +08001524func (c *Module) isCfi() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001525 return c.sanitize.isSanitizerEnabled(cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001526}
1527
Yi Konged79fa32023-06-04 17:15:42 +09001528func (c *Module) isFuzzer() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001529 return c.sanitize.isSanitizerEnabled(Fuzzer)
Yi Konged79fa32023-06-04 17:15:42 +09001530}
1531
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001532func (c *Module) isNDKStubLibrary() bool {
1533 if _, ok := c.compiler.(*stubDecorator); ok {
1534 return true
1535 }
1536 return false
1537}
1538
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001539func (c *Module) SubName() string {
1540 return c.Properties.SubName
1541}
1542
Jiyong Park25fc6a92018-11-18 18:02:45 +09001543func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001544 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001545 return lib.BuildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001546 }
1547 return false
1548}
1549
1550func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001551 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001552 return lib.HasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001553 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001554 return false
1555}
1556
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00001557func (c *Module) RustApexExclude() bool {
1558 return false
1559}
1560
Alan Stokes73feba32022-11-14 12:21:24 +00001561func (c *Module) IsStubsImplementationRequired() bool {
1562 if lib := c.library; lib != nil {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001563 return lib.IsStubsImplementationRequired()
Alan Stokes73feba32022-11-14 12:21:24 +00001564 }
1565 return false
1566}
1567
Colin Cross0477b422020-10-13 18:43:54 -07001568// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1569// the implementation. If it is an implementation library it returns its own name.
1570func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1571 name := ctx.OtherModuleName(c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001572 if versioned, ok := c.linker.(VersionedInterface); ok {
1573 name = versioned.ImplementationModuleName(name)
Colin Cross0477b422020-10-13 18:43:54 -07001574 }
1575 return name
1576}
1577
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001578// Similar to ImplementationModuleNameByCtx, but uses the Make variant of the module
Martin Stjernholm2856c662020-12-02 15:03:42 +00001579// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1580// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1581// under the premise that the prebuilt module overrides its source counterpart
1582// if it is exposed to Make).
Yu Liu0a37d422025-02-13 02:05:00 +00001583func (c *Module) ImplementationModuleNameForMake() string {
Martin Stjernholm2856c662020-12-02 15:03:42 +00001584 name := c.BaseModuleName()
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001585 if versioned, ok := c.linker.(VersionedInterface); ok {
1586 name = versioned.ImplementationModuleName(name)
Martin Stjernholm2856c662020-12-02 15:03:42 +00001587 }
1588 return name
1589}
1590
Jiyong Park7d55b612021-06-11 17:22:09 +09001591func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001592 return Bool(c.Properties.Bootstrap)
1593}
1594
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001595func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001596 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1597 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1598 return false
1599 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001600 return c.linker != nil && c.linker.nativeCoverage()
1601}
1602
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001603func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001604 if p, ok := c.linker.(SnapshotInterface); ok {
1605 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001606 }
1607 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001608}
1609
Jiyong Parkf1194352019-02-25 11:05:47 +09001610func isBionic(name string) bool {
1611 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001612 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001613 return true
1614 }
1615 return false
1616}
1617
Martin Stjernholm279de572019-09-10 23:18:20 +01001618func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001619 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001620 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001621 }
1622 return isBionic(name)
1623}
1624
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001625func (c *Module) isCfiAssemblySupportEnabled() bool {
1626 return c.sanitize != nil &&
1627 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1628}
1629
Inseob Kim800d1142021-06-14 12:03:51 +09001630func (c *Module) InstallInRoot() bool {
1631 return c.installer != nil && c.installer.installInRoot()
1632}
1633
Colin Crossca860ac2016-01-04 14:34:37 -08001634type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001635 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001636 moduleContextImpl
1637}
1638
Colin Cross37047f12016-12-13 17:06:13 -08001639type depsContext struct {
1640 android.BottomUpMutatorContext
1641 moduleContextImpl
1642}
1643
Colin Crossca860ac2016-01-04 14:34:37 -08001644type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001645 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001646 moduleContextImpl
1647}
1648
1649type moduleContextImpl struct {
1650 mod *Module
1651 ctx BaseModuleContext
1652}
1653
Colin Crossb98c8b02016-07-29 13:44:28 -07001654func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001655 return ctx.mod.toolchain(ctx.ctx)
1656}
1657
1658func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001659 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001660}
1661
1662func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001663 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001664}
1665
Colin Cross6a730042024-12-05 13:53:43 -08001666func (ctx *moduleContextImpl) staticLibrary() bool {
1667 return ctx.mod.staticLibrary()
1668}
1669
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001670func (ctx *moduleContextImpl) testBinary() bool {
1671 return ctx.mod.testBinary()
1672}
1673
Yi Kong56fc1b62022-09-06 16:24:00 +08001674func (ctx *moduleContextImpl) testLibrary() bool {
1675 return ctx.mod.testLibrary()
1676}
1677
Jiyong Park1d1119f2019-07-29 21:27:18 +09001678func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001679 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001680}
1681
Inseob Kim7f283f42020-06-01 21:53:49 +09001682func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001683 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001684}
1685
Inseob Kim1042d292020-06-01 23:23:05 +09001686func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001687 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001688}
1689
Yi Kong5786f5c2024-05-28 02:22:34 +09001690func (ctx *moduleContextImpl) optimizeForSize() bool {
1691 return ctx.mod.OptimizeForSize()
1692}
1693
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001694func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001695 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001696}
1697
1698func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001699 if ctx.ctx.Device() {
Justin Yun732aa6a2018-03-23 17:43:47 +09001700 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001701 }
1702 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001703}
1704
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001705func MinSdkVersion(mod VersionedLinkableInterface, ctxIsForPlatform bool, device bool,
1706 platformSdkVersion string) string {
1707
1708 ver := mod.MinSdkVersion()
1709 if ver == "apex_inherit" && !ctxIsForPlatform {
1710 ver = mod.ApexSdkVersion().String()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001711 }
1712 if ver == "apex_inherit" || ver == "" {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001713 ver = mod.SdkVersion()
Jiyong Parkb35a8192020-08-10 15:59:36 +09001714 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001715
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001716 if device {
Jooyung Hanaa2d3f52024-11-09 02:41:06 +00001717 // When building for vendor/product, use the latest _stable_ API as "current".
1718 // This is passed to clang/aidl compilers so that compiled/generated code works
1719 // with the system.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001720 if (mod.InVendor() || mod.InProduct()) && (ver == "" || ver == "current") {
1721 ver = platformSdkVersion
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001722 }
1723 }
1724
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001725 // For crt objects, the meaning of min_sdk_version is very different from other types of
1726 // module. For them, min_sdk_version defines the oldest version that the build system will
1727 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1728 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1729 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001730 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1731 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1732 // support such an old version. The version is set to the later version in case when the
1733 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1734 // it's for an APEX.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001735 if mod.IsCrt() && !mod.IsSdkVariant() {
1736 if ctxIsForPlatform {
Jiyong Park5df7bd32021-08-25 16:18:46 +09001737 ver = strconv.Itoa(android.FutureApiLevelInt)
1738 } else { // for apex
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001739 ver = mod.ApexSdkVersion().String()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001740 if ver == "" { // in case when min_sdk_version was not set by the APEX
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001741 ver = mod.SdkVersion()
Jiyong Park5df7bd32021-08-25 16:18:46 +09001742 }
1743 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001744 }
1745
Jiyong Parkb35a8192020-08-10 15:59:36 +09001746 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001747 sdkVersionInt, err := strconv.Atoi(mod.SdkVersion())
Jiyong Parkb35a8192020-08-10 15:59:36 +09001748 minSdkVersionInt, err2 := strconv.Atoi(ver)
1749 if err == nil && err2 == nil {
1750 if sdkVersionInt < minSdkVersionInt {
1751 return strconv.Itoa(sdkVersionInt)
1752 }
1753 }
1754 return ver
1755}
1756
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001757func (ctx *moduleContextImpl) minSdkVersion() string {
1758 platformSdkVersion := ""
1759 if ctx.ctx.Device() {
1760 platformSdkVersion = ctx.ctx.Config().PlatformSdkVersion().String()
1761 }
1762 return MinSdkVersion(ctx.mod, CtxIsForPlatform(ctx.ctx), ctx.ctx.Device(), platformSdkVersion)
1763}
1764
Jiyong Parkb35a8192020-08-10 15:59:36 +09001765func (ctx *moduleContextImpl) isSdkVariant() bool {
1766 return ctx.mod.IsSdkVariant()
1767}
1768
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001769func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001770 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001771}
Justin Yun8effde42017-06-23 19:24:43 +09001772
Kiyoung Kimaa394802024-01-08 12:55:45 +09001773func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1774 return ctx.mod.InVendorOrProduct()
1775}
1776
Colin Cross95f1ca02020-10-29 20:47:22 -07001777func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1778 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001779}
1780
Colin Cross127bb8b2020-12-16 16:46:01 -08001781func (ctx *moduleContextImpl) IsLlndk() bool {
1782 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001783}
1784
Colin Cross127bb8b2020-12-16 16:46:01 -08001785func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1786 return ctx.mod.isImplementationForLLNDKPublic()
1787}
1788
Colin Cross3513fb12024-01-24 14:44:47 -08001789func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1790 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001791}
1792
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001793func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1794 return ctx.mod.isOrderfileCompile()
1795}
1796
Yi Kongc702ebd2022-08-19 16:02:45 +08001797func (ctx *moduleContextImpl) isCfi() bool {
1798 return ctx.mod.isCfi()
1799}
1800
Yi Konged79fa32023-06-04 17:15:42 +09001801func (ctx *moduleContextImpl) isFuzzer() bool {
1802 return ctx.mod.isFuzzer()
1803}
1804
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001805func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1806 return ctx.mod.isNDKStubLibrary()
1807}
1808
Colin Cross5271fea2021-04-27 13:06:04 -07001809func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1810 return ctx.mod.IsVendorPublicLibrary()
1811}
1812
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001813func (ctx *moduleContextImpl) selectedStl() string {
1814 if stl := ctx.mod.stl; stl != nil {
1815 return stl.Properties.SelectedStl
1816 }
1817 return ""
1818}
1819
Ivan Lozanobd721262018-11-27 14:33:03 -08001820func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1821 return ctx.mod.linker.useClangLld(actx)
1822}
1823
Colin Crossce75d2c2016-10-06 16:12:58 -07001824func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001825 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001826}
1827
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001828func CtxIsForPlatform(ctx android.BaseModuleContext) bool {
1829 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crossff694a82023-12-13 15:54:49 -08001830 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001831}
1832
Colin Crosse07f2312020-08-13 11:24:56 -07001833func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001834 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1835 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001836}
1837
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001838func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001839 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001840}
1841
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001842func (ctx *moduleContextImpl) nativeCoverage() bool {
1843 return ctx.mod.nativeCoverage()
1844}
1845
Colin Cross95b07f22020-12-16 11:06:50 -08001846func (ctx *moduleContextImpl) isPreventInstall() bool {
1847 return ctx.mod.Properties.PreventInstall
1848}
1849
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001850func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1851 shared := &ctx.mod.sharedFlags
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001852 if shared.FlagsMap == nil {
1853 shared.NumSharedFlags = 0
1854 shared.FlagsMap = make(map[string]string)
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001855 }
1856 return shared
1857}
1858
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001859func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1860 return ctx.mod.isCfiAssemblySupportEnabled()
1861}
1862
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001863func (ctx *moduleContextImpl) notInPlatform() bool {
1864 return ctx.mod.NotInPlatform()
1865}
1866
Yu Liu76d94462024-10-31 23:32:36 +00001867func (ctx *moduleContextImpl) getOrCreateMakeVarsInfo() *CcMakeVarsInfo {
1868 if ctx.mod.makeVarsInfo == nil {
1869 ctx.mod.makeVarsInfo = &CcMakeVarsInfo{}
1870 }
1871 return ctx.mod.makeVarsInfo
1872}
1873
Colin Cross635c3b02016-05-18 15:37:25 -07001874func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001875 return &Module{
1876 hod: hod,
1877 multilib: multilib,
1878 }
1879}
1880
Colin Cross635c3b02016-05-18 15:37:25 -07001881func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001882 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001883 module.features = []feature{
1884 &tidyFeature{},
1885 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001886 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001887 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001888 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001889 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001890 module.sabi = &sabi{}
Stephen Craneba090d12017-05-09 15:44:35 -07001891 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001892 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001893 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001894 return module
1895}
1896
Colin Crossce75d2c2016-10-06 16:12:58 -07001897func (c *Module) Prebuilt() *android.Prebuilt {
1898 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1899 return p.prebuilt()
1900 }
1901 return nil
1902}
1903
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001904func (c *Module) IsPrebuilt() bool {
1905 return c.Prebuilt() != nil
1906}
1907
Colin Crossce75d2c2016-10-06 16:12:58 -07001908func (c *Module) Name() string {
1909 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001910 if p, ok := c.linker.(interface {
1911 Name(string) string
1912 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001913 name = p.Name(name)
1914 }
1915 return name
1916}
1917
Ivan Lozano9eaacc82024-10-30 14:28:17 +00001918func (c *Module) Multilib() string {
1919 return c.Arch().ArchType.Multilib
1920}
1921
1922func (c *Module) ApexSdkVersion() android.ApiLevel {
1923 return c.apexSdkVersion
1924}
1925
Alex Light3d673592019-01-18 14:37:31 -08001926func (c *Module) Symlinks() []string {
1927 if p, ok := c.installer.(interface {
1928 symlinkList() []string
1929 }); ok {
1930 return p.symlinkList()
1931 }
1932 return nil
1933}
1934
Chris Parsons216e10a2020-07-09 17:12:52 -04001935func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001936 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001937 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001938 }); ok {
1939 return p.dataPaths()
1940 }
1941 return nil
1942}
1943
Ivan Lozanof1868af2022-04-12 13:08:36 -04001944func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001945 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1946 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001947 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001948 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001949 if c.ProductSpecific() {
1950 // If the module is product specific with 'product_specific: true',
1951 // do not add a name suffix because it is a base module.
1952 return ""
1953 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001954 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001955 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001956 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001957 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001958 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001959 // add version suffix only if the module is using different vndk version than the
1960 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001961 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001962 }
1963 return nameSuffix
1964}
1965
Ivan Lozanof1868af2022-04-12 13:08:36 -04001966func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1967 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001968
1969 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001970 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001971 }
1972
Colin Cross127bb8b2020-12-16 16:46:01 -08001973 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001974 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001975 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1976 // added for product variant only when we have vendor and product variants with core
1977 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001978 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001979 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001980 subName += vendorPublicLibrarySuffix
1981 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001982 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1983 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001984 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001985 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001986 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001987 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001988 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001989 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001990 subName += RecoverySuffix
1991 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1992 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001993 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001994 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001995 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001996 } else if c.IsStubs() && c.IsSdkVariant() {
1997 // Public API surface (NDK)
1998 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1999 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09002000 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04002001
2002 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05002003}
2004
Sam Delmerico75dbca22023-04-20 13:13:25 +00002005func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
2006 ctx := &moduleContext{
2007 ModuleContext: actx,
2008 moduleContextImpl: moduleContextImpl{
2009 mod: c,
2010 },
2011 }
2012 ctx.ctx = ctx
2013 return ctx
2014}
2015
Spandan Das20fce2d2023-04-12 17:21:39 +00002016// TODO (b/277651159): Remove this allowlist
2017var (
2018 skipStubLibraryMultipleApexViolation = map[string]bool{
2019 "libclang_rt.asan": true,
2020 "libclang_rt.hwasan": true,
2021 // runtime apex
2022 "libc": true,
2023 "libc_hwasan": true,
2024 "libdl_android": true,
2025 "libm": true,
2026 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00002027 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00002028 // art apex
Martin Stjernholm75598032024-07-12 18:47:26 +01002029 // TODO(b/234351700): Remove this when com.android.art.debug is gone.
Spandan Das20fce2d2023-04-12 17:21:39 +00002030 "libandroidio": true,
2031 "libdexfile": true,
Martin Stjernholm75598032024-07-12 18:47:26 +01002032 "libdexfiled": true, // com.android.art.debug only
Spandan Das20fce2d2023-04-12 17:21:39 +00002033 "libnativebridge": true,
2034 "libnativehelper": true,
2035 "libnativeloader": true,
2036 "libsigchain": true,
2037 }
2038)
2039
2040// Returns true if a stub library could be installed in multiple apexes
2041func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
2042 // If this is not an apex variant, no check necessary
Colin Cross2dcbca62024-11-20 14:55:14 -08002043 if info, ok := android.ModuleProvider(ctx, android.ApexInfoProvider); !ok || info.IsForPlatform() {
Spandan Das20fce2d2023-04-12 17:21:39 +00002044 return false
2045 }
2046 // If this is not a stub library, no check necessary
2047 if !c.HasStubsVariants() {
2048 return false
2049 }
2050 // Skip the allowlist
2051 // Use BaseModuleName so that this matches prebuilts.
2052 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
2053 return false
2054 }
2055
Spandan Das20fce2d2023-04-12 17:21:39 +00002056 // Stub libraries should not have more than one apex_available
Colin Crossaf4c8562024-11-20 15:07:58 -08002057 apexAvailable := android.FirstUniqueStrings(c.ApexAvailable())
2058 if len(apexAvailable) > 1 {
Spandan Das20fce2d2023-04-12 17:21:39 +00002059 return true
2060 }
2061 // Stub libraries should not use the wildcard
Colin Crossaf4c8562024-11-20 15:07:58 -08002062 if apexAvailable[0] == android.AvailableToAnyApex {
Spandan Das20fce2d2023-04-12 17:21:39 +00002063 return true
2064 }
2065 // Default: no violation
2066 return false
2067}
2068
Chris Parsons8d6e4332021-02-22 16:13:50 -05002069func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002070 ctx := moduleContextFromAndroidModuleContext(actx, c)
2071
Inseob Kim37e0bb02024-04-29 15:54:44 +09002072 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
2073 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
2074 Logtags: c.logtagsPaths,
2075 })
2076
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002077 // If Test_only is set on a module in bp file, respect the setting, otherwise
2078 // see if is a known test module type.
2079 testOnly := c.testModule || c.testLibrary()
2080 if c.sourceProperties.Test_only != nil {
2081 testOnly = Bool(c.sourceProperties.Test_only)
2082 }
2083 // Keep before any early returns.
2084 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2085 TestOnly: testOnly,
2086 TopLevelTarget: c.testModule,
2087 })
2088
Ivan Lozanof1868af2022-04-12 13:08:36 -04002089 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002090 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002091 if !apexInfo.IsForPlatform() {
2092 c.hideApexVariantFromMake = true
2093 }
2094
Chris Parsonseefc9e62021-04-02 17:36:47 -04002095 c.makeLinkType = GetMakeLinkType(actx, c)
2096
Colin Crossf18e1102017-11-16 14:33:08 -08002097 deps := c.depsToPaths(ctx)
2098 if ctx.Failed() {
2099 return
2100 }
2101
Joe Onorato37f900c2023-07-18 16:58:16 -07002102 for _, generator := range c.generators {
2103 gen := generator.GeneratorSources(ctx)
2104 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2105 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2106 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2107 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2108 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2109 if len(deps.Objs.objFiles) == 0 {
2110 // If we are reusuing object files (which happens when we're a shared library and we're
2111 // reusing our static variant's object files), then skip adding the actual source files,
2112 // because we already have the object for it.
2113 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2114 }
2115 }
2116
2117 if ctx.Failed() {
2118 return
2119 }
2120
Spandan Das20fce2d2023-04-12 17:21:39 +00002121 if c.stubLibraryMultipleApexViolation(actx) {
2122 actx.PropertyErrorf("apex_available",
2123 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2124 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002125 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2126 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002127 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2128 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002129 }
2130
Colin Crossca860ac2016-01-04 14:34:37 -08002131 flags := Flags{
2132 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002133 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002134 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002135 for _, generator := range c.generators {
2136 flags = generator.GeneratorFlags(ctx, flags, deps)
2137 }
Colin Crossca860ac2016-01-04 14:34:37 -08002138 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002139 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002140 }
2141 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002142 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002143 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002144 if c.stl != nil {
2145 flags = c.stl.flags(ctx, flags)
2146 }
Colin Cross16b23492016-01-06 14:41:07 -08002147 if c.sanitize != nil {
2148 flags = c.sanitize.flags(ctx, flags)
2149 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002150 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002151 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002152 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002153 if c.fuzzer != nil {
2154 flags = c.fuzzer.flags(ctx, flags)
2155 }
Stephen Craneba090d12017-05-09 15:44:35 -07002156 if c.lto != nil {
2157 flags = c.lto.flags(ctx, flags)
2158 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002159 if c.afdo != nil {
2160 flags = c.afdo.flags(ctx, flags)
2161 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002162 if c.orderfile != nil {
2163 flags = c.orderfile.flags(ctx, flags)
2164 }
Colin Crossca860ac2016-01-04 14:34:37 -08002165 for _, feature := range c.features {
2166 flags = feature.flags(ctx, flags)
2167 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002168 if ctx.Failed() {
2169 return
2170 }
2171
Colin Cross4af21ed2019-11-04 09:37:55 -08002172 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2173 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2174 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002175
Colin Cross4af21ed2019-11-04 09:37:55 -08002176 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002177
2178 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002179 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002180 }
2181 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002182 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002183 }
2184
Colin Cross3e5e7782022-06-17 22:17:05 +00002185 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2186
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002187 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002188 // We need access to all the flags seen by a source file.
2189 if c.sabi != nil {
2190 flags = c.sabi.flags(ctx, flags)
2191 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002192
Colin Cross4af21ed2019-11-04 09:37:55 -08002193 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002194
Joe Onorato37f900c2023-07-18 16:58:16 -07002195 for _, generator := range c.generators {
2196 generator.GeneratorBuildActions(ctx, flags, deps)
2197 }
2198
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002199 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002200 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002201 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002202 if ctx.Failed() {
2203 return
2204 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002205 }
2206
Colin Crossca860ac2016-01-04 14:34:37 -08002207 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002208 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002209 if ctx.Failed() {
2210 return
2211 }
Colin Cross635c3b02016-05-18 15:37:25 -07002212 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002213
Chris Parsons94a0bba2021-06-04 15:03:47 -04002214 c.maybeUnhideFromMake()
Colin Crossb614cd42024-10-11 12:52:21 -07002215
2216 android.SetProvider(ctx, ImplementationDepInfoProvider, &ImplementationDepInfo{
2217 ImplementationDeps: depset.New(depset.PREORDER, deps.directImplementationDeps, deps.transitiveImplementationDeps),
2218 })
Colin Crossce75d2c2016-10-06 16:12:58 -07002219 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002220
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002221 if Bool(c.Properties.Cmake_snapshot_supported) {
2222 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2223 }
2224
Chris Parsons94a0bba2021-06-04 15:03:47 -04002225 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002226
2227 if c.linker != nil {
2228 moduleInfoJSON := ctx.ModuleInfoJSON()
2229 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2230 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2231 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2232 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2233 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2234
2235 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2236 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2237 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2238 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2239
2240 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2241 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2242 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2243 moduleInfoJSON.SubName += ".cfi"
2244 }
2245 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2246 moduleInfoJSON.SubName += ".hwasan"
2247 }
2248 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2249 moduleInfoJSON.SubName += ".scs"
2250 }
2251 }
2252 moduleInfoJSON.SubName += c.Properties.SubName
2253
2254 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2255 moduleInfoJSON.Uninstallable = true
2256 }
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002257 }
Wei Lia1aa2972024-06-21 13:08:51 -07002258
2259 buildComplianceMetadataInfo(ctx, c, deps)
mrziwangabdb2932024-06-18 12:43:41 -07002260
Cole Faust96a692b2024-08-08 14:47:51 -07002261 if b, ok := c.compiler.(*baseCompiler); ok {
2262 c.hasAidl = b.hasSrcExt(ctx, ".aidl")
2263 c.hasLex = b.hasSrcExt(ctx, ".l") || b.hasSrcExt(ctx, ".ll")
2264 c.hasProto = b.hasSrcExt(ctx, ".proto")
2265 c.hasRenderscript = b.hasSrcExt(ctx, ".rscript") || b.hasSrcExt(ctx, ".fs")
2266 c.hasSysprop = b.hasSrcExt(ctx, ".sysprop")
2267 c.hasWinMsg = b.hasSrcExt(ctx, ".mc")
2268 c.hasYacc = b.hasSrcExt(ctx, ".y") || b.hasSrcExt(ctx, ".yy")
2269 }
2270
Yu Liuec7043d2024-11-05 18:22:20 +00002271 ccObjectInfo := CcObjectInfo{
Yu Liu4f825132024-12-18 00:35:39 +00002272 KytheFiles: objs.kytheFiles,
Yu Liuec7043d2024-11-05 18:22:20 +00002273 }
2274 if !ctx.Config().KatiEnabled() || !android.ShouldSkipAndroidMkProcessing(ctx, c) {
Yu Liu4f825132024-12-18 00:35:39 +00002275 ccObjectInfo.ObjFiles = objs.objFiles
2276 ccObjectInfo.TidyFiles = objs.tidyFiles
Yu Liuec7043d2024-11-05 18:22:20 +00002277 }
Yu Liu4f825132024-12-18 00:35:39 +00002278 if len(ccObjectInfo.KytheFiles)+len(ccObjectInfo.ObjFiles)+len(ccObjectInfo.TidyFiles) > 0 {
Yu Liuec7043d2024-11-05 18:22:20 +00002279 android.SetProvider(ctx, CcObjectInfoProvider, ccObjectInfo)
2280 }
2281
Yu Liuf6f85492025-01-13 21:02:36 +00002282 linkableInfo := CreateCommonLinkableInfo(ctx, c)
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002283 if lib, ok := c.linker.(VersionedInterface); ok {
2284 linkableInfo.StubsVersion = lib.StubsVersion()
Yu Liu8024b922024-12-20 23:31:32 +00002285 }
2286 if c.linker != nil {
2287 if library, ok := c.linker.(libraryInterface); ok {
2288 linkableInfo.Static = library.static()
Yu Liu8a8d5b42025-01-07 00:48:08 +00002289 linkableInfo.Shared = library.shared()
Yu Liu8024b922024-12-20 23:31:32 +00002290 linkableInfo.CoverageFiles = library.objs().coverageFiles
2291 linkableInfo.SAbiDumpFiles = library.objs().sAbiDumpFiles
2292 }
2293 }
2294 android.SetProvider(ctx, LinkableInfoProvider, linkableInfo)
Yu Liu986d98c2024-11-12 00:28:11 +00002295
Yu Liu323d77a2024-12-16 23:13:57 +00002296 ccInfo := CcInfo{
Yu Liu323d77a2024-12-16 23:13:57 +00002297 IsPrebuilt: c.IsPrebuilt(),
2298 CmakeSnapshotSupported: proptools.Bool(c.Properties.Cmake_snapshot_supported),
Yu Liu68a70b72025-01-08 22:54:44 +00002299 HasLlndkStubs: c.HasLlndkStubs(),
Yu Liu0a37d422025-02-13 02:05:00 +00002300 DataPaths: c.DataPaths(),
Yu Liu323d77a2024-12-16 23:13:57 +00002301 }
2302 if c.compiler != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002303 cflags := c.compiler.baseCompilerProps().Cflags
Yu Liu323d77a2024-12-16 23:13:57 +00002304 ccInfo.CompilerInfo = &CompilerInfo{
2305 Srcs: c.compiler.(CompiledInterface).Srcs(),
Cole Faustc9b88c92025-02-06 17:58:26 -08002306 Cflags: cflags.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002307 AidlInterfaceInfo: AidlInterfaceInfo{
2308 Sources: c.compiler.baseCompilerProps().AidlInterface.Sources,
2309 AidlRoot: c.compiler.baseCompilerProps().AidlInterface.AidlRoot,
2310 Lang: c.compiler.baseCompilerProps().AidlInterface.Lang,
2311 Flags: c.compiler.baseCompilerProps().AidlInterface.Flags,
2312 },
2313 }
2314 switch decorator := c.compiler.(type) {
2315 case *libraryDecorator:
2316 ccInfo.CompilerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002317 ExportIncludeDirs: decorator.flagExporter.Properties.Export_include_dirs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002318 }
2319 }
2320 }
2321 if c.linker != nil {
Cole Faustc9b88c92025-02-06 17:58:26 -08002322 baseLinkerProps := c.linker.baseLinkerProps()
Yu Liu323d77a2024-12-16 23:13:57 +00002323 ccInfo.LinkerInfo = &LinkerInfo{
Cole Faustc9b88c92025-02-06 17:58:26 -08002324 WholeStaticLibs: baseLinkerProps.Whole_static_libs.GetOrDefault(ctx, nil),
2325 StaticLibs: baseLinkerProps.Static_libs.GetOrDefault(ctx, nil),
2326 SharedLibs: baseLinkerProps.Shared_libs.GetOrDefault(ctx, nil),
2327 HeaderLibs: baseLinkerProps.Header_libs.GetOrDefault(ctx, nil),
Yu Liu323d77a2024-12-16 23:13:57 +00002328 }
2329 switch decorator := c.linker.(type) {
2330 case *binaryDecorator:
2331 ccInfo.LinkerInfo.BinaryDecoratorInfo = &BinaryDecoratorInfo{}
2332 case *libraryDecorator:
Yu Liu116610a2025-01-06 21:54:48 +00002333 ccInfo.LinkerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
2334 InjectBsslHash: Bool(c.linker.(*libraryDecorator).Properties.Inject_bssl_hash),
2335 }
Yu Liu323d77a2024-12-16 23:13:57 +00002336 case *testBinary:
2337 ccInfo.LinkerInfo.TestBinaryInfo = &TestBinaryInfo{
2338 Gtest: decorator.testDecorator.gtest(),
2339 }
2340 case *benchmarkDecorator:
2341 ccInfo.LinkerInfo.BenchmarkDecoratorInfo = &BenchmarkDecoratorInfo{}
2342 case *objectLinker:
2343 ccInfo.LinkerInfo.ObjectLinkerInfo = &ObjectLinkerInfo{}
Yu Liu8a8d5b42025-01-07 00:48:08 +00002344 case *stubDecorator:
2345 ccInfo.LinkerInfo.StubDecoratorInfo = &StubDecoratorInfo{}
Yu Liu323d77a2024-12-16 23:13:57 +00002346 }
Yu Liu8024b922024-12-20 23:31:32 +00002347
2348 if s, ok := c.linker.(SnapshotInterface); ok {
2349 ccInfo.SnapshotInfo = &SnapshotInfo{
2350 SnapshotAndroidMkSuffix: s.SnapshotAndroidMkSuffix(),
2351 }
Yu Liuffe86322024-12-18 18:53:12 +00002352 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002353 if v, ok := c.linker.(VersionedInterface); ok {
2354 name := v.ImplementationModuleName(ctx.OtherModuleName(c))
Yu Liu68a70b72025-01-08 22:54:44 +00002355 ccInfo.LinkerInfo.ImplementationModuleName = &name
2356 }
Yu Liuffe86322024-12-18 18:53:12 +00002357 }
Yu Liu8a8d5b42025-01-07 00:48:08 +00002358 if c.library != nil {
2359 ccInfo.LibraryInfo = &LibraryInfo{
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002360 BuildStubs: c.library.BuildStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002361 }
2362 }
Yu Liu8024b922024-12-20 23:31:32 +00002363 android.SetProvider(ctx, CcInfoProvider, &ccInfo)
Yu Liub1bfa9d2024-12-05 18:57:51 +00002364
mrziwangabdb2932024-06-18 12:43:41 -07002365 c.setOutputFiles(ctx)
Yu Liu76d94462024-10-31 23:32:36 +00002366
2367 if c.makeVarsInfo != nil {
2368 android.SetProvider(ctx, CcMakeVarsInfoProvider, c.makeVarsInfo)
2369 }
mrziwangabdb2932024-06-18 12:43:41 -07002370}
2371
Yu Liuf6f85492025-01-13 21:02:36 +00002372func CreateCommonLinkableInfo(ctx android.ModuleContext, mod VersionedLinkableInterface) *LinkableInfo {
Yu Liu0a37d422025-02-13 02:05:00 +00002373 info := &LinkableInfo{
Yu Liu8024b922024-12-20 23:31:32 +00002374 StaticExecutable: mod.StaticExecutable(),
2375 HasStubsVariants: mod.HasStubsVariants(),
2376 OutputFile: mod.OutputFile(),
2377 UnstrippedOutputFile: mod.UnstrippedOutputFile(),
Yu Liuf6f85492025-01-13 21:02:36 +00002378 CoverageOutputFile: mod.CoverageOutputFile(),
2379 Partition: mod.Partition(),
Yu Liu8024b922024-12-20 23:31:32 +00002380 IsStubs: mod.IsStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002381 CcLibrary: mod.CcLibrary(),
Yu Liu8024b922024-12-20 23:31:32 +00002382 CcLibraryInterface: mod.CcLibraryInterface(),
2383 RustLibraryInterface: mod.RustLibraryInterface(),
Yu Liu8024b922024-12-20 23:31:32 +00002384 IsLlndk: mod.IsLlndk(),
Yu Liuf6f85492025-01-13 21:02:36 +00002385 IsNdk: mod.IsNdk(ctx.Config()),
Yu Liu8024b922024-12-20 23:31:32 +00002386 HasNonSystemVariants: mod.HasNonSystemVariants(),
2387 SubName: mod.SubName(),
2388 InVendorOrProduct: mod.InVendorOrProduct(),
2389 InRamdisk: mod.InRamdisk(),
2390 OnlyInRamdisk: mod.OnlyInRamdisk(),
2391 InVendorRamdisk: mod.InVendorRamdisk(),
2392 OnlyInVendorRamdisk: mod.OnlyInVendorRamdisk(),
2393 InRecovery: mod.InRecovery(),
2394 OnlyInRecovery: mod.OnlyInRecovery(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002395 Installable: mod.Installable(),
Yu Liu97880e12025-01-07 19:03:34 +00002396 RelativeInstallPath: mod.RelativeInstallPath(),
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00002397 // TODO(b/362509506): remove this once all apex_exclude uses are switched to stubs.
Yu Liu0a37d422025-02-13 02:05:00 +00002398 RustApexExclude: mod.RustApexExclude(),
2399 Bootstrap: mod.Bootstrap(),
2400 Multilib: mod.Multilib(),
2401 ImplementationModuleNameForMake: mod.ImplementationModuleNameForMake(),
2402 Symlinks: mod.Symlinks(),
Yu Liu8024b922024-12-20 23:31:32 +00002403 }
Yu Liu0a37d422025-02-13 02:05:00 +00002404 if mod.VersionedInterface() != nil {
2405 info.IsStubsImplementationRequired = mod.VersionedInterface().IsStubsImplementationRequired()
2406 }
2407 return info
Yu Liu8024b922024-12-20 23:31:32 +00002408}
2409
Yu Liuec7043d2024-11-05 18:22:20 +00002410func setOutputFilesIfNotEmpty(ctx ModuleContext, files android.Paths, tag string) {
2411 if len(files) > 0 {
2412 ctx.SetOutputFiles(files, tag)
2413 }
2414}
2415
mrziwangabdb2932024-06-18 12:43:41 -07002416func (c *Module) setOutputFiles(ctx ModuleContext) {
2417 if c.outputFile.Valid() {
2418 ctx.SetOutputFiles(android.Paths{c.outputFile.Path()}, "")
2419 } else {
2420 ctx.SetOutputFiles(android.Paths{}, "")
2421 }
2422 if c.linker != nil {
2423 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), "unstripped")
2424 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), "stripped_all")
2425 }
Wei Lia1aa2972024-06-21 13:08:51 -07002426}
2427
2428func buildComplianceMetadataInfo(ctx ModuleContext, c *Module, deps PathDeps) {
2429 // Dump metadata that can not be done in android/compliance-metadata.go
2430 complianceMetadataInfo := ctx.ComplianceMetadataInfo()
Wei Li8ede4f72025-01-15 21:24:22 -08002431 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.IS_STATIC_LIB, strconv.FormatBool(ctx.static() || ctx.ModuleType() == "cc_object"))
Wei Lia1aa2972024-06-21 13:08:51 -07002432 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.BUILT_FILES, c.outputFile.String())
2433
2434 // Static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002435 staticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(false))
Wei Lia1aa2972024-06-21 13:08:51 -07002436 staticDepNames := make([]string, 0, len(staticDeps))
2437 for _, dep := range staticDeps {
2438 staticDepNames = append(staticDepNames, dep.Name())
2439 }
Wei Li8ede4f72025-01-15 21:24:22 -08002440 // Process CrtBegin and CrtEnd as static libs
Yu Liu727204c2025-01-23 20:58:32 +00002441 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Wei Li8ede4f72025-01-15 21:24:22 -08002442 depName := ctx.OtherModuleName(dep)
2443 depTag := ctx.OtherModuleDependencyTag(dep)
2444 switch depTag {
2445 case CrtBeginDepTag:
2446 staticDepNames = append(staticDepNames, depName)
2447 case CrtEndDepTag:
2448 staticDepNames = append(staticDepNames, depName)
2449 }
2450 })
Wei Lia1aa2972024-06-21 13:08:51 -07002451
Wei Li8ede4f72025-01-15 21:24:22 -08002452 staticDepPaths := make([]string, 0, len(deps.StaticLibs)+len(deps.CrtBegin)+len(deps.CrtEnd))
Wei Lia1aa2972024-06-21 13:08:51 -07002453 for _, dep := range deps.StaticLibs {
2454 staticDepPaths = append(staticDepPaths, dep.String())
2455 }
Wei Li8ede4f72025-01-15 21:24:22 -08002456 for _, dep := range deps.CrtBegin {
2457 staticDepPaths = append(staticDepPaths, dep.String())
2458 }
2459 for _, dep := range deps.CrtEnd {
2460 staticDepPaths = append(staticDepPaths, dep.String())
2461 }
Wei Lia1aa2972024-06-21 13:08:51 -07002462 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
2463 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEP_FILES, android.FirstUniqueStrings(staticDepPaths))
2464
2465 // Whole static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002466 wholeStaticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(true))
Wei Lia1aa2972024-06-21 13:08:51 -07002467 wholeStaticDepNames := make([]string, 0, len(wholeStaticDeps))
2468 for _, dep := range wholeStaticDeps {
2469 wholeStaticDepNames = append(wholeStaticDepNames, dep.Name())
2470 }
2471
2472 wholeStaticDepPaths := make([]string, 0, len(deps.WholeStaticLibs))
2473 for _, dep := range deps.WholeStaticLibs {
2474 wholeStaticDepPaths = append(wholeStaticDepPaths, dep.String())
2475 }
2476 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEPS, android.FirstUniqueStrings(wholeStaticDepNames))
2477 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEP_FILES, android.FirstUniqueStrings(wholeStaticDepPaths))
Wei Li8ede4f72025-01-15 21:24:22 -08002478
2479 // Header libs
2480 headerLibDeps := ctx.GetDirectDepsProxyWithTag(HeaderDepTag())
2481 headerLibDepNames := make([]string, 0, len(headerLibDeps))
2482 for _, dep := range headerLibDeps {
2483 headerLibDepNames = append(headerLibDepNames, dep.Name())
2484 }
2485 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.HEADER_LIBS, android.FirstUniqueStrings(headerLibDepNames))
Chris Parsons94a0bba2021-06-04 15:03:47 -04002486}
2487
2488func (c *Module) maybeUnhideFromMake() {
2489 // If a lib is directly included in any of the APEXes or is not available to the
2490 // platform (which is often the case when the stub is provided as a prebuilt),
2491 // unhide the stubs variant having the latest version gets visible to make. In
2492 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2493 // force anything in the make world to link against the stubs library. (unless it
2494 // is explicitly referenced via .bootstrap suffix or the module is marked with
2495 // 'bootstrap: true').
2496 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002497 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002498 c.IsStubs() && !c.InVendorRamdisk() {
2499 c.Properties.HideFromMake = false // unhide
2500 // Note: this is still non-installable
2501 }
2502}
2503
Colin Cross8ff10582023-12-07 13:10:56 -08002504// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2505// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002506func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002507 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002508 // If the module has been specifically configure to not be installed then
2509 // hide from make as otherwise it will break when running inside make
2510 // as the output path to install will not be specified. Not all uninstallable
2511 // modules can be hidden from make as some are needed for resolving make side
2512 // dependencies.
2513 c.HideFromMake()
Spandan Das034af2c2024-10-30 21:45:09 +00002514 c.SkipInstall()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002515 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002516 c.SkipInstall()
2517 }
2518
2519 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2520 // to allow using the outputs in a genrule.
2521 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002522 c.installer.install(ctx, c.outputFile.Path())
2523 if ctx.Failed() {
2524 return
Colin Crossca860ac2016-01-04 14:34:37 -08002525 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002526 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002527}
2528
Colin Cross0ea8ba82019-06-06 14:33:29 -07002529func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002530 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002531 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002532 }
Colin Crossca860ac2016-01-04 14:34:37 -08002533 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002534}
2535
Colin Crossca860ac2016-01-04 14:34:37 -08002536func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002537 for _, generator := range c.generators {
2538 generator.GeneratorInit(ctx)
2539 }
Colin Crossca860ac2016-01-04 14:34:37 -08002540 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002541 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002542 }
Colin Crossca860ac2016-01-04 14:34:37 -08002543 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002544 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002545 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002546 if c.stl != nil {
2547 c.stl.begin(ctx)
2548 }
Colin Cross16b23492016-01-06 14:41:07 -08002549 if c.sanitize != nil {
2550 c.sanitize.begin(ctx)
2551 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002552 if c.coverage != nil {
2553 c.coverage.begin(ctx)
2554 }
Yi Kong9723e332023-12-04 14:52:53 +09002555 if c.afdo != nil {
2556 c.afdo.begin(ctx)
2557 }
Stephen Craneba090d12017-05-09 15:44:35 -07002558 if c.lto != nil {
2559 c.lto.begin(ctx)
2560 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002561 if c.orderfile != nil {
2562 c.orderfile.begin(ctx)
2563 }
Dan Albert92fe7402020-07-15 13:33:30 -07002564 if ctx.useSdk() && c.IsSdkVariant() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00002565 version, err := NativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002566 if err != nil {
2567 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002568 c.Properties.Sdk_version = nil
2569 } else {
2570 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002571 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002572 }
Colin Crossca860ac2016-01-04 14:34:37 -08002573}
2574
Colin Cross37047f12016-12-13 17:06:13 -08002575func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002576 deps := Deps{}
2577
Joe Onorato37f900c2023-07-18 16:58:16 -07002578 for _, generator := range c.generators {
2579 deps = generator.GeneratorDeps(ctx, deps)
2580 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002581 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002582 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002583 }
2584 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002585 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002586 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002587 if c.stl != nil {
2588 deps = c.stl.deps(ctx, deps)
2589 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002590 if c.coverage != nil {
2591 deps = c.coverage.deps(ctx, deps)
2592 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002593
Colin Crossb6715442017-10-24 11:13:31 -07002594 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2595 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2596 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2597 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2598 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2599 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002600 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002601 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002602
Colin Cross516c5452024-10-28 13:45:21 -07002603 if err := checkConflictingExplicitVersions(deps.SharedLibs); err != nil {
2604 ctx.PropertyErrorf("shared_libs", "%s", err.Error())
2605 }
2606
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002607 for _, lib := range deps.ReexportSharedLibHeaders {
2608 if !inList(lib, deps.SharedLibs) {
2609 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2610 }
2611 }
2612
2613 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002614 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2615 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 -07002616 }
2617 }
2618
Colin Cross5950f382016-12-13 12:50:57 -08002619 for _, lib := range deps.ReexportHeaderLibHeaders {
2620 if !inList(lib, deps.HeaderLibs) {
2621 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2622 }
2623 }
2624
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002625 for _, gen := range deps.ReexportGeneratedHeaders {
2626 if !inList(gen, deps.GeneratedHeaders) {
2627 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2628 }
2629 }
2630
Colin Crossc99deeb2016-04-11 15:06:20 -07002631 return deps
2632}
2633
Colin Cross516c5452024-10-28 13:45:21 -07002634func checkConflictingExplicitVersions(libs []string) error {
2635 withoutVersion := func(s string) string {
2636 name, _ := StubsLibNameAndVersion(s)
2637 return name
2638 }
2639 var errs []error
2640 for i, lib := range libs {
2641 libName := withoutVersion(lib)
2642 libsToCompare := libs[i+1:]
2643 j := slices.IndexFunc(libsToCompare, func(s string) bool {
2644 return withoutVersion(s) == libName
2645 })
2646 if j >= 0 {
2647 errs = append(errs, fmt.Errorf("duplicate shared libraries with different explicit versions: %q and %q",
2648 lib, libsToCompare[j]))
2649 }
2650 }
2651 return errors.Join(errs...)
2652}
2653
Dan Albert7e9d2952016-08-04 13:02:36 -07002654func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002655 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002656 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002657 moduleContextImpl: moduleContextImpl{
2658 mod: c,
2659 },
2660 }
2661 ctx.ctx = ctx
2662
Colin Crossca860ac2016-01-04 14:34:37 -08002663 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002664}
2665
Jiyong Park7ed9de32018-10-15 22:25:07 +09002666// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002667func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002668 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2669 version := name[sharp+1:]
2670 libname := name[:sharp]
2671 return libname, version
2672 }
2673 return name, ""
2674}
2675
Dan Albert92fe7402020-07-15 13:33:30 -07002676func GetCrtVariations(ctx android.BottomUpMutatorContext,
2677 m LinkableInterface) []blueprint.Variation {
2678 if ctx.Os() != android.Android {
2679 return nil
2680 }
2681 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002682 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2683 minSdkVersion := m.MinSdkVersion()
2684 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2685 minSdkVersion = m.SdkVersion()
2686 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002687 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2688 if err != nil {
2689 ctx.PropertyErrorf("min_sdk_version", err.Error())
2690 }
Colin Cross363ec762023-01-13 13:45:14 -08002691
2692 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002693 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002694 if apiLevel.LessThan(minApiForArch) {
2695 apiLevel = minApiForArch
2696 }
2697
Dan Albert92fe7402020-07-15 13:33:30 -07002698 return []blueprint.Variation{
2699 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002700 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002701 }
2702 }
2703 return []blueprint.Variation{
2704 {Mutator: "sdk", Variation: ""},
2705 }
2706}
2707
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002708func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2709 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002710
2711 variations = append([]blueprint.Variation(nil), variations...)
2712
Liz Kammer23942242022-04-08 15:41:00 -04002713 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002714 // Version is explicitly specified. i.e. libFoo#30
Colin Crossb614cd42024-10-11 12:52:21 -07002715 if version == "impl" {
2716 version = ""
2717 }
Colin Crosse7257d22020-09-24 09:56:18 -07002718 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002719 if tag, ok := depTag.(libraryDependencyTag); ok {
2720 tag.explicitlyVersioned = true
Colin Crossbd930bc2025-02-03 12:17:42 -08002721 if version == "" {
2722 tag.explicitlyImpl = true
2723 }
Colin Crossafcdce82024-10-22 13:59:33 -07002724 // depTag is an interface that contains a concrete non-pointer struct. That makes the local
2725 // tag variable a copy of the contents of depTag, and updating it doesn't change depTag. Reassign
2726 // the modified copy to depTag.
2727 depTag = tag
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002728 } else {
2729 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2730 }
Colin Crosse7257d22020-09-24 09:56:18 -07002731 }
Colin Crosse7257d22020-09-24 09:56:18 -07002732
Colin Cross0de8a1e2020-09-18 14:15:30 -07002733 if far {
2734 ctx.AddFarVariationDependencies(variations, depTag, name)
2735 } else {
2736 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002737 }
2738}
2739
Kiyoung Kim487689e2022-07-26 09:48:22 +09002740func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2741 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002742 return snapshot
2743 }
2744
2745 return lib
2746}
2747
Kiyoung Kim37693d02024-04-04 09:56:15 +09002748// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002749// of names:
2750//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002751// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002752//
2753// For each of these, it adds the name of the ndk_library module to the list of
2754// variant libs.
2755//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002756// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002757//
2758// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002759//
2760// The caller can then know to add the variantLibs dependencies differently from the
2761// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002762func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002763 variantLibs = []string{}
2764
2765 nonvariantLibs = []string{}
2766 for _, entry := range list {
2767 // strip #version suffix out
2768 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002769 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002770 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002771 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002772 nonvariantLibs = append(nonvariantLibs, entry)
2773 }
2774 }
2775 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002776
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002777}
2778
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002779func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2780 nonVariantLibs := []string{}
2781 variantLibs := []string{}
2782
2783 for _, lib := range libs {
2784 replaceLibName := GetReplaceModuleName(lib, replaceList)
2785 if replaceLibName == lib {
2786 // Do not handle any libs which are not in API imports
2787 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2788 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2789 variantLibs = append(variantLibs, replaceLibName)
2790 } else {
2791 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2792 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002793 }
2794
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002795 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002796}
2797
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002798func (c *Module) shouldUseApiSurface() bool {
2799 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2800 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2801 // LLNDK Variant
2802 return true
2803 }
2804
2805 if c.Properties.IsSdkVariant {
2806 // NDK Variant
2807 return true
2808 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002809 }
2810
2811 return false
2812}
2813
Colin Cross1e676be2016-10-12 14:38:15 -07002814func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002815 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002816 return
2817 }
2818
Colin Cross37047f12016-12-13 17:06:13 -08002819 ctx := &depsContext{
2820 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002821 moduleContextImpl: moduleContextImpl{
2822 mod: c,
2823 },
2824 }
2825 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002826
Colin Crossc99deeb2016-04-11 15:06:20 -07002827 deps := c.deps(ctx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002828
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002829 apiNdkLibs := []string{}
2830 apiLateNdkLibs := []string{}
2831
Yo Chiang219968c2020-09-22 18:45:04 +08002832 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2833
Dan Albert914449f2016-06-17 16:45:24 -07002834 variantNdkLibs := []string{}
2835 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002836 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002837 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2838 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2839 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002840 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002841
Colin Cross32ec36c2016-12-15 07:39:51 -08002842 for _, lib := range deps.HeaderLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002843 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002844 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002845 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002846 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002847
Spandan Das73bcafc2022-08-18 23:26:00 +00002848 if c.isNDKStubLibrary() {
Jiyong Parkf8fab9b2024-09-02 15:24:15 +09002849 variationExists := actx.OtherModuleDependencyVariantExists(nil, lib)
2850 if variationExists {
2851 actx.AddVariationDependencies(nil, depTag, lib)
2852 } else {
2853 // dependencies to ndk_headers fall here as ndk_headers do not have
2854 // any variants.
2855 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
2856 }
Spandan Dasff665182024-09-11 18:48:44 +00002857 } else if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002858 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002859 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002860 } else {
2861 actx.AddVariationDependencies(nil, depTag, lib)
2862 }
2863 }
2864
Dan Albertf1d14c72020-07-30 14:32:55 -07002865 if c.isNDKStubLibrary() {
2866 // NDK stubs depend on their implementation because the ABI dumps are
2867 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002868
Spandan Das8b08aea2023-03-14 19:29:34 +00002869 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2870 c.ImageVariation(),
2871 blueprint.Variation{Mutator: "link", Variation: "shared"},
2872 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002873 }
2874
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002875 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2876 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2877 c.Target().NativeBridge == android.NativeBridgeDisabled {
2878 actx.AddVariationDependencies(
Jihoon Kang47e91842024-06-19 00:51:16 +00002879 []blueprint.Variation{{Mutator: "image", Variation: android.VendorVariation}},
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002880 llndkHeaderLibTag,
2881 deps.LlndkHeaderLibs...)
2882 }
2883
Jiyong Park5d1598f2019-02-25 22:14:17 +09002884 for _, lib := range deps.WholeStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002885 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002886
Jiyong Park5d1598f2019-02-25 22:14:17 +09002887 actx.AddVariationDependencies([]blueprint.Variation{
2888 {Mutator: "link", Variation: "static"},
2889 }, depTag, lib)
2890 }
2891
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002892 for _, lib := range deps.StaticLibs {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002893 // Some dependencies listed in static_libs might actually be rust_ffi rlib variants.
Colin Cross8acea3e2024-12-12 14:53:30 -08002894 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002895
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002896 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002897 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002898 }
Jiyong Parke3867542020-12-03 17:28:25 +09002899 if inList(lib, deps.ExcludeLibsForApex) {
2900 depTag.excludeInApex = true
2901 }
Dan Willemsen59339a22018-07-22 21:18:45 -07002902 actx.AddVariationDependencies([]blueprint.Variation{
2903 {Mutator: "link", Variation: "static"},
2904 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002905 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002906
Jooyung Han75568392020-03-20 04:29:24 +09002907 // staticUnwinderDep is treated as staticDep for Q apexes
2908 // so that native libraries/binaries are linked with static unwinder
2909 // because Q libc doesn't have unwinder APIs
2910 if deps.StaticUnwinderIfLegacy {
Colin Cross8acea3e2024-12-12 14:53:30 -08002911 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002912 actx.AddVariationDependencies([]blueprint.Variation{
2913 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002914 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002915 }
2916
Jiyong Park7ed9de32018-10-15 22:25:07 +09002917 // shared lib names without the #version suffix
2918 var sharedLibNames []string
2919
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002920 for _, lib := range deps.SharedLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002921 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002922 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002923 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002924 }
Jiyong Parke3867542020-12-03 17:28:25 +09002925 if inList(lib, deps.ExcludeLibsForApex) {
2926 depTag.excludeInApex = true
2927 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002928 if inList(lib, deps.ExcludeLibsForNonApex) {
2929 depTag.excludeInNonApex = true
2930 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002931
Jiyong Park73c54ee2019-10-22 20:31:18 +09002932 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002933 sharedLibNames = append(sharedLibNames, name)
2934
Colin Crosse7257d22020-09-24 09:56:18 -07002935 variations := []blueprint.Variation{
2936 {Mutator: "link", Variation: "shared"},
2937 }
Spandan Dasff665182024-09-11 18:48:44 +00002938 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002939 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002940
Colin Crossfe9acfe2021-06-14 16:13:03 -07002941 for _, lib := range deps.LateStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002942 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Colin Crossfe9acfe2021-06-14 16:13:03 -07002943 actx.AddVariationDependencies([]blueprint.Variation{
2944 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002945 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002946 }
2947
Colin Cross3e5e7782022-06-17 22:17:05 +00002948 for _, lib := range deps.UnexportedStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002949 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
Colin Cross3e5e7782022-06-17 22:17:05 +00002950 actx.AddVariationDependencies([]blueprint.Variation{
2951 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002952 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002953 }
2954
Jiyong Park7ed9de32018-10-15 22:25:07 +09002955 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002956 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002957 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2958 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2959 // linking against both the stubs lib and the non-stubs lib at the same time.
2960 continue
2961 }
Colin Cross8acea3e2024-12-12 14:53:30 -08002962 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002963 variations := []blueprint.Variation{
2964 {Mutator: "link", Variation: "shared"},
2965 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002966 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002967 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002968
Dan Willemsen59339a22018-07-22 21:18:45 -07002969 actx.AddVariationDependencies([]blueprint.Variation{
2970 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002971 }, dataLibDepTag, deps.DataLibs...)
2972
Colin Crossc8caa062021-09-24 16:50:14 -07002973 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2974
Chris Parsons79d66a52020-06-05 17:26:16 -04002975 actx.AddVariationDependencies([]blueprint.Variation{
2976 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002977 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002978
Colin Cross68861832016-07-08 10:41:41 -07002979 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002980
2981 for _, gen := range deps.GeneratedHeaders {
2982 depTag := genHeaderDepTag
2983 if inList(gen, deps.ReexportGeneratedHeaders) {
2984 depTag = genHeaderExportDepTag
2985 }
2986 actx.AddDependency(c, depTag, gen)
2987 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002988
Cole Faust65cb40a2024-10-21 15:41:42 -07002989 for _, gen := range deps.DeviceFirstGeneratedHeaders {
2990 depTag := genHeaderDepTag
2991 actx.AddVariationDependencies(ctx.Config().AndroidFirstDeviceTarget.Variations(), depTag, gen)
2992 }
2993
Dan Albert92fe7402020-07-15 13:33:30 -07002994 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002995 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002996 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002997 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002998 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08002999 }
Colin Crossc465efd2021-06-11 18:00:04 -07003000 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07003001 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09003002 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07003003 }
Dan Willemsena0790e32018-10-12 00:24:23 -07003004 if deps.DynamicLinker != "" {
3005 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07003006 }
Dan Albert914449f2016-06-17 16:45:24 -07003007
3008 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07003009
Colin Cross8acea3e2024-12-12 14:53:30 -08003010 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003011 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003012 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003013 {Mutator: "link", Variation: "shared"},
3014 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003015 actx.AddVariationDependencies([]blueprint.Variation{
3016 {Mutator: "version", Variation: version},
3017 {Mutator: "link", Variation: "shared"},
3018 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07003019
Colin Cross8acea3e2024-12-12 14:53:30 -08003020 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07003021 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07003022 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07003023 {Mutator: "link", Variation: "shared"},
3024 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09003025 actx.AddVariationDependencies([]blueprint.Variation{
3026 {Mutator: "version", Variation: version},
3027 {Mutator: "link", Variation: "shared"},
3028 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08003029
Vinh Tran367d89d2023-04-28 11:21:25 -04003030 if len(deps.AidlLibs) > 0 {
3031 actx.AddDependency(
3032 c,
3033 aidlLibraryTag,
3034 deps.AidlLibs...,
3035 )
3036 }
3037
Colin Cross6362e272015-10-29 15:25:03 -07003038}
Colin Cross21b9a242015-03-24 14:15:58 -07003039
Colin Crosse40b4ea2018-10-02 22:25:58 -07003040func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07003041 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07003042 c.beginMutator(ctx)
3043 }
3044}
3045
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003046// Whether a module can link to another module, taking into
3047// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09003048func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07003049 tag blueprint.DependencyTag) {
3050
3051 switch t := tag.(type) {
3052 case dependencyTag:
3053 if t != vndkExtDepTag {
3054 return
3055 }
3056 case libraryDependencyTag:
3057 default:
3058 return
3059 }
3060
Ivan Lozanof9e21722020-12-02 09:00:51 -05003061 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003062 // Host code is not restricted
3063 return
3064 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003065
Ivan Lozano52767be2019-10-18 14:49:46 -07003066 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003067 // Platform code can link to anything
3068 return
3069 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08003070 if from.InRamdisk() {
3071 // Ramdisk code is not NDK
3072 return
3073 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003074 if from.InVendorRamdisk() {
3075 // Vendor ramdisk code is not NDK
3076 return
3077 }
Ivan Lozano52767be2019-10-18 14:49:46 -07003078 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09003079 // Recovery code is not NDK
3080 return
3081 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003082 // Change this to LinkableInterface if Rust gets NDK support, which stubDecorators are for
Colin Cross31076b32020-10-23 17:22:06 -07003083 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07003084 if c.StubDecorator() {
3085 // These aren't real libraries, but are the stub shared libraries that are included in
3086 // the NDK.
3087 return
3088 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003089 }
Logan Chien834b9a62019-01-14 15:39:03 +08003090
Ivan Lozano52767be2019-10-18 14:49:46 -07003091 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08003092 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
3093 // to link to libc++ (non-NDK and without sdk_version).
3094 return
3095 }
3096
Ivan Lozano52767be2019-10-18 14:49:46 -07003097 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003098 // NDK code linking to platform code is never okay.
3099 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003100 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08003101 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003102 }
3103
3104 // At this point we know we have two NDK libraries, but we need to
3105 // check that we're not linking against anything built against a higher
3106 // API level, as it is only valid to link against older or equivalent
3107 // APIs.
3108
Inseob Kim01a28722018-04-11 09:48:45 +09003109 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07003110 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003111 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07003112 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003113 // Current can't be linked against by anything else.
3114 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003115 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09003116 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003117 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003118 if err != nil {
3119 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003120 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003121 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003122 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003123 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003124 if err != nil {
3125 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003126 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003127 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003128 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003129
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003130 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09003131 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003132 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003133 }
3134 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003135 }
Dan Albert202fe492017-12-15 13:56:59 -08003136
3137 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07003138 fromStl := from.SelectedStl()
3139 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08003140 if fromStl == "" || toStl == "" {
3141 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09003142 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08003143 // We can be permissive with the system "STL" since it is only the C++
3144 // ABI layer, but in the future we should make sure that everyone is
3145 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07003146 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08003147 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003148 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
3149 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08003150 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003151}
3152
Jooyung Han479ca172020-10-19 18:51:07 +09003153func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
3154 if c, ok := ctx.Module().(*Module); ok {
3155 ctx.VisitDirectDeps(func(dep android.Module) {
3156 depTag := ctx.OtherModuleDependencyTag(dep)
3157 ccDep, ok := dep.(LinkableInterface)
3158 if ok {
3159 checkLinkType(ctx, c, ccDep, depTag)
3160 }
3161 })
3162 }
3163}
3164
Jiyong Park5fb8c102018-04-09 12:03:06 +09003165// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09003166// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
3167// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003168// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Colin Crossda279cf2024-09-17 14:25:45 -07003169func checkDoubleLoadableLibraries(ctx android.BottomUpMutatorContext) {
Jooyung Hana70f0672019-01-18 15:20:43 +09003170 check := func(child, parent android.Module) bool {
3171 to, ok := child.(*Module)
3172 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09003173 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09003174 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003175
Jooyung Hana70f0672019-01-18 15:20:43 +09003176 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
3177 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09003178 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003179
Jiyong Park0474e1f2021-01-14 14:26:06 +09003180 // These dependencies are not excercised at runtime. Tracking these will give us
3181 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09003182 depTag := ctx.OtherModuleDependencyTag(child)
3183 if IsHeaderDepTag(depTag) {
3184 return false
3185 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09003186 if depTag == staticVariantTag {
3187 return false
3188 }
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003189 if depTag == StubImplDepTag {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003190 return false
3191 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003192 if depTag == android.RequiredDepTag {
3193 return false
3194 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003195
Justin Yun63e9ec72020-10-29 16:49:43 +09003196 // Even if target lib has no vendor variant, keep checking dependency
3197 // graph in case it depends on vendor_available or product_available
3198 // but not double_loadable transtively.
3199 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003200 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003201 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003202
Jiyong Park0474e1f2021-01-14 14:26:06 +09003203 // The happy path. Keep tracking dependencies until we hit a non double-loadable
3204 // one.
3205 if Bool(to.VendorProperties.Double_loadable) {
3206 return true
3207 }
3208
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09003209 if to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003210 return false
3211 }
3212
Jooyung Hana70f0672019-01-18 15:20:43 +09003213 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3214 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003215 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003216 return false
3217 }
3218 if module, ok := ctx.Module().(*Module); ok {
3219 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003220 if lib.HasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003221 ctx.WalkDeps(check)
3222 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003223 }
3224 }
3225}
3226
Yu Liue4312402023-01-18 09:15:31 -08003227func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3228 // For the dependency from platform to apex, use the latest stubs
3229 apexSdkVersion := android.FutureApiLevel
3230 if !apexInfo.IsForPlatform() {
3231 apexSdkVersion = apexInfo.MinSdkVersion
3232 }
3233
3234 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3235 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3236 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3237 // (b/144430859)
3238 apexSdkVersion = android.FutureApiLevel
3239 }
3240
3241 return apexSdkVersion
3242}
3243
Colin Crossc99deeb2016-04-11 15:06:20 -07003244// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003245func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003246 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003247
Colin Cross0de8a1e2020-09-18 14:15:30 -07003248 var directStaticDeps []StaticLibraryInfo
3249 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003250
Colin Cross0de8a1e2020-09-18 14:15:30 -07003251 reexportExporter := func(exporter FlagExporterInfo) {
3252 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3253 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3254 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3255 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3256 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003257 }
3258
Colin Crossff694a82023-12-13 15:54:49 -08003259 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003260 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003261
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003262 skipModuleList := map[string]bool{}
3263
Yu Liu8024b922024-12-20 23:31:32 +00003264 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003265 depName := ctx.OtherModuleName(dep)
3266 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003267
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003268 if _, ok := skipModuleList[depName]; ok {
3269 // skip this module because original module or API imported module matching with this should be used instead.
3270 return
3271 }
3272
Yu Liu8024b922024-12-20 23:31:32 +00003273 var ccInfo *CcInfo
3274 v, hasCcInfo := android.OtherModuleProvider(ctx, dep, CcInfoProvider)
3275 if hasCcInfo {
3276 ccInfo = v
3277 }
3278 linkableInfo, hasLinkableInfo := android.OtherModuleProvider(ctx, dep, LinkableInfoProvider)
Dan Willemsen47450072021-10-19 20:24:49 -07003279 if depTag == android.DarwinUniversalVariantTag {
Yu Liu8024b922024-12-20 23:31:32 +00003280 if !hasCcInfo {
3281 panic(fmt.Errorf("dep is not a cc module: %s", dep.String()))
3282 }
3283 depPaths.DarwinSecondArchOutput = linkableInfo.OutputFile
Dan Willemsen47450072021-10-19 20:24:49 -07003284 return
3285 }
3286
Vinh Tran367d89d2023-04-28 11:21:25 -04003287 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003288 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003289 depPaths.AidlLibraryInfos = append(
3290 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003291 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003292 )
3293 }
3294 }
3295
Yu Liu8024b922024-12-20 23:31:32 +00003296 if !hasLinkableInfo {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003297 // handling for a few module types that aren't cc Module but that are also supported
Yu Liu8024b922024-12-20 23:31:32 +00003298 genRule, ok := android.OtherModuleProvider(ctx, dep, android.GeneratedSourceInfoProvider)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003299 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003300 case genSourceDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003301 if ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003302 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
Yu Liu8024b922024-12-20 23:31:32 +00003303 genRule.GeneratedSourceFiles...)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003304 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003305 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003306 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003307 // Support exported headers from a generated_sources dependency
3308 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003309 case genHeaderDepTag, genHeaderExportDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003310 if ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003311 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Yu Liu8024b922024-12-20 23:31:32 +00003312 genRule.GeneratedDeps...)
3313 dirs := genRule.GeneratedHeaderDirs
Inseob Kim69378442019-06-03 19:10:47 +09003314 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003315 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003316 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003317 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
Yu Liu8024b922024-12-20 23:31:32 +00003318 genRule.GeneratedSourceFiles...)
3319 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003320 // 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 +09003321 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003322 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003323 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003324 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003325 }
Colin Crosscef792e2021-06-11 18:01:26 -07003326 case CrtBeginDepTag:
3327 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3328 case CrtEndDepTag:
3329 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003330 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003331 return
3332 }
3333
Colin Crossfe17f6f2019-03-28 19:30:56 -07003334 if depTag == android.ProtoPluginDepTag {
3335 return
3336 }
3337
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003338 if depTag == android.RequiredDepTag {
3339 return
3340 }
3341
Yu Liu8024b922024-12-20 23:31:32 +00003342 commonInfo := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey)
3343 if commonInfo.Target.Os != ctx.Os() {
Steven Morelandaaae81f2024-08-27 22:55:48 +00003344 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 -07003345 return
3346 }
Yu Liu8024b922024-12-20 23:31:32 +00003347 if commonInfo.Target.Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003348 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
Yu Liu8024b922024-12-20 23:31:32 +00003349 ctx.ModuleName(), ctx.Arch().ArchType, depName, commonInfo.Target.Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003350 return
3351 }
3352
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003353 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003354 // Skip reused objects for stub libraries, they use their own stub object file instead.
3355 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3356 // version mutator, so the stubs variant is created from the shared variant that
3357 // already has the reuseObjTag dependency on the static variant.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003358 if !c.library.BuildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003359 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003360 objs := staticAnalogue.ReuseObjects
3361 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003362 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003363 reexportExporter(depExporterInfo)
3364 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003365 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003366 }
3367
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003368 if depTag == llndkHeaderLibTag {
3369 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3370 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3371 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3372 }
3373
Yu Liu8024b922024-12-20 23:31:32 +00003374 linkFile := linkableInfo.OutputFile
Colin Cross6e511a92020-07-27 21:26:48 -07003375
3376 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3377 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003378 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003379 return
3380 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003381
Jiyong Parke3867542020-12-03 17:28:25 +09003382 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3383 return
3384 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003385 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3386 return
3387 }
Jiyong Parke3867542020-12-03 17:28:25 +09003388
Colin Cross313aa542023-12-13 13:47:44 -08003389 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003390
Colin Cross6e511a92020-07-27 21:26:48 -07003391 var ptr *android.Paths
3392 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003393
Colin Cross6e511a92020-07-27 21:26:48 -07003394 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003395
Colin Cross6e511a92020-07-27 21:26:48 -07003396 switch {
3397 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003398 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003399 if !ctx.Config().AllowMissingDependencies() {
3400 ctx.ModuleErrorf("module %q is not a header library", depName)
3401 } else {
3402 ctx.AddMissingDependencies([]string{depName})
3403 }
3404 return
3405 }
Colin Cross6e511a92020-07-27 21:26:48 -07003406 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003407 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003408 if !ctx.Config().AllowMissingDependencies() {
3409 ctx.ModuleErrorf("module %q is not a shared library", depName)
3410 } else {
3411 ctx.AddMissingDependencies([]string{depName})
3412 }
3413 return
3414 }
Jiyong Parke3867542020-12-03 17:28:25 +09003415
Jiyong Park7d55b612021-06-11 17:22:09 +09003416 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3417 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003418
Jiyong Park1ad8e162020-12-01 23:40:09 +09003419 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3420 // linkFile, depFile, and ptr.
3421 if c.IsStubs() {
3422 break
3423 }
3424
Colin Cross0de8a1e2020-09-18 14:15:30 -07003425 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3426 depFile = sharedLibraryInfo.TableOfContents
3427
Colin Crossb614cd42024-10-11 12:52:21 -07003428 if !sharedLibraryInfo.IsStubs {
Ivan Lozanoa8a1fa12024-10-30 18:15:59 +00003429 // TODO(b/362509506): remove this additional check once all apex_exclude uses are switched to stubs.
3430 if !linkableInfo.RustApexExclude {
3431 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
3432 if info, ok := android.OtherModuleProvider(ctx, dep, ImplementationDepInfoProvider); ok {
3433 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
3434 }
Colin Crossb614cd42024-10-11 12:52:21 -07003435 }
3436 }
3437
Colin Cross6e511a92020-07-27 21:26:48 -07003438 ptr = &depPaths.SharedLibs
3439 switch libDepTag.Order {
3440 case earlyLibraryDependency:
3441 ptr = &depPaths.EarlySharedLibs
3442 depPtr = &depPaths.EarlySharedLibsDeps
3443 case normalLibraryDependency:
3444 ptr = &depPaths.SharedLibs
3445 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003446 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003447 case lateLibraryDependency:
3448 ptr = &depPaths.LateSharedLibs
3449 depPtr = &depPaths.LateSharedLibsDeps
3450 default:
3451 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003452 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003453
Colin Cross6e511a92020-07-27 21:26:48 -07003454 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003455 if linkableInfo.RustLibraryInterface {
3456 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: linkableInfo.CrateName, LinkDirs: linkableInfo.ExportedCrateLinkDirs}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003457 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3458 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3459 if libDepTag.wholeStatic {
3460 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3461 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
Jiyong Park1ad8e162020-12-01 23:40:09 +09003462
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003463 // If whole_static, track this as we want to make sure that in a final linkage for a shared library,
3464 // exported functions from the rust generated staticlib still exported.
3465 if c.CcLibrary() && c.Shared() {
3466 c.WholeRustStaticlib = true
3467 }
Colin Cross6e511a92020-07-27 21:26:48 -07003468 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003469
Colin Cross6e511a92020-07-27 21:26:48 -07003470 } else {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003471 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3472 if !isStaticLib {
3473 if !ctx.Config().AllowMissingDependencies() {
3474 ctx.ModuleErrorf("module %q is not a static library", depName)
3475 } else {
3476 ctx.AddMissingDependencies([]string{depName})
3477 }
3478 return
Inseob Kimeec88e12020-01-22 11:11:29 +09003479 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003480
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003481 // Stubs lib doesn't link to the static lib dependencies. Don't set
3482 // linkFile, depFile, and ptr.
3483 if c.IsStubs() {
3484 break
3485 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003486
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003487 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
3488 if libDepTag.wholeStatic {
3489 ptr = &depPaths.WholeStaticLibs
3490 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3491 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
3492 } else {
3493 // This case normally catches prebuilt static
3494 // libraries, but it can also occur when
3495 // AllowMissingDependencies is on and the
3496 // dependencies has no sources of its own
3497 // but has a whole_static_libs dependency
3498 // on a missing library. We want to depend
3499 // on the .a file so that there is something
3500 // in the dependency tree that contains the
3501 // error rule for the missing transitive
3502 // dependency.
3503 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
3504 }
3505 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3506 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
3507 } else {
3508 switch libDepTag.Order {
3509 case earlyLibraryDependency:
3510 panic(fmt.Errorf("early static libs not supported"))
3511 case normalLibraryDependency:
3512 // static dependencies will be handled separately so they can be ordered
3513 // using transitive dependencies.
3514 ptr = nil
3515 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
3516 case lateLibraryDependency:
3517 ptr = &depPaths.LateStaticLibs
3518 default:
3519 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
3520 }
3521 }
3522
3523 // Collect any exported Rust rlib deps from static libraries which have been included as whole_static_libs
3524 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3525
3526 if libDepTag.unexportedSymbols {
3527 depPaths.LdFlags = append(depPaths.LdFlags,
3528 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3529 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003530 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003531 }
3532
Yu Liu8024b922024-12-20 23:31:32 +00003533 if libDepTag.static() && !libDepTag.wholeStatic && !linkableInfo.RustLibraryInterface {
3534 if !linkableInfo.CcLibraryInterface || !linkableInfo.Static {
Colin Cross6e511a92020-07-27 21:26:48 -07003535 ctx.ModuleErrorf("module %q not a static library", depName)
3536 return
3537 }
Logan Chien43d34c32017-12-20 01:17:32 +08003538
Colin Cross6e511a92020-07-27 21:26:48 -07003539 // When combining coverage files for shared libraries and executables, coverage files
3540 // in static libraries act as if they were whole static libraries. The same goes for
3541 // source based Abi dump files.
Yu Liu8024b922024-12-20 23:31:32 +00003542 if hasCcInfo {
Colin Cross6e511a92020-07-27 21:26:48 -07003543 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003544 linkableInfo.CoverageFiles...)
Colin Cross6e511a92020-07-27 21:26:48 -07003545 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003546 linkableInfo.SAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003547 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003548 // Handle non-CC modules here
3549 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003550 linkableInfo.CoverageFiles...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003551 }
3552 }
3553
Colin Cross6e511a92020-07-27 21:26:48 -07003554 if ptr != nil {
3555 if !linkFile.Valid() {
3556 if !ctx.Config().AllowMissingDependencies() {
3557 ctx.ModuleErrorf("module %q missing output file", depName)
3558 } else {
3559 ctx.AddMissingDependencies([]string{depName})
3560 }
3561 return
3562 }
3563 *ptr = append(*ptr, linkFile.Path())
3564 }
3565
3566 if depPtr != nil {
3567 dep := depFile
3568 if !dep.Valid() {
3569 dep = linkFile
3570 }
3571 *depPtr = append(*depPtr, dep.Path())
3572 }
3573
Colin Cross0de8a1e2020-09-18 14:15:30 -07003574 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3575 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3576 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3577 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003578 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3579
3580 // Only re-export RustRlibDeps for cc static libs
3581 if c.static() {
3582 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3583 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003584
3585 if libDepTag.reexportFlags {
3586 reexportExporter(depExporterInfo)
3587 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3588 // Re-exported shared library headers must be included as well since they can help us with type information
3589 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003590 c.sabi.Properties.ReexportedIncludes = append(
3591 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003592 c.sabi.Properties.ReexportedSystemIncludes = append(
3593 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003594 }
3595
Yu Liu0a37d422025-02-13 02:05:00 +00003596 makeLibName := MakeLibName(ccInfo, linkableInfo, &commonInfo, commonInfo.BaseModuleName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003597 switch {
3598 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003599 c.Properties.AndroidMkHeaderLibs = append(
3600 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003601 case libDepTag.shared():
Colin Cross6e511a92020-07-27 21:26:48 -07003602 // Note: the order of libs in this list is not important because
3603 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003604 c.Properties.AndroidMkSharedLibs = append(
3605 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003606 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003607 if !linkableInfo.RustLibraryInterface {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003608 if libDepTag.wholeStatic {
3609 c.Properties.AndroidMkWholeStaticLibs = append(
3610 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3611 } else {
3612 c.Properties.AndroidMkStaticLibs = append(
3613 c.Properties.AndroidMkStaticLibs, makeLibName)
3614 }
Colin Cross6e511a92020-07-27 21:26:48 -07003615 }
3616 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003617 } else if !c.IsStubs() {
3618 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3619
Colin Cross6e511a92020-07-27 21:26:48 -07003620 switch depTag {
3621 case runtimeDepTag:
3622 c.Properties.AndroidMkRuntimeLibs = append(
Yu Liu0a37d422025-02-13 02:05:00 +00003623 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ccInfo, linkableInfo, &commonInfo,
3624 commonInfo.BaseModuleName)+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003625 case objDepTag:
3626 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3627 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003628 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003629 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003630 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003631 case dynamicLinkerDepTag:
3632 depPaths.DynamicLinker = linkFile
3633 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003634 }
Colin Crossca860ac2016-01-04 14:34:37 -08003635 })
3636
Jeff Gaston294356f2017-09-27 17:05:30 -07003637 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003638 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3639 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3640 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003641
Colin Crossdd84e052017-05-17 13:44:16 -07003642 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003643 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003644 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3645 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003646 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003647 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3648
Jiyong Park74955042019-10-22 20:19:51 +09003649 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3650 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003651 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003652 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003653 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003654 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003655
3656 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003657 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003658 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003659 }
Colin Crossdd84e052017-05-17 13:44:16 -07003660
Colin Crossca860ac2016-01-04 14:34:37 -08003661 return depPaths
3662}
3663
Yu Liuf6f85492025-01-13 21:02:36 +00003664func ShouldUseStubForApex(ctx android.ModuleContext, parent android.Module, dep android.ModuleProxy) bool {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003665 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003666 bootstrap := false
Yu Liuf6f85492025-01-13 21:02:36 +00003667 if ctx.EqualModules(ctx.Module(), parent) {
3668 if linkable, ok := parent.(LinkableInterface); !ok {
3669 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3670 } else {
3671 inVendorOrProduct = linkable.InVendorOrProduct()
3672 bootstrap = linkable.Bootstrap()
3673 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003674 } else {
Yu Liuf6f85492025-01-13 21:02:36 +00003675 if linkable, ok := android.OtherModuleProvider(ctx, parent, LinkableInfoProvider); !ok {
3676 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
3677 } else {
3678 inVendorOrProduct = linkable.InVendorOrProduct
3679 bootstrap = linkable.Bootstrap
3680 }
Jiyong Park7d55b612021-06-11 17:22:09 +09003681 }
3682
Spandan Das10c41362024-12-03 01:33:09 +00003683 apexInfo, _ := android.OtherModuleProvider(ctx, parent, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003684
3685 useStubs := false
3686
Yu Liu8024b922024-12-20 23:31:32 +00003687 if android.OtherModuleProviderOrDefault(ctx, dep, LinkableInfoProvider).IsStubs && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003688 if !apexInfo.IsForPlatform() {
3689 // For platform libraries, use current version of LLNDK
3690 // If this is for use_vendor apex we will apply the same rules
3691 // of apex sdk enforcement below to choose right version.
3692 useStubs = true
3693 }
3694 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3695 // If not building for APEX or the containing APEX allows the use of
3696 // platform APIs, use stubs only when it is from an APEX (and not from
3697 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3698 // bootstrap modules, always link to non-stub variant
Yu Liu8024b922024-12-20 23:31:32 +00003699 isNotInPlatform := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey).NotInPlatform
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003700
Spandan Dasff665182024-09-11 18:48:44 +00003701 useStubs = isNotInPlatform && !bootstrap
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003702 } else {
Colin Crossea91a172024-11-05 16:14:05 -08003703 // If building for APEX, always use stubs (can be bypassed by depending on <dep>#impl)
3704 useStubs = true
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003705 }
3706
3707 return useStubs
3708}
3709
3710// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3711// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3712// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3713// has different level of updatability. For example, if a library foo in an APEX depends on a
3714// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3715// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3716// same APEX as foo, the non-stub variant of bar is used.
Yu Liuf6f85492025-01-13 21:02:36 +00003717func ChooseStubOrImpl(ctx android.ModuleContext, dep android.ModuleProxy) (SharedLibraryInfo, FlagExporterInfo) {
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003718 depTag := ctx.OtherModuleDependencyTag(dep)
3719 libDepTag, ok := depTag.(libraryDependencyTag)
3720 if !ok || !libDepTag.shared() {
3721 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3722 }
3723
Colin Cross313aa542023-12-13 13:47:44 -08003724 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3725 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3726 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003727
3728 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003729 // when to use (unspecified) stubs, use the latest one.
Spandan Das10c41362024-12-03 01:33:09 +00003730 if ShouldUseStubForApex(ctx, ctx.Module(), dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003731 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3732 toUse := stubs[len(stubs)-1]
3733 sharedLibraryInfo = toUse.SharedLibraryInfo
3734 depExporterInfo = toUse.FlagExporterInfo
3735 }
3736 }
3737 return sharedLibraryInfo, depExporterInfo
3738}
3739
Colin Cross0de8a1e2020-09-18 14:15:30 -07003740// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3741// to match the topological order of the dependency tree, including any static analogues of
Colin Crossa14fb6a2024-10-23 16:57:06 -07003742// direct shared libraries. It returns the ordered static dependencies, and a depset.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07003743// of the transitive dependencies.
Colin Crossa14fb6a2024-10-23 16:57:06 -07003744func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive depset.DepSet[android.Path]) {
3745 transitiveStaticLibsBuilder := depset.NewBuilder[android.Path](depset.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003746 var staticPaths android.Paths
3747 for _, staticDep := range staticDeps {
3748 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3749 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3750 }
3751 for _, sharedDep := range sharedDeps {
Colin Crossa14fb6a2024-10-23 16:57:06 -07003752 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003753 }
3754 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3755
3756 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3757
3758 // reorder the dependencies based on transitive dependencies
3759 staticPaths = android.FirstUniquePaths(staticPaths)
3760 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3761
3762 if len(orderedStaticPaths) != len(staticPaths) {
3763 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3764 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3765 }
3766
3767 return orderedStaticPaths, transitiveStaticLibs
3768}
3769
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003770// BaseLibName trims known prefixes and suffixes
3771func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003772 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3773 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003774 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003775 return libName
3776}
3777
Yu Liu8024b922024-12-20 23:31:32 +00003778func MakeLibName(ccInfo *CcInfo, linkableInfo *LinkableInfo, commonInfo *android.CommonModuleInfo, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003779 libName := BaseLibName(depName)
Yu Liu8024b922024-12-20 23:31:32 +00003780 isLLndk := ccInfo != nil && linkableInfo.IsLlndk
3781 nonSystemVariantsExist := linkableInfo.HasNonSystemVariants || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003782
Yu Liu8024b922024-12-20 23:31:32 +00003783 if ccInfo != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003784 // Use base module name for snapshots when exporting to Makefile.
Yu Liu8024b922024-12-20 23:31:32 +00003785 if ccInfo.SnapshotInfo != nil {
Yu Liu0a37d422025-02-13 02:05:00 +00003786 return commonInfo.BaseModuleName + ccInfo.SnapshotInfo.SnapshotAndroidMkSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003787 }
3788 }
3789
Yu Liu8024b922024-12-20 23:31:32 +00003790 if linkableInfo.InVendorOrProduct && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003791 // The vendor and product modules in Make will have been renamed to not conflict with the
3792 // core module, so update the dependency name here accordingly.
Yu Liu8024b922024-12-20 23:31:32 +00003793 return libName + linkableInfo.SubName
3794 } else if linkableInfo.InRamdisk && !linkableInfo.OnlyInRamdisk {
Matthew Maurerc6868382021-07-13 14:12:37 -07003795 return libName + RamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003796 } else if linkableInfo.InVendorRamdisk && !linkableInfo.OnlyInVendorRamdisk {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003797 return libName + VendorRamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003798 } else if linkableInfo.InRecovery && !linkableInfo.OnlyInRecovery {
Matthew Maurer460ee942021-02-11 12:31:46 -08003799 return libName + RecoverySuffix
Yu Liu8024b922024-12-20 23:31:32 +00003800 } else if commonInfo.Target.NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003801 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003802 } else {
3803 return libName
3804 }
3805}
3806
Colin Crossca860ac2016-01-04 14:34:37 -08003807func (c *Module) InstallInData() bool {
3808 if c.installer == nil {
3809 return false
3810 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003811 return c.installer.inData()
3812}
3813
3814func (c *Module) InstallInSanitizerDir() bool {
3815 if c.installer == nil {
3816 return false
3817 }
3818 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003819 return true
3820 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003821 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003822}
3823
Yifan Hong1b3348d2020-01-21 15:53:22 -08003824func (c *Module) InstallInRamdisk() bool {
3825 return c.InRamdisk()
3826}
3827
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003828func (c *Module) InstallInVendorRamdisk() bool {
3829 return c.InVendorRamdisk()
3830}
3831
Jiyong Parkf9332f12018-02-01 00:54:12 +09003832func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003833 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003834}
3835
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003836func (c *Module) MakeUninstallable() {
3837 if c.installer == nil {
3838 c.ModuleBase.MakeUninstallable()
3839 return
3840 }
3841 c.installer.makeUninstallable(c)
3842}
3843
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003844func (c *Module) HostToolPath() android.OptionalPath {
3845 if c.installer == nil {
3846 return android.OptionalPath{}
3847 }
3848 return c.installer.hostToolPath()
3849}
3850
Nan Zhangd4e641b2017-07-12 12:55:28 -07003851func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3852 return c.outputFile
3853}
3854
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003855func (c *Module) static() bool {
3856 if static, ok := c.linker.(interface {
3857 static() bool
3858 }); ok {
3859 return static.static()
3860 }
3861 return false
3862}
3863
Colin Cross6a730042024-12-05 13:53:43 -08003864func (c *Module) staticLibrary() bool {
3865 if static, ok := c.linker.(interface {
3866 staticLibrary() bool
3867 }); ok {
3868 return static.staticLibrary()
3869 }
3870 return false
3871}
3872
Jiyong Park379de2f2018-12-19 02:47:14 +09003873func (c *Module) staticBinary() bool {
3874 if static, ok := c.linker.(interface {
3875 staticBinary() bool
3876 }); ok {
3877 return static.staticBinary()
3878 }
3879 return false
3880}
3881
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003882func (c *Module) testBinary() bool {
3883 if test, ok := c.linker.(interface {
3884 testBinary() bool
3885 }); ok {
3886 return test.testBinary()
3887 }
3888 return false
3889}
3890
Jingwen Chen537242c2022-08-24 11:53:27 +00003891func (c *Module) testLibrary() bool {
3892 if test, ok := c.linker.(interface {
3893 testLibrary() bool
3894 }); ok {
3895 return test.testLibrary()
3896 }
3897 return false
3898}
3899
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003900func (c *Module) benchmarkBinary() bool {
3901 if b, ok := c.linker.(interface {
3902 benchmarkBinary() bool
3903 }); ok {
3904 return b.benchmarkBinary()
3905 }
3906 return false
3907}
3908
3909func (c *Module) fuzzBinary() bool {
3910 if f, ok := c.linker.(interface {
3911 fuzzBinary() bool
3912 }); ok {
3913 return f.fuzzBinary()
3914 }
3915 return false
3916}
3917
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003918// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3919func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003920 if h, ok := c.linker.(interface {
3921 header() bool
3922 }); ok {
3923 return h.header()
3924 }
3925 return false
3926}
3927
Ivan Lozanod7586b62021-04-01 09:49:36 -04003928func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003929 if b, ok := c.linker.(interface {
3930 binary() bool
3931 }); ok {
3932 return b.binary()
3933 }
3934 return false
3935}
3936
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003937func (c *Module) ForceDisableSanitizers() {
3938 c.sanitize.Properties.ForceDisable = true
3939}
3940
Justin Yun5e035862021-06-29 20:50:37 +09003941func (c *Module) StaticExecutable() bool {
3942 if b, ok := c.linker.(*binaryDecorator); ok {
3943 return b.static()
3944 }
3945 return false
3946}
3947
Ivan Lozanod7586b62021-04-01 09:49:36 -04003948func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003949 if o, ok := c.linker.(interface {
3950 object() bool
3951 }); ok {
3952 return o.object()
3953 }
3954 return false
3955}
3956
Kiyoung Kim37693d02024-04-04 09:56:15 +09003957func (m *Module) Dylib() bool {
3958 return false
3959}
3960
3961func (m *Module) Rlib() bool {
3962 return false
3963}
3964
Ivan Lozanof9e21722020-12-02 09:00:51 -05003965func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003966 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003967 if c.IsLlndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003968 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003969 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003970 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003971 return "native:product"
3972 }
Jooyung Han38002912019-05-16 04:01:54 +09003973 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003974 } else if c.InRamdisk() {
3975 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003976 } else if c.InVendorRamdisk() {
3977 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003978 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003979 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003980 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003981 return "native:ndk:none:none"
3982 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3983 //family, link := getNdkStlFamilyAndLinkType(c)
3984 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
3985 } else {
3986 return "native:platform"
3987 }
3988}
3989
Jiyong Park9d452992018-10-03 00:38:19 +09003990// Overrides ApexModule.IsInstallabeToApex()
Colin Cross3a02c7b2024-05-21 13:46:22 -07003991// Only shared/runtime libraries .
Jiyong Park9d452992018-10-03 00:38:19 +09003992func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003993 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003994 // Stub libs and prebuilt libs in a versioned SDK are not
3995 // installable to APEX even though they are shared libs.
Ivan Lozano9eaacc82024-10-30 14:28:17 +00003996 return lib.shared() && !lib.BuildStubs()
Jiyong Park9d452992018-10-03 00:38:19 +09003997 }
3998 return false
3999}
4000
Jiyong Parka90ca002019-10-07 15:47:24 +09004001func (c *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +00004002 return android.CheckAvailableForApex(what, c.ApexAvailableFor())
4003}
4004
4005func (c *Module) ApexAvailableFor() []string {
4006 list := c.ApexModuleBase.ApexAvailable()
Jiyong Parka90ca002019-10-07 15:47:24 +09004007 if linker, ok := c.linker.(interface {
Yu Liub73c3a62024-12-10 00:58:06 +00004008 apexAvailable() []string
Jiyong Parka90ca002019-10-07 15:47:24 +09004009 }); ok {
Yu Liub73c3a62024-12-10 00:58:06 +00004010 list = append(list, linker.apexAvailable()...)
Jiyong Parka90ca002019-10-07 15:47:24 +09004011 }
Yu Liub73c3a62024-12-10 00:58:06 +00004012
4013 return android.FirstUniqueStrings(list)
Jiyong Parka90ca002019-10-07 15:47:24 +09004014}
4015
Paul Duffin0cb37b92020-03-04 14:52:46 +00004016func (c *Module) EverInstallable() bool {
4017 return c.installer != nil &&
4018 // Check to see whether the module is actually ever installable.
4019 c.installer.everInstallable()
4020}
4021
Ivan Lozanod7586b62021-04-01 09:49:36 -04004022func (c *Module) PreventInstall() bool {
4023 return c.Properties.PreventInstall
4024}
4025
4026func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07004027 if c.library != nil {
4028 if i := c.library.installable(); i != nil {
4029 return i
4030 }
4031 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04004032 return c.Properties.Installable
4033}
4034
4035func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00004036 ret := c.EverInstallable() &&
4037 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04004038 proptools.BoolDefault(c.Installable(), true) &&
4039 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004040
4041 // The platform variant doesn't need further condition. Apex variants however might not
4042 // be installable because it will likely to be included in the APEX and won't appear
4043 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07004044 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09004045 return ret
4046 }
4047
4048 // Special case for modules that are configured to be installed to /data, which includes
4049 // test modules. For these modules, both APEX and non-APEX variants are considered as
4050 // installable. This is because even the APEX variants won't be included in the APEX, but
4051 // will anyway be installed to /data/*.
4052 // See b/146995717
4053 if c.InstallInData() {
4054 return ret
4055 }
4056
4057 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