blob: af1b259655cd06dac54e0a3ebec5bddf1bf82bce [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.
69 Cflags proptools.Configurable[[]string]
70 AidlInterfaceInfo AidlInterfaceInfo
71 LibraryDecoratorInfo *LibraryDecoratorInfo
72}
73
74type LinkerInfo struct {
Yu Liu4f825132024-12-18 00:35:39 +000075 WholeStaticLibs proptools.Configurable[[]string]
Yu Liu323d77a2024-12-16 23:13:57 +000076 // list of modules that should be statically linked into this module.
Yu Liu4f825132024-12-18 00:35:39 +000077 StaticLibs proptools.Configurable[[]string]
Yu Liu323d77a2024-12-16 23:13:57 +000078 // list of modules that should be dynamically linked into this module.
Yu Liu4f825132024-12-18 00:35:39 +000079 SharedLibs proptools.Configurable[[]string]
Yu Liu323d77a2024-12-16 23:13:57 +000080 // list of modules that should only provide headers for this module.
Yu Liu68a70b72025-01-08 22:54:44 +000081 HeaderLibs proptools.Configurable[[]string]
82 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 {
Yu Liu4f825132024-12-18 00:35:39 +000094 ExportIncludeDirs proptools.Configurable[[]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 Liu323d77a2024-12-16 23:13:57 +0000120 CompilerInfo *CompilerInfo
121 LinkerInfo *LinkerInfo
Yu Liu8024b922024-12-20 23:31:32 +0000122 SnapshotInfo *SnapshotInfo
Yu Liu8a8d5b42025-01-07 00:48:08 +0000123 LibraryInfo *LibraryInfo
Yu Liub1bfa9d2024-12-05 18:57:51 +0000124}
125
Yu Liu8024b922024-12-20 23:31:32 +0000126var CcInfoProvider = blueprint.NewProvider[*CcInfo]()
Yu Liub1bfa9d2024-12-05 18:57:51 +0000127
Yu Liu986d98c2024-11-12 00:28:11 +0000128type LinkableInfo struct {
129 // StaticExecutable returns true if this is a binary module with "static_executable: true".
Yu Liu8024b922024-12-20 23:31:32 +0000130 StaticExecutable bool
131 Static bool
132 Shared bool
133 HasStubsVariants bool
134 StubsVersion string
135 IsStubs bool
136 UnstrippedOutputFile android.Path
137 OutputFile android.OptionalPath
138 CoverageFiles android.Paths
139 SAbiDumpFiles android.Paths
Yu Liu8a8d5b42025-01-07 00:48:08 +0000140 CcLibrary bool
Yu Liu8024b922024-12-20 23:31:32 +0000141 CcLibraryInterface bool
142 RustLibraryInterface bool
143 // CrateName returns the crateName for a Rust library
144 CrateName string
145 // DepFlags returns a slice of Rustc string flags
146 ExportedCrateLinkDirs []string
147 // This can be different from the one on CommonModuleInfo
148 BaseModuleName string
149 HasNonSystemVariants bool
150 IsLlndk bool
151 InVendorOrProduct bool
152 // SubName returns the modules SubName, used for image and NDK/SDK variations.
153 SubName string
154 InRamdisk bool
155 OnlyInRamdisk bool
156 InVendorRamdisk bool
157 OnlyInVendorRamdisk bool
158 InRecovery bool
159 OnlyInRecovery bool
Yu Liu8a8d5b42025-01-07 00:48:08 +0000160 Installable *bool
Yu Liu97880e12025-01-07 19:03:34 +0000161 // RelativeInstallPath returns the relative install path for this module.
162 RelativeInstallPath string
Yu Liu986d98c2024-11-12 00:28:11 +0000163}
164
Yu Liu8024b922024-12-20 23:31:32 +0000165var LinkableInfoProvider = blueprint.NewProvider[*LinkableInfo]()
Yu Liu986d98c2024-11-12 00:28:11 +0000166
Colin Cross463a90e2015-06-17 14:20:06 -0700167func init() {
Paul Duffin036e7002019-12-19 19:16:28 +0000168 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -0700169
Inseob Kim3b244062023-07-11 13:31:36 +0900170 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +0000171 pctx.Import("android/soong/cc/config")
172}
173
174func RegisterCCBuildComponents(ctx android.RegistrationContext) {
175 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
176
177 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossac57a6c2024-06-26 13:09:53 -0700178 ctx.Transition("sdk", &sdkTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700179 ctx.BottomUp("llndk", llndkMutator)
Colin Cross767819f2024-05-22 14:22:34 -0700180 ctx.Transition("link", &linkageTransitionMutator{})
Colin Crossadd04a82024-05-22 09:57:59 -0700181 ctx.Transition("version", &versionTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -0700182 ctx.BottomUp("begin", BeginMutator)
Colin Cross1e676be2016-10-12 14:38:15 -0700183 })
Colin Cross16b23492016-01-06 14:41:07 -0800184
Paul Duffin036e7002019-12-19 19:16:28 +0000185 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -0400186 for _, san := range Sanitizers {
187 san.registerMutators(ctx)
188 }
Dan Willemsen581341d2017-02-09 16:16:31 -0800189
Colin Cross8a962802024-10-09 15:29:27 -0700190 ctx.BottomUp("sanitize_runtime_deps", sanitizerRuntimeDepsMutator)
191 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator)
Ivan Lozano30c5db22018-02-21 15:49:20 -0800192
Colin Cross597bad62024-10-08 15:10:55 -0700193 ctx.Transition("fuzz", &fuzzTransitionMutator{})
Cory Barkera1da26f2022-06-07 20:12:06 +0000194
Colin Crossf5f4ad32024-01-19 15:41:48 -0800195 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -0700196
Colin Crossd38feb02024-01-23 16:38:06 -0800197 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +0800198
Colin Cross33e0c812024-01-23 16:36:07 -0800199 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000200
Colin Cross6ac83a82024-01-23 11:23:10 -0800201 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +0900202
Colin Cross8a962802024-10-09 15:29:27 -0700203 ctx.BottomUp("check_linktype", checkLinkTypeMutator)
204 ctx.BottomUp("double_loadable", checkDoubleLoadableLibraries)
Colin Cross1e676be2016-10-12 14:38:15 -0700205 })
Colin Crossb98c8b02016-07-29 13:44:28 -0700206
Colin Cross91ae5ec2024-10-01 14:03:40 -0700207 ctx.PostApexMutators(func(ctx android.RegisterMutatorsContext) {
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800208 // sabi mutator needs to be run after apex mutator finishes.
Colin Cross91ae5ec2024-10-01 14:03:40 -0700209 ctx.Transition("sabi", &sabiTransitionMutator{})
Yo Chiang8aa4e3f2020-11-19 16:30:49 +0800210 })
211
LaMont Jones0c10e4d2023-05-16 00:58:37 +0000212 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -0700213}
214
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500215// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
216// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
217// edges to these modules.
218// This object is constructed in DepsMutator, by calling to various module delegates to set
219// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
220// dependencies.
221// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
222// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -0800223type Deps struct {
224 SharedLibs, LateSharedLibs []string
225 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -0800226 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800227 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700228
Colin Cross3e5e7782022-06-17 22:17:05 +0000229 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
230 // prevent automatically exporting symbols.
231 UnexportedStaticLibs []string
232
Chris Parsons79d66a52020-06-05 17:26:16 -0400233 // Used for data dependencies adjacent to tests
234 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700235 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400236
Yo Chiang219968c2020-09-22 18:45:04 +0800237 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
238 SystemSharedLibs []string
239
Vinh Tran367d89d2023-04-28 11:21:25 -0400240 // Used by DepMutator to pass aidl_library modules to aidl compiler
241 AidlLibs []string
242
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500243 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800244 StaticUnwinderIfLegacy bool
245
Colin Cross5950f382016-12-13 12:50:57 -0800246 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700247
Colin Cross81413472016-04-11 14:37:39 -0700248 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700249
Cole Faust65cb40a2024-10-21 15:41:42 -0700250 GeneratedSources []string
251 GeneratedHeaders []string
252 DeviceFirstGeneratedHeaders []string
253 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700254
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700255 ReexportGeneratedHeaders []string
256
Colin Crossc465efd2021-06-11 18:00:04 -0700257 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700258
259 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700260 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900261
262 // List of libs that need to be excluded for APEX variant
263 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900264 // List of libs that need to be excluded for non-APEX variant
265 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800266
267 // LLNDK headers for the ABI checker to check LLNDK implementation library.
268 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
Colin Cross1e954b62024-09-13 13:50:00 -0700269 // The core variant cannot depend on the vendor variant because of the order of imageTransitionMutator.Split().
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800270 // Instead, the LLNDK implementation depends on the LLNDK header libs.
271 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700272}
273
Ivan Lozano0a468a42024-05-13 21:03:34 -0400274// A struct which to collect flags for rlib dependencies
275type RustRlibDep struct {
276 LibPath android.Path // path to the rlib
277 LinkDirs []string // flags required for dependency (e.g. -L flags)
278 CrateName string // crateNames associated with rlibDeps
279}
280
281func EqRustRlibDeps(a RustRlibDep, b RustRlibDep) bool {
282 return a.LibPath == b.LibPath
283}
284
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500285// PathDeps is a struct containing file paths to dependencies of a module.
286// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
287// It's used to construct flags for various build statements (such as for compiling and linking).
288// It is then passed to module decorator functions responsible for registering build statements
289// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800290type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700291 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900292 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700293 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900294 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700295 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700296 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400297 // Paths and crateNames for RustStaticLib dependencies
298 RustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700299
Colin Cross0de8a1e2020-09-18 14:15:30 -0700300 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossa14fb6a2024-10-23 16:57:06 -0700301 TranstiveStaticLibrariesForOrdering depset.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700302
Colin Cross26c34ed2016-09-30 17:10:16 -0700303 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100304 Objs Objects
305 // Paths to .o files in dependencies that provide them. Note that these lists
306 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800307 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700308 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700309
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100310 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
311 // the libs from all whole_static_lib dependencies.
312 WholeStaticLibsFromPrebuilts android.Paths
313
Colin Cross26c34ed2016-09-30 17:10:16 -0700314 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700315 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900316 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700317
Inseob Kimd110f872019-12-06 13:15:38 +0900318 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000319 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900320 IncludeDirs android.Paths
321 SystemIncludeDirs android.Paths
322 ReexportedDirs android.Paths
323 ReexportedSystemDirs android.Paths
324 ReexportedFlags []string
325 ReexportedGeneratedHeaders android.Paths
326 ReexportedDeps android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400327 ReexportedRustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700328
Colin Cross26c34ed2016-09-30 17:10:16 -0700329 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700330 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700331
Dan Willemsena0790e32018-10-12 00:24:23 -0700332 // Path to the dynamic linker binary
333 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700334
335 // For Darwin builds, the path to the second architecture's output that should
336 // be combined with this architectures's output into a FAT MachO file.
337 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400338
339 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
340 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800341
342 // LLNDK headers for the ABI checker to check LLNDK implementation library.
343 LlndkIncludeDirs android.Paths
344 LlndkSystemIncludeDirs android.Paths
Colin Crossb614cd42024-10-11 12:52:21 -0700345
346 directImplementationDeps android.Paths
347 transitiveImplementationDeps []depset.DepSet[android.Path]
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700348}
349
Colin Cross4af21ed2019-11-04 09:37:55 -0800350// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
351// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
352// command line so they can be overridden by the local module flags).
353type LocalOrGlobalFlags struct {
354 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700355 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800356 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700357 CFlags []string // Flags that apply to C and C++ source files
358 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
359 ConlyFlags []string // Flags that apply to C source files
360 CppFlags []string // Flags that apply to C++ source files
361 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700362 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800363}
364
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500365// Flags contains various types of command line flags (and settings) for use in building build
366// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800367type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500368 // Local flags (which individual modules are responsible for). These may override global flags.
369 Local LocalOrGlobalFlags
370 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700371 Global LocalOrGlobalFlags
372 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800373
374 aidlFlags []string // Flags that apply to aidl source files
375 rsFlags []string // Flags that apply to renderscript source files
376 libFlags []string // Flags to add libraries early to the link order
377 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
378 TidyFlags []string // Flags that apply to clang-tidy
379 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700380
Colin Crossc3199482017-03-30 15:03:04 -0700381 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800382 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700383 SystemIncludeFlags []string
384
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800385 Toolchain config.Toolchain
386 Tidy bool // True if ninja .tidy rules should be generated.
387 NeedTidyFiles bool // True if module link should depend on .tidy files
388 GcovCoverage bool // True if coverage files should be generated.
389 SAbiDump bool // True if header abi dumps should be generated.
390 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
kellyhungd62ea302024-05-19 21:16:07 +0800391 ClangVerify bool // If true, append cflags "-Xclang -verify" and append "&& touch $out" to the clang command line.
Colin Crossca860ac2016-01-04 14:34:37 -0800392
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500393 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800394 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500395 // The target-device system path to the dynamic linker.
396 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800397
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700398 CFlagsDeps android.Paths // Files depended on by compiler flags
399 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800400
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500401 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700402 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800403
Colin Cross19878da2019-03-28 14:45:07 -0700404 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700405 protoC bool // Whether to use C instead of C++
406 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700407
408 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200409 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700410}
411
Colin Crossca860ac2016-01-04 14:34:37 -0800412// Properties used to compile all C or C++ modules
413type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700414 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800415 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700416
Yi Kong5786f5c2024-05-28 02:22:34 +0900417 // Aggresively trade performance for smaller binary size.
418 // This should only be used for on-device binaries that are rarely executed and not
419 // performance critical.
420 Optimize_for_size *bool `android:"arch_variant"`
421
Jiyong Parkb35a8192020-08-10 15:59:36 +0900422 // The API level that this module is built against. The APIs of this API level will be
423 // visible at build time, but use of any APIs newer than min_sdk_version will render the
424 // module unloadable on older devices. In the future it will be possible to weakly-link new
425 // APIs, making the behavior match Java: such modules will load on older devices, but
426 // calling new APIs on devices that do not support them will result in a crash.
427 //
428 // This property has the same behavior as sdk_version does for Java modules. For those
429 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
430 // does for Java code.
431 //
432 // In addition, setting this property causes two variants to be built, one for the platform
433 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800434 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700435
Jiyong Parkb35a8192020-08-10 15:59:36 +0900436 // Minimum OS API level supported by this C or C++ module. This property becomes the value
437 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
438 // this property is also used to ensure that the min_sdk_version of the containing module is
439 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
440 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
441 // min_sdk_version of the containing APEX. When the module
442 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900443 Min_sdk_version *string
444
Colin Crossc511bc52020-04-07 16:50:32 +0000445 // If true, always create an sdk variant and don't create a platform variant.
446 Sdk_variant_only *bool
447
Colin Cross4297f402024-11-20 15:20:09 -0800448 AndroidMkSharedLibs []string `blueprint:"mutated"`
449 AndroidMkStaticLibs []string `blueprint:"mutated"`
450 AndroidMkRlibs []string `blueprint:"mutated"`
451 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
452 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
453 AndroidMkHeaderLibs []string `blueprint:"mutated"`
454 HideFromMake bool `blueprint:"mutated"`
455 PreventInstall bool `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700456
Yo Chiang219968c2020-09-22 18:45:04 +0800457 // Set by DepsMutator.
458 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
459
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900460 // The name of the image this module is built for
461 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200462
463 // The VNDK version this module is built against. If empty, the module is not
464 // build against the VNDK.
465 VndkVersion string `blueprint:"mutated"`
466
467 // Suffix for the name of Android.mk entries generated by this module
468 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800469
470 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
471 // file
Inseob Kim37e0bb02024-04-29 15:54:44 +0900472 Logtags []string `android:"path"`
Jiyong Parkf9332f12018-02-01 00:54:12 +0900473
Yifan Hong39143a92020-10-26 12:43:12 -0700474 // Make this module available when building for ramdisk.
475 // On device without a dedicated recovery partition, the module is only
476 // available after switching root into
477 // /first_stage_ramdisk. To expose the module before switching root, install
478 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800479 Ramdisk_available *bool
480
Yifan Hong39143a92020-10-26 12:43:12 -0700481 // Make this module available when building for vendor ramdisk.
482 // On device without a dedicated recovery partition, the module is only
483 // available after switching root into
484 // /first_stage_ramdisk. To expose the module before switching root, install
485 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700486 Vendor_ramdisk_available *bool
487
Jiyong Parkf9332f12018-02-01 00:54:12 +0900488 // Make this module available when building for recovery
489 Recovery_available *bool
490
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200491 // Used by imageMutator, set by ImageMutatorBegin()
Jihoon Kang47e91842024-06-19 00:51:16 +0000492 VendorVariantNeeded bool `blueprint:"mutated"`
493 ProductVariantNeeded bool `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200494 CoreVariantNeeded bool `blueprint:"mutated"`
495 RamdiskVariantNeeded bool `blueprint:"mutated"`
496 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
497 RecoveryVariantNeeded bool `blueprint:"mutated"`
498
499 // A list of variations for the "image" mutator of the form
500 //<image name> '.' <version char>, for example, 'vendor.S'
501 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900502
503 // Allows this module to use non-APEX version of libraries. Useful
504 // for building binaries that are started before APEXes are activated.
505 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900506
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000507 // Allows this module to be included in CMake release snapshots to be built outside of Android
508 // build system and source tree.
509 Cmake_snapshot_supported *bool
510
Colin Cross1bc94122021-10-28 13:25:54 -0700511 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000512
513 // Set by factories of module types that can only be referenced from variants compiled against
514 // the SDK.
515 AlwaysSdk bool `blueprint:"mutated"`
516
517 // Variant is an SDK variant created by sdkMutator
518 IsSdkVariant bool `blueprint:"mutated"`
519 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
520 // variant to have a ".sdk" suffix.
521 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700522
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800523 Target struct {
524 Platform struct {
525 // List of modules required by the core variant.
526 Required []string `android:"arch_variant"`
527
528 // List of modules not required by the core variant.
529 Exclude_required []string `android:"arch_variant"`
530 } `android:"arch_variant"`
531
532 Recovery struct {
533 // List of modules required by the recovery variant.
534 Required []string `android:"arch_variant"`
535
536 // List of modules not required by the recovery variant.
537 Exclude_required []string `android:"arch_variant"`
538 } `android:"arch_variant"`
539 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700540}
541
542type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900543 // whether this module should be allowed to be directly depended by other
544 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900545 // If set to true, two variants will be built separately, one like
546 // normal, and the other limited to the set of libraries and headers
547 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700548 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900549 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700550 // so it shouldn't have any unversioned runtime dependencies, or
551 // make assumptions about the system that may not be true in the
552 // future.
553 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900554 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900555 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900556 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900557 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900558 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700559 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
560 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900561
Justin Yunebcf0c52021-01-08 18:00:19 +0900562 // This is the same as the "vendor_available" except that the install path
563 // of the vendor variant is /odm or /vendor/odm.
564 // By replacing "vendor_available: true" with "odm_available: true", the
565 // module will install its vendor variant to the /odm partition or /vendor/odm.
566 // As the modules with "odm_available: true" still create the vendor variants,
567 // they can link to the other vendor modules as the vendor_available modules do.
568 // Also, the vendor modules can link to odm_available modules.
569 //
570 // It may not be used for VNDK modules.
571 Odm_available *bool
572
Justin Yun63e9ec72020-10-29 16:49:43 +0900573 // whether this module should be allowed to be directly depended by other
574 // modules with `product_specific: true` or `product_available: true`.
575 // If set to true, an additional product variant will be built separately
576 // that is limited to the set of libraries and headers that are exposed to
577 // /product modules.
578 //
579 // The product variant may be used with a different (newer) /system,
580 // so it shouldn't have any unversioned runtime dependencies, or
581 // make assumptions about the system that may not be true in the
582 // future.
583 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900584 // If set to false, this module becomes inaccessible from /product modules.
585 //
586 // Different from the 'vendor_available' property, the modules with
587 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
588 // library without 'product_available' may not be depended on by any other
589 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900590 //
591 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
592 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
593 Product_available *bool
594
Jiyong Park5fb8c102018-04-09 12:03:06 +0900595 // whether this module is capable of being loaded with other instance
596 // (possibly an older version) of the same module in the same process.
597 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
598 // can be double loaded in a vendor process if the library is also a
599 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
600 // explicitly marked as `double_loadable: true` by the owner, or the dependency
601 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
602 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800603
604 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
605 IsLLNDK bool `blueprint:"mutated"`
606
Colin Cross5271fea2021-04-27 13:06:04 -0700607 // IsVendorPublicLibrary is set for the core and product variants of a library that has
608 // vendor_public_library stubs.
609 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800610}
611
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500612// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
613// to understanding details about the type of the current module.
614// For example, one might call these functions to determine whether the current module is a static
615// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800616type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800617 static() bool
618 staticBinary() bool
Colin Cross6a730042024-12-05 13:53:43 -0800619 staticLibrary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700620 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800621 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900622 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900623 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900624 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700625 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900626 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700627 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800628 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900629 minSdkVersion() string
630 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700631 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700632 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800633 IsLlndk() bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800634 isImplementationForLLNDKPublic() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700635 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900636 inProduct() bool
637 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800638 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700639 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900640 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900641 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700642 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700643 baseModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800644 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000645 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800646 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900647 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800648 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800649 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800650 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700651 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700652 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900653 bootstrap() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700654 nativeCoverage() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800655 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800656 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800657 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800658 notInPlatform() bool
Yi Kong5786f5c2024-05-28 02:22:34 +0900659 optimizeForSize() bool
Yu Liu76d94462024-10-31 23:32:36 +0000660 getOrCreateMakeVarsInfo() *CcMakeVarsInfo
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800661}
662
663type SharedFlags struct {
664 numSharedFlags int
665 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800666}
667
668type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700669 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800670 ModuleContextIntf
671}
672
673type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700674 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800675 ModuleContextIntf
676}
677
Colin Cross37047f12016-12-13 17:06:13 -0800678type DepsContext interface {
679 android.BottomUpMutatorContext
680 ModuleContextIntf
681}
682
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500683// feature represents additional (optional) steps to building cc-related modules, such as invocation
684// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800685type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800686 flags(ctx ModuleContext, flags Flags) Flags
687 props() []interface{}
688}
689
Joe Onorato37f900c2023-07-18 16:58:16 -0700690// Information returned from Generator about the source code it's generating
691type GeneratedSource struct {
692 IncludeDirs android.Paths
693 Sources android.Paths
694 Headers android.Paths
695 ReexportedDirs android.Paths
696}
697
698// generator allows injection of generated code
699type Generator interface {
700 GeneratorProps() []interface{}
701 GeneratorInit(ctx BaseModuleContext)
702 GeneratorDeps(ctx DepsContext, deps Deps) Deps
703 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
704 GeneratorSources(ctx ModuleContext) GeneratedSource
705 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
706}
707
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500708// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500709// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800710type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700711 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800712 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800713 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700714 compilerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000715 baseCompilerProps() BaseCompilerProperties
Colin Cross42742b82016-08-01 13:20:05 -0700716
Colin Cross76fada02016-07-27 10:31:13 -0700717 appendCflags([]string)
718 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700719 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800720}
721
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500722// linker is the interface for a linker decorator object. Individual module types can provide
723// their own implementation for this decorator, and thus specify custom logic regarding build
724// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800725type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700726 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800727 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700728 linkerFlags(ctx ModuleContext, flags Flags) Flags
729 linkerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000730 baseLinkerProps() BaseLinkerProperties
Ivan Lozanobd721262018-11-27 14:33:03 -0800731 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700732
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700733 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700734 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900735 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800736 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700737
738 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900739 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000740
741 // Get the deps that have been explicitly specified in the properties.
Cole Fauste8a87832024-09-11 11:35:46 -0700742 linkerSpecifiedDeps(ctx android.ConfigurableEvaluatorContext, module *Module, specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800743
744 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000745}
746
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500747// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000748type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500749 sharedLibs []string
750 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
751 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700752 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800753}
754
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500755// installer is the interface for an installer helper object. This helper is responsible for
756// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800757type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700758 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700759 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000760 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800761 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700762 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700763 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900764 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000765 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900766 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800767}
768
Inseob Kima1888ce2022-10-04 14:42:02 +0900769type overridable interface {
770 overriddenModules() []string
771}
772
Colin Cross6e511a92020-07-27 21:26:48 -0700773type libraryDependencyKind int
774
775const (
776 headerLibraryDependency = iota
777 sharedLibraryDependency
778 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400779 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700780)
781
782func (k libraryDependencyKind) String() string {
783 switch k {
784 case headerLibraryDependency:
785 return "headerLibraryDependency"
786 case sharedLibraryDependency:
787 return "sharedLibraryDependency"
788 case staticLibraryDependency:
789 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400790 case rlibLibraryDependency:
791 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700792 default:
793 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
794 }
795}
796
797type libraryDependencyOrder int
798
799const (
800 earlyLibraryDependency = -1
801 normalLibraryDependency = 0
802 lateLibraryDependency = 1
803)
804
805func (o libraryDependencyOrder) String() string {
806 switch o {
807 case earlyLibraryDependency:
808 return "earlyLibraryDependency"
809 case normalLibraryDependency:
810 return "normalLibraryDependency"
811 case lateLibraryDependency:
812 return "lateLibraryDependency"
813 default:
814 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
815 }
816}
817
818// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
819// tags that have a set of predefined tag objects that are reused for each dependency, a
820// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
821// That means that comparing a libraryDependencyTag for equality will only be equal if all
822// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
823// then check individual metadata fields instead.
824type libraryDependencyTag struct {
825 blueprint.BaseDependencyTag
826
827 // These are exported so that fmt.Printf("%#v") can call their String methods.
828 Kind libraryDependencyKind
829 Order libraryDependencyOrder
830
831 wholeStatic bool
832
833 reexportFlags bool
834 explicitlyVersioned bool
835 dataLib bool
836 ndk bool
837
838 staticUnwinder bool
839
840 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900841
Cindy Zhou18417cb2020-12-10 07:12:38 -0800842 // Whether or not this dependency should skip the apex dependency check
843 skipApexAllowedDependenciesCheck bool
844
Jiyong Parke3867542020-12-03 17:28:25 +0900845 // Whether or not this dependency has to be followed for the apex variants
846 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900847 // Whether or not this dependency has to be followed for the non-apex variants
848 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000849
850 // If true, don't automatically export symbols from the static library into a shared library.
851 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700852}
853
854// header returns true if the libraryDependencyTag is tagging a header lib dependency.
855func (d libraryDependencyTag) header() bool {
856 return d.Kind == headerLibraryDependency
857}
858
859// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
860func (d libraryDependencyTag) shared() bool {
861 return d.Kind == sharedLibraryDependency
862}
863
864// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
865func (d libraryDependencyTag) static() bool {
866 return d.Kind == staticLibraryDependency
867}
868
Colin Cross65cb3142021-12-10 23:05:02 +0000869func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
870 if d.shared() {
871 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
872 }
873 return nil
874}
875
876var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
877
Colin Crosse9fe2942020-11-10 18:12:15 -0800878// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
879// binaries or other shared libraries are installed as dependencies.
880func (d libraryDependencyTag) InstallDepNeeded() bool {
881 return d.shared()
882}
883
884var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
885
Yu Liu67a28422024-03-05 00:36:31 +0000886func (d libraryDependencyTag) PropagateAconfigValidation() bool {
887 return d.static()
888}
889
890var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
891
Colin Crosse9fe2942020-11-10 18:12:15 -0800892// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700893// libraryDependencyTag. Each tag object is created globally and reused for multiple
894// dependencies (although since the object contains no references, assigning a tag to a
895// variable and modifying it will not modify the original). Users can compare the tag
896// returned by ctx.OtherModuleDependencyTag against the global original
897type dependencyTag struct {
898 blueprint.BaseDependencyTag
899 name string
900}
901
Colin Crosse9fe2942020-11-10 18:12:15 -0800902// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
903// libraryDependencyTag, but where the dependency needs to be installed when the parent is
904// installed.
905type installDependencyTag struct {
906 blueprint.BaseDependencyTag
907 android.InstallAlwaysNeededDependencyTag
908 name string
909}
910
Colin Crossc99deeb2016-04-11 15:06:20 -0700911var (
Colin Cross6e511a92020-07-27 21:26:48 -0700912 genSourceDepTag = dependencyTag{name: "gen source"}
913 genHeaderDepTag = dependencyTag{name: "gen header"}
914 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
915 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900916 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700917 reuseObjTag = dependencyTag{name: "reuse objects"}
918 staticVariantTag = dependencyTag{name: "static variant"}
919 vndkExtDepTag = dependencyTag{name: "vndk extends"}
920 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700921 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800922 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700923 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000924 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500925 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400926 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800927 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700928)
929
Roland Levillainf89cd092019-07-29 16:22:59 +0100930func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700931 ccLibDepTag, ok := depTag.(libraryDependencyTag)
932 return ok && ccLibDepTag.shared()
933}
934
935func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
936 ccLibDepTag, ok := depTag.(libraryDependencyTag)
937 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100938}
939
Zach Johnson3df4e632020-11-06 11:56:27 -0800940func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
941 ccLibDepTag, ok := depTag.(libraryDependencyTag)
942 return ok && ccLibDepTag.header()
943}
944
Roland Levillainf89cd092019-07-29 16:22:59 +0100945func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800946 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100947}
948
Colin Crossca860ac2016-01-04 14:34:37 -0800949// Module contains the properties and members used by all C/C++ module types, and implements
950// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500951// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
952// interface.
953//
954// To define a C/C++ related module, construct a new Module object and point its delegates to
955// type-specific structs. These delegates will be invoked to register module-specific build
956// statements which may be unique to the module type. For example, module.compiler.compile() should
957// be defined so as to register build statements which are responsible for compiling the module.
958//
959// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
960// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
961// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
962// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800963type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700964 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700965
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700966 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700967 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700968 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700969
Colin Crossca860ac2016-01-04 14:34:37 -0800970 // initialize before calling Init
Yu Liu76d94462024-10-31 23:32:36 +0000971 hod android.HostOrDeviceSupported
972 multilib android.Multilib
973 testModule bool
974 incremental bool
Colin Crossc472d572015-03-17 15:06:21 -0700975
Paul Duffina0843f62019-12-13 19:50:38 +0000976 // Allowable SdkMemberTypes of this module type.
977 sdkMemberTypes []android.SdkMemberType
978
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500979 // decorator delegates, initialize before calling Init
980 // these may contain module-specific implementations, and effectively allow for custom
981 // type-specific logic. These members may reference different objects or the same object.
982 // Functions of these decorators will be invoked to initialize and register type-specific
983 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800984 generators []Generator
985 compiler compiler
986 linker linker
987 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500988
Spandan Dase12d2522023-09-12 21:42:31 +0000989 features []feature
990 stl *stl
991 sanitize *sanitize
992 coverage *coverage
993 fuzzer *fuzzer
994 sabi *sabi
Spandan Dase12d2522023-09-12 21:42:31 +0000995 lto *lto
996 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000997 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800998
Colin Cross31076b32020-10-23 17:22:06 -0700999 library libraryInterface
1000
Colin Cross635c3b02016-05-18 15:37:25 -07001001 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -08001002
Colin Crossb98c8b02016-07-29 13:44:28 -07001003 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -07001004
Yu Liue70976d2024-10-15 20:45:35 +00001005 subAndroidMkOnce map[subAndroidMkProviderInfoProducer]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08001006
1007 // Flags used to compile this module
1008 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -07001009
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001010 // Shared flags among build rules of this module
1011 sharedFlags SharedFlags
1012
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -08001013 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -07001014 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +09001015
1016 makeLinkType string
Jooyung Han75568392020-03-20 04:29:24 +09001017
1018 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -07001019 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -07001020
1021 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -08001022
Inseob Kim37e0bb02024-04-29 15:54:44 +09001023 logtagsPaths android.Paths
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001024
1025 WholeRustStaticlib bool
Cole Faust96a692b2024-08-08 14:47:51 -07001026
1027 hasAidl bool
1028 hasLex bool
1029 hasProto bool
1030 hasRenderscript bool
1031 hasSysprop bool
1032 hasWinMsg bool
1033 hasYacc bool
Yu Liu76d94462024-10-31 23:32:36 +00001034
1035 makeVarsInfo *CcMakeVarsInfo
Colin Crossc472d572015-03-17 15:06:21 -07001036}
1037
Yu Liu76d94462024-10-31 23:32:36 +00001038func (c *Module) IncrementalSupported() bool {
1039 return c.incremental
1040}
1041
1042var _ blueprint.Incremental = (*Module)(nil)
1043
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001044func (c *Module) AddJSONData(d *map[string]interface{}) {
1045 c.AndroidModuleBase().AddJSONData(d)
1046 (*d)["Cc"] = map[string]interface{}{
1047 "SdkVersion": c.SdkVersion(),
1048 "MinSdkVersion": c.MinSdkVersion(),
1049 "VndkVersion": c.VndkVersion(),
1050 "ProductSpecific": c.ProductSpecific(),
1051 "SocSpecific": c.SocSpecific(),
1052 "DeviceSpecific": c.DeviceSpecific(),
1053 "InProduct": c.InProduct(),
1054 "InVendor": c.InVendor(),
1055 "InRamdisk": c.InRamdisk(),
1056 "InVendorRamdisk": c.InVendorRamdisk(),
1057 "InRecovery": c.InRecovery(),
1058 "VendorAvailable": c.VendorAvailable(),
1059 "ProductAvailable": c.ProductAvailable(),
1060 "RamdiskAvailable": c.RamdiskAvailable(),
1061 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
1062 "RecoveryAvailable": c.RecoveryAvailable(),
1063 "OdmAvailable": c.OdmAvailable(),
1064 "InstallInData": c.InstallInData(),
1065 "InstallInRamdisk": c.InstallInRamdisk(),
1066 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
1067 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
1068 "InstallInRecovery": c.InstallInRecovery(),
1069 "InstallInRoot": c.InstallInRoot(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001070 "IsLlndk": c.IsLlndk(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001071 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
1072 "ApexSdkVersion": c.apexSdkVersion,
Cole Faust96a692b2024-08-08 14:47:51 -07001073 "AidlSrcs": c.hasAidl,
1074 "LexSrcs": c.hasLex,
1075 "ProtoSrcs": c.hasProto,
1076 "RenderscriptSrcs": c.hasRenderscript,
1077 "SyspropSrcs": c.hasSysprop,
1078 "WinMsgSrcs": c.hasWinMsg,
1079 "YaccSrsc": c.hasYacc,
1080 "OnlyCSrcs": !(c.hasAidl || c.hasLex || c.hasProto || c.hasRenderscript || c.hasSysprop || c.hasWinMsg || c.hasYacc),
Yi Kong5786f5c2024-05-28 02:22:34 +09001081 "OptimizeForSize": c.OptimizeForSize(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +02001082 }
1083}
1084
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001085func (c *Module) SetPreventInstall() {
1086 c.Properties.PreventInstall = true
1087}
1088
1089func (c *Module) SetHideFromMake() {
1090 c.Properties.HideFromMake = true
1091}
1092
Ivan Lozanod7586b62021-04-01 09:49:36 -04001093func (c *Module) HiddenFromMake() bool {
1094 return c.Properties.HideFromMake
1095}
1096
Cole Fauste8a87832024-09-11 11:35:46 -07001097func (c *Module) RequiredModuleNames(ctx android.ConfigurableEvaluatorContext) []string {
Cole Faust43ddd082024-06-17 12:32:40 -07001098 required := android.CopyOf(c.ModuleBase.RequiredModuleNames(ctx))
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +08001099 if c.ImageVariation().Variation == android.CoreVariation {
1100 required = append(required, c.Properties.Target.Platform.Required...)
1101 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
1102 } else if c.InRecovery() {
1103 required = append(required, c.Properties.Target.Recovery.Required...)
1104 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
1105 }
1106 return android.FirstUniqueStrings(required)
1107}
1108
Ivan Lozano52767be2019-10-18 14:49:46 -07001109func (c *Module) Toc() android.OptionalPath {
1110 if c.linker != nil {
1111 if library, ok := c.linker.(libraryInterface); ok {
1112 return library.toc()
1113 }
1114 }
1115 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
1116}
1117
1118func (c *Module) ApiLevel() string {
1119 if c.linker != nil {
1120 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -07001121 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -07001122 }
1123 }
1124 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
1125}
1126
1127func (c *Module) Static() bool {
1128 if c.linker != nil {
1129 if library, ok := c.linker.(libraryInterface); ok {
1130 return library.static()
1131 }
1132 }
1133 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1134}
1135
1136func (c *Module) Shared() bool {
1137 if c.linker != nil {
1138 if library, ok := c.linker.(libraryInterface); ok {
1139 return library.shared()
1140 }
1141 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001142
Ivan Lozano52767be2019-10-18 14:49:46 -07001143 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1144}
1145
1146func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001147 if c.stl != nil {
1148 return c.stl.Properties.SelectedStl
1149 }
1150 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001151}
1152
Ivan Lozano52767be2019-10-18 14:49:46 -07001153func (c *Module) StubDecorator() bool {
1154 if _, ok := c.linker.(*stubDecorator); ok {
1155 return true
1156 }
1157 return false
1158}
1159
Yi Kong5786f5c2024-05-28 02:22:34 +09001160func (c *Module) OptimizeForSize() bool {
1161 return Bool(c.Properties.Optimize_for_size)
1162}
1163
Ivan Lozano52767be2019-10-18 14:49:46 -07001164func (c *Module) SdkVersion() string {
1165 return String(c.Properties.Sdk_version)
1166}
1167
Artur Satayev480e25b2020-04-27 18:53:18 +01001168func (c *Module) MinSdkVersion() string {
1169 return String(c.Properties.Min_sdk_version)
1170}
1171
Jiyong Park5df7bd32021-08-25 16:18:46 +09001172func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001173 if linker, ok := c.linker.(*objectLinker); ok {
1174 return linker.isCrt()
1175 }
1176 return false
1177}
1178
Jiyong Park5df7bd32021-08-25 16:18:46 +09001179func (c *Module) SplitPerApiLevel() bool {
1180 return c.canUseSdk() && c.isCrt()
1181}
1182
Colin Crossc511bc52020-04-07 16:50:32 +00001183func (c *Module) AlwaysSdk() bool {
1184 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1185}
1186
Ivan Lozano183a3212019-10-18 14:18:45 -07001187func (c *Module) CcLibrary() bool {
1188 if c.linker != nil {
1189 if _, ok := c.linker.(*libraryDecorator); ok {
1190 return true
1191 }
Colin Crossd48fe732020-09-23 20:37:24 -07001192 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1193 return true
1194 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001195 }
1196 return false
1197}
1198
1199func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001200 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001201 return true
1202 }
1203 return false
1204}
1205
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001206func (c *Module) RlibStd() bool {
1207 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1208}
1209
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001210func (c *Module) RustLibraryInterface() bool {
1211 return false
1212}
1213
Ivan Lozano0a468a42024-05-13 21:03:34 -04001214func (c *Module) CrateName() string {
1215 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1216}
1217
1218func (c *Module) ExportedCrateLinkDirs() []string {
1219 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1220}
1221
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001222func (c *Module) IsFuzzModule() bool {
1223 if _, ok := c.compiler.(*fuzzBinary); ok {
1224 return true
1225 }
1226 return false
1227}
1228
1229func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1230 return c.FuzzModule
1231}
1232
1233func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1234 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1235 return fuzzer.fuzzPackagedModule
1236 }
1237 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1238}
1239
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001240func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001241 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1242 return fuzzer.sharedLibraries
1243 }
1244 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1245}
1246
Ivan Lozano2b262972019-11-21 12:30:50 -08001247func (c *Module) NonCcVariants() bool {
1248 return false
1249}
1250
Ivan Lozano183a3212019-10-18 14:18:45 -07001251func (c *Module) SetStatic() {
1252 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001253 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001254 library.setStatic()
1255 return
1256 }
1257 }
1258 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1259}
1260
1261func (c *Module) SetShared() {
1262 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001263 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001264 library.setShared()
1265 return
1266 }
1267 }
1268 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1269}
1270
1271func (c *Module) BuildStaticVariant() bool {
1272 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001273 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001274 return library.buildStatic()
1275 }
1276 }
1277 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1278}
1279
1280func (c *Module) BuildSharedVariant() bool {
1281 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001282 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001283 return library.buildShared()
1284 }
1285 }
1286 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1287}
1288
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001289func (c *Module) BuildRlibVariant() bool {
1290 // cc modules can never build rlib variants
1291 return false
1292}
1293
Ivan Lozano183a3212019-10-18 14:18:45 -07001294func (c *Module) Module() android.Module {
1295 return c
1296}
1297
Jiyong Parkc20eee32018-09-05 22:36:17 +09001298func (c *Module) OutputFile() android.OptionalPath {
1299 return c.outputFile
1300}
1301
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001302func (c *Module) CoverageFiles() android.Paths {
1303 if c.linker != nil {
1304 if library, ok := c.linker.(libraryInterface); ok {
1305 return library.objs().coverageFiles
1306 }
1307 }
1308 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1309}
1310
Ivan Lozano183a3212019-10-18 14:18:45 -07001311var _ LinkableInterface = (*Module)(nil)
1312
Jiyong Park719b4462019-01-13 00:39:51 +09001313func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001314 if c.linker != nil {
1315 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001316 }
1317 return nil
1318}
1319
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001320func (c *Module) CoverageOutputFile() android.OptionalPath {
1321 if c.linker != nil {
1322 return c.linker.coverageOutputFilePath()
1323 }
1324 return android.OptionalPath{}
1325}
1326
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001327func (c *Module) RelativeInstallPath() string {
1328 if c.installer != nil {
1329 return c.installer.relativeInstallPath()
1330 }
1331 return ""
1332}
1333
Jooyung Han344d5432019-08-23 11:17:39 +09001334func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001335 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001336}
1337
Colin Cross36242852017-06-23 15:06:31 -07001338func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001339 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001340 for _, generator := range c.generators {
1341 c.AddProperties(generator.GeneratorProps()...)
1342 }
Colin Crossca860ac2016-01-04 14:34:37 -08001343 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001344 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001345 }
1346 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001347 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001348 }
1349 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001350 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001351 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001352 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001353 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001354 }
Colin Cross16b23492016-01-06 14:41:07 -08001355 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001356 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001357 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001358 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001359 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001360 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001361 if c.fuzzer != nil {
1362 c.AddProperties(c.fuzzer.props()...)
1363 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001364 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001365 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001366 }
Stephen Craneba090d12017-05-09 15:44:35 -07001367 if c.lto != nil {
1368 c.AddProperties(c.lto.props()...)
1369 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001370 if c.afdo != nil {
1371 c.AddProperties(c.afdo.props()...)
1372 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001373 if c.orderfile != nil {
1374 c.AddProperties(c.orderfile.props()...)
1375 }
Colin Crossca860ac2016-01-04 14:34:37 -08001376 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001377 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001378 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001379 // Allow test-only on libraries that are not cc_test_library
1380 if c.library != nil && !c.testLibrary() {
1381 c.AddProperties(&c.sourceProperties)
1382 }
Colin Crossc472d572015-03-17 15:06:21 -07001383
Colin Cross36242852017-06-23 15:06:31 -07001384 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001385 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001386 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001387
Colin Cross36242852017-06-23 15:06:31 -07001388 return c
Colin Crossc472d572015-03-17 15:06:21 -07001389}
1390
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001391// UseVndk() returns true if this module is built against VNDK.
1392// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001393func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001394 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001395}
1396
Colin Crossc511bc52020-04-07 16:50:32 +00001397func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001398 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001399 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001400}
1401
1402func (c *Module) UseSdk() bool {
1403 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001404 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001405 }
1406 return false
1407}
1408
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001409func (c *Module) isCoverageVariant() bool {
1410 return c.coverage.Properties.IsCoverageVariant
1411}
1412
Colin Cross95f1ca02020-10-29 20:47:22 -07001413func (c *Module) IsNdk(config android.Config) bool {
1414 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001415}
1416
Colin Cross127bb8b2020-12-16 16:46:01 -08001417func (c *Module) IsLlndk() bool {
1418 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001419}
1420
Colin Cross1f3f1302021-04-26 18:37:44 -07001421func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001422 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001423 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001424}
1425
Colin Cross5271fea2021-04-27 13:06:04 -07001426func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1427 lib := moduleLibraryInterface(m)
1428 return lib != nil && (lib.hasVendorPublicLibrary())
1429}
1430
1431// IsVendorPublicLibrary returns true for vendor public libraries.
1432func (c *Module) IsVendorPublicLibrary() bool {
1433 return c.VendorProperties.IsVendorPublicLibrary
1434}
1435
Ivan Lozanof1868af2022-04-12 13:08:36 -04001436func (c *Module) IsVndkPrebuiltLibrary() bool {
1437 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1438 return true
1439 }
1440 return false
1441}
1442
1443func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1444 return c.Properties.SdkAndPlatformVariantVisibleToMake
1445}
1446
Ivan Lozanod7586b62021-04-01 09:49:36 -04001447func (c *Module) HasLlndkStubs() bool {
1448 lib := moduleLibraryInterface(c)
1449 return lib != nil && lib.hasLLNDKStubs()
1450}
1451
1452func (c *Module) StubsVersion() string {
1453 if lib, ok := c.linker.(versionedInterface); ok {
1454 return lib.stubsVersion()
1455 }
1456 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1457}
1458
Colin Cross127bb8b2020-12-16 16:46:01 -08001459// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1460// and does not set llndk.vendor_available: false.
1461func (c *Module) isImplementationForLLNDKPublic() bool {
1462 library, _ := c.library.(*libraryDecorator)
1463 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001464 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001465}
1466
Colin Cross3513fb12024-01-24 14:44:47 -08001467func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001468 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001469 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001470 }
1471 return false
1472}
1473
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001474func (c *Module) isOrderfileCompile() bool {
1475 if orderfile := c.orderfile; orderfile != nil {
1476 return orderfile.Properties.OrderfileLoad
1477 }
1478 return false
1479}
1480
Yi Kongc702ebd2022-08-19 16:02:45 +08001481func (c *Module) isCfi() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001482 return c.sanitize.isSanitizerEnabled(cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001483}
1484
Yi Konged79fa32023-06-04 17:15:42 +09001485func (c *Module) isFuzzer() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001486 return c.sanitize.isSanitizerEnabled(Fuzzer)
Yi Konged79fa32023-06-04 17:15:42 +09001487}
1488
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001489func (c *Module) isNDKStubLibrary() bool {
1490 if _, ok := c.compiler.(*stubDecorator); ok {
1491 return true
1492 }
1493 return false
1494}
1495
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001496func (c *Module) SubName() string {
1497 return c.Properties.SubName
1498}
1499
Jiyong Park25fc6a92018-11-18 18:02:45 +09001500func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001501 if lib := c.library; lib != nil {
1502 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001503 }
1504 return false
1505}
1506
1507func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001508 if lib := c.library; lib != nil {
1509 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001510 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001511 return false
1512}
1513
Alan Stokes73feba32022-11-14 12:21:24 +00001514func (c *Module) IsStubsImplementationRequired() bool {
1515 if lib := c.library; lib != nil {
1516 return lib.isStubsImplementationRequired()
1517 }
1518 return false
1519}
1520
Colin Cross0477b422020-10-13 18:43:54 -07001521// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1522// the implementation. If it is an implementation library it returns its own name.
1523func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1524 name := ctx.OtherModuleName(c)
1525 if versioned, ok := c.linker.(versionedInterface); ok {
1526 name = versioned.implementationModuleName(name)
1527 }
1528 return name
1529}
1530
Martin Stjernholm2856c662020-12-02 15:03:42 +00001531// Similar to ImplementationModuleName, but uses the Make variant of the module
1532// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1533// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1534// under the premise that the prebuilt module overrides its source counterpart
1535// if it is exposed to Make).
1536func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1537 name := c.BaseModuleName()
1538 if versioned, ok := c.linker.(versionedInterface); ok {
1539 name = versioned.implementationModuleName(name)
1540 }
1541 return name
1542}
1543
Jiyong Park7d55b612021-06-11 17:22:09 +09001544func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001545 return Bool(c.Properties.Bootstrap)
1546}
1547
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001548func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001549 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1550 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1551 return false
1552 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001553 return c.linker != nil && c.linker.nativeCoverage()
1554}
1555
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001556func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001557 if p, ok := c.linker.(SnapshotInterface); ok {
1558 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001559 }
1560 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001561}
1562
Jiyong Parkf1194352019-02-25 11:05:47 +09001563func isBionic(name string) bool {
1564 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001565 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001566 return true
1567 }
1568 return false
1569}
1570
Martin Stjernholm279de572019-09-10 23:18:20 +01001571func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001572 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001573 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001574 }
1575 return isBionic(name)
1576}
1577
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001578func (c *Module) isCfiAssemblySupportEnabled() bool {
1579 return c.sanitize != nil &&
1580 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1581}
1582
Inseob Kim800d1142021-06-14 12:03:51 +09001583func (c *Module) InstallInRoot() bool {
1584 return c.installer != nil && c.installer.installInRoot()
1585}
1586
Colin Crossca860ac2016-01-04 14:34:37 -08001587type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001588 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001589 moduleContextImpl
1590}
1591
Colin Cross37047f12016-12-13 17:06:13 -08001592type depsContext struct {
1593 android.BottomUpMutatorContext
1594 moduleContextImpl
1595}
1596
Colin Crossca860ac2016-01-04 14:34:37 -08001597type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001598 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001599 moduleContextImpl
1600}
1601
1602type moduleContextImpl struct {
1603 mod *Module
1604 ctx BaseModuleContext
1605}
1606
Colin Crossb98c8b02016-07-29 13:44:28 -07001607func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001608 return ctx.mod.toolchain(ctx.ctx)
1609}
1610
1611func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001612 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001613}
1614
1615func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001616 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001617}
1618
Colin Cross6a730042024-12-05 13:53:43 -08001619func (ctx *moduleContextImpl) staticLibrary() bool {
1620 return ctx.mod.staticLibrary()
1621}
1622
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001623func (ctx *moduleContextImpl) testBinary() bool {
1624 return ctx.mod.testBinary()
1625}
1626
Yi Kong56fc1b62022-09-06 16:24:00 +08001627func (ctx *moduleContextImpl) testLibrary() bool {
1628 return ctx.mod.testLibrary()
1629}
1630
Jiyong Park1d1119f2019-07-29 21:27:18 +09001631func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001632 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001633}
1634
Inseob Kim7f283f42020-06-01 21:53:49 +09001635func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001636 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001637}
1638
Inseob Kim1042d292020-06-01 23:23:05 +09001639func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001640 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001641}
1642
Yi Kong5786f5c2024-05-28 02:22:34 +09001643func (ctx *moduleContextImpl) optimizeForSize() bool {
1644 return ctx.mod.OptimizeForSize()
1645}
1646
Jooyung Hanccce2f22020-03-07 03:45:53 +09001647func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001648 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001649}
1650
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001651func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001652 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001653}
1654
1655func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001656 if ctx.ctx.Device() {
Justin Yun732aa6a2018-03-23 17:43:47 +09001657 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001658 }
1659 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001660}
1661
Jiyong Parkb35a8192020-08-10 15:59:36 +09001662func (ctx *moduleContextImpl) minSdkVersion() string {
1663 ver := ctx.mod.MinSdkVersion()
1664 if ver == "apex_inherit" && !ctx.isForPlatform() {
1665 ver = ctx.apexSdkVersion().String()
1666 }
1667 if ver == "apex_inherit" || ver == "" {
1668 ver = ctx.sdkVersion()
1669 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001670
1671 if ctx.ctx.Device() {
Jooyung Hanaa2d3f52024-11-09 02:41:06 +00001672 // When building for vendor/product, use the latest _stable_ API as "current".
1673 // This is passed to clang/aidl compilers so that compiled/generated code works
1674 // with the system.
1675 if (ctx.inVendor() || ctx.inProduct()) && (ver == "" || ver == "current") {
1676 ver = ctx.ctx.Config().PlatformSdkVersion().String()
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001677 }
1678 }
1679
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001680 // For crt objects, the meaning of min_sdk_version is very different from other types of
1681 // module. For them, min_sdk_version defines the oldest version that the build system will
1682 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1683 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1684 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001685 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1686 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1687 // support such an old version. The version is set to the later version in case when the
1688 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1689 // it's for an APEX.
1690 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1691 if ctx.isForPlatform() {
1692 ver = strconv.Itoa(android.FutureApiLevelInt)
1693 } else { // for apex
1694 ver = ctx.apexSdkVersion().String()
1695 if ver == "" { // in case when min_sdk_version was not set by the APEX
1696 ver = ctx.sdkVersion()
1697 }
1698 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001699 }
1700
Jiyong Parkb35a8192020-08-10 15:59:36 +09001701 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1702 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1703 minSdkVersionInt, err2 := strconv.Atoi(ver)
1704 if err == nil && err2 == nil {
1705 if sdkVersionInt < minSdkVersionInt {
1706 return strconv.Itoa(sdkVersionInt)
1707 }
1708 }
1709 return ver
1710}
1711
1712func (ctx *moduleContextImpl) isSdkVariant() bool {
1713 return ctx.mod.IsSdkVariant()
1714}
1715
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001716func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001717 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001718}
Justin Yun8effde42017-06-23 19:24:43 +09001719
Kiyoung Kimaa394802024-01-08 12:55:45 +09001720func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1721 return ctx.mod.InVendorOrProduct()
1722}
1723
Colin Cross95f1ca02020-10-29 20:47:22 -07001724func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1725 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001726}
1727
Colin Cross127bb8b2020-12-16 16:46:01 -08001728func (ctx *moduleContextImpl) IsLlndk() bool {
1729 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001730}
1731
Colin Cross127bb8b2020-12-16 16:46:01 -08001732func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1733 return ctx.mod.isImplementationForLLNDKPublic()
1734}
1735
Colin Cross3513fb12024-01-24 14:44:47 -08001736func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1737 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001738}
1739
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001740func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1741 return ctx.mod.isOrderfileCompile()
1742}
1743
Yi Kongc702ebd2022-08-19 16:02:45 +08001744func (ctx *moduleContextImpl) isCfi() bool {
1745 return ctx.mod.isCfi()
1746}
1747
Yi Konged79fa32023-06-04 17:15:42 +09001748func (ctx *moduleContextImpl) isFuzzer() bool {
1749 return ctx.mod.isFuzzer()
1750}
1751
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001752func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1753 return ctx.mod.isNDKStubLibrary()
1754}
1755
Colin Cross5271fea2021-04-27 13:06:04 -07001756func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1757 return ctx.mod.IsVendorPublicLibrary()
1758}
1759
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001760func (ctx *moduleContextImpl) selectedStl() string {
1761 if stl := ctx.mod.stl; stl != nil {
1762 return stl.Properties.SelectedStl
1763 }
1764 return ""
1765}
1766
Ivan Lozanobd721262018-11-27 14:33:03 -08001767func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1768 return ctx.mod.linker.useClangLld(actx)
1769}
1770
Colin Crossce75d2c2016-10-06 16:12:58 -07001771func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001772 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001773}
1774
Logan Chiene274fc92019-12-03 11:18:32 -08001775func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001776 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1777 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001778}
1779
Colin Crosse07f2312020-08-13 11:24:56 -07001780func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001781 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1782 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001783}
1784
Dan Albertc8060532020-07-22 22:32:17 -07001785func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001786 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001787}
1788
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001789func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001790 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001791}
1792
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001793func (ctx *moduleContextImpl) nativeCoverage() bool {
1794 return ctx.mod.nativeCoverage()
1795}
1796
Colin Cross95b07f22020-12-16 11:06:50 -08001797func (ctx *moduleContextImpl) isPreventInstall() bool {
1798 return ctx.mod.Properties.PreventInstall
1799}
1800
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001801func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1802 shared := &ctx.mod.sharedFlags
1803 if shared.flagsMap == nil {
1804 shared.numSharedFlags = 0
1805 shared.flagsMap = make(map[string]string)
1806 }
1807 return shared
1808}
1809
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001810func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1811 return ctx.mod.isCfiAssemblySupportEnabled()
1812}
1813
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001814func (ctx *moduleContextImpl) notInPlatform() bool {
1815 return ctx.mod.NotInPlatform()
1816}
1817
Yu Liu76d94462024-10-31 23:32:36 +00001818func (ctx *moduleContextImpl) getOrCreateMakeVarsInfo() *CcMakeVarsInfo {
1819 if ctx.mod.makeVarsInfo == nil {
1820 ctx.mod.makeVarsInfo = &CcMakeVarsInfo{}
1821 }
1822 return ctx.mod.makeVarsInfo
1823}
1824
Colin Cross635c3b02016-05-18 15:37:25 -07001825func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001826 return &Module{
1827 hod: hod,
1828 multilib: multilib,
1829 }
1830}
1831
Colin Cross635c3b02016-05-18 15:37:25 -07001832func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001833 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001834 module.features = []feature{
1835 &tidyFeature{},
1836 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001837 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001838 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001839 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001840 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001841 module.sabi = &sabi{}
Stephen Craneba090d12017-05-09 15:44:35 -07001842 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001843 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001844 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001845 return module
1846}
1847
Colin Crossce75d2c2016-10-06 16:12:58 -07001848func (c *Module) Prebuilt() *android.Prebuilt {
1849 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1850 return p.prebuilt()
1851 }
1852 return nil
1853}
1854
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001855func (c *Module) IsPrebuilt() bool {
1856 return c.Prebuilt() != nil
1857}
1858
Colin Crossce75d2c2016-10-06 16:12:58 -07001859func (c *Module) Name() string {
1860 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001861 if p, ok := c.linker.(interface {
1862 Name(string) string
1863 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001864 name = p.Name(name)
1865 }
1866 return name
1867}
1868
Alex Light3d673592019-01-18 14:37:31 -08001869func (c *Module) Symlinks() []string {
1870 if p, ok := c.installer.(interface {
1871 symlinkList() []string
1872 }); ok {
1873 return p.symlinkList()
1874 }
1875 return nil
1876}
1877
Chris Parsons216e10a2020-07-09 17:12:52 -04001878func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001879 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001880 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001881 }); ok {
1882 return p.dataPaths()
1883 }
1884 return nil
1885}
1886
Ivan Lozanof1868af2022-04-12 13:08:36 -04001887func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001888 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1889 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001890 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001891 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001892 if c.ProductSpecific() {
1893 // If the module is product specific with 'product_specific: true',
1894 // do not add a name suffix because it is a base module.
1895 return ""
1896 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001897 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001898 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001899 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001900 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001901 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001902 // add version suffix only if the module is using different vndk version than the
1903 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001904 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001905 }
1906 return nameSuffix
1907}
1908
Ivan Lozanof1868af2022-04-12 13:08:36 -04001909func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1910 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001911
1912 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001913 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001914 }
1915
Colin Cross127bb8b2020-12-16 16:46:01 -08001916 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001917 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001918 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1919 // added for product variant only when we have vendor and product variants with core
1920 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001921 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001922 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001923 subName += vendorPublicLibrarySuffix
1924 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001925 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1926 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001927 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001928 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001929 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001930 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001931 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001932 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001933 subName += RecoverySuffix
1934 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1935 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001936 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001937 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001938 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001939 } else if c.IsStubs() && c.IsSdkVariant() {
1940 // Public API surface (NDK)
1941 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1942 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001943 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001944
1945 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001946}
1947
Sam Delmerico75dbca22023-04-20 13:13:25 +00001948func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1949 ctx := &moduleContext{
1950 ModuleContext: actx,
1951 moduleContextImpl: moduleContextImpl{
1952 mod: c,
1953 },
1954 }
1955 ctx.ctx = ctx
1956 return ctx
1957}
1958
Spandan Das20fce2d2023-04-12 17:21:39 +00001959// TODO (b/277651159): Remove this allowlist
1960var (
1961 skipStubLibraryMultipleApexViolation = map[string]bool{
1962 "libclang_rt.asan": true,
1963 "libclang_rt.hwasan": true,
1964 // runtime apex
1965 "libc": true,
1966 "libc_hwasan": true,
1967 "libdl_android": true,
1968 "libm": true,
1969 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001970 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001971 // art apex
Martin Stjernholm75598032024-07-12 18:47:26 +01001972 // TODO(b/234351700): Remove this when com.android.art.debug is gone.
Spandan Das20fce2d2023-04-12 17:21:39 +00001973 "libandroidio": true,
1974 "libdexfile": true,
Martin Stjernholm75598032024-07-12 18:47:26 +01001975 "libdexfiled": true, // com.android.art.debug only
Spandan Das20fce2d2023-04-12 17:21:39 +00001976 "libnativebridge": true,
1977 "libnativehelper": true,
1978 "libnativeloader": true,
1979 "libsigchain": true,
1980 }
1981)
1982
1983// Returns true if a stub library could be installed in multiple apexes
1984func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1985 // If this is not an apex variant, no check necessary
Colin Cross2dcbca62024-11-20 14:55:14 -08001986 if info, ok := android.ModuleProvider(ctx, android.ApexInfoProvider); !ok || info.IsForPlatform() {
Spandan Das20fce2d2023-04-12 17:21:39 +00001987 return false
1988 }
1989 // If this is not a stub library, no check necessary
1990 if !c.HasStubsVariants() {
1991 return false
1992 }
1993 // Skip the allowlist
1994 // Use BaseModuleName so that this matches prebuilts.
1995 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1996 return false
1997 }
1998
Spandan Das20fce2d2023-04-12 17:21:39 +00001999 // Stub libraries should not have more than one apex_available
Colin Crossaf4c8562024-11-20 15:07:58 -08002000 apexAvailable := android.FirstUniqueStrings(c.ApexAvailable())
2001 if len(apexAvailable) > 1 {
Spandan Das20fce2d2023-04-12 17:21:39 +00002002 return true
2003 }
2004 // Stub libraries should not use the wildcard
Colin Crossaf4c8562024-11-20 15:07:58 -08002005 if apexAvailable[0] == android.AvailableToAnyApex {
Spandan Das20fce2d2023-04-12 17:21:39 +00002006 return true
2007 }
2008 // Default: no violation
2009 return false
2010}
2011
Chris Parsons8d6e4332021-02-22 16:13:50 -05002012func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002013 ctx := moduleContextFromAndroidModuleContext(actx, c)
2014
Inseob Kim37e0bb02024-04-29 15:54:44 +09002015 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
2016 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
2017 Logtags: c.logtagsPaths,
2018 })
2019
Ronald Braunstein6a08d492024-04-15 12:55:30 -07002020 // If Test_only is set on a module in bp file, respect the setting, otherwise
2021 // see if is a known test module type.
2022 testOnly := c.testModule || c.testLibrary()
2023 if c.sourceProperties.Test_only != nil {
2024 testOnly = Bool(c.sourceProperties.Test_only)
2025 }
2026 // Keep before any early returns.
2027 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
2028 TestOnly: testOnly,
2029 TopLevelTarget: c.testModule,
2030 })
2031
Ivan Lozanof1868af2022-04-12 13:08:36 -04002032 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08002033 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05002034 if !apexInfo.IsForPlatform() {
2035 c.hideApexVariantFromMake = true
2036 }
2037
Chris Parsonseefc9e62021-04-02 17:36:47 -04002038 c.makeLinkType = GetMakeLinkType(actx, c)
2039
Colin Crossf18e1102017-11-16 14:33:08 -08002040 deps := c.depsToPaths(ctx)
2041 if ctx.Failed() {
2042 return
2043 }
2044
Joe Onorato37f900c2023-07-18 16:58:16 -07002045 for _, generator := range c.generators {
2046 gen := generator.GeneratorSources(ctx)
2047 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
2048 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
2049 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
2050 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
2051 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
2052 if len(deps.Objs.objFiles) == 0 {
2053 // If we are reusuing object files (which happens when we're a shared library and we're
2054 // reusing our static variant's object files), then skip adding the actual source files,
2055 // because we already have the object for it.
2056 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
2057 }
2058 }
2059
2060 if ctx.Failed() {
2061 return
2062 }
2063
Spandan Das20fce2d2023-04-12 17:21:39 +00002064 if c.stubLibraryMultipleApexViolation(actx) {
2065 actx.PropertyErrorf("apex_available",
2066 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
2067 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002068 if c.Properties.Clang != nil && *c.Properties.Clang == false {
2069 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00002070 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
2071 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07002072 }
2073
Colin Crossca860ac2016-01-04 14:34:37 -08002074 flags := Flags{
2075 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002076 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08002077 }
Joe Onorato37f900c2023-07-18 16:58:16 -07002078 for _, generator := range c.generators {
2079 flags = generator.GeneratorFlags(ctx, flags, deps)
2080 }
Colin Crossca860ac2016-01-04 14:34:37 -08002081 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08002082 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002083 }
2084 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002085 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08002086 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002087 if c.stl != nil {
2088 flags = c.stl.flags(ctx, flags)
2089 }
Colin Cross16b23492016-01-06 14:41:07 -08002090 if c.sanitize != nil {
2091 flags = c.sanitize.flags(ctx, flags)
2092 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002093 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07002094 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08002095 }
Cory Barkera1da26f2022-06-07 20:12:06 +00002096 if c.fuzzer != nil {
2097 flags = c.fuzzer.flags(ctx, flags)
2098 }
Stephen Craneba090d12017-05-09 15:44:35 -07002099 if c.lto != nil {
2100 flags = c.lto.flags(ctx, flags)
2101 }
Yi Kongeb8efc92021-12-09 18:06:29 +08002102 if c.afdo != nil {
2103 flags = c.afdo.flags(ctx, flags)
2104 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002105 if c.orderfile != nil {
2106 flags = c.orderfile.flags(ctx, flags)
2107 }
Colin Crossca860ac2016-01-04 14:34:37 -08002108 for _, feature := range c.features {
2109 flags = feature.flags(ctx, flags)
2110 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002111 if ctx.Failed() {
2112 return
2113 }
2114
Colin Cross4af21ed2019-11-04 09:37:55 -08002115 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
2116 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
2117 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08002118
Colin Cross4af21ed2019-11-04 09:37:55 -08002119 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09002120
2121 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002122 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002123 }
2124 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002125 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002126 }
2127
Colin Cross3e5e7782022-06-17 22:17:05 +00002128 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2129
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002130 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002131 // We need access to all the flags seen by a source file.
2132 if c.sabi != nil {
2133 flags = c.sabi.flags(ctx, flags)
2134 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002135
Colin Cross4af21ed2019-11-04 09:37:55 -08002136 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002137
Joe Onorato37f900c2023-07-18 16:58:16 -07002138 for _, generator := range c.generators {
2139 generator.GeneratorBuildActions(ctx, flags, deps)
2140 }
2141
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002142 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002143 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002144 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002145 if ctx.Failed() {
2146 return
2147 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002148 }
2149
Colin Crossca860ac2016-01-04 14:34:37 -08002150 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002151 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002152 if ctx.Failed() {
2153 return
2154 }
Colin Cross635c3b02016-05-18 15:37:25 -07002155 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002156
Chris Parsons94a0bba2021-06-04 15:03:47 -04002157 c.maybeUnhideFromMake()
Colin Crossb614cd42024-10-11 12:52:21 -07002158
2159 android.SetProvider(ctx, ImplementationDepInfoProvider, &ImplementationDepInfo{
2160 ImplementationDeps: depset.New(depset.PREORDER, deps.directImplementationDeps, deps.transitiveImplementationDeps),
2161 })
Colin Crossce75d2c2016-10-06 16:12:58 -07002162 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002163
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002164 if Bool(c.Properties.Cmake_snapshot_supported) {
2165 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2166 }
2167
Chris Parsons94a0bba2021-06-04 15:03:47 -04002168 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002169
2170 if c.linker != nil {
2171 moduleInfoJSON := ctx.ModuleInfoJSON()
2172 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2173 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2174 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2175 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2176 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2177
2178 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2179 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2180 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2181 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2182
2183 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2184 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2185 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2186 moduleInfoJSON.SubName += ".cfi"
2187 }
2188 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2189 moduleInfoJSON.SubName += ".hwasan"
2190 }
2191 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2192 moduleInfoJSON.SubName += ".scs"
2193 }
2194 }
2195 moduleInfoJSON.SubName += c.Properties.SubName
2196
2197 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2198 moduleInfoJSON.Uninstallable = true
2199 }
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002200 }
Wei Lia1aa2972024-06-21 13:08:51 -07002201
2202 buildComplianceMetadataInfo(ctx, c, deps)
mrziwangabdb2932024-06-18 12:43:41 -07002203
Cole Faust96a692b2024-08-08 14:47:51 -07002204 if b, ok := c.compiler.(*baseCompiler); ok {
2205 c.hasAidl = b.hasSrcExt(ctx, ".aidl")
2206 c.hasLex = b.hasSrcExt(ctx, ".l") || b.hasSrcExt(ctx, ".ll")
2207 c.hasProto = b.hasSrcExt(ctx, ".proto")
2208 c.hasRenderscript = b.hasSrcExt(ctx, ".rscript") || b.hasSrcExt(ctx, ".fs")
2209 c.hasSysprop = b.hasSrcExt(ctx, ".sysprop")
2210 c.hasWinMsg = b.hasSrcExt(ctx, ".mc")
2211 c.hasYacc = b.hasSrcExt(ctx, ".y") || b.hasSrcExt(ctx, ".yy")
2212 }
2213
Yu Liuec7043d2024-11-05 18:22:20 +00002214 ccObjectInfo := CcObjectInfo{
Yu Liu4f825132024-12-18 00:35:39 +00002215 KytheFiles: objs.kytheFiles,
Yu Liuec7043d2024-11-05 18:22:20 +00002216 }
2217 if !ctx.Config().KatiEnabled() || !android.ShouldSkipAndroidMkProcessing(ctx, c) {
Yu Liu4f825132024-12-18 00:35:39 +00002218 ccObjectInfo.ObjFiles = objs.objFiles
2219 ccObjectInfo.TidyFiles = objs.tidyFiles
Yu Liuec7043d2024-11-05 18:22:20 +00002220 }
Yu Liu4f825132024-12-18 00:35:39 +00002221 if len(ccObjectInfo.KytheFiles)+len(ccObjectInfo.ObjFiles)+len(ccObjectInfo.TidyFiles) > 0 {
Yu Liuec7043d2024-11-05 18:22:20 +00002222 android.SetProvider(ctx, CcObjectInfoProvider, ccObjectInfo)
2223 }
2224
Yu Liu8024b922024-12-20 23:31:32 +00002225 linkableInfo := CreateCommonLinkableInfo(c)
2226 if lib, ok := c.linker.(versionedInterface); ok {
2227 linkableInfo.StubsVersion = lib.stubsVersion()
2228 }
2229 if c.linker != nil {
2230 if library, ok := c.linker.(libraryInterface); ok {
2231 linkableInfo.Static = library.static()
Yu Liu8a8d5b42025-01-07 00:48:08 +00002232 linkableInfo.Shared = library.shared()
Yu Liu8024b922024-12-20 23:31:32 +00002233 linkableInfo.CoverageFiles = library.objs().coverageFiles
2234 linkableInfo.SAbiDumpFiles = library.objs().sAbiDumpFiles
2235 }
2236 }
2237 android.SetProvider(ctx, LinkableInfoProvider, linkableInfo)
Yu Liu986d98c2024-11-12 00:28:11 +00002238
Yu Liu323d77a2024-12-16 23:13:57 +00002239 ccInfo := CcInfo{
Yu Liu323d77a2024-12-16 23:13:57 +00002240 IsPrebuilt: c.IsPrebuilt(),
2241 CmakeSnapshotSupported: proptools.Bool(c.Properties.Cmake_snapshot_supported),
Yu Liu68a70b72025-01-08 22:54:44 +00002242 HasLlndkStubs: c.HasLlndkStubs(),
Yu Liu323d77a2024-12-16 23:13:57 +00002243 }
2244 if c.compiler != nil {
2245 ccInfo.CompilerInfo = &CompilerInfo{
2246 Srcs: c.compiler.(CompiledInterface).Srcs(),
2247 Cflags: c.compiler.baseCompilerProps().Cflags,
2248 AidlInterfaceInfo: AidlInterfaceInfo{
2249 Sources: c.compiler.baseCompilerProps().AidlInterface.Sources,
2250 AidlRoot: c.compiler.baseCompilerProps().AidlInterface.AidlRoot,
2251 Lang: c.compiler.baseCompilerProps().AidlInterface.Lang,
2252 Flags: c.compiler.baseCompilerProps().AidlInterface.Flags,
2253 },
2254 }
2255 switch decorator := c.compiler.(type) {
2256 case *libraryDecorator:
2257 ccInfo.CompilerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
Yu Liu4f825132024-12-18 00:35:39 +00002258 ExportIncludeDirs: decorator.flagExporter.Properties.Export_include_dirs,
Yu Liu323d77a2024-12-16 23:13:57 +00002259 }
2260 }
2261 }
2262 if c.linker != nil {
2263 ccInfo.LinkerInfo = &LinkerInfo{
Yu Liu8024b922024-12-20 23:31:32 +00002264 WholeStaticLibs: c.linker.baseLinkerProps().Whole_static_libs,
2265 StaticLibs: c.linker.baseLinkerProps().Static_libs,
2266 SharedLibs: c.linker.baseLinkerProps().Shared_libs,
2267 HeaderLibs: c.linker.baseLinkerProps().Header_libs,
Yu Liu323d77a2024-12-16 23:13:57 +00002268 }
2269 switch decorator := c.linker.(type) {
2270 case *binaryDecorator:
2271 ccInfo.LinkerInfo.BinaryDecoratorInfo = &BinaryDecoratorInfo{}
2272 case *libraryDecorator:
Yu Liu116610a2025-01-06 21:54:48 +00002273 ccInfo.LinkerInfo.LibraryDecoratorInfo = &LibraryDecoratorInfo{
2274 InjectBsslHash: Bool(c.linker.(*libraryDecorator).Properties.Inject_bssl_hash),
2275 }
Yu Liu323d77a2024-12-16 23:13:57 +00002276 case *testBinary:
2277 ccInfo.LinkerInfo.TestBinaryInfo = &TestBinaryInfo{
2278 Gtest: decorator.testDecorator.gtest(),
2279 }
2280 case *benchmarkDecorator:
2281 ccInfo.LinkerInfo.BenchmarkDecoratorInfo = &BenchmarkDecoratorInfo{}
2282 case *objectLinker:
2283 ccInfo.LinkerInfo.ObjectLinkerInfo = &ObjectLinkerInfo{}
Yu Liu8a8d5b42025-01-07 00:48:08 +00002284 case *stubDecorator:
2285 ccInfo.LinkerInfo.StubDecoratorInfo = &StubDecoratorInfo{}
Yu Liu323d77a2024-12-16 23:13:57 +00002286 }
Yu Liu8024b922024-12-20 23:31:32 +00002287
2288 if s, ok := c.linker.(SnapshotInterface); ok {
2289 ccInfo.SnapshotInfo = &SnapshotInfo{
2290 SnapshotAndroidMkSuffix: s.SnapshotAndroidMkSuffix(),
2291 }
Yu Liuffe86322024-12-18 18:53:12 +00002292 }
Yu Liu68a70b72025-01-08 22:54:44 +00002293 if v, ok := c.linker.(versionedInterface); ok {
2294 name := v.implementationModuleName(ctx.OtherModuleName(c))
2295 ccInfo.LinkerInfo.ImplementationModuleName = &name
2296 }
Yu Liuffe86322024-12-18 18:53:12 +00002297 }
Yu Liu8a8d5b42025-01-07 00:48:08 +00002298 if c.library != nil {
2299 ccInfo.LibraryInfo = &LibraryInfo{
2300 BuildStubs: c.library.buildStubs(),
2301 }
2302 }
Yu Liu8024b922024-12-20 23:31:32 +00002303 android.SetProvider(ctx, CcInfoProvider, &ccInfo)
Yu Liub1bfa9d2024-12-05 18:57:51 +00002304
mrziwangabdb2932024-06-18 12:43:41 -07002305 c.setOutputFiles(ctx)
Yu Liu76d94462024-10-31 23:32:36 +00002306
2307 if c.makeVarsInfo != nil {
2308 android.SetProvider(ctx, CcMakeVarsInfoProvider, c.makeVarsInfo)
2309 }
mrziwangabdb2932024-06-18 12:43:41 -07002310}
2311
Yu Liu8024b922024-12-20 23:31:32 +00002312func CreateCommonLinkableInfo(mod LinkableInterface) *LinkableInfo {
2313 return &LinkableInfo{
2314 StaticExecutable: mod.StaticExecutable(),
2315 HasStubsVariants: mod.HasStubsVariants(),
2316 OutputFile: mod.OutputFile(),
2317 UnstrippedOutputFile: mod.UnstrippedOutputFile(),
2318 IsStubs: mod.IsStubs(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002319 CcLibrary: mod.CcLibrary(),
Yu Liu8024b922024-12-20 23:31:32 +00002320 CcLibraryInterface: mod.CcLibraryInterface(),
2321 RustLibraryInterface: mod.RustLibraryInterface(),
2322 BaseModuleName: mod.BaseModuleName(),
2323 IsLlndk: mod.IsLlndk(),
2324 HasNonSystemVariants: mod.HasNonSystemVariants(),
2325 SubName: mod.SubName(),
2326 InVendorOrProduct: mod.InVendorOrProduct(),
2327 InRamdisk: mod.InRamdisk(),
2328 OnlyInRamdisk: mod.OnlyInRamdisk(),
2329 InVendorRamdisk: mod.InVendorRamdisk(),
2330 OnlyInVendorRamdisk: mod.OnlyInVendorRamdisk(),
2331 InRecovery: mod.InRecovery(),
2332 OnlyInRecovery: mod.OnlyInRecovery(),
Yu Liu8a8d5b42025-01-07 00:48:08 +00002333 Installable: mod.Installable(),
Yu Liu97880e12025-01-07 19:03:34 +00002334 RelativeInstallPath: mod.RelativeInstallPath(),
Yu Liu8024b922024-12-20 23:31:32 +00002335 }
2336}
2337
Yu Liuec7043d2024-11-05 18:22:20 +00002338func setOutputFilesIfNotEmpty(ctx ModuleContext, files android.Paths, tag string) {
2339 if len(files) > 0 {
2340 ctx.SetOutputFiles(files, tag)
2341 }
2342}
2343
mrziwangabdb2932024-06-18 12:43:41 -07002344func (c *Module) setOutputFiles(ctx ModuleContext) {
2345 if c.outputFile.Valid() {
2346 ctx.SetOutputFiles(android.Paths{c.outputFile.Path()}, "")
2347 } else {
2348 ctx.SetOutputFiles(android.Paths{}, "")
2349 }
2350 if c.linker != nil {
2351 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), "unstripped")
2352 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), "stripped_all")
2353 }
Wei Lia1aa2972024-06-21 13:08:51 -07002354}
2355
2356func buildComplianceMetadataInfo(ctx ModuleContext, c *Module, deps PathDeps) {
2357 // Dump metadata that can not be done in android/compliance-metadata.go
2358 complianceMetadataInfo := ctx.ComplianceMetadataInfo()
2359 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.IS_STATIC_LIB, strconv.FormatBool(ctx.static()))
2360 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.BUILT_FILES, c.outputFile.String())
2361
2362 // Static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002363 staticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(false))
Wei Lia1aa2972024-06-21 13:08:51 -07002364 staticDepNames := make([]string, 0, len(staticDeps))
2365 for _, dep := range staticDeps {
2366 staticDepNames = append(staticDepNames, dep.Name())
2367 }
2368
2369 staticDepPaths := make([]string, 0, len(deps.StaticLibs))
2370 for _, dep := range deps.StaticLibs {
2371 staticDepPaths = append(staticDepPaths, dep.String())
2372 }
2373 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
2374 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEP_FILES, android.FirstUniqueStrings(staticDepPaths))
2375
2376 // Whole static deps
Yu Liuf432c2e2024-12-17 00:09:15 +00002377 wholeStaticDeps := ctx.GetDirectDepsProxyWithTag(StaticDepTag(true))
Wei Lia1aa2972024-06-21 13:08:51 -07002378 wholeStaticDepNames := make([]string, 0, len(wholeStaticDeps))
2379 for _, dep := range wholeStaticDeps {
2380 wholeStaticDepNames = append(wholeStaticDepNames, dep.Name())
2381 }
2382
2383 wholeStaticDepPaths := make([]string, 0, len(deps.WholeStaticLibs))
2384 for _, dep := range deps.WholeStaticLibs {
2385 wholeStaticDepPaths = append(wholeStaticDepPaths, dep.String())
2386 }
2387 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEPS, android.FirstUniqueStrings(wholeStaticDepNames))
2388 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEP_FILES, android.FirstUniqueStrings(wholeStaticDepPaths))
Chris Parsons94a0bba2021-06-04 15:03:47 -04002389}
2390
2391func (c *Module) maybeUnhideFromMake() {
2392 // If a lib is directly included in any of the APEXes or is not available to the
2393 // platform (which is often the case when the stub is provided as a prebuilt),
2394 // unhide the stubs variant having the latest version gets visible to make. In
2395 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2396 // force anything in the make world to link against the stubs library. (unless it
2397 // is explicitly referenced via .bootstrap suffix or the module is marked with
2398 // 'bootstrap: true').
2399 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002400 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002401 c.IsStubs() && !c.InVendorRamdisk() {
2402 c.Properties.HideFromMake = false // unhide
2403 // Note: this is still non-installable
2404 }
2405}
2406
Colin Cross8ff10582023-12-07 13:10:56 -08002407// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2408// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002409func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002410 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002411 // If the module has been specifically configure to not be installed then
2412 // hide from make as otherwise it will break when running inside make
2413 // as the output path to install will not be specified. Not all uninstallable
2414 // modules can be hidden from make as some are needed for resolving make side
2415 // dependencies.
2416 c.HideFromMake()
Spandan Das034af2c2024-10-30 21:45:09 +00002417 c.SkipInstall()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002418 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002419 c.SkipInstall()
2420 }
2421
2422 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2423 // to allow using the outputs in a genrule.
2424 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002425 c.installer.install(ctx, c.outputFile.Path())
2426 if ctx.Failed() {
2427 return
Colin Crossca860ac2016-01-04 14:34:37 -08002428 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002429 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002430}
2431
Colin Cross0ea8ba82019-06-06 14:33:29 -07002432func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002433 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002434 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002435 }
Colin Crossca860ac2016-01-04 14:34:37 -08002436 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002437}
2438
Colin Crossca860ac2016-01-04 14:34:37 -08002439func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002440 for _, generator := range c.generators {
2441 generator.GeneratorInit(ctx)
2442 }
Colin Crossca860ac2016-01-04 14:34:37 -08002443 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002444 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002445 }
Colin Crossca860ac2016-01-04 14:34:37 -08002446 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002447 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002448 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002449 if c.stl != nil {
2450 c.stl.begin(ctx)
2451 }
Colin Cross16b23492016-01-06 14:41:07 -08002452 if c.sanitize != nil {
2453 c.sanitize.begin(ctx)
2454 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002455 if c.coverage != nil {
2456 c.coverage.begin(ctx)
2457 }
Yi Kong9723e332023-12-04 14:52:53 +09002458 if c.afdo != nil {
2459 c.afdo.begin(ctx)
2460 }
Stephen Craneba090d12017-05-09 15:44:35 -07002461 if c.lto != nil {
2462 c.lto.begin(ctx)
2463 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002464 if c.orderfile != nil {
2465 c.orderfile.begin(ctx)
2466 }
Dan Albert92fe7402020-07-15 13:33:30 -07002467 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002468 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002469 if err != nil {
2470 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002471 c.Properties.Sdk_version = nil
2472 } else {
2473 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002474 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002475 }
Colin Crossca860ac2016-01-04 14:34:37 -08002476}
2477
Colin Cross37047f12016-12-13 17:06:13 -08002478func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002479 deps := Deps{}
2480
Joe Onorato37f900c2023-07-18 16:58:16 -07002481 for _, generator := range c.generators {
2482 deps = generator.GeneratorDeps(ctx, deps)
2483 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002484 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002485 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002486 }
2487 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002488 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002489 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002490 if c.stl != nil {
2491 deps = c.stl.deps(ctx, deps)
2492 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002493 if c.coverage != nil {
2494 deps = c.coverage.deps(ctx, deps)
2495 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002496
Colin Crossb6715442017-10-24 11:13:31 -07002497 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2498 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2499 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2500 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2501 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2502 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002503 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002504 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002505
Colin Cross516c5452024-10-28 13:45:21 -07002506 if err := checkConflictingExplicitVersions(deps.SharedLibs); err != nil {
2507 ctx.PropertyErrorf("shared_libs", "%s", err.Error())
2508 }
2509
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002510 for _, lib := range deps.ReexportSharedLibHeaders {
2511 if !inList(lib, deps.SharedLibs) {
2512 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2513 }
2514 }
2515
2516 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002517 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2518 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 -07002519 }
2520 }
2521
Colin Cross5950f382016-12-13 12:50:57 -08002522 for _, lib := range deps.ReexportHeaderLibHeaders {
2523 if !inList(lib, deps.HeaderLibs) {
2524 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2525 }
2526 }
2527
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002528 for _, gen := range deps.ReexportGeneratedHeaders {
2529 if !inList(gen, deps.GeneratedHeaders) {
2530 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2531 }
2532 }
2533
Colin Crossc99deeb2016-04-11 15:06:20 -07002534 return deps
2535}
2536
Colin Cross516c5452024-10-28 13:45:21 -07002537func checkConflictingExplicitVersions(libs []string) error {
2538 withoutVersion := func(s string) string {
2539 name, _ := StubsLibNameAndVersion(s)
2540 return name
2541 }
2542 var errs []error
2543 for i, lib := range libs {
2544 libName := withoutVersion(lib)
2545 libsToCompare := libs[i+1:]
2546 j := slices.IndexFunc(libsToCompare, func(s string) bool {
2547 return withoutVersion(s) == libName
2548 })
2549 if j >= 0 {
2550 errs = append(errs, fmt.Errorf("duplicate shared libraries with different explicit versions: %q and %q",
2551 lib, libsToCompare[j]))
2552 }
2553 }
2554 return errors.Join(errs...)
2555}
2556
Dan Albert7e9d2952016-08-04 13:02:36 -07002557func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002558 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002559 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002560 moduleContextImpl: moduleContextImpl{
2561 mod: c,
2562 },
2563 }
2564 ctx.ctx = ctx
2565
Colin Crossca860ac2016-01-04 14:34:37 -08002566 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002567}
2568
Jiyong Park7ed9de32018-10-15 22:25:07 +09002569// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002570func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002571 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2572 version := name[sharp+1:]
2573 libname := name[:sharp]
2574 return libname, version
2575 }
2576 return name, ""
2577}
2578
Dan Albert92fe7402020-07-15 13:33:30 -07002579func GetCrtVariations(ctx android.BottomUpMutatorContext,
2580 m LinkableInterface) []blueprint.Variation {
2581 if ctx.Os() != android.Android {
2582 return nil
2583 }
2584 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002585 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2586 minSdkVersion := m.MinSdkVersion()
2587 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2588 minSdkVersion = m.SdkVersion()
2589 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002590 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2591 if err != nil {
2592 ctx.PropertyErrorf("min_sdk_version", err.Error())
2593 }
Colin Cross363ec762023-01-13 13:45:14 -08002594
2595 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002596 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002597 if apiLevel.LessThan(minApiForArch) {
2598 apiLevel = minApiForArch
2599 }
2600
Dan Albert92fe7402020-07-15 13:33:30 -07002601 return []blueprint.Variation{
2602 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002603 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002604 }
2605 }
2606 return []blueprint.Variation{
2607 {Mutator: "sdk", Variation: ""},
2608 }
2609}
2610
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002611func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2612 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002613
2614 variations = append([]blueprint.Variation(nil), variations...)
2615
Liz Kammer23942242022-04-08 15:41:00 -04002616 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002617 // Version is explicitly specified. i.e. libFoo#30
Colin Crossb614cd42024-10-11 12:52:21 -07002618 if version == "impl" {
2619 version = ""
2620 }
Colin Crosse7257d22020-09-24 09:56:18 -07002621 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002622 if tag, ok := depTag.(libraryDependencyTag); ok {
2623 tag.explicitlyVersioned = true
Colin Crossafcdce82024-10-22 13:59:33 -07002624 // depTag is an interface that contains a concrete non-pointer struct. That makes the local
2625 // tag variable a copy of the contents of depTag, and updating it doesn't change depTag. Reassign
2626 // the modified copy to depTag.
2627 depTag = tag
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002628 } else {
2629 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2630 }
Colin Crosse7257d22020-09-24 09:56:18 -07002631 }
Colin Crosse7257d22020-09-24 09:56:18 -07002632
Colin Cross0de8a1e2020-09-18 14:15:30 -07002633 if far {
2634 ctx.AddFarVariationDependencies(variations, depTag, name)
2635 } else {
2636 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002637 }
2638}
2639
Kiyoung Kim487689e2022-07-26 09:48:22 +09002640func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2641 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002642 return snapshot
2643 }
2644
2645 return lib
2646}
2647
Kiyoung Kim37693d02024-04-04 09:56:15 +09002648// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002649// of names:
2650//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002651// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002652//
2653// For each of these, it adds the name of the ndk_library module to the list of
2654// variant libs.
2655//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002656// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002657//
2658// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002659//
2660// The caller can then know to add the variantLibs dependencies differently from the
2661// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002662func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002663 variantLibs = []string{}
2664
2665 nonvariantLibs = []string{}
2666 for _, entry := range list {
2667 // strip #version suffix out
2668 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002669 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002670 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002671 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002672 nonvariantLibs = append(nonvariantLibs, entry)
2673 }
2674 }
2675 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002676
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002677}
2678
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002679func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2680 nonVariantLibs := []string{}
2681 variantLibs := []string{}
2682
2683 for _, lib := range libs {
2684 replaceLibName := GetReplaceModuleName(lib, replaceList)
2685 if replaceLibName == lib {
2686 // Do not handle any libs which are not in API imports
2687 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2688 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2689 variantLibs = append(variantLibs, replaceLibName)
2690 } else {
2691 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2692 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002693 }
2694
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002695 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002696}
2697
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002698func (c *Module) shouldUseApiSurface() bool {
2699 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2700 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2701 // LLNDK Variant
2702 return true
2703 }
2704
2705 if c.Properties.IsSdkVariant {
2706 // NDK Variant
2707 return true
2708 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002709 }
2710
2711 return false
2712}
2713
Colin Cross1e676be2016-10-12 14:38:15 -07002714func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002715 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002716 return
2717 }
2718
Colin Cross37047f12016-12-13 17:06:13 -08002719 ctx := &depsContext{
2720 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002721 moduleContextImpl: moduleContextImpl{
2722 mod: c,
2723 },
2724 }
2725 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002726
Colin Crossc99deeb2016-04-11 15:06:20 -07002727 deps := c.deps(ctx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002728
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002729 apiNdkLibs := []string{}
2730 apiLateNdkLibs := []string{}
2731
Yo Chiang219968c2020-09-22 18:45:04 +08002732 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2733
Dan Albert914449f2016-06-17 16:45:24 -07002734 variantNdkLibs := []string{}
2735 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002736 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002737 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2738 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2739 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002740 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002741
Colin Cross32ec36c2016-12-15 07:39:51 -08002742 for _, lib := range deps.HeaderLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002743 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002744 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002745 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002746 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002747
Spandan Das73bcafc2022-08-18 23:26:00 +00002748 if c.isNDKStubLibrary() {
Jiyong Parkf8fab9b2024-09-02 15:24:15 +09002749 variationExists := actx.OtherModuleDependencyVariantExists(nil, lib)
2750 if variationExists {
2751 actx.AddVariationDependencies(nil, depTag, lib)
2752 } else {
2753 // dependencies to ndk_headers fall here as ndk_headers do not have
2754 // any variants.
2755 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
2756 }
Spandan Dasff665182024-09-11 18:48:44 +00002757 } else if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002758 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002759 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002760 } else {
2761 actx.AddVariationDependencies(nil, depTag, lib)
2762 }
2763 }
2764
Dan Albertf1d14c72020-07-30 14:32:55 -07002765 if c.isNDKStubLibrary() {
2766 // NDK stubs depend on their implementation because the ABI dumps are
2767 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002768
Spandan Das8b08aea2023-03-14 19:29:34 +00002769 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2770 c.ImageVariation(),
2771 blueprint.Variation{Mutator: "link", Variation: "shared"},
2772 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002773 }
2774
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002775 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2776 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2777 c.Target().NativeBridge == android.NativeBridgeDisabled {
2778 actx.AddVariationDependencies(
Jihoon Kang47e91842024-06-19 00:51:16 +00002779 []blueprint.Variation{{Mutator: "image", Variation: android.VendorVariation}},
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002780 llndkHeaderLibTag,
2781 deps.LlndkHeaderLibs...)
2782 }
2783
Jiyong Park5d1598f2019-02-25 22:14:17 +09002784 for _, lib := range deps.WholeStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002785 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002786
Jiyong Park5d1598f2019-02-25 22:14:17 +09002787 actx.AddVariationDependencies([]blueprint.Variation{
2788 {Mutator: "link", Variation: "static"},
2789 }, depTag, lib)
2790 }
2791
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002792 for _, lib := range deps.StaticLibs {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002793 // Some dependencies listed in static_libs might actually be rust_ffi rlib variants.
Colin Cross8acea3e2024-12-12 14:53:30 -08002794 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002795
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002796 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002797 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002798 }
Jiyong Parke3867542020-12-03 17:28:25 +09002799 if inList(lib, deps.ExcludeLibsForApex) {
2800 depTag.excludeInApex = true
2801 }
Dan Willemsen59339a22018-07-22 21:18:45 -07002802 actx.AddVariationDependencies([]blueprint.Variation{
2803 {Mutator: "link", Variation: "static"},
2804 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002805 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002806
Jooyung Han75568392020-03-20 04:29:24 +09002807 // staticUnwinderDep is treated as staticDep for Q apexes
2808 // so that native libraries/binaries are linked with static unwinder
2809 // because Q libc doesn't have unwinder APIs
2810 if deps.StaticUnwinderIfLegacy {
Colin Cross8acea3e2024-12-12 14:53:30 -08002811 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002812 actx.AddVariationDependencies([]blueprint.Variation{
2813 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002814 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002815 }
2816
Jiyong Park7ed9de32018-10-15 22:25:07 +09002817 // shared lib names without the #version suffix
2818 var sharedLibNames []string
2819
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002820 for _, lib := range deps.SharedLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002821 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002822 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002823 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002824 }
Jiyong Parke3867542020-12-03 17:28:25 +09002825 if inList(lib, deps.ExcludeLibsForApex) {
2826 depTag.excludeInApex = true
2827 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002828 if inList(lib, deps.ExcludeLibsForNonApex) {
2829 depTag.excludeInNonApex = true
2830 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002831
Jiyong Park73c54ee2019-10-22 20:31:18 +09002832 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002833 sharedLibNames = append(sharedLibNames, name)
2834
Colin Crosse7257d22020-09-24 09:56:18 -07002835 variations := []blueprint.Variation{
2836 {Mutator: "link", Variation: "shared"},
2837 }
Spandan Dasff665182024-09-11 18:48:44 +00002838 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002839 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002840
Colin Crossfe9acfe2021-06-14 16:13:03 -07002841 for _, lib := range deps.LateStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002842 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
Colin Crossfe9acfe2021-06-14 16:13:03 -07002843 actx.AddVariationDependencies([]blueprint.Variation{
2844 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002845 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002846 }
2847
Colin Cross3e5e7782022-06-17 22:17:05 +00002848 for _, lib := range deps.UnexportedStaticLibs {
Colin Cross8acea3e2024-12-12 14:53:30 -08002849 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
Colin Cross3e5e7782022-06-17 22:17:05 +00002850 actx.AddVariationDependencies([]blueprint.Variation{
2851 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002852 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002853 }
2854
Jiyong Park7ed9de32018-10-15 22:25:07 +09002855 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002856 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002857 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2858 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2859 // linking against both the stubs lib and the non-stubs lib at the same time.
2860 continue
2861 }
Colin Cross8acea3e2024-12-12 14:53:30 -08002862 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002863 variations := []blueprint.Variation{
2864 {Mutator: "link", Variation: "shared"},
2865 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002866 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002867 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002868
Dan Willemsen59339a22018-07-22 21:18:45 -07002869 actx.AddVariationDependencies([]blueprint.Variation{
2870 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002871 }, dataLibDepTag, deps.DataLibs...)
2872
Colin Crossc8caa062021-09-24 16:50:14 -07002873 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2874
Chris Parsons79d66a52020-06-05 17:26:16 -04002875 actx.AddVariationDependencies([]blueprint.Variation{
2876 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002877 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002878
Colin Cross68861832016-07-08 10:41:41 -07002879 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002880
2881 for _, gen := range deps.GeneratedHeaders {
2882 depTag := genHeaderDepTag
2883 if inList(gen, deps.ReexportGeneratedHeaders) {
2884 depTag = genHeaderExportDepTag
2885 }
2886 actx.AddDependency(c, depTag, gen)
2887 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002888
Cole Faust65cb40a2024-10-21 15:41:42 -07002889 for _, gen := range deps.DeviceFirstGeneratedHeaders {
2890 depTag := genHeaderDepTag
2891 actx.AddVariationDependencies(ctx.Config().AndroidFirstDeviceTarget.Variations(), depTag, gen)
2892 }
2893
Dan Albert92fe7402020-07-15 13:33:30 -07002894 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002895 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002896 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002897 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002898 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08002899 }
Colin Crossc465efd2021-06-11 18:00:04 -07002900 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002901 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002902 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07002903 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002904 if deps.DynamicLinker != "" {
2905 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002906 }
Dan Albert914449f2016-06-17 16:45:24 -07002907
2908 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002909
Colin Cross8acea3e2024-12-12 14:53:30 -08002910 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002911 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002912 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002913 {Mutator: "link", Variation: "shared"},
2914 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002915 actx.AddVariationDependencies([]blueprint.Variation{
2916 {Mutator: "version", Variation: version},
2917 {Mutator: "link", Variation: "shared"},
2918 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002919
Colin Cross8acea3e2024-12-12 14:53:30 -08002920 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002921 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002922 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002923 {Mutator: "link", Variation: "shared"},
2924 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002925 actx.AddVariationDependencies([]blueprint.Variation{
2926 {Mutator: "version", Variation: version},
2927 {Mutator: "link", Variation: "shared"},
2928 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002929
Vinh Tran367d89d2023-04-28 11:21:25 -04002930 if len(deps.AidlLibs) > 0 {
2931 actx.AddDependency(
2932 c,
2933 aidlLibraryTag,
2934 deps.AidlLibs...,
2935 )
2936 }
2937
Colin Cross6362e272015-10-29 15:25:03 -07002938}
Colin Cross21b9a242015-03-24 14:15:58 -07002939
Colin Crosse40b4ea2018-10-02 22:25:58 -07002940func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002941 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002942 c.beginMutator(ctx)
2943 }
2944}
2945
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002946// Whether a module can link to another module, taking into
2947// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002948func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002949 tag blueprint.DependencyTag) {
2950
2951 switch t := tag.(type) {
2952 case dependencyTag:
2953 if t != vndkExtDepTag {
2954 return
2955 }
2956 case libraryDependencyTag:
2957 default:
2958 return
2959 }
2960
Ivan Lozanof9e21722020-12-02 09:00:51 -05002961 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002962 // Host code is not restricted
2963 return
2964 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002965
Ivan Lozano52767be2019-10-18 14:49:46 -07002966 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002967 // Platform code can link to anything
2968 return
2969 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002970 if from.InRamdisk() {
2971 // Ramdisk code is not NDK
2972 return
2973 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002974 if from.InVendorRamdisk() {
2975 // Vendor ramdisk code is not NDK
2976 return
2977 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002978 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002979 // Recovery code is not NDK
2980 return
2981 }
Colin Cross31076b32020-10-23 17:22:06 -07002982 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002983 if c.StubDecorator() {
2984 // These aren't real libraries, but are the stub shared libraries that are included in
2985 // the NDK.
2986 return
2987 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002988 }
Logan Chien834b9a62019-01-14 15:39:03 +08002989
Ivan Lozano52767be2019-10-18 14:49:46 -07002990 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002991 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2992 // to link to libc++ (non-NDK and without sdk_version).
2993 return
2994 }
2995
Ivan Lozano52767be2019-10-18 14:49:46 -07002996 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002997 // NDK code linking to platform code is never okay.
2998 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002999 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08003000 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003001 }
3002
3003 // At this point we know we have two NDK libraries, but we need to
3004 // check that we're not linking against anything built against a higher
3005 // API level, as it is only valid to link against older or equivalent
3006 // APIs.
3007
Inseob Kim01a28722018-04-11 09:48:45 +09003008 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07003009 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003010 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07003011 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09003012 // Current can't be linked against by anything else.
3013 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003014 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09003015 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003016 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003017 if err != nil {
3018 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003019 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003020 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003021 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003022 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003023 if err != nil {
3024 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003025 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003026 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003027 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003028
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07003029 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09003030 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003031 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09003032 }
3033 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003034 }
Dan Albert202fe492017-12-15 13:56:59 -08003035
3036 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07003037 fromStl := from.SelectedStl()
3038 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08003039 if fromStl == "" || toStl == "" {
3040 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09003041 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08003042 // We can be permissive with the system "STL" since it is only the C++
3043 // ABI layer, but in the future we should make sure that everyone is
3044 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07003045 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08003046 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07003047 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
3048 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08003049 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003050}
3051
Jooyung Han479ca172020-10-19 18:51:07 +09003052func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
3053 if c, ok := ctx.Module().(*Module); ok {
3054 ctx.VisitDirectDeps(func(dep android.Module) {
3055 depTag := ctx.OtherModuleDependencyTag(dep)
3056 ccDep, ok := dep.(LinkableInterface)
3057 if ok {
3058 checkLinkType(ctx, c, ccDep, depTag)
3059 }
3060 })
3061 }
3062}
3063
Jiyong Park5fb8c102018-04-09 12:03:06 +09003064// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09003065// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
3066// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003067// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Colin Crossda279cf2024-09-17 14:25:45 -07003068func checkDoubleLoadableLibraries(ctx android.BottomUpMutatorContext) {
Jooyung Hana70f0672019-01-18 15:20:43 +09003069 check := func(child, parent android.Module) bool {
3070 to, ok := child.(*Module)
3071 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09003072 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09003073 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003074
Jooyung Hana70f0672019-01-18 15:20:43 +09003075 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
3076 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09003077 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003078
Jiyong Park0474e1f2021-01-14 14:26:06 +09003079 // These dependencies are not excercised at runtime. Tracking these will give us
3080 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09003081 depTag := ctx.OtherModuleDependencyTag(child)
3082 if IsHeaderDepTag(depTag) {
3083 return false
3084 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09003085 if depTag == staticVariantTag {
3086 return false
3087 }
3088 if depTag == stubImplDepTag {
3089 return false
3090 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003091 if depTag == android.RequiredDepTag {
3092 return false
3093 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003094
Justin Yun63e9ec72020-10-29 16:49:43 +09003095 // Even if target lib has no vendor variant, keep checking dependency
3096 // graph in case it depends on vendor_available or product_available
3097 // but not double_loadable transtively.
3098 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003099 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09003100 }
Jooyung Hana70f0672019-01-18 15:20:43 +09003101
Jiyong Park0474e1f2021-01-14 14:26:06 +09003102 // The happy path. Keep tracking dependencies until we hit a non double-loadable
3103 // one.
3104 if Bool(to.VendorProperties.Double_loadable) {
3105 return true
3106 }
3107
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09003108 if to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003109 return false
3110 }
3111
Jooyung Hana70f0672019-01-18 15:20:43 +09003112 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
3113 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09003114 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09003115 return false
3116 }
3117 if module, ok := ctx.Module().(*Module); ok {
3118 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09003119 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09003120 ctx.WalkDeps(check)
3121 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09003122 }
3123 }
3124}
3125
Yu Liue4312402023-01-18 09:15:31 -08003126func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
3127 // For the dependency from platform to apex, use the latest stubs
3128 apexSdkVersion := android.FutureApiLevel
3129 if !apexInfo.IsForPlatform() {
3130 apexSdkVersion = apexInfo.MinSdkVersion
3131 }
3132
3133 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
3134 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
3135 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
3136 // (b/144430859)
3137 apexSdkVersion = android.FutureApiLevel
3138 }
3139
3140 return apexSdkVersion
3141}
3142
Colin Crossc99deeb2016-04-11 15:06:20 -07003143// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07003144func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08003145 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08003146
Colin Cross0de8a1e2020-09-18 14:15:30 -07003147 var directStaticDeps []StaticLibraryInfo
3148 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07003149
Colin Cross0de8a1e2020-09-18 14:15:30 -07003150 reexportExporter := func(exporter FlagExporterInfo) {
3151 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
3152 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
3153 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
3154 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
3155 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09003156 }
3157
Colin Crossff694a82023-12-13 15:54:49 -08003158 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08003159 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09003160
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003161 skipModuleList := map[string]bool{}
3162
Yu Liu8024b922024-12-20 23:31:32 +00003163 ctx.VisitDirectDepsProxy(func(dep android.ModuleProxy) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003164 depName := ctx.OtherModuleName(dep)
3165 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07003166
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003167 if _, ok := skipModuleList[depName]; ok {
3168 // skip this module because original module or API imported module matching with this should be used instead.
3169 return
3170 }
3171
Yu Liu8024b922024-12-20 23:31:32 +00003172 var ccInfo *CcInfo
3173 v, hasCcInfo := android.OtherModuleProvider(ctx, dep, CcInfoProvider)
3174 if hasCcInfo {
3175 ccInfo = v
3176 }
3177 linkableInfo, hasLinkableInfo := android.OtherModuleProvider(ctx, dep, LinkableInfoProvider)
Dan Willemsen47450072021-10-19 20:24:49 -07003178 if depTag == android.DarwinUniversalVariantTag {
Yu Liu8024b922024-12-20 23:31:32 +00003179 if !hasCcInfo {
3180 panic(fmt.Errorf("dep is not a cc module: %s", dep.String()))
3181 }
3182 depPaths.DarwinSecondArchOutput = linkableInfo.OutputFile
Dan Willemsen47450072021-10-19 20:24:49 -07003183 return
3184 }
3185
Vinh Tran367d89d2023-04-28 11:21:25 -04003186 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08003187 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04003188 depPaths.AidlLibraryInfos = append(
3189 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08003190 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04003191 )
3192 }
3193 }
3194
Yu Liu8024b922024-12-20 23:31:32 +00003195 if !hasLinkableInfo {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003196 // handling for a few module types that aren't cc Module but that are also supported
Yu Liu8024b922024-12-20 23:31:32 +00003197 genRule, ok := android.OtherModuleProvider(ctx, dep, android.GeneratedSourceInfoProvider)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003198 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003199 case genSourceDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003200 if ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07003201 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
Yu Liu8024b922024-12-20 23:31:32 +00003202 genRule.GeneratedSourceFiles...)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003203 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003204 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003205 }
Colin Crosse90bfd12017-04-26 16:59:26 -07003206 // Support exported headers from a generated_sources dependency
3207 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003208 case genHeaderDepTag, genHeaderExportDepTag:
Yu Liu8024b922024-12-20 23:31:32 +00003209 if ok {
Inseob Kimd110f872019-12-06 13:15:38 +09003210 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Yu Liu8024b922024-12-20 23:31:32 +00003211 genRule.GeneratedDeps...)
3212 dirs := genRule.GeneratedHeaderDirs
Inseob Kim69378442019-06-03 19:10:47 +09003213 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003214 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09003215 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09003216 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
Yu Liu8024b922024-12-20 23:31:32 +00003217 genRule.GeneratedSourceFiles...)
3218 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07003219 // 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 +09003220 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07003221 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07003222 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003223 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07003224 }
Colin Crosscef792e2021-06-11 18:01:26 -07003225 case CrtBeginDepTag:
3226 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
3227 case CrtEndDepTag:
3228 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08003229 }
Colin Crossc99deeb2016-04-11 15:06:20 -07003230 return
3231 }
3232
Colin Crossfe17f6f2019-03-28 19:30:56 -07003233 if depTag == android.ProtoPluginDepTag {
3234 return
3235 }
3236
Jiyong Park8bcf3c62024-03-18 18:37:10 +09003237 if depTag == android.RequiredDepTag {
3238 return
3239 }
3240
Yu Liu8024b922024-12-20 23:31:32 +00003241 commonInfo := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey)
3242 if commonInfo.Target.Os != ctx.Os() {
Steven Morelandaaae81f2024-08-27 22:55:48 +00003243 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 -07003244 return
3245 }
Yu Liu8024b922024-12-20 23:31:32 +00003246 if commonInfo.Target.Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00003247 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
Yu Liu8024b922024-12-20 23:31:32 +00003248 ctx.ModuleName(), ctx.Arch().ArchType, depName, commonInfo.Target.Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07003249 return
3250 }
3251
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07003252 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07003253 // Skip reused objects for stub libraries, they use their own stub object file instead.
3254 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3255 // version mutator, so the stubs variant is created from the shared variant that
3256 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003257 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003258 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003259 objs := staticAnalogue.ReuseObjects
3260 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003261 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003262 reexportExporter(depExporterInfo)
3263 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003264 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003265 }
3266
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003267 if depTag == llndkHeaderLibTag {
3268 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3269 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3270 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3271 }
3272
Yu Liu8024b922024-12-20 23:31:32 +00003273 linkFile := linkableInfo.OutputFile
Colin Cross6e511a92020-07-27 21:26:48 -07003274
3275 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3276 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003277 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003278 return
3279 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003280
Jiyong Parke3867542020-12-03 17:28:25 +09003281 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3282 return
3283 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003284 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3285 return
3286 }
Jiyong Parke3867542020-12-03 17:28:25 +09003287
Colin Cross313aa542023-12-13 13:47:44 -08003288 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003289
Colin Cross6e511a92020-07-27 21:26:48 -07003290 var ptr *android.Paths
3291 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003292
Colin Cross6e511a92020-07-27 21:26:48 -07003293 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003294
Colin Cross6e511a92020-07-27 21:26:48 -07003295 switch {
3296 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003297 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003298 if !ctx.Config().AllowMissingDependencies() {
3299 ctx.ModuleErrorf("module %q is not a header library", depName)
3300 } else {
3301 ctx.AddMissingDependencies([]string{depName})
3302 }
3303 return
3304 }
Colin Cross6e511a92020-07-27 21:26:48 -07003305 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003306 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003307 if !ctx.Config().AllowMissingDependencies() {
3308 ctx.ModuleErrorf("module %q is not a shared library", depName)
3309 } else {
3310 ctx.AddMissingDependencies([]string{depName})
3311 }
3312 return
3313 }
Jiyong Parke3867542020-12-03 17:28:25 +09003314
Jiyong Park7d55b612021-06-11 17:22:09 +09003315 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3316 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003317
Jiyong Park1ad8e162020-12-01 23:40:09 +09003318 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3319 // linkFile, depFile, and ptr.
3320 if c.IsStubs() {
3321 break
3322 }
3323
Colin Cross0de8a1e2020-09-18 14:15:30 -07003324 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3325 depFile = sharedLibraryInfo.TableOfContents
3326
Colin Crossb614cd42024-10-11 12:52:21 -07003327 if !sharedLibraryInfo.IsStubs {
3328 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
3329 if info, ok := android.OtherModuleProvider(ctx, dep, ImplementationDepInfoProvider); ok {
3330 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
3331 }
3332 }
3333
Colin Cross6e511a92020-07-27 21:26:48 -07003334 ptr = &depPaths.SharedLibs
3335 switch libDepTag.Order {
3336 case earlyLibraryDependency:
3337 ptr = &depPaths.EarlySharedLibs
3338 depPtr = &depPaths.EarlySharedLibsDeps
3339 case normalLibraryDependency:
3340 ptr = &depPaths.SharedLibs
3341 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003342 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003343 case lateLibraryDependency:
3344 ptr = &depPaths.LateSharedLibs
3345 depPtr = &depPaths.LateSharedLibsDeps
3346 default:
3347 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003348 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003349
Colin Cross6e511a92020-07-27 21:26:48 -07003350 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003351 if linkableInfo.RustLibraryInterface {
3352 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: linkableInfo.CrateName, LinkDirs: linkableInfo.ExportedCrateLinkDirs}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003353 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3354 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3355 if libDepTag.wholeStatic {
3356 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3357 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
Jiyong Park1ad8e162020-12-01 23:40:09 +09003358
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003359 // If whole_static, track this as we want to make sure that in a final linkage for a shared library,
3360 // exported functions from the rust generated staticlib still exported.
3361 if c.CcLibrary() && c.Shared() {
3362 c.WholeRustStaticlib = true
3363 }
Colin Cross6e511a92020-07-27 21:26:48 -07003364 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003365
Colin Cross6e511a92020-07-27 21:26:48 -07003366 } else {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003367 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3368 if !isStaticLib {
3369 if !ctx.Config().AllowMissingDependencies() {
3370 ctx.ModuleErrorf("module %q is not a static library", depName)
3371 } else {
3372 ctx.AddMissingDependencies([]string{depName})
3373 }
3374 return
Inseob Kimeec88e12020-01-22 11:11:29 +09003375 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003376
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003377 // Stubs lib doesn't link to the static lib dependencies. Don't set
3378 // linkFile, depFile, and ptr.
3379 if c.IsStubs() {
3380 break
3381 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003382
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003383 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
3384 if libDepTag.wholeStatic {
3385 ptr = &depPaths.WholeStaticLibs
3386 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3387 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
3388 } else {
3389 // This case normally catches prebuilt static
3390 // libraries, but it can also occur when
3391 // AllowMissingDependencies is on and the
3392 // dependencies has no sources of its own
3393 // but has a whole_static_libs dependency
3394 // on a missing library. We want to depend
3395 // on the .a file so that there is something
3396 // in the dependency tree that contains the
3397 // error rule for the missing transitive
3398 // dependency.
3399 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
3400 }
3401 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3402 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
3403 } else {
3404 switch libDepTag.Order {
3405 case earlyLibraryDependency:
3406 panic(fmt.Errorf("early static libs not supported"))
3407 case normalLibraryDependency:
3408 // static dependencies will be handled separately so they can be ordered
3409 // using transitive dependencies.
3410 ptr = nil
3411 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
3412 case lateLibraryDependency:
3413 ptr = &depPaths.LateStaticLibs
3414 default:
3415 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
3416 }
3417 }
3418
3419 // Collect any exported Rust rlib deps from static libraries which have been included as whole_static_libs
3420 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3421
3422 if libDepTag.unexportedSymbols {
3423 depPaths.LdFlags = append(depPaths.LdFlags,
3424 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3425 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003426 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003427 }
3428
Yu Liu8024b922024-12-20 23:31:32 +00003429 if libDepTag.static() && !libDepTag.wholeStatic && !linkableInfo.RustLibraryInterface {
3430 if !linkableInfo.CcLibraryInterface || !linkableInfo.Static {
Colin Cross6e511a92020-07-27 21:26:48 -07003431 ctx.ModuleErrorf("module %q not a static library", depName)
3432 return
3433 }
Logan Chien43d34c32017-12-20 01:17:32 +08003434
Colin Cross6e511a92020-07-27 21:26:48 -07003435 // When combining coverage files for shared libraries and executables, coverage files
3436 // in static libraries act as if they were whole static libraries. The same goes for
3437 // source based Abi dump files.
Yu Liu8024b922024-12-20 23:31:32 +00003438 if hasCcInfo {
Colin Cross6e511a92020-07-27 21:26:48 -07003439 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003440 linkableInfo.CoverageFiles...)
Colin Cross6e511a92020-07-27 21:26:48 -07003441 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003442 linkableInfo.SAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003443 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003444 // Handle non-CC modules here
3445 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Yu Liu8024b922024-12-20 23:31:32 +00003446 linkableInfo.CoverageFiles...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003447 }
3448 }
3449
Colin Cross6e511a92020-07-27 21:26:48 -07003450 if ptr != nil {
3451 if !linkFile.Valid() {
3452 if !ctx.Config().AllowMissingDependencies() {
3453 ctx.ModuleErrorf("module %q missing output file", depName)
3454 } else {
3455 ctx.AddMissingDependencies([]string{depName})
3456 }
3457 return
3458 }
3459 *ptr = append(*ptr, linkFile.Path())
3460 }
3461
3462 if depPtr != nil {
3463 dep := depFile
3464 if !dep.Valid() {
3465 dep = linkFile
3466 }
3467 *depPtr = append(*depPtr, dep.Path())
3468 }
3469
Colin Cross0de8a1e2020-09-18 14:15:30 -07003470 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3471 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3472 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3473 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003474 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3475
3476 // Only re-export RustRlibDeps for cc static libs
3477 if c.static() {
3478 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3479 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003480
3481 if libDepTag.reexportFlags {
3482 reexportExporter(depExporterInfo)
3483 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3484 // Re-exported shared library headers must be included as well since they can help us with type information
3485 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003486 c.sabi.Properties.ReexportedIncludes = append(
3487 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003488 c.sabi.Properties.ReexportedSystemIncludes = append(
3489 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003490 }
3491
Yu Liu8024b922024-12-20 23:31:32 +00003492 makeLibName := MakeLibName(ccInfo, linkableInfo, &commonInfo, linkableInfo.BaseModuleName) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003493 switch {
3494 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003495 c.Properties.AndroidMkHeaderLibs = append(
3496 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003497 case libDepTag.shared():
Colin Cross6e511a92020-07-27 21:26:48 -07003498 // Note: the order of libs in this list is not important because
3499 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003500 c.Properties.AndroidMkSharedLibs = append(
3501 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003502 case libDepTag.static():
Yu Liu8024b922024-12-20 23:31:32 +00003503 if !linkableInfo.RustLibraryInterface {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003504 if libDepTag.wholeStatic {
3505 c.Properties.AndroidMkWholeStaticLibs = append(
3506 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3507 } else {
3508 c.Properties.AndroidMkStaticLibs = append(
3509 c.Properties.AndroidMkStaticLibs, makeLibName)
3510 }
Colin Cross6e511a92020-07-27 21:26:48 -07003511 }
3512 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003513 } else if !c.IsStubs() {
3514 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3515
Colin Cross6e511a92020-07-27 21:26:48 -07003516 switch depTag {
3517 case runtimeDepTag:
3518 c.Properties.AndroidMkRuntimeLibs = append(
Yu Liu8024b922024-12-20 23:31:32 +00003519 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ccInfo, linkableInfo, &commonInfo, linkableInfo.BaseModuleName)+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003520 case objDepTag:
3521 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3522 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003523 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003524 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003525 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003526 case dynamicLinkerDepTag:
3527 depPaths.DynamicLinker = linkFile
3528 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003529 }
Colin Crossca860ac2016-01-04 14:34:37 -08003530 })
3531
Jeff Gaston294356f2017-09-27 17:05:30 -07003532 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003533 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3534 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3535 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003536
Colin Crossdd84e052017-05-17 13:44:16 -07003537 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003538 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003539 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3540 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003541 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003542 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3543
Jiyong Park74955042019-10-22 20:19:51 +09003544 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3545 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003546 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003547 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003548 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003549 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003550
3551 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003552 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003553 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003554 }
Colin Crossdd84e052017-05-17 13:44:16 -07003555
Colin Crossca860ac2016-01-04 14:34:37 -08003556 return depPaths
3557}
3558
Spandan Das10c41362024-12-03 01:33:09 +00003559func ShouldUseStubForApex(ctx android.ModuleContext, parent, dep android.Module) bool {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003560 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003561 bootstrap := false
Spandan Das10c41362024-12-03 01:33:09 +00003562 if linkable, ok := parent.(LinkableInterface); !ok {
3563 ctx.ModuleErrorf("Not a Linkable module: %q", ctx.ModuleName())
Jiyong Park7d55b612021-06-11 17:22:09 +09003564 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003565 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003566 bootstrap = linkable.Bootstrap()
3567 }
3568
Spandan Das10c41362024-12-03 01:33:09 +00003569 apexInfo, _ := android.OtherModuleProvider(ctx, parent, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003570
3571 useStubs := false
3572
Yu Liu8024b922024-12-20 23:31:32 +00003573 if android.OtherModuleProviderOrDefault(ctx, dep, LinkableInfoProvider).IsStubs && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003574 if !apexInfo.IsForPlatform() {
3575 // For platform libraries, use current version of LLNDK
3576 // If this is for use_vendor apex we will apply the same rules
3577 // of apex sdk enforcement below to choose right version.
3578 useStubs = true
3579 }
3580 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3581 // If not building for APEX or the containing APEX allows the use of
3582 // platform APIs, use stubs only when it is from an APEX (and not from
3583 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3584 // bootstrap modules, always link to non-stub variant
Yu Liu8024b922024-12-20 23:31:32 +00003585 isNotInPlatform := android.OtherModuleProviderOrDefault(ctx, dep, android.CommonModuleInfoKey).NotInPlatform
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003586
Spandan Dasff665182024-09-11 18:48:44 +00003587 useStubs = isNotInPlatform && !bootstrap
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003588 } else {
Colin Crossea91a172024-11-05 16:14:05 -08003589 // If building for APEX, always use stubs (can be bypassed by depending on <dep>#impl)
3590 useStubs = true
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003591 }
3592
3593 return useStubs
3594}
3595
3596// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3597// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3598// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3599// has different level of updatability. For example, if a library foo in an APEX depends on a
3600// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3601// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3602// same APEX as foo, the non-stub variant of bar is used.
3603func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3604 depTag := ctx.OtherModuleDependencyTag(dep)
3605 libDepTag, ok := depTag.(libraryDependencyTag)
3606 if !ok || !libDepTag.shared() {
3607 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3608 }
3609
Colin Cross313aa542023-12-13 13:47:44 -08003610 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3611 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3612 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003613
3614 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003615 // when to use (unspecified) stubs, use the latest one.
Spandan Das10c41362024-12-03 01:33:09 +00003616 if ShouldUseStubForApex(ctx, ctx.Module(), dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003617 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3618 toUse := stubs[len(stubs)-1]
3619 sharedLibraryInfo = toUse.SharedLibraryInfo
3620 depExporterInfo = toUse.FlagExporterInfo
3621 }
3622 }
3623 return sharedLibraryInfo, depExporterInfo
3624}
3625
Colin Cross0de8a1e2020-09-18 14:15:30 -07003626// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3627// to match the topological order of the dependency tree, including any static analogues of
Colin Crossa14fb6a2024-10-23 16:57:06 -07003628// direct shared libraries. It returns the ordered static dependencies, and a depset.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07003629// of the transitive dependencies.
Colin Crossa14fb6a2024-10-23 16:57:06 -07003630func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive depset.DepSet[android.Path]) {
3631 transitiveStaticLibsBuilder := depset.NewBuilder[android.Path](depset.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003632 var staticPaths android.Paths
3633 for _, staticDep := range staticDeps {
3634 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3635 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3636 }
3637 for _, sharedDep := range sharedDeps {
Colin Crossa14fb6a2024-10-23 16:57:06 -07003638 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003639 }
3640 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3641
3642 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3643
3644 // reorder the dependencies based on transitive dependencies
3645 staticPaths = android.FirstUniquePaths(staticPaths)
3646 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3647
3648 if len(orderedStaticPaths) != len(staticPaths) {
3649 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3650 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3651 }
3652
3653 return orderedStaticPaths, transitiveStaticLibs
3654}
3655
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003656// BaseLibName trims known prefixes and suffixes
3657func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003658 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3659 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003660 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003661 return libName
3662}
3663
Yu Liu8024b922024-12-20 23:31:32 +00003664func MakeLibName(ccInfo *CcInfo, linkableInfo *LinkableInfo, commonInfo *android.CommonModuleInfo, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003665 libName := BaseLibName(depName)
Yu Liu8024b922024-12-20 23:31:32 +00003666 isLLndk := ccInfo != nil && linkableInfo.IsLlndk
3667 nonSystemVariantsExist := linkableInfo.HasNonSystemVariants || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003668
Yu Liu8024b922024-12-20 23:31:32 +00003669 if ccInfo != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003670 // Use base module name for snapshots when exporting to Makefile.
Yu Liu8024b922024-12-20 23:31:32 +00003671 if ccInfo.SnapshotInfo != nil {
3672 return linkableInfo.BaseModuleName + ccInfo.SnapshotInfo.SnapshotAndroidMkSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003673 }
3674 }
3675
Yu Liu8024b922024-12-20 23:31:32 +00003676 if linkableInfo.InVendorOrProduct && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003677 // The vendor and product modules in Make will have been renamed to not conflict with the
3678 // core module, so update the dependency name here accordingly.
Yu Liu8024b922024-12-20 23:31:32 +00003679 return libName + linkableInfo.SubName
3680 } else if linkableInfo.InRamdisk && !linkableInfo.OnlyInRamdisk {
Matthew Maurerc6868382021-07-13 14:12:37 -07003681 return libName + RamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003682 } else if linkableInfo.InVendorRamdisk && !linkableInfo.OnlyInVendorRamdisk {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003683 return libName + VendorRamdiskSuffix
Yu Liu8024b922024-12-20 23:31:32 +00003684 } else if linkableInfo.InRecovery && !linkableInfo.OnlyInRecovery {
Matthew Maurer460ee942021-02-11 12:31:46 -08003685 return libName + RecoverySuffix
Yu Liu8024b922024-12-20 23:31:32 +00003686 } else if commonInfo.Target.NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003687 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003688 } else {
3689 return libName
3690 }
3691}
3692
Colin Crossca860ac2016-01-04 14:34:37 -08003693func (c *Module) InstallInData() bool {
3694 if c.installer == nil {
3695 return false
3696 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003697 return c.installer.inData()
3698}
3699
3700func (c *Module) InstallInSanitizerDir() bool {
3701 if c.installer == nil {
3702 return false
3703 }
3704 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003705 return true
3706 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003707 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003708}
3709
Yifan Hong1b3348d2020-01-21 15:53:22 -08003710func (c *Module) InstallInRamdisk() bool {
3711 return c.InRamdisk()
3712}
3713
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003714func (c *Module) InstallInVendorRamdisk() bool {
3715 return c.InVendorRamdisk()
3716}
3717
Jiyong Parkf9332f12018-02-01 00:54:12 +09003718func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003719 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003720}
3721
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003722func (c *Module) MakeUninstallable() {
3723 if c.installer == nil {
3724 c.ModuleBase.MakeUninstallable()
3725 return
3726 }
3727 c.installer.makeUninstallable(c)
3728}
3729
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003730func (c *Module) HostToolPath() android.OptionalPath {
3731 if c.installer == nil {
3732 return android.OptionalPath{}
3733 }
3734 return c.installer.hostToolPath()
3735}
3736
Nan Zhangd4e641b2017-07-12 12:55:28 -07003737func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3738 return c.outputFile
3739}
3740
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003741func (c *Module) static() bool {
3742 if static, ok := c.linker.(interface {
3743 static() bool
3744 }); ok {
3745 return static.static()
3746 }
3747 return false
3748}
3749
Colin Cross6a730042024-12-05 13:53:43 -08003750func (c *Module) staticLibrary() bool {
3751 if static, ok := c.linker.(interface {
3752 staticLibrary() bool
3753 }); ok {
3754 return static.staticLibrary()
3755 }
3756 return false
3757}
3758
Jiyong Park379de2f2018-12-19 02:47:14 +09003759func (c *Module) staticBinary() bool {
3760 if static, ok := c.linker.(interface {
3761 staticBinary() bool
3762 }); ok {
3763 return static.staticBinary()
3764 }
3765 return false
3766}
3767
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003768func (c *Module) testBinary() bool {
3769 if test, ok := c.linker.(interface {
3770 testBinary() bool
3771 }); ok {
3772 return test.testBinary()
3773 }
3774 return false
3775}
3776
Jingwen Chen537242c2022-08-24 11:53:27 +00003777func (c *Module) testLibrary() bool {
3778 if test, ok := c.linker.(interface {
3779 testLibrary() bool
3780 }); ok {
3781 return test.testLibrary()
3782 }
3783 return false
3784}
3785
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003786func (c *Module) benchmarkBinary() bool {
3787 if b, ok := c.linker.(interface {
3788 benchmarkBinary() bool
3789 }); ok {
3790 return b.benchmarkBinary()
3791 }
3792 return false
3793}
3794
3795func (c *Module) fuzzBinary() bool {
3796 if f, ok := c.linker.(interface {
3797 fuzzBinary() bool
3798 }); ok {
3799 return f.fuzzBinary()
3800 }
3801 return false
3802}
3803
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003804// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3805func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003806 if h, ok := c.linker.(interface {
3807 header() bool
3808 }); ok {
3809 return h.header()
3810 }
3811 return false
3812}
3813
Ivan Lozanod7586b62021-04-01 09:49:36 -04003814func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003815 if b, ok := c.linker.(interface {
3816 binary() bool
3817 }); ok {
3818 return b.binary()
3819 }
3820 return false
3821}
3822
Justin Yun5e035862021-06-29 20:50:37 +09003823func (c *Module) StaticExecutable() bool {
3824 if b, ok := c.linker.(*binaryDecorator); ok {
3825 return b.static()
3826 }
3827 return false
3828}
3829
Ivan Lozanod7586b62021-04-01 09:49:36 -04003830func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003831 if o, ok := c.linker.(interface {
3832 object() bool
3833 }); ok {
3834 return o.object()
3835 }
3836 return false
3837}
3838
Kiyoung Kim37693d02024-04-04 09:56:15 +09003839func (m *Module) Dylib() bool {
3840 return false
3841}
3842
3843func (m *Module) Rlib() bool {
3844 return false
3845}
3846
Ivan Lozanof9e21722020-12-02 09:00:51 -05003847func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003848 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003849 if c.IsLlndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003850 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003851 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003852 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003853 return "native:product"
3854 }
Jooyung Han38002912019-05-16 04:01:54 +09003855 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003856 } else if c.InRamdisk() {
3857 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003858 } else if c.InVendorRamdisk() {
3859 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003860 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003861 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003862 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003863 return "native:ndk:none:none"
3864 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3865 //family, link := getNdkStlFamilyAndLinkType(c)
3866 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
3867 } else {
3868 return "native:platform"
3869 }
3870}
3871
Jiyong Park9d452992018-10-03 00:38:19 +09003872// Overrides ApexModule.IsInstallabeToApex()
Colin Cross3a02c7b2024-05-21 13:46:22 -07003873// Only shared/runtime libraries .
Jiyong Park9d452992018-10-03 00:38:19 +09003874func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003875 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003876 // Stub libs and prebuilt libs in a versioned SDK are not
3877 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003878 return lib.shared() && !lib.buildStubs()
Jiyong Park9d452992018-10-03 00:38:19 +09003879 }
3880 return false
3881}
3882
Jiyong Parka90ca002019-10-07 15:47:24 +09003883func (c *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +00003884 return android.CheckAvailableForApex(what, c.ApexAvailableFor())
3885}
3886
3887func (c *Module) ApexAvailableFor() []string {
3888 list := c.ApexModuleBase.ApexAvailable()
Jiyong Parka90ca002019-10-07 15:47:24 +09003889 if linker, ok := c.linker.(interface {
Yu Liub73c3a62024-12-10 00:58:06 +00003890 apexAvailable() []string
Jiyong Parka90ca002019-10-07 15:47:24 +09003891 }); ok {
Yu Liub73c3a62024-12-10 00:58:06 +00003892 list = append(list, linker.apexAvailable()...)
Jiyong Parka90ca002019-10-07 15:47:24 +09003893 }
Yu Liub73c3a62024-12-10 00:58:06 +00003894
3895 return android.FirstUniqueStrings(list)
Jiyong Parka90ca002019-10-07 15:47:24 +09003896}
3897
Paul Duffin0cb37b92020-03-04 14:52:46 +00003898func (c *Module) EverInstallable() bool {
3899 return c.installer != nil &&
3900 // Check to see whether the module is actually ever installable.
3901 c.installer.everInstallable()
3902}
3903
Ivan Lozanod7586b62021-04-01 09:49:36 -04003904func (c *Module) PreventInstall() bool {
3905 return c.Properties.PreventInstall
3906}
3907
3908func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003909 if c.library != nil {
3910 if i := c.library.installable(); i != nil {
3911 return i
3912 }
3913 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003914 return c.Properties.Installable
3915}
3916
3917func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003918 ret := c.EverInstallable() &&
3919 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003920 proptools.BoolDefault(c.Installable(), true) &&
3921 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003922
3923 // The platform variant doesn't need further condition. Apex variants however might not
3924 // be installable because it will likely to be included in the APEX and won't appear
3925 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003926 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003927 return ret
3928 }
3929
3930 // Special case for modules that are configured to be installed to /data, which includes
3931 // test modules. For these modules, both APEX and non-APEX variants are considered as
3932 // installable. This is because even the APEX variants won't be included in the APEX, but
3933 // will anyway be installed to /data/*.
3934 // See b/146995717
3935 if c.InstallInData() {
3936 return ret
3937 }
3938
3939 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003940}
3941
Logan Chien41eabe62019-04-10 13:33:58 +08003942func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3943 if c.linker != nil {
3944 if library, ok := c.linker.(*libraryDecorator); ok {
3945 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3946 }
3947 }
3948}
3949
Jiyong Park45bf82e2020-12-15 22:29:02 +09003950var _ android.ApexModule = (*Module)(nil)
3951
3952// Implements android.ApexModule
Colin Crossf7bbd2f2024-12-05 13:57:10 -08003953func (c *Module) OutgoingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
Colin Crossc1b36442021-05-06 13:42:48 -07003954 if depTag == stubImplDepTag {
3955 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003956 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003957 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003958 if depTag == staticVariantTag {
3959 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3960 // actually mean that the static lib (and its dependencies) are copied into the
3961 // APEX.
3962 return false
3963 }
Colin Cross8acea3e2024-12-12 14:53:30 -08003964
3965 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3966 if isLibDepTag && c.static() && libDepTag.shared() {
3967 // shared_lib dependency from a static lib is considered as crossing
3968 // the APEX boundary because the dependency doesn't actually is
3969 // linked; the dependency is used only during the compilation phase.
3970 return false
3971 }
3972
3973 if isLibDepTag && libDepTag.excludeInApex {
3974 return false
3975 }
3976
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003977 return true
3978}
3979
Colin Crossf7bbd2f2024-12-05 13:57:10 -08003980func (c *Module) IncomingDepIsInSameApex(depTag blueprint.DependencyTag) bool {
Colin Crossf7bbd2f2024-12-05 13:57:10 -08003981 if c.HasStubsVariants() {
3982 if IsSharedDepTag(depTag) {
3983 // dynamic dep to a stubs lib crosses APEX boundary
3984 return false
3985 }
3986 if IsRuntimeDepTag(depTag) {
3987 // runtime dep to a stubs lib also crosses APEX boundary
3988 return false
3989 }
3990 if IsHeaderDepTag(depTag) {
3991 return false
3992 }
3993 }
3994 if c.IsLlndk() {
3995 return false
3996 }
Colin Crossf7bbd2f2024-12-05 13:57:10 -08003997
3998 return true
3999}
4000
Jiyong Park45bf82e2020-12-15 22:29:02 +09004001// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07004002func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
4003 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09004004 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
4005 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
4006 return nil
4007 }
Jooyung Han749dc692020-04-15 11:03:39 +09004008 // We don't check for prebuilt modules
4009 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
4010 return nil
4011 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09004012
Jooyung Han749dc692020-04-15 11:03:39 +09004013 minSdkVersion := c.MinSdkVersion()
4014 if minSdkVersion == "apex_inherit" {
4015 return nil
4016 }
4017 if minSdkVersion == "" {
4018 // JNI libs within APK-in-APEX fall into here
4019 // Those are okay to set sdk_version instead
4020 // We don't have to check if this is a SDK variant because
4021 // non-SDK variant resets sdk_version, which works too.
4022 minSdkVersion = c.SdkVersion()
4023 }
Dan Albertc8060532020-07-22 22:32:17 -07004024 if minSdkVersion == "" {
4025 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
4026 }
4027 // Not using nativeApiLevelFromUser because the context here is not
4028 // necessarily a native context.
4029 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09004030 if err != nil {
4031 return err
4032 }
Dan Albertc8060532020-07-22 22:32:17 -07004033
Colin Cross8ca61c12022-10-06 21:00:14 -07004034 // A dependency only needs to support a min_sdk_version at least
4035 // as high as the api level that the architecture was introduced in.
4036 // This allows introducing new architectures in the platform that
4037 // need to be included in apexes that normally require an older
4038 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08004039 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07004040 if sdkVersion.LessThan(minApiForArch) {
4041 sdkVersion = minApiForArch
4042 }
4043
Dan Albertc8060532020-07-22 22:32:17 -07004044 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09004045 return fmt.Errorf("newer SDK(%v)", ver)
4046 }
4047 return nil
4048}
4049
Paul Duffinb5769c12021-05-12 16:16:51 +01004050// Implements android.ApexModule
4051func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
4052 // stub libraries and native bridge libraries are always available to platform
4053 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
4054}
4055
Inseob Kima1888ce2022-10-04 14:42:02 +09004056func (c *Module) overriddenModules() []string {
4057 if o, ok := c.linker.(overridable); ok {
4058 return o.overriddenModules()
4059 }
4060 return nil
4061}
4062
Liz Kammer35ca77e2021-12-22 15:31:40 -05004063type moduleType int
4064
4065const (
4066 unknownType moduleType = iota
4067 binary
4068 object
4069 fullLibrary
4070 staticLibrary
4071 sharedLibrary
4072 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00004073 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00004074 ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004075)
4076
4077func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00004078 if c.testBinary() {
4079 // testBinary is also a binary, so this comes before the c.Binary()
4080 // conditional. A testBinary has additional implicit dependencies and
4081 // other test-only semantics.
4082 return testBin
4083 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004084 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004085 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004086 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00004087 } else if c.testLibrary() {
4088 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
4089 // will let them add implicit compile deps on gtest, for example.
4090 //
Liz Kammerefc51d92023-04-21 15:11:25 -04004091 // For now, treat them as regular libraries.
4092 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004093 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05004094 static := false
4095 shared := false
4096 if library, ok := c.linker.(*libraryDecorator); ok {
4097 static = library.MutatedProperties.BuildStatic
4098 shared = library.MutatedProperties.BuildShared
4099 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
4100 static = library.MutatedProperties.BuildStatic
4101 shared = library.MutatedProperties.BuildShared
4102 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004103 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004104 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004105 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004106 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04004107 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05004108 return staticLibrary
4109 }
4110 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00004111 } else if c.isNDKStubLibrary() {
4112 return ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05004113 }
4114 return unknownType
4115}
4116
Colin Crosscfad1192015-11-02 16:43:11 -08004117// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08004118type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07004119 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07004120 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09004121 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08004122}
4123
Patrice Arrudac249c712019-03-19 17:00:29 -07004124// cc_defaults provides a set of properties that can be inherited by other cc
4125// modules. A module can use the properties from a cc_defaults using
4126// `defaults: ["<:default_module_name>"]`. Properties of both modules are
4127// merged (when possible) by prepending the default module's values to the
4128// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07004129func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07004130 return DefaultsFactory()
4131}
4132
Colin Cross36242852017-06-23 15:06:31 -07004133func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08004134 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08004135
Colin Cross36242852017-06-23 15:06:31 -07004136 module.AddProperties(props...)
4137 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08004138 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07004139 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004140 &BaseCompilerProperties{},
4141 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01004142 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004143 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07004144 &StaticProperties{},
4145 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07004146 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004147 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00004148 &TestLinkerProperties{},
4149 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07004150 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07004151 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07004152 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08004153 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08004154 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07004155 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07004156 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07004157 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08004158 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08004159 &SAbiProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07004160 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08004161 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00004162 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08004163 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04004164 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
4165 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07004166 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07004167 )
Colin Crosscfad1192015-11-02 16:43:11 -08004168
Jooyung Hancc372c52019-09-25 15:18:44 +09004169 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07004170
4171 return module
Colin Crosscfad1192015-11-02 16:43:11 -08004172}
4173
Jiyong Park2286afd2020-06-16 21:58:53 +09004174func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02004175 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09004176}
4177
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004178func kytheExtractAllFactory() android.Singleton {
4179 return &kytheExtractAllSingleton{}
4180}
4181
4182type kytheExtractAllSingleton struct {
4183}
4184
4185func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
4186 var xrefTargets android.Paths
Yu Liuec7043d2024-11-05 18:22:20 +00004187 ctx.VisitAllModuleProxies(func(module android.ModuleProxy) {
Yu Liu4f825132024-12-18 00:35:39 +00004188 files := android.OtherModuleProviderOrDefault(ctx, module, CcObjectInfoProvider).KytheFiles
Yu Liuec7043d2024-11-05 18:22:20 +00004189 if len(files) > 0 {
4190 xrefTargets = append(xrefTargets, files...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004191 }
4192 })
4193 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
4194 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07004195 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08004196 }
4197}
4198
Jihoon Kangf78a8902022-09-01 22:47:07 +00004199func (c *Module) Partition() string {
4200 if p, ok := c.installer.(interface {
4201 getPartition() string
4202 }); ok {
4203 return p.getPartition()
4204 }
4205 return ""
4206}
4207
Spandan Das2b6dfb52024-01-19 00:22:22 +00004208type sourceModuleName interface {
4209 sourceModuleName() string
4210}
4211
4212func (c *Module) BaseModuleName() string {
4213 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
4214 // if the prebuilt module sets a source_module_name in Android.bp, use that
4215 return smn.sourceModuleName()
4216 }
4217 return c.ModuleBase.BaseModuleName()
4218}
4219
Spandan Dase20c56c2024-07-23 21:34:24 +00004220func (c *Module) stubsSymbolFilePath() android.Path {
4221 if library, ok := c.linker.(*libraryDecorator); ok {
4222 return library.stubsSymbolFilePath
4223 }
4224 return android.OptionalPath{}.Path()
4225}
4226
Colin Cross06a931b2015-10-28 17:23:31 -07004227var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07004228var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08004229var BoolPtr = proptools.BoolPtr
4230var String = proptools.String
4231var StringPtr = proptools.StringPtr