blob: 59b13efac15a7208c5fdda7c6ef373f4683ab87c [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 Cross5049f022015-03-18 13:28:46 -070037 "android/soong/genrule"
Colin Cross3f40fa42015-01-30 17:27:36 -080038)
39
Colin Cross463a90e2015-06-17 14:20:06 -070040func init() {
Paul Duffin036e7002019-12-19 19:16:28 +000041 RegisterCCBuildComponents(android.InitRegistrationContext)
Colin Cross463a90e2015-06-17 14:20:06 -070042
Inseob Kim3b244062023-07-11 13:31:36 +090043 pctx.Import("android/soong/android")
Paul Duffin036e7002019-12-19 19:16:28 +000044 pctx.Import("android/soong/cc/config")
45}
46
47func RegisterCCBuildComponents(ctx android.RegistrationContext) {
48 ctx.RegisterModuleType("cc_defaults", defaultsFactory)
49
50 ctx.PreDepsMutators(func(ctx android.RegisterMutatorsContext) {
Colin Crossac57a6c2024-06-26 13:09:53 -070051 ctx.Transition("sdk", &sdkTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -070052 ctx.BottomUp("llndk", llndkMutator)
Colin Cross767819f2024-05-22 14:22:34 -070053 ctx.Transition("link", &linkageTransitionMutator{})
Colin Crossadd04a82024-05-22 09:57:59 -070054 ctx.Transition("version", &versionTransitionMutator{})
Colin Cross8a962802024-10-09 15:29:27 -070055 ctx.BottomUp("begin", BeginMutator)
Colin Cross1e676be2016-10-12 14:38:15 -070056 })
Colin Cross16b23492016-01-06 14:41:07 -080057
Paul Duffin036e7002019-12-19 19:16:28 +000058 ctx.PostDepsMutators(func(ctx android.RegisterMutatorsContext) {
Liz Kammer75db9312021-07-07 16:41:50 -040059 for _, san := range Sanitizers {
60 san.registerMutators(ctx)
61 }
Dan Willemsen581341d2017-02-09 16:16:31 -080062
Colin Cross8a962802024-10-09 15:29:27 -070063 ctx.BottomUp("sanitize_runtime_deps", sanitizerRuntimeDepsMutator)
64 ctx.BottomUp("sanitize_runtime", sanitizerRuntimeMutator)
Ivan Lozano30c5db22018-02-21 15:49:20 -080065
Colin Cross597bad62024-10-08 15:10:55 -070066 ctx.Transition("fuzz", &fuzzTransitionMutator{})
Cory Barkera1da26f2022-06-07 20:12:06 +000067
Colin Crossf5f4ad32024-01-19 15:41:48 -080068 ctx.Transition("coverage", &coverageTransitionMutator{})
Stephen Craneba090d12017-05-09 15:44:35 -070069
Colin Crossd38feb02024-01-23 16:38:06 -080070 ctx.Transition("afdo", &afdoTransitionMutator{})
Yi Kongeb8efc92021-12-09 18:06:29 +080071
Colin Cross33e0c812024-01-23 16:36:07 -080072 ctx.Transition("orderfile", &orderfileTransitionMutator{})
Sharjeel Khanc6a93d82023-07-18 21:01:11 +000073
Colin Cross6ac83a82024-01-23 11:23:10 -080074 ctx.Transition("lto", &ltoTransitionMutator{})
Jooyung Hana70f0672019-01-18 15:20:43 +090075
Colin Cross8a962802024-10-09 15:29:27 -070076 ctx.BottomUp("check_linktype", checkLinkTypeMutator)
77 ctx.BottomUp("double_loadable", checkDoubleLoadableLibraries)
Colin Cross1e676be2016-10-12 14:38:15 -070078 })
Colin Crossb98c8b02016-07-29 13:44:28 -070079
Colin Cross91ae5ec2024-10-01 14:03:40 -070080 ctx.PostApexMutators(func(ctx android.RegisterMutatorsContext) {
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080081 // sabi mutator needs to be run after apex mutator finishes.
Colin Cross91ae5ec2024-10-01 14:03:40 -070082 ctx.Transition("sabi", &sabiTransitionMutator{})
Yo Chiang8aa4e3f2020-11-19 16:30:49 +080083 })
84
LaMont Jones0c10e4d2023-05-16 00:58:37 +000085 ctx.RegisterParallelSingletonType("kythe_extract_all", kytheExtractAllFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070086}
87
Chris Parsonsef6e0cf2020-12-01 18:26:21 -050088// Deps is a struct containing module names of dependencies, separated by the kind of dependency.
89// Mutators should use `AddVariationDependencies` or its sibling methods to add actual dependency
90// edges to these modules.
91// This object is constructed in DepsMutator, by calling to various module delegates to set
92// relevant fields. For example, `module.compiler.compilerDeps()` may append type-specific
93// dependencies.
94// This is then consumed by the same DepsMutator, which will call `ctx.AddVariationDependencies()`
95// (or its sibling methods) to set real dependencies on the given modules.
Colin Crossca860ac2016-01-04 14:34:37 -080096type Deps struct {
97 SharedLibs, LateSharedLibs []string
98 StaticLibs, LateStaticLibs, WholeStaticLibs []string
Colin Cross5950f382016-12-13 12:50:57 -080099 HeaderLibs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800100 RuntimeLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700101
Colin Cross3e5e7782022-06-17 22:17:05 +0000102 // UnexportedStaticLibs are static libraries that are also passed to -Wl,--exclude-libs= to
103 // prevent automatically exporting symbols.
104 UnexportedStaticLibs []string
105
Chris Parsons79d66a52020-06-05 17:26:16 -0400106 // Used for data dependencies adjacent to tests
107 DataLibs []string
Colin Crossc8caa062021-09-24 16:50:14 -0700108 DataBins []string
Chris Parsons79d66a52020-06-05 17:26:16 -0400109
Yo Chiang219968c2020-09-22 18:45:04 +0800110 // Used by DepsMutator to pass system_shared_libs information to check_elf_file.py.
111 SystemSharedLibs []string
112
Vinh Tran367d89d2023-04-28 11:21:25 -0400113 // Used by DepMutator to pass aidl_library modules to aidl compiler
114 AidlLibs []string
115
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500116 // If true, statically link the unwinder into native libraries/binaries.
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800117 StaticUnwinderIfLegacy bool
118
Colin Cross5950f382016-12-13 12:50:57 -0800119 ReexportSharedLibHeaders, ReexportStaticLibHeaders, ReexportHeaderLibHeaders []string
Dan Willemsen490a8dc2016-06-06 18:22:19 -0700120
Colin Cross81413472016-04-11 14:37:39 -0700121 ObjFiles []string
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700122
Cole Faust65cb40a2024-10-21 15:41:42 -0700123 GeneratedSources []string
124 GeneratedHeaders []string
125 DeviceFirstGeneratedHeaders []string
126 GeneratedDeps []string
Dan Willemsenb40aab62016-04-20 14:21:14 -0700127
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700128 ReexportGeneratedHeaders []string
129
Colin Crossc465efd2021-06-11 18:00:04 -0700130 CrtBegin, CrtEnd []string
Dan Willemsena0790e32018-10-12 00:24:23 -0700131
132 // Used for host bionic
Colin Cross9cfe6112021-06-11 18:02:22 -0700133 DynamicLinker string
Jiyong Parke3867542020-12-03 17:28:25 +0900134
135 // List of libs that need to be excluded for APEX variant
136 ExcludeLibsForApex []string
Jooyung Han9ffbe832023-11-28 22:31:35 +0900137 // List of libs that need to be excluded for non-APEX variant
138 ExcludeLibsForNonApex []string
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800139
140 // LLNDK headers for the ABI checker to check LLNDK implementation library.
141 // An LLNDK implementation is the core variant. LLNDK header libs are reexported by the vendor variant.
Colin Cross1e954b62024-09-13 13:50:00 -0700142 // The core variant cannot depend on the vendor variant because of the order of imageTransitionMutator.Split().
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800143 // Instead, the LLNDK implementation depends on the LLNDK header libs.
144 LlndkHeaderLibs []string
Colin Crossc472d572015-03-17 15:06:21 -0700145}
146
Ivan Lozano0a468a42024-05-13 21:03:34 -0400147// A struct which to collect flags for rlib dependencies
148type RustRlibDep struct {
149 LibPath android.Path // path to the rlib
150 LinkDirs []string // flags required for dependency (e.g. -L flags)
151 CrateName string // crateNames associated with rlibDeps
152}
153
154func EqRustRlibDeps(a RustRlibDep, b RustRlibDep) bool {
155 return a.LibPath == b.LibPath
156}
157
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500158// PathDeps is a struct containing file paths to dependencies of a module.
159// It's constructed in depsToPath() by traversing the direct dependencies of the current module.
160// It's used to construct flags for various build statements (such as for compiling and linking).
161// It is then passed to module decorator functions responsible for registering build statements
162// (such as `module.compiler.compile()`).`
Colin Crossca860ac2016-01-04 14:34:37 -0800163type PathDeps struct {
Colin Cross26c34ed2016-09-30 17:10:16 -0700164 // Paths to .so files
Jiyong Park64a44f22019-01-18 14:37:08 +0900165 SharedLibs, EarlySharedLibs, LateSharedLibs android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700166 // Paths to the dependencies to use for .so files (.so.toc files)
Jiyong Park64a44f22019-01-18 14:37:08 +0900167 SharedLibsDeps, EarlySharedLibsDeps, LateSharedLibsDeps android.Paths
Colin Cross26c34ed2016-09-30 17:10:16 -0700168 // Paths to .a files
Colin Cross635c3b02016-05-18 15:37:25 -0700169 StaticLibs, LateStaticLibs, WholeStaticLibs android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400170 // Paths and crateNames for RustStaticLib dependencies
171 RustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700172
Colin Cross0de8a1e2020-09-18 14:15:30 -0700173 // Transitive static library dependencies of static libraries for use in ordering.
Colin Crossa14fb6a2024-10-23 16:57:06 -0700174 TranstiveStaticLibrariesForOrdering depset.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -0700175
Colin Cross26c34ed2016-09-30 17:10:16 -0700176 // Paths to .o files
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100177 Objs Objects
178 // Paths to .o files in dependencies that provide them. Note that these lists
179 // aren't complete since prebuilt modules don't provide the .o files.
Dan Willemsen581341d2017-02-09 16:16:31 -0800180 StaticLibObjs Objects
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700181 WholeStaticLibObjs Objects
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700182
Martin Stjernholm391d94c2020-04-17 17:34:31 +0100183 // Paths to .a files in prebuilts. Complements WholeStaticLibObjs to contain
184 // the libs from all whole_static_lib dependencies.
185 WholeStaticLibsFromPrebuilts android.Paths
186
Colin Cross26c34ed2016-09-30 17:10:16 -0700187 // Paths to generated source files
Colin Cross635c3b02016-05-18 15:37:25 -0700188 GeneratedSources android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900189 GeneratedDeps android.Paths
Dan Willemsenb40aab62016-04-20 14:21:14 -0700190
Inseob Kimd110f872019-12-06 13:15:38 +0900191 Flags []string
Colin Cross3e5e7782022-06-17 22:17:05 +0000192 LdFlags []string
Inseob Kimd110f872019-12-06 13:15:38 +0900193 IncludeDirs android.Paths
194 SystemIncludeDirs android.Paths
195 ReexportedDirs android.Paths
196 ReexportedSystemDirs android.Paths
197 ReexportedFlags []string
198 ReexportedGeneratedHeaders android.Paths
199 ReexportedDeps android.Paths
Ivan Lozano0a468a42024-05-13 21:03:34 -0400200 ReexportedRustRlibDeps []RustRlibDep
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700201
Colin Cross26c34ed2016-09-30 17:10:16 -0700202 // Paths to crt*.o files
Colin Crossc465efd2021-06-11 18:00:04 -0700203 CrtBegin, CrtEnd android.Paths
Dan Willemsena0790e32018-10-12 00:24:23 -0700204
Dan Willemsena0790e32018-10-12 00:24:23 -0700205 // Path to the dynamic linker binary
206 DynamicLinker android.OptionalPath
Dan Willemsen47450072021-10-19 20:24:49 -0700207
208 // For Darwin builds, the path to the second architecture's output that should
209 // be combined with this architectures's output into a FAT MachO file.
210 DarwinSecondArchOutput android.OptionalPath
Vinh Tran367d89d2023-04-28 11:21:25 -0400211
212 // Paths to direct srcs and transitive include dirs from direct aidl_library deps
213 AidlLibraryInfos []aidl_library.AidlLibraryInfo
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800214
215 // LLNDK headers for the ABI checker to check LLNDK implementation library.
216 LlndkIncludeDirs android.Paths
217 LlndkSystemIncludeDirs android.Paths
Colin Crossb614cd42024-10-11 12:52:21 -0700218
219 directImplementationDeps android.Paths
220 transitiveImplementationDeps []depset.DepSet[android.Path]
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700221}
222
Colin Cross4af21ed2019-11-04 09:37:55 -0800223// LocalOrGlobalFlags contains flags that need to have values set globally by the build system or locally by the module
224// tracked separately, in order to maintain the required ordering (most of the global flags need to go first on the
225// command line so they can be overridden by the local module flags).
226type LocalOrGlobalFlags struct {
227 CommonFlags []string // Flags that apply to C, C++, and assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700228 AsFlags []string // Flags that apply to assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800229 YasmFlags []string // Flags that apply to yasm assembly source files
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700230 CFlags []string // Flags that apply to C and C++ source files
231 ToolingCFlags []string // Flags that apply to C and C++ source files parsed by clang LibTooling tools
232 ConlyFlags []string // Flags that apply to C source files
233 CppFlags []string // Flags that apply to C++ source files
234 ToolingCppFlags []string // Flags that apply to C++ source files parsed by clang LibTooling tools
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -0700235 LdFlags []string // Flags that apply to linker command lines
Colin Cross4af21ed2019-11-04 09:37:55 -0800236}
237
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500238// Flags contains various types of command line flags (and settings) for use in building build
239// statements related to C++.
Colin Cross4af21ed2019-11-04 09:37:55 -0800240type Flags struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500241 // Local flags (which individual modules are responsible for). These may override global flags.
242 Local LocalOrGlobalFlags
243 // Global flags (which build system or toolchain is responsible for).
Luis Useche342fa6b2024-04-01 19:33:18 -0700244 Global LocalOrGlobalFlags
245 NoOverrideFlags []string // Flags applied to the end of list of flags so they are not overridden
Colin Cross4af21ed2019-11-04 09:37:55 -0800246
247 aidlFlags []string // Flags that apply to aidl source files
248 rsFlags []string // Flags that apply to renderscript source files
249 libFlags []string // Flags to add libraries early to the link order
250 extraLibFlags []string // Flags to add libraries late in the link order after LdFlags
251 TidyFlags []string // Flags that apply to clang-tidy
252 SAbiFlags []string // Flags that apply to header-abi-dumper
Colin Cross28344522015-04-22 13:07:53 -0700253
Colin Crossc3199482017-03-30 15:03:04 -0700254 // Global include flags that apply to C, C++, and assembly source files
Colin Cross4af21ed2019-11-04 09:37:55 -0800255 // These must be after any module include flags, which will be in CommonFlags.
Colin Crossc3199482017-03-30 15:03:04 -0700256 SystemIncludeFlags []string
257
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800258 Toolchain config.Toolchain
259 Tidy bool // True if ninja .tidy rules should be generated.
260 NeedTidyFiles bool // True if module link should depend on .tidy files
261 GcovCoverage bool // True if coverage files should be generated.
262 SAbiDump bool // True if header abi dumps should be generated.
263 EmitXrefs bool // If true, generate Ninja rules to generate emitXrefs input files for Kythe
kellyhungd62ea302024-05-19 21:16:07 +0800264 ClangVerify bool // If true, append cflags "-Xclang -verify" and append "&& touch $out" to the clang command line.
Colin Crossca860ac2016-01-04 14:34:37 -0800265
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500266 // The instruction set required for clang ("arm" or "thumb").
Colin Crossca860ac2016-01-04 14:34:37 -0800267 RequiredInstructionSet string
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500268 // The target-device system path to the dynamic linker.
269 DynamicLinker string
Colin Cross16b23492016-01-06 14:41:07 -0800270
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -0700271 CFlagsDeps android.Paths // Files depended on by compiler flags
272 LdFlagsDeps android.Paths // Files depended on by linker flags
Colin Cross18c0c5a2016-12-01 14:45:23 -0800273
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500274 // True if .s files should be processed with the c preprocessor.
Dan Willemsen98ab3112019-08-27 21:20:40 -0700275 AssemblerWithCpp bool
Dan Willemsen60e62f02018-11-16 21:05:32 -0800276
Colin Cross19878da2019-03-28 14:45:07 -0700277 proto android.ProtoFlags
Colin Cross19878da2019-03-28 14:45:07 -0700278 protoC bool // Whether to use C instead of C++
279 protoOptionsFile bool // Whether to look for a .options file next to the .proto
Dan Willemsen4e0aa232019-04-10 22:59:54 -0700280
281 Yacc *YaccProperties
Matthias Maennich22fd4d12020-07-15 10:58:56 +0200282 Lex *LexProperties
Colin Crossc472d572015-03-17 15:06:21 -0700283}
284
Colin Crossca860ac2016-01-04 14:34:37 -0800285// Properties used to compile all C or C++ modules
286type BaseProperties struct {
Dan Willemsen742a5452018-07-23 17:19:36 -0700287 // Deprecated. true is the default, false is invalid.
Colin Crossca860ac2016-01-04 14:34:37 -0800288 Clang *bool `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700289
Yi Kong5786f5c2024-05-28 02:22:34 +0900290 // Aggresively trade performance for smaller binary size.
291 // This should only be used for on-device binaries that are rarely executed and not
292 // performance critical.
293 Optimize_for_size *bool `android:"arch_variant"`
294
Jiyong Parkb35a8192020-08-10 15:59:36 +0900295 // The API level that this module is built against. The APIs of this API level will be
296 // visible at build time, but use of any APIs newer than min_sdk_version will render the
297 // module unloadable on older devices. In the future it will be possible to weakly-link new
298 // APIs, making the behavior match Java: such modules will load on older devices, but
299 // calling new APIs on devices that do not support them will result in a crash.
300 //
301 // This property has the same behavior as sdk_version does for Java modules. For those
302 // familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
303 // does for Java code.
304 //
305 // In addition, setting this property causes two variants to be built, one for the platform
306 // and one for apps.
Nan Zhang0007d812017-11-07 10:57:05 -0800307 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700308
Jiyong Parkb35a8192020-08-10 15:59:36 +0900309 // Minimum OS API level supported by this C or C++ module. This property becomes the value
310 // of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
311 // this property is also used to ensure that the min_sdk_version of the containing module is
312 // not older (i.e. less) than this module's min_sdk_version. When not set, this property
313 // defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
314 // min_sdk_version of the containing APEX. When the module
315 // is not built for an APEX, "apex_inherit" defaults to sdk_version.
Jooyung Han379660c2020-04-21 15:24:00 +0900316 Min_sdk_version *string
317
Colin Crossc511bc52020-04-07 16:50:32 +0000318 // If true, always create an sdk variant and don't create a platform variant.
319 Sdk_variant_only *bool
320
Jiyong Parkde866cb2018-12-07 23:08:36 +0900321 AndroidMkSharedLibs []string `blueprint:"mutated"`
322 AndroidMkStaticLibs []string `blueprint:"mutated"`
Ivan Lozano0a468a42024-05-13 21:03:34 -0400323 AndroidMkRlibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900324 AndroidMkRuntimeLibs []string `blueprint:"mutated"`
325 AndroidMkWholeStaticLibs []string `blueprint:"mutated"`
Bill Peckhama46de702020-04-21 17:23:37 -0700326 AndroidMkHeaderLibs []string `blueprint:"mutated"`
Jiyong Parkde866cb2018-12-07 23:08:36 +0900327 HideFromMake bool `blueprint:"mutated"`
328 PreventInstall bool `blueprint:"mutated"`
329 ApexesProvidingSharedLibs []string `blueprint:"mutated"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700330
Yo Chiang219968c2020-09-22 18:45:04 +0800331 // Set by DepsMutator.
332 AndroidMkSystemSharedLibs []string `blueprint:"mutated"`
333
Kiyoung Kimb5fdb2e2024-01-03 14:24:34 +0900334 // The name of the image this module is built for
335 ImageVariation string `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200336
337 // The VNDK version this module is built against. If empty, the module is not
338 // build against the VNDK.
339 VndkVersion string `blueprint:"mutated"`
340
341 // Suffix for the name of Android.mk entries generated by this module
342 SubName string `blueprint:"mutated"`
Colin Cross5beccee2017-12-07 15:28:59 -0800343
344 // *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
345 // file
Inseob Kim37e0bb02024-04-29 15:54:44 +0900346 Logtags []string `android:"path"`
Jiyong Parkf9332f12018-02-01 00:54:12 +0900347
Yifan Hong39143a92020-10-26 12:43:12 -0700348 // Make this module available when building for ramdisk.
349 // On device without a dedicated recovery partition, the module is only
350 // available after switching root into
351 // /first_stage_ramdisk. To expose the module before switching root, install
352 // the recovery variant instead.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800353 Ramdisk_available *bool
354
Yifan Hong39143a92020-10-26 12:43:12 -0700355 // Make this module available when building for vendor ramdisk.
356 // On device without a dedicated recovery partition, the module is only
357 // available after switching root into
358 // /first_stage_ramdisk. To expose the module before switching root, install
359 // the recovery variant instead.
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700360 Vendor_ramdisk_available *bool
361
Jiyong Parkf9332f12018-02-01 00:54:12 +0900362 // Make this module available when building for recovery
363 Recovery_available *bool
364
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200365 // Used by imageMutator, set by ImageMutatorBegin()
Jihoon Kang47e91842024-06-19 00:51:16 +0000366 VendorVariantNeeded bool `blueprint:"mutated"`
367 ProductVariantNeeded bool `blueprint:"mutated"`
Lukacs T. Berki2f5c3402021-06-15 11:27:56 +0200368 CoreVariantNeeded bool `blueprint:"mutated"`
369 RamdiskVariantNeeded bool `blueprint:"mutated"`
370 VendorRamdiskVariantNeeded bool `blueprint:"mutated"`
371 RecoveryVariantNeeded bool `blueprint:"mutated"`
372
373 // A list of variations for the "image" mutator of the form
374 //<image name> '.' <version char>, for example, 'vendor.S'
375 ExtraVersionedImageVariations []string `blueprint:"mutated"`
Jiyong Parkb0788572018-12-20 22:10:17 +0900376
377 // Allows this module to use non-APEX version of libraries. Useful
378 // for building binaries that are started before APEXes are activated.
379 Bootstrap *bool
Jooyung Han097087b2019-10-22 19:32:18 +0900380
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000381 // Allows this module to be included in CMake release snapshots to be built outside of Android
382 // build system and source tree.
383 Cmake_snapshot_supported *bool
384
Colin Cross1bc94122021-10-28 13:25:54 -0700385 Installable *bool `android:"arch_variant"`
Colin Crossc511bc52020-04-07 16:50:32 +0000386
387 // Set by factories of module types that can only be referenced from variants compiled against
388 // the SDK.
389 AlwaysSdk bool `blueprint:"mutated"`
390
391 // Variant is an SDK variant created by sdkMutator
392 IsSdkVariant bool `blueprint:"mutated"`
393 // Set when both SDK and platform variants are exported to Make to trigger renaming the SDK
394 // variant to have a ".sdk" suffix.
395 SdkAndPlatformVariantVisibleToMake bool `blueprint:"mutated"`
Bill Peckham945441c2020-08-31 16:07:58 -0700396
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800397 Target struct {
398 Platform struct {
399 // List of modules required by the core variant.
400 Required []string `android:"arch_variant"`
401
402 // List of modules not required by the core variant.
403 Exclude_required []string `android:"arch_variant"`
404 } `android:"arch_variant"`
405
406 Recovery struct {
407 // List of modules required by the recovery variant.
408 Required []string `android:"arch_variant"`
409
410 // List of modules not required by the recovery variant.
411 Exclude_required []string `android:"arch_variant"`
412 } `android:"arch_variant"`
413 } `android:"arch_variant"`
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700414}
415
416type VendorProperties struct {
Jiyong Park82e2bf32017-08-16 14:05:54 +0900417 // whether this module should be allowed to be directly depended by other
418 // modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
Justin Yun63e9ec72020-10-29 16:49:43 +0900419 // If set to true, two variants will be built separately, one like
420 // normal, and the other limited to the set of libraries and headers
421 // that are exposed to /vendor modules.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700422 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900423 // The vendor variant may be used with a different (newer) /system,
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700424 // so it shouldn't have any unversioned runtime dependencies, or
425 // make assumptions about the system that may not be true in the
426 // future.
427 //
Justin Yun63e9ec72020-10-29 16:49:43 +0900428 // If set to false, this module becomes inaccessible from /vendor modules.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900429 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900430 // The modules with vndk: {enabled: true} must define 'vendor_available'
Justin Yun0b1db6d2021-01-08 15:22:34 +0900431 // to 'true'.
Jiyong Park82e2bf32017-08-16 14:05:54 +0900432 //
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700433 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
434 Vendor_available *bool
Jiyong Park5fb8c102018-04-09 12:03:06 +0900435
Justin Yunebcf0c52021-01-08 18:00:19 +0900436 // This is the same as the "vendor_available" except that the install path
437 // of the vendor variant is /odm or /vendor/odm.
438 // By replacing "vendor_available: true" with "odm_available: true", the
439 // module will install its vendor variant to the /odm partition or /vendor/odm.
440 // As the modules with "odm_available: true" still create the vendor variants,
441 // they can link to the other vendor modules as the vendor_available modules do.
442 // Also, the vendor modules can link to odm_available modules.
443 //
444 // It may not be used for VNDK modules.
445 Odm_available *bool
446
Justin Yun63e9ec72020-10-29 16:49:43 +0900447 // whether this module should be allowed to be directly depended by other
448 // modules with `product_specific: true` or `product_available: true`.
449 // If set to true, an additional product variant will be built separately
450 // that is limited to the set of libraries and headers that are exposed to
451 // /product modules.
452 //
453 // The product variant may be used with a different (newer) /system,
454 // so it shouldn't have any unversioned runtime dependencies, or
455 // make assumptions about the system that may not be true in the
456 // future.
457 //
Justin Yun6977e8a2020-10-29 18:24:11 +0900458 // If set to false, this module becomes inaccessible from /product modules.
459 //
460 // Different from the 'vendor_available' property, the modules with
461 // vndk: {enabled: true} don't have to define 'product_available'. The VNDK
462 // library without 'product_available' may not be depended on by any other
463 // modules that has product variants including the product available VNDKs.
Justin Yun63e9ec72020-10-29 16:49:43 +0900464 //
465 // Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
466 // and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
467 Product_available *bool
468
Jiyong Park5fb8c102018-04-09 12:03:06 +0900469 // whether this module is capable of being loaded with other instance
470 // (possibly an older version) of the same module in the same process.
471 // Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
472 // can be double loaded in a vendor process if the library is also a
473 // (direct and indirect) dependency of an LLNDK library. Such libraries must be
474 // explicitly marked as `double_loadable: true` by the owner, or the dependency
475 // from the LLNDK lib should be cut if the lib is not designed to be double loaded.
476 Double_loadable *bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800477
478 // IsLLNDK is set to true for the vendor variant of a cc_library module that has LLNDK stubs.
479 IsLLNDK bool `blueprint:"mutated"`
480
Colin Cross5271fea2021-04-27 13:06:04 -0700481 // IsVendorPublicLibrary is set for the core and product variants of a library that has
482 // vendor_public_library stubs.
483 IsVendorPublicLibrary bool `blueprint:"mutated"`
Colin Crossca860ac2016-01-04 14:34:37 -0800484}
485
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500486// ModuleContextIntf is an interface (on a module context helper) consisting of functions related
487// to understanding details about the type of the current module.
488// For example, one might call these functions to determine whether the current module is a static
489// library and/or is installed in vendor directories.
Colin Crossca860ac2016-01-04 14:34:37 -0800490type ModuleContextIntf interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800491 static() bool
492 staticBinary() bool
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -0700493 testBinary() bool
Yi Kong56fc1b62022-09-06 16:24:00 +0800494 testLibrary() bool
Jiyong Park1d1119f2019-07-29 21:27:18 +0900495 header() bool
Inseob Kim7f283f42020-06-01 21:53:49 +0900496 binary() bool
Inseob Kim1042d292020-06-01 23:23:05 +0900497 object() bool
Colin Crossb98c8b02016-07-29 13:44:28 -0700498 toolchain() config.Toolchain
Jooyung Hanccce2f22020-03-07 03:45:53 +0900499 canUseSdk() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700500 useSdk() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800501 sdkVersion() string
Jiyong Parkb35a8192020-08-10 15:59:36 +0900502 minSdkVersion() string
503 isSdkVariant() bool
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700504 useVndk() bool
Colin Cross95f1ca02020-10-29 20:47:22 -0700505 isNdk(config android.Config) bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800506 IsLlndk() bool
Colin Cross127bb8b2020-12-16 16:46:01 -0800507 isImplementationForLLNDKPublic() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700508 IsVendorPublicLibrary() bool
Justin Yun5f7f7e82019-11-18 19:52:14 +0900509 inProduct() bool
510 inVendor() bool
Yifan Hong1b3348d2020-01-21 15:53:22 -0800511 inRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -0700512 inVendorRamdisk() bool
Jiyong Parkf9332f12018-02-01 00:54:12 +0900513 inRecovery() bool
Kiyoung Kimaa394802024-01-08 12:55:45 +0900514 InVendorOrProduct() bool
Dan Willemsen8146b2f2016-03-30 21:00:30 -0700515 selectedStl() string
Colin Crossce75d2c2016-10-06 16:12:58 -0700516 baseModuleName() string
Colin Cross3513fb12024-01-24 14:44:47 -0800517 isAfdoCompile(ctx ModuleContext) bool
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000518 isOrderfileCompile() bool
Yi Kongc702ebd2022-08-19 16:02:45 +0800519 isCfi() bool
Yi Konged79fa32023-06-04 17:15:42 +0900520 isFuzzer() bool
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -0800521 isNDKStubLibrary() bool
Ivan Lozanobd721262018-11-27 14:33:03 -0800522 useClangLld(actx ModuleContext) bool
Logan Chiene274fc92019-12-03 11:18:32 -0800523 isForPlatform() bool
Colin Crosse07f2312020-08-13 11:24:56 -0700524 apexVariationName() string
Dan Albertc8060532020-07-22 22:32:17 -0700525 apexSdkVersion() android.ApiLevel
Jiyong Parka4b9dd02019-01-16 22:53:13 +0900526 bootstrap() bool
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700527 nativeCoverage() bool
Colin Cross56a83212020-09-15 18:30:11 -0700528 directlyInAnyApex() bool
Colin Cross95b07f22020-12-16 11:06:50 -0800529 isPreventInstall() bool
Cindy Zhou5d5cfc12021-01-09 08:25:22 -0800530 isCfiAssemblySupportEnabled() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800531 getSharedFlags() *SharedFlags
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800532 notInPlatform() bool
Yi Kong5786f5c2024-05-28 02:22:34 +0900533 optimizeForSize() bool
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800534}
535
536type SharedFlags struct {
537 numSharedFlags int
538 flagsMap map[string]string
Colin Crossca860ac2016-01-04 14:34:37 -0800539}
540
541type ModuleContext interface {
Colin Cross635c3b02016-05-18 15:37:25 -0700542 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800543 ModuleContextIntf
544}
545
546type BaseModuleContext interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700547 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -0800548 ModuleContextIntf
549}
550
Colin Cross37047f12016-12-13 17:06:13 -0800551type DepsContext interface {
552 android.BottomUpMutatorContext
553 ModuleContextIntf
554}
555
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500556// feature represents additional (optional) steps to building cc-related modules, such as invocation
557// of clang-tidy.
Colin Crossca860ac2016-01-04 14:34:37 -0800558type feature interface {
Colin Crossca860ac2016-01-04 14:34:37 -0800559 flags(ctx ModuleContext, flags Flags) Flags
560 props() []interface{}
561}
562
Joe Onorato37f900c2023-07-18 16:58:16 -0700563// Information returned from Generator about the source code it's generating
564type GeneratedSource struct {
565 IncludeDirs android.Paths
566 Sources android.Paths
567 Headers android.Paths
568 ReexportedDirs android.Paths
569}
570
571// generator allows injection of generated code
572type Generator interface {
573 GeneratorProps() []interface{}
574 GeneratorInit(ctx BaseModuleContext)
575 GeneratorDeps(ctx DepsContext, deps Deps) Deps
576 GeneratorFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
577 GeneratorSources(ctx ModuleContext) GeneratedSource
578 GeneratorBuildActions(ctx ModuleContext, flags Flags, deps PathDeps)
579}
580
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500581// compiler is the interface for a compiler helper object. Different module decorators may implement
Liz Kammer718eb272022-01-07 10:53:37 -0500582// this helper differently.
Colin Crossca860ac2016-01-04 14:34:37 -0800583type compiler interface {
Colin Cross42742b82016-08-01 13:20:05 -0700584 compilerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800585 compilerDeps(ctx DepsContext, deps Deps) Deps
Colin Crossf18e1102017-11-16 14:33:08 -0800586 compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags
Colin Cross42742b82016-08-01 13:20:05 -0700587 compilerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000588 baseCompilerProps() BaseCompilerProperties
Colin Cross42742b82016-08-01 13:20:05 -0700589
Colin Cross76fada02016-07-27 10:31:13 -0700590 appendCflags([]string)
591 appendAsflags([]string)
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700592 compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects
Colin Crossca860ac2016-01-04 14:34:37 -0800593}
594
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500595// linker is the interface for a linker decorator object. Individual module types can provide
596// their own implementation for this decorator, and thus specify custom logic regarding build
597// statements pertaining to linking.
Colin Crossca860ac2016-01-04 14:34:37 -0800598type linker interface {
Colin Cross42742b82016-08-01 13:20:05 -0700599 linkerInit(ctx BaseModuleContext)
Colin Cross37047f12016-12-13 17:06:13 -0800600 linkerDeps(ctx DepsContext, deps Deps) Deps
Colin Cross42742b82016-08-01 13:20:05 -0700601 linkerFlags(ctx ModuleContext, flags Flags) Flags
602 linkerProps() []interface{}
Hao Chen1c8ea5b2023-10-20 23:03:45 +0000603 baseLinkerProps() BaseLinkerProperties
Ivan Lozanobd721262018-11-27 14:33:03 -0800604 useClangLld(actx ModuleContext) bool
Colin Cross42742b82016-08-01 13:20:05 -0700605
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700606 link(ctx ModuleContext, flags Flags, deps PathDeps, objs Objects) android.Path
Colin Cross76fada02016-07-27 10:31:13 -0700607 appendLdflags([]string)
Jiyong Parkaf6d8952019-01-31 12:21:23 +0900608 unstrippedOutputFilePath() android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800609 strippedAllOutputFilePath() android.Path
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700610
611 nativeCoverage() bool
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900612 coverageOutputFilePath() android.OptionalPath
Paul Duffin13f02712020-03-06 12:30:43 +0000613
614 // Get the deps that have been explicitly specified in the properties.
Cole Fauste8a87832024-09-11 11:35:46 -0700615 linkerSpecifiedDeps(ctx android.ConfigurableEvaluatorContext, module *Module, specifiedDeps specifiedDeps) specifiedDeps
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800616
617 moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON)
Paul Duffin13f02712020-03-06 12:30:43 +0000618}
619
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500620// specifiedDeps is a tuple struct representing dependencies of a linked binary owned by the linker.
Paul Duffin13f02712020-03-06 12:30:43 +0000621type specifiedDeps struct {
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500622 sharedLibs []string
623 // Note nil and [] are semantically distinct. [] prevents linking against the defaults (usually
624 // libc, libm, etc.)
Colin Cross6b8f4252021-07-22 11:39:44 -0700625 systemSharedLibs []string
Colin Crossca860ac2016-01-04 14:34:37 -0800626}
627
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500628// installer is the interface for an installer helper object. This helper is responsible for
629// copying build outputs to the appropriate locations so that they may be installed on device.
Colin Crossca860ac2016-01-04 14:34:37 -0800630type installer interface {
Colin Cross42742b82016-08-01 13:20:05 -0700631 installerProps() []interface{}
Colin Cross635c3b02016-05-18 15:37:25 -0700632 install(ctx ModuleContext, path android.Path)
Paul Duffin0cb37b92020-03-04 14:52:46 +0000633 everInstallable() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800634 inData() bool
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700635 inSanitizerDir() bool
Dan Willemsen4aa75ca2016-09-28 16:18:03 -0700636 hostToolPath() android.OptionalPath
Jiyong Parkb7c24df2019-02-01 12:03:59 +0900637 relativeInstallPath() string
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +0000638 makeUninstallable(mod *Module)
Inseob Kim800d1142021-06-14 12:03:51 +0900639 installInRoot() bool
Colin Crossca860ac2016-01-04 14:34:37 -0800640}
641
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800642type xref interface {
643 XrefCcFiles() android.Paths
644}
645
Inseob Kima1888ce2022-10-04 14:42:02 +0900646type overridable interface {
647 overriddenModules() []string
648}
649
Colin Cross6e511a92020-07-27 21:26:48 -0700650type libraryDependencyKind int
651
652const (
653 headerLibraryDependency = iota
654 sharedLibraryDependency
655 staticLibraryDependency
Ivan Lozano0a468a42024-05-13 21:03:34 -0400656 rlibLibraryDependency
Colin Cross6e511a92020-07-27 21:26:48 -0700657)
658
659func (k libraryDependencyKind) String() string {
660 switch k {
661 case headerLibraryDependency:
662 return "headerLibraryDependency"
663 case sharedLibraryDependency:
664 return "sharedLibraryDependency"
665 case staticLibraryDependency:
666 return "staticLibraryDependency"
Ivan Lozano0a468a42024-05-13 21:03:34 -0400667 case rlibLibraryDependency:
668 return "rlibLibraryDependency"
Colin Cross6e511a92020-07-27 21:26:48 -0700669 default:
670 panic(fmt.Errorf("unknown libraryDependencyKind %d", k))
671 }
672}
673
674type libraryDependencyOrder int
675
676const (
677 earlyLibraryDependency = -1
678 normalLibraryDependency = 0
679 lateLibraryDependency = 1
680)
681
682func (o libraryDependencyOrder) String() string {
683 switch o {
684 case earlyLibraryDependency:
685 return "earlyLibraryDependency"
686 case normalLibraryDependency:
687 return "normalLibraryDependency"
688 case lateLibraryDependency:
689 return "lateLibraryDependency"
690 default:
691 panic(fmt.Errorf("unknown libraryDependencyOrder %d", o))
692 }
693}
694
695// libraryDependencyTag is used to tag dependencies on libraries. Unlike many dependency
696// tags that have a set of predefined tag objects that are reused for each dependency, a
697// libraryDependencyTag is designed to contain extra metadata and is constructed as needed.
698// That means that comparing a libraryDependencyTag for equality will only be equal if all
699// of the metadata is equal. Most usages will want to type assert to libraryDependencyTag and
700// then check individual metadata fields instead.
701type libraryDependencyTag struct {
702 blueprint.BaseDependencyTag
703
704 // These are exported so that fmt.Printf("%#v") can call their String methods.
705 Kind libraryDependencyKind
706 Order libraryDependencyOrder
707
708 wholeStatic bool
709
710 reexportFlags bool
711 explicitlyVersioned bool
712 dataLib bool
713 ndk bool
714
715 staticUnwinder bool
716
717 makeSuffix string
Jiyong Parke3867542020-12-03 17:28:25 +0900718
Cindy Zhou18417cb2020-12-10 07:12:38 -0800719 // Whether or not this dependency should skip the apex dependency check
720 skipApexAllowedDependenciesCheck bool
721
Jiyong Parke3867542020-12-03 17:28:25 +0900722 // Whether or not this dependency has to be followed for the apex variants
723 excludeInApex bool
Jooyung Han9ffbe832023-11-28 22:31:35 +0900724 // Whether or not this dependency has to be followed for the non-apex variants
725 excludeInNonApex bool
Colin Cross3e5e7782022-06-17 22:17:05 +0000726
727 // If true, don't automatically export symbols from the static library into a shared library.
728 unexportedSymbols bool
Colin Cross6e511a92020-07-27 21:26:48 -0700729}
730
731// header returns true if the libraryDependencyTag is tagging a header lib dependency.
732func (d libraryDependencyTag) header() bool {
733 return d.Kind == headerLibraryDependency
734}
735
736// shared returns true if the libraryDependencyTag is tagging a shared lib dependency.
737func (d libraryDependencyTag) shared() bool {
738 return d.Kind == sharedLibraryDependency
739}
740
741// shared returns true if the libraryDependencyTag is tagging a static lib dependency.
742func (d libraryDependencyTag) static() bool {
743 return d.Kind == staticLibraryDependency
744}
745
Colin Cross65cb3142021-12-10 23:05:02 +0000746func (d libraryDependencyTag) LicenseAnnotations() []android.LicenseAnnotation {
747 if d.shared() {
748 return []android.LicenseAnnotation{android.LicenseAnnotationSharedDependency}
749 }
750 return nil
751}
752
753var _ android.LicenseAnnotationsDependencyTag = libraryDependencyTag{}
754
Colin Crosse9fe2942020-11-10 18:12:15 -0800755// InstallDepNeeded returns true for shared libraries so that shared library dependencies of
756// binaries or other shared libraries are installed as dependencies.
757func (d libraryDependencyTag) InstallDepNeeded() bool {
758 return d.shared()
759}
760
761var _ android.InstallNeededDependencyTag = libraryDependencyTag{}
762
Yu Liu67a28422024-03-05 00:36:31 +0000763func (d libraryDependencyTag) PropagateAconfigValidation() bool {
764 return d.static()
765}
766
767var _ android.PropagateAconfigValidationDependencyTag = libraryDependencyTag{}
768
Colin Crosse9fe2942020-11-10 18:12:15 -0800769// dependencyTag is used for tagging miscellaneous dependency types that don't fit into
Colin Cross6e511a92020-07-27 21:26:48 -0700770// libraryDependencyTag. Each tag object is created globally and reused for multiple
771// dependencies (although since the object contains no references, assigning a tag to a
772// variable and modifying it will not modify the original). Users can compare the tag
773// returned by ctx.OtherModuleDependencyTag against the global original
774type dependencyTag struct {
775 blueprint.BaseDependencyTag
776 name string
777}
778
Colin Crosse9fe2942020-11-10 18:12:15 -0800779// installDependencyTag is used for tagging miscellaneous dependency types that don't fit into
780// libraryDependencyTag, but where the dependency needs to be installed when the parent is
781// installed.
782type installDependencyTag struct {
783 blueprint.BaseDependencyTag
784 android.InstallAlwaysNeededDependencyTag
785 name string
786}
787
Colin Crossc99deeb2016-04-11 15:06:20 -0700788var (
Colin Cross6e511a92020-07-27 21:26:48 -0700789 genSourceDepTag = dependencyTag{name: "gen source"}
790 genHeaderDepTag = dependencyTag{name: "gen header"}
791 genHeaderExportDepTag = dependencyTag{name: "gen header export"}
792 objDepTag = dependencyTag{name: "obj"}
Jiyong Parkd630bdd2020-11-25 11:47:24 +0900793 dynamicLinkerDepTag = installDependencyTag{name: "dynamic linker"}
Colin Cross6e511a92020-07-27 21:26:48 -0700794 reuseObjTag = dependencyTag{name: "reuse objects"}
795 staticVariantTag = dependencyTag{name: "static variant"}
796 vndkExtDepTag = dependencyTag{name: "vndk extends"}
797 dataLibDepTag = dependencyTag{name: "data lib"}
Colin Crossc8caa062021-09-24 16:50:14 -0700798 dataBinDepTag = dependencyTag{name: "data bin"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800799 runtimeDepTag = installDependencyTag{name: "runtime lib"}
Colin Cross0de8a1e2020-09-18 14:15:30 -0700800 stubImplDepTag = dependencyTag{name: "stub_impl"}
Muhammad Haseeb Ahmad7e744052022-03-25 22:50:53 +0000801 JniFuzzLibTag = dependencyTag{name: "jni_fuzz_lib_tag"}
Vinh Tran44cb78c2023-03-09 22:07:19 -0500802 FdoProfileTag = dependencyTag{name: "fdo_profile"}
Vinh Tran367d89d2023-04-28 11:21:25 -0400803 aidlLibraryTag = dependencyTag{name: "aidl_library"}
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800804 llndkHeaderLibTag = dependencyTag{name: "llndk_header_lib"}
Colin Crossc99deeb2016-04-11 15:06:20 -0700805)
806
Roland Levillainf89cd092019-07-29 16:22:59 +0100807func IsSharedDepTag(depTag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700808 ccLibDepTag, ok := depTag.(libraryDependencyTag)
809 return ok && ccLibDepTag.shared()
810}
811
812func IsStaticDepTag(depTag blueprint.DependencyTag) bool {
813 ccLibDepTag, ok := depTag.(libraryDependencyTag)
814 return ok && ccLibDepTag.static()
Roland Levillainf89cd092019-07-29 16:22:59 +0100815}
816
Zach Johnson3df4e632020-11-06 11:56:27 -0800817func IsHeaderDepTag(depTag blueprint.DependencyTag) bool {
818 ccLibDepTag, ok := depTag.(libraryDependencyTag)
819 return ok && ccLibDepTag.header()
820}
821
Roland Levillainf89cd092019-07-29 16:22:59 +0100822func IsRuntimeDepTag(depTag blueprint.DependencyTag) bool {
Colin Crosse9fe2942020-11-10 18:12:15 -0800823 return depTag == runtimeDepTag
Roland Levillainf89cd092019-07-29 16:22:59 +0100824}
825
Colin Crossca860ac2016-01-04 14:34:37 -0800826// Module contains the properties and members used by all C/C++ module types, and implements
827// the blueprint.Module interface. It delegates to compiler, linker, and installer interfaces
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500828// to construct the output file. Behavior can be customized with a Customizer, or "decorator",
829// interface.
830//
831// To define a C/C++ related module, construct a new Module object and point its delegates to
832// type-specific structs. These delegates will be invoked to register module-specific build
833// statements which may be unique to the module type. For example, module.compiler.compile() should
834// be defined so as to register build statements which are responsible for compiling the module.
835//
836// Another example: to construct a cc_binary module, one can create a `cc.binaryDecorator` struct
837// which implements the `linker` and `installer` interfaces, and points the `linker` and `installer`
838// members of the cc.Module to this decorator. Thus, a cc_binary module has custom linker and
839// installer logic.
Colin Crossca860ac2016-01-04 14:34:37 -0800840type Module struct {
hamzehc0a671f2021-07-22 12:05:08 -0700841 fuzz.FuzzModule
hamzeh41ad8812021-07-07 14:00:07 -0700842
Dan Willemsen3e5bdf22017-09-13 18:37:08 -0700843 VendorProperties VendorProperties
hamzeh41ad8812021-07-07 14:00:07 -0700844 Properties BaseProperties
Ronald Braunsteina115e262024-04-09 18:07:38 -0700845 sourceProperties android.SourceProperties
Colin Crossfa138792015-04-24 17:31:52 -0700846
Colin Crossca860ac2016-01-04 14:34:37 -0800847 // initialize before calling Init
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000848 hod android.HostOrDeviceSupported
849 multilib android.Multilib
Aditya Choudhary87b2ab22023-11-17 15:27:06 +0000850 testModule bool
Colin Crossc472d572015-03-17 15:06:21 -0700851
Paul Duffina0843f62019-12-13 19:50:38 +0000852 // Allowable SdkMemberTypes of this module type.
853 sdkMemberTypes []android.SdkMemberType
854
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500855 // decorator delegates, initialize before calling Init
856 // these may contain module-specific implementations, and effectively allow for custom
857 // type-specific logic. These members may reference different objects or the same object.
858 // Functions of these decorators will be invoked to initialize and register type-specific
859 // build statements.
Colin Cross8ff10582023-12-07 13:10:56 -0800860 generators []Generator
861 compiler compiler
862 linker linker
863 installer installer
Chris Parsonsef6e0cf2020-12-01 18:26:21 -0500864
Spandan Dase12d2522023-09-12 21:42:31 +0000865 features []feature
866 stl *stl
867 sanitize *sanitize
868 coverage *coverage
869 fuzzer *fuzzer
870 sabi *sabi
Spandan Dase12d2522023-09-12 21:42:31 +0000871 lto *lto
872 afdo *afdo
Sharjeel Khanc6a93d82023-07-18 21:01:11 +0000873 orderfile *orderfile
Colin Cross16b23492016-01-06 14:41:07 -0800874
Colin Cross31076b32020-10-23 17:22:06 -0700875 library libraryInterface
876
Colin Cross635c3b02016-05-18 15:37:25 -0700877 outputFile android.OptionalPath
Colin Crossca860ac2016-01-04 14:34:37 -0800878
Colin Crossb98c8b02016-07-29 13:44:28 -0700879 cachedToolchain config.Toolchain
Colin Crossb916a382016-07-29 17:28:03 -0700880
Yu Liue70976d2024-10-15 20:45:35 +0000881 subAndroidMkOnce map[subAndroidMkProviderInfoProducer]bool
Fabien Sanglardd61f1f42017-01-10 16:21:22 -0800882
883 // Flags used to compile this module
884 flags Flags
Jeff Gaston294356f2017-09-27 17:05:30 -0700885
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800886 // Shared flags among build rules of this module
887 sharedFlags SharedFlags
888
Jeff Gastonf5b6e8f2017-11-27 15:48:57 -0800889 // only non-nil when this is a shared library that reuses the objects of a static library
Colin Cross0de8a1e2020-09-18 14:15:30 -0700890 staticAnalogue *StaticLibraryInfo
Inseob Kim9516ee92019-05-09 10:56:13 +0900891
892 makeLinkType string
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800893 // Kythe (source file indexer) paths for this compilation module
894 kytheFiles android.Paths
Chih-Hung Hsieh80783772021-10-11 16:46:56 -0700895 // Object .o file output paths for this compilation module
896 objFiles android.Paths
897 // Tidy .tidy file output paths for this compilation module
898 tidyFiles android.Paths
Jooyung Han75568392020-03-20 04:29:24 +0900899
900 // For apex variants, this is set as apex.min_sdk_version
Dan Albertc8060532020-07-22 22:32:17 -0700901 apexSdkVersion android.ApiLevel
Colin Cross56a83212020-09-15 18:30:11 -0700902
903 hideApexVariantFromMake bool
Yu Liueae7b362023-11-16 17:05:47 -0800904
Inseob Kim37e0bb02024-04-29 15:54:44 +0900905 logtagsPaths android.Paths
Ivan Lozanofd47b1a2024-05-17 14:13:41 -0400906
907 WholeRustStaticlib bool
Cole Faust96a692b2024-08-08 14:47:51 -0700908
909 hasAidl bool
910 hasLex bool
911 hasProto bool
912 hasRenderscript bool
913 hasSysprop bool
914 hasWinMsg bool
915 hasYacc bool
Colin Crossc472d572015-03-17 15:06:21 -0700916}
917
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200918func (c *Module) AddJSONData(d *map[string]interface{}) {
919 c.AndroidModuleBase().AddJSONData(d)
920 (*d)["Cc"] = map[string]interface{}{
921 "SdkVersion": c.SdkVersion(),
922 "MinSdkVersion": c.MinSdkVersion(),
923 "VndkVersion": c.VndkVersion(),
924 "ProductSpecific": c.ProductSpecific(),
925 "SocSpecific": c.SocSpecific(),
926 "DeviceSpecific": c.DeviceSpecific(),
927 "InProduct": c.InProduct(),
928 "InVendor": c.InVendor(),
929 "InRamdisk": c.InRamdisk(),
930 "InVendorRamdisk": c.InVendorRamdisk(),
931 "InRecovery": c.InRecovery(),
932 "VendorAvailable": c.VendorAvailable(),
933 "ProductAvailable": c.ProductAvailable(),
934 "RamdiskAvailable": c.RamdiskAvailable(),
935 "VendorRamdiskAvailable": c.VendorRamdiskAvailable(),
936 "RecoveryAvailable": c.RecoveryAvailable(),
937 "OdmAvailable": c.OdmAvailable(),
938 "InstallInData": c.InstallInData(),
939 "InstallInRamdisk": c.InstallInRamdisk(),
940 "InstallInSanitizerDir": c.InstallInSanitizerDir(),
941 "InstallInVendorRamdisk": c.InstallInVendorRamdisk(),
942 "InstallInRecovery": c.InstallInRecovery(),
943 "InstallInRoot": c.InstallInRoot(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200944 "IsLlndk": c.IsLlndk(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200945 "IsVendorPublicLibrary": c.IsVendorPublicLibrary(),
946 "ApexSdkVersion": c.apexSdkVersion,
Cole Faust96a692b2024-08-08 14:47:51 -0700947 "AidlSrcs": c.hasAidl,
948 "LexSrcs": c.hasLex,
949 "ProtoSrcs": c.hasProto,
950 "RenderscriptSrcs": c.hasRenderscript,
951 "SyspropSrcs": c.hasSysprop,
952 "WinMsgSrcs": c.hasWinMsg,
953 "YaccSrsc": c.hasYacc,
954 "OnlyCSrcs": !(c.hasAidl || c.hasLex || c.hasProto || c.hasRenderscript || c.hasSysprop || c.hasWinMsg || c.hasYacc),
Yi Kong5786f5c2024-05-28 02:22:34 +0900955 "OptimizeForSize": c.OptimizeForSize(),
Lukacs T. Berkid18d8ca2021-06-25 09:11:22 +0200956 }
957}
958
Ivan Lozano3968d8f2020-12-14 11:27:52 -0500959func (c *Module) SetPreventInstall() {
960 c.Properties.PreventInstall = true
961}
962
963func (c *Module) SetHideFromMake() {
964 c.Properties.HideFromMake = true
965}
966
Ivan Lozanod7586b62021-04-01 09:49:36 -0400967func (c *Module) HiddenFromMake() bool {
968 return c.Properties.HideFromMake
969}
970
Cole Fauste8a87832024-09-11 11:35:46 -0700971func (c *Module) RequiredModuleNames(ctx android.ConfigurableEvaluatorContext) []string {
Cole Faust43ddd082024-06-17 12:32:40 -0700972 required := android.CopyOf(c.ModuleBase.RequiredModuleNames(ctx))
Yi-Yo Chiangc7e044f2021-06-18 19:44:24 +0800973 if c.ImageVariation().Variation == android.CoreVariation {
974 required = append(required, c.Properties.Target.Platform.Required...)
975 required = removeListFromList(required, c.Properties.Target.Platform.Exclude_required)
976 } else if c.InRecovery() {
977 required = append(required, c.Properties.Target.Recovery.Required...)
978 required = removeListFromList(required, c.Properties.Target.Recovery.Exclude_required)
979 }
980 return android.FirstUniqueStrings(required)
981}
982
Ivan Lozano52767be2019-10-18 14:49:46 -0700983func (c *Module) Toc() android.OptionalPath {
984 if c.linker != nil {
985 if library, ok := c.linker.(libraryInterface); ok {
986 return library.toc()
987 }
988 }
989 panic(fmt.Errorf("Toc() called on non-library module: %q", c.BaseModuleName()))
990}
991
992func (c *Module) ApiLevel() string {
993 if c.linker != nil {
994 if stub, ok := c.linker.(*stubDecorator); ok {
Dan Albert1a246272020-07-06 14:49:35 -0700995 return stub.apiLevel.String()
Ivan Lozano52767be2019-10-18 14:49:46 -0700996 }
997 }
998 panic(fmt.Errorf("ApiLevel() called on non-stub library module: %q", c.BaseModuleName()))
999}
1000
1001func (c *Module) Static() bool {
1002 if c.linker != nil {
1003 if library, ok := c.linker.(libraryInterface); ok {
1004 return library.static()
1005 }
1006 }
1007 panic(fmt.Errorf("Static() called on non-library module: %q", c.BaseModuleName()))
1008}
1009
1010func (c *Module) Shared() bool {
1011 if c.linker != nil {
1012 if library, ok := c.linker.(libraryInterface); ok {
1013 return library.shared()
1014 }
1015 }
Lukacs T. Berki6c716762022-06-13 20:50:39 +02001016
Ivan Lozano52767be2019-10-18 14:49:46 -07001017 panic(fmt.Errorf("Shared() called on non-library module: %q", c.BaseModuleName()))
1018}
1019
1020func (c *Module) SelectedStl() string {
Colin Crossc511bc52020-04-07 16:50:32 +00001021 if c.stl != nil {
1022 return c.stl.Properties.SelectedStl
1023 }
1024 return ""
Ivan Lozano52767be2019-10-18 14:49:46 -07001025}
1026
Ivan Lozano52767be2019-10-18 14:49:46 -07001027func (c *Module) StubDecorator() bool {
1028 if _, ok := c.linker.(*stubDecorator); ok {
1029 return true
1030 }
1031 return false
1032}
1033
Yi Kong5786f5c2024-05-28 02:22:34 +09001034func (c *Module) OptimizeForSize() bool {
1035 return Bool(c.Properties.Optimize_for_size)
1036}
1037
Ivan Lozano52767be2019-10-18 14:49:46 -07001038func (c *Module) SdkVersion() string {
1039 return String(c.Properties.Sdk_version)
1040}
1041
Artur Satayev480e25b2020-04-27 18:53:18 +01001042func (c *Module) MinSdkVersion() string {
1043 return String(c.Properties.Min_sdk_version)
1044}
1045
Jiyong Park5df7bd32021-08-25 16:18:46 +09001046func (c *Module) isCrt() bool {
Dan Albert92fe7402020-07-15 13:33:30 -07001047 if linker, ok := c.linker.(*objectLinker); ok {
1048 return linker.isCrt()
1049 }
1050 return false
1051}
1052
Jiyong Park5df7bd32021-08-25 16:18:46 +09001053func (c *Module) SplitPerApiLevel() bool {
1054 return c.canUseSdk() && c.isCrt()
1055}
1056
Colin Crossc511bc52020-04-07 16:50:32 +00001057func (c *Module) AlwaysSdk() bool {
1058 return c.Properties.AlwaysSdk || Bool(c.Properties.Sdk_variant_only)
1059}
1060
Ivan Lozano183a3212019-10-18 14:18:45 -07001061func (c *Module) CcLibrary() bool {
1062 if c.linker != nil {
1063 if _, ok := c.linker.(*libraryDecorator); ok {
1064 return true
1065 }
Colin Crossd48fe732020-09-23 20:37:24 -07001066 if _, ok := c.linker.(*prebuiltLibraryLinker); ok {
1067 return true
1068 }
Ivan Lozano183a3212019-10-18 14:18:45 -07001069 }
1070 return false
1071}
1072
1073func (c *Module) CcLibraryInterface() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001074 if _, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001075 return true
1076 }
1077 return false
1078}
1079
Ivan Lozanoadd122a2023-07-13 11:01:41 -04001080func (c *Module) RlibStd() bool {
1081 panic(fmt.Errorf("RlibStd called on non-Rust module: %q", c.BaseModuleName()))
1082}
1083
Ivan Lozano61c02cc2023-06-09 14:06:44 -04001084func (c *Module) RustLibraryInterface() bool {
1085 return false
1086}
1087
Ivan Lozano0a468a42024-05-13 21:03:34 -04001088func (c *Module) CrateName() string {
1089 panic(fmt.Errorf("CrateName called on non-Rust module: %q", c.BaseModuleName()))
1090}
1091
1092func (c *Module) ExportedCrateLinkDirs() []string {
1093 panic(fmt.Errorf("ExportedCrateLinkDirs called on non-Rust module: %q", c.BaseModuleName()))
1094}
1095
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001096func (c *Module) IsFuzzModule() bool {
1097 if _, ok := c.compiler.(*fuzzBinary); ok {
1098 return true
1099 }
1100 return false
1101}
1102
1103func (c *Module) FuzzModuleStruct() fuzz.FuzzModule {
1104 return c.FuzzModule
1105}
1106
1107func (c *Module) FuzzPackagedModule() fuzz.FuzzPackagedModule {
1108 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1109 return fuzzer.fuzzPackagedModule
1110 }
1111 panic(fmt.Errorf("FuzzPackagedModule called on non-fuzz module: %q", c.BaseModuleName()))
1112}
1113
Hamzeh Zawawy38917492023-04-05 22:08:46 +00001114func (c *Module) FuzzSharedLibraries() android.RuleBuilderInstalls {
Ivan Lozano0f9963e2023-02-06 13:31:02 -05001115 if fuzzer, ok := c.compiler.(*fuzzBinary); ok {
1116 return fuzzer.sharedLibraries
1117 }
1118 panic(fmt.Errorf("FuzzSharedLibraries called on non-fuzz module: %q", c.BaseModuleName()))
1119}
1120
Ivan Lozano2b262972019-11-21 12:30:50 -08001121func (c *Module) NonCcVariants() bool {
1122 return false
1123}
1124
Ivan Lozano183a3212019-10-18 14:18:45 -07001125func (c *Module) SetStatic() {
1126 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001127 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001128 library.setStatic()
1129 return
1130 }
1131 }
1132 panic(fmt.Errorf("SetStatic called on non-library module: %q", c.BaseModuleName()))
1133}
1134
1135func (c *Module) SetShared() {
1136 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001137 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001138 library.setShared()
1139 return
1140 }
1141 }
1142 panic(fmt.Errorf("SetShared called on non-library module: %q", c.BaseModuleName()))
1143}
1144
1145func (c *Module) BuildStaticVariant() bool {
1146 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001147 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001148 return library.buildStatic()
1149 }
1150 }
1151 panic(fmt.Errorf("BuildStaticVariant called on non-library module: %q", c.BaseModuleName()))
1152}
1153
1154func (c *Module) BuildSharedVariant() bool {
1155 if c.linker != nil {
Ivan Lozano52767be2019-10-18 14:49:46 -07001156 if library, ok := c.linker.(libraryInterface); ok {
Ivan Lozano183a3212019-10-18 14:18:45 -07001157 return library.buildShared()
1158 }
1159 }
1160 panic(fmt.Errorf("BuildSharedVariant called on non-library module: %q", c.BaseModuleName()))
1161}
1162
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001163func (c *Module) BuildRlibVariant() bool {
1164 // cc modules can never build rlib variants
1165 return false
1166}
1167
1168func (c *Module) IsRustFFI() bool {
1169 // cc modules are not Rust modules
1170 return false
1171}
1172
Ivan Lozano183a3212019-10-18 14:18:45 -07001173func (c *Module) Module() android.Module {
1174 return c
1175}
1176
Jiyong Parkc20eee32018-09-05 22:36:17 +09001177func (c *Module) OutputFile() android.OptionalPath {
1178 return c.outputFile
1179}
1180
Ivan Lozanoa0cd8f92020-04-09 09:56:02 -04001181func (c *Module) CoverageFiles() android.Paths {
1182 if c.linker != nil {
1183 if library, ok := c.linker.(libraryInterface); ok {
1184 return library.objs().coverageFiles
1185 }
1186 }
1187 panic(fmt.Errorf("CoverageFiles called on non-library module: %q", c.BaseModuleName()))
1188}
1189
Ivan Lozano183a3212019-10-18 14:18:45 -07001190var _ LinkableInterface = (*Module)(nil)
1191
Jiyong Park719b4462019-01-13 00:39:51 +09001192func (c *Module) UnstrippedOutputFile() android.Path {
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001193 if c.linker != nil {
1194 return c.linker.unstrippedOutputFilePath()
Jiyong Park719b4462019-01-13 00:39:51 +09001195 }
1196 return nil
1197}
1198
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001199func (c *Module) CoverageOutputFile() android.OptionalPath {
1200 if c.linker != nil {
1201 return c.linker.coverageOutputFilePath()
1202 }
1203 return android.OptionalPath{}
1204}
1205
Jiyong Parkb7c24df2019-02-01 12:03:59 +09001206func (c *Module) RelativeInstallPath() string {
1207 if c.installer != nil {
1208 return c.installer.relativeInstallPath()
1209 }
1210 return ""
1211}
1212
Jooyung Han344d5432019-08-23 11:17:39 +09001213func (c *Module) VndkVersion() string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001214 return c.Properties.VndkVersion
Jooyung Han344d5432019-08-23 11:17:39 +09001215}
1216
Colin Cross36242852017-06-23 15:06:31 -07001217func (c *Module) Init() android.Module {
Dan Willemsenf923f2b2018-05-09 13:45:03 -07001218 c.AddProperties(&c.Properties, &c.VendorProperties)
Joe Onorato37f900c2023-07-18 16:58:16 -07001219 for _, generator := range c.generators {
1220 c.AddProperties(generator.GeneratorProps()...)
1221 }
Colin Crossca860ac2016-01-04 14:34:37 -08001222 if c.compiler != nil {
Colin Cross36242852017-06-23 15:06:31 -07001223 c.AddProperties(c.compiler.compilerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001224 }
1225 if c.linker != nil {
Colin Cross36242852017-06-23 15:06:31 -07001226 c.AddProperties(c.linker.linkerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001227 }
1228 if c.installer != nil {
Colin Cross36242852017-06-23 15:06:31 -07001229 c.AddProperties(c.installer.installerProps()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001230 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001231 if c.stl != nil {
Colin Cross36242852017-06-23 15:06:31 -07001232 c.AddProperties(c.stl.props()...)
Colin Crossa8e07cc2016-04-04 15:07:06 -07001233 }
Colin Cross16b23492016-01-06 14:41:07 -08001234 if c.sanitize != nil {
Colin Cross36242852017-06-23 15:06:31 -07001235 c.AddProperties(c.sanitize.props()...)
Colin Cross16b23492016-01-06 14:41:07 -08001236 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001237 if c.coverage != nil {
Colin Cross36242852017-06-23 15:06:31 -07001238 c.AddProperties(c.coverage.props()...)
Dan Willemsen581341d2017-02-09 16:16:31 -08001239 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001240 if c.fuzzer != nil {
1241 c.AddProperties(c.fuzzer.props()...)
1242 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001243 if c.sabi != nil {
Colin Cross36242852017-06-23 15:06:31 -07001244 c.AddProperties(c.sabi.props()...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001245 }
Stephen Craneba090d12017-05-09 15:44:35 -07001246 if c.lto != nil {
1247 c.AddProperties(c.lto.props()...)
1248 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001249 if c.afdo != nil {
1250 c.AddProperties(c.afdo.props()...)
1251 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001252 if c.orderfile != nil {
1253 c.AddProperties(c.orderfile.props()...)
1254 }
Colin Crossca860ac2016-01-04 14:34:37 -08001255 for _, feature := range c.features {
Colin Cross36242852017-06-23 15:06:31 -07001256 c.AddProperties(feature.props()...)
Colin Crossca860ac2016-01-04 14:34:37 -08001257 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07001258 // Allow test-only on libraries that are not cc_test_library
1259 if c.library != nil && !c.testLibrary() {
1260 c.AddProperties(&c.sourceProperties)
1261 }
Colin Crossc472d572015-03-17 15:06:21 -07001262
Colin Cross36242852017-06-23 15:06:31 -07001263 android.InitAndroidArchModule(c, c.hod, c.multilib)
Jiyong Park7916bfc2019-09-30 19:13:12 +09001264 android.InitApexModule(c)
Jooyung Han18020ea2019-11-13 10:50:48 +09001265 android.InitDefaultableModule(c)
Jiyong Park9d452992018-10-03 00:38:19 +09001266
Colin Cross36242852017-06-23 15:06:31 -07001267 return c
Colin Crossc472d572015-03-17 15:06:21 -07001268}
1269
Yi-Yo Chiang1080f0c2022-11-22 18:24:14 +08001270// UseVndk() returns true if this module is built against VNDK.
1271// This means the vendor and product variants of a module.
Ivan Lozano52767be2019-10-18 14:49:46 -07001272func (c *Module) UseVndk() bool {
Inseob Kim64c43952019-08-26 16:52:35 +09001273 return c.Properties.VndkVersion != ""
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001274}
1275
Colin Crossc511bc52020-04-07 16:50:32 +00001276func (c *Module) canUseSdk() bool {
Colin Cross94e347e2021-01-19 14:56:07 -08001277 return c.Os() == android.Android && c.Target().NativeBridge == android.NativeBridgeDisabled &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001278 !c.InVendorOrProduct() && !c.InRamdisk() && !c.InRecovery() && !c.InVendorRamdisk()
Colin Crossc511bc52020-04-07 16:50:32 +00001279}
1280
1281func (c *Module) UseSdk() bool {
1282 if c.canUseSdk() {
Colin Cross1348ce32020-10-01 13:37:16 -07001283 return String(c.Properties.Sdk_version) != ""
Colin Crossc511bc52020-04-07 16:50:32 +00001284 }
1285 return false
1286}
1287
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001288func (c *Module) isCoverageVariant() bool {
1289 return c.coverage.Properties.IsCoverageVariant
1290}
1291
Colin Cross95f1ca02020-10-29 20:47:22 -07001292func (c *Module) IsNdk(config android.Config) bool {
1293 return inList(c.BaseModuleName(), *getNDKKnownLibs(config))
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001294}
1295
Colin Cross127bb8b2020-12-16 16:46:01 -08001296func (c *Module) IsLlndk() bool {
1297 return c.VendorProperties.IsLLNDK
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001298}
1299
Colin Cross1f3f1302021-04-26 18:37:44 -07001300func (m *Module) NeedsLlndkVariants() bool {
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001301 lib := moduleLibraryInterface(m)
Colin Cross1f3f1302021-04-26 18:37:44 -07001302 return lib != nil && (lib.hasLLNDKStubs() || lib.hasLLNDKHeaders())
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001303}
1304
Colin Cross5271fea2021-04-27 13:06:04 -07001305func (m *Module) NeedsVendorPublicLibraryVariants() bool {
1306 lib := moduleLibraryInterface(m)
1307 return lib != nil && (lib.hasVendorPublicLibrary())
1308}
1309
1310// IsVendorPublicLibrary returns true for vendor public libraries.
1311func (c *Module) IsVendorPublicLibrary() bool {
1312 return c.VendorProperties.IsVendorPublicLibrary
1313}
1314
Ivan Lozanof1868af2022-04-12 13:08:36 -04001315func (c *Module) IsVndkPrebuiltLibrary() bool {
1316 if _, ok := c.linker.(*vndkPrebuiltLibraryDecorator); ok {
1317 return true
1318 }
1319 return false
1320}
1321
1322func (c *Module) SdkAndPlatformVariantVisibleToMake() bool {
1323 return c.Properties.SdkAndPlatformVariantVisibleToMake
1324}
1325
Ivan Lozanod7586b62021-04-01 09:49:36 -04001326func (c *Module) HasLlndkStubs() bool {
1327 lib := moduleLibraryInterface(c)
1328 return lib != nil && lib.hasLLNDKStubs()
1329}
1330
1331func (c *Module) StubsVersion() string {
1332 if lib, ok := c.linker.(versionedInterface); ok {
1333 return lib.stubsVersion()
1334 }
1335 panic(fmt.Errorf("StubsVersion called on non-versioned module: %q", c.BaseModuleName()))
1336}
1337
Colin Cross127bb8b2020-12-16 16:46:01 -08001338// isImplementationForLLNDKPublic returns true for any variant of a cc_library that has LLNDK stubs
1339// and does not set llndk.vendor_available: false.
1340func (c *Module) isImplementationForLLNDKPublic() bool {
1341 library, _ := c.library.(*libraryDecorator)
1342 return library != nil && library.hasLLNDKStubs() &&
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001343 !Bool(library.Properties.Llndk.Private)
Colin Cross127bb8b2020-12-16 16:46:01 -08001344}
1345
Colin Cross3513fb12024-01-24 14:44:47 -08001346func (c *Module) isAfdoCompile(ctx ModuleContext) bool {
Yi Kong4ef54592022-02-14 20:00:10 +08001347 if afdo := c.afdo; afdo != nil {
Colin Cross3513fb12024-01-24 14:44:47 -08001348 return afdo.isAfdoCompile(ctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001349 }
1350 return false
1351}
1352
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001353func (c *Module) isOrderfileCompile() bool {
1354 if orderfile := c.orderfile; orderfile != nil {
1355 return orderfile.Properties.OrderfileLoad
1356 }
1357 return false
1358}
1359
Yi Kongc702ebd2022-08-19 16:02:45 +08001360func (c *Module) isCfi() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001361 return c.sanitize.isSanitizerEnabled(cfi)
Yi Kongc702ebd2022-08-19 16:02:45 +08001362}
1363
Yi Konged79fa32023-06-04 17:15:42 +09001364func (c *Module) isFuzzer() bool {
Colin Cross694fced2024-06-25 14:56:42 -07001365 return c.sanitize.isSanitizerEnabled(Fuzzer)
Yi Konged79fa32023-06-04 17:15:42 +09001366}
1367
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001368func (c *Module) isNDKStubLibrary() bool {
1369 if _, ok := c.compiler.(*stubDecorator); ok {
1370 return true
1371 }
1372 return false
1373}
1374
Ivan Lozanoc08897c2021-04-02 12:41:32 -04001375func (c *Module) SubName() string {
1376 return c.Properties.SubName
1377}
1378
Jiyong Park25fc6a92018-11-18 18:02:45 +09001379func (c *Module) IsStubs() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001380 if lib := c.library; lib != nil {
1381 return lib.buildStubs()
Jiyong Park25fc6a92018-11-18 18:02:45 +09001382 }
1383 return false
1384}
1385
1386func (c *Module) HasStubsVariants() bool {
Colin Cross31076b32020-10-23 17:22:06 -07001387 if lib := c.library; lib != nil {
1388 return lib.hasStubsVariants()
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001389 }
Jiyong Park25fc6a92018-11-18 18:02:45 +09001390 return false
1391}
1392
Alan Stokes73feba32022-11-14 12:21:24 +00001393func (c *Module) IsStubsImplementationRequired() bool {
1394 if lib := c.library; lib != nil {
1395 return lib.isStubsImplementationRequired()
1396 }
1397 return false
1398}
1399
Colin Cross0477b422020-10-13 18:43:54 -07001400// If this is a stubs library, ImplementationModuleName returns the name of the module that contains
1401// the implementation. If it is an implementation library it returns its own name.
1402func (c *Module) ImplementationModuleName(ctx android.BaseModuleContext) string {
1403 name := ctx.OtherModuleName(c)
1404 if versioned, ok := c.linker.(versionedInterface); ok {
1405 name = versioned.implementationModuleName(name)
1406 }
1407 return name
1408}
1409
Martin Stjernholm2856c662020-12-02 15:03:42 +00001410// Similar to ImplementationModuleName, but uses the Make variant of the module
1411// name as base name, for use in AndroidMk output. E.g. for a prebuilt module
1412// where the Soong name is prebuilt_foo, this returns foo (which works in Make
1413// under the premise that the prebuilt module overrides its source counterpart
1414// if it is exposed to Make).
1415func (c *Module) ImplementationModuleNameForMake(ctx android.BaseModuleContext) string {
1416 name := c.BaseModuleName()
1417 if versioned, ok := c.linker.(versionedInterface); ok {
1418 name = versioned.implementationModuleName(name)
1419 }
1420 return name
1421}
1422
Jiyong Park7d55b612021-06-11 17:22:09 +09001423func (c *Module) Bootstrap() bool {
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001424 return Bool(c.Properties.Bootstrap)
1425}
1426
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001427func (c *Module) nativeCoverage() bool {
Pirama Arumuga Nainar5f69b9a2019-09-12 13:18:48 -07001428 // Bug: http://b/137883967 - native-bridge modules do not currently work with coverage
1429 if c.Target().NativeBridge == android.NativeBridgeEnabled {
1430 return false
1431 }
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001432 return c.linker != nil && c.linker.nativeCoverage()
1433}
1434
Ivan Lozano3a7d0002021-03-30 12:19:36 -04001435func (c *Module) IsSnapshotPrebuilt() bool {
Ivan Lozanod1dec542021-05-26 15:33:11 -04001436 if p, ok := c.linker.(SnapshotInterface); ok {
1437 return p.IsSnapshotPrebuilt()
Inseob Kimeec88e12020-01-22 11:11:29 +09001438 }
1439 return false
Inseob Kim8471cda2019-11-15 09:59:12 +09001440}
1441
Jiyong Parkf1194352019-02-25 11:05:47 +09001442func isBionic(name string) bool {
1443 switch name {
Jooyung Hanbff73352022-12-13 18:29:44 +09001444 case "libc", "libm", "libdl", "libdl_android", "linker":
Jiyong Parkf1194352019-02-25 11:05:47 +09001445 return true
1446 }
1447 return false
1448}
1449
Martin Stjernholm279de572019-09-10 23:18:20 +01001450func InstallToBootstrap(name string, config android.Config) bool {
Florian Mayer95cd6db2023-03-23 17:48:07 -07001451 if name == "libclang_rt.hwasan" || name == "libc_hwasan" {
Jooyung Han8ce8db92020-05-15 19:05:05 +09001452 return true
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001453 }
1454 return isBionic(name)
1455}
1456
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001457func (c *Module) XrefCcFiles() android.Paths {
1458 return c.kytheFiles
1459}
1460
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001461func (c *Module) isCfiAssemblySupportEnabled() bool {
1462 return c.sanitize != nil &&
1463 Bool(c.sanitize.Properties.Sanitize.Config.Cfi_assembly_support)
1464}
1465
Inseob Kim800d1142021-06-14 12:03:51 +09001466func (c *Module) InstallInRoot() bool {
1467 return c.installer != nil && c.installer.installInRoot()
1468}
1469
Colin Crossca860ac2016-01-04 14:34:37 -08001470type baseModuleContext struct {
Colin Cross0ea8ba82019-06-06 14:33:29 -07001471 android.BaseModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001472 moduleContextImpl
1473}
1474
Colin Cross37047f12016-12-13 17:06:13 -08001475type depsContext struct {
1476 android.BottomUpMutatorContext
1477 moduleContextImpl
1478}
1479
Colin Crossca860ac2016-01-04 14:34:37 -08001480type moduleContext struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001481 android.ModuleContext
Colin Crossca860ac2016-01-04 14:34:37 -08001482 moduleContextImpl
1483}
1484
1485type moduleContextImpl struct {
1486 mod *Module
1487 ctx BaseModuleContext
1488}
1489
Colin Crossb98c8b02016-07-29 13:44:28 -07001490func (ctx *moduleContextImpl) toolchain() config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08001491 return ctx.mod.toolchain(ctx.ctx)
1492}
1493
1494func (ctx *moduleContextImpl) static() bool {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001495 return ctx.mod.static()
Colin Crossca860ac2016-01-04 14:34:37 -08001496}
1497
1498func (ctx *moduleContextImpl) staticBinary() bool {
Jiyong Park379de2f2018-12-19 02:47:14 +09001499 return ctx.mod.staticBinary()
Colin Crossca860ac2016-01-04 14:34:37 -08001500}
1501
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07001502func (ctx *moduleContextImpl) testBinary() bool {
1503 return ctx.mod.testBinary()
1504}
1505
Yi Kong56fc1b62022-09-06 16:24:00 +08001506func (ctx *moduleContextImpl) testLibrary() bool {
1507 return ctx.mod.testLibrary()
1508}
1509
Jiyong Park1d1119f2019-07-29 21:27:18 +09001510func (ctx *moduleContextImpl) header() bool {
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001511 return ctx.mod.Header()
Jiyong Park1d1119f2019-07-29 21:27:18 +09001512}
1513
Inseob Kim7f283f42020-06-01 21:53:49 +09001514func (ctx *moduleContextImpl) binary() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001515 return ctx.mod.Binary()
Inseob Kim7f283f42020-06-01 21:53:49 +09001516}
1517
Inseob Kim1042d292020-06-01 23:23:05 +09001518func (ctx *moduleContextImpl) object() bool {
Ivan Lozanod7586b62021-04-01 09:49:36 -04001519 return ctx.mod.Object()
Inseob Kim1042d292020-06-01 23:23:05 +09001520}
1521
Yi Kong5786f5c2024-05-28 02:22:34 +09001522func (ctx *moduleContextImpl) optimizeForSize() bool {
1523 return ctx.mod.OptimizeForSize()
1524}
1525
Jooyung Hanccce2f22020-03-07 03:45:53 +09001526func (ctx *moduleContextImpl) canUseSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001527 return ctx.mod.canUseSdk()
Jooyung Hanccce2f22020-03-07 03:45:53 +09001528}
1529
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001530func (ctx *moduleContextImpl) useSdk() bool {
Colin Crossc511bc52020-04-07 16:50:32 +00001531 return ctx.mod.UseSdk()
Colin Crossca860ac2016-01-04 14:34:37 -08001532}
1533
1534func (ctx *moduleContextImpl) sdkVersion() string {
Dan Willemsena96ff642016-06-07 12:34:45 -07001535 if ctx.ctx.Device() {
Justin Yun732aa6a2018-03-23 17:43:47 +09001536 return String(ctx.mod.Properties.Sdk_version)
Dan Willemsena96ff642016-06-07 12:34:45 -07001537 }
1538 return ""
Colin Crossca860ac2016-01-04 14:34:37 -08001539}
1540
Jiyong Parkb35a8192020-08-10 15:59:36 +09001541func (ctx *moduleContextImpl) minSdkVersion() string {
1542 ver := ctx.mod.MinSdkVersion()
1543 if ver == "apex_inherit" && !ctx.isForPlatform() {
1544 ver = ctx.apexSdkVersion().String()
1545 }
1546 if ver == "apex_inherit" || ver == "" {
1547 ver = ctx.sdkVersion()
1548 }
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001549
1550 if ctx.ctx.Device() {
1551 config := ctx.ctx.Config()
Kiyoung Kim8f05c542024-05-22 16:50:34 +09001552 if ctx.inVendor() {
Yi-Yo Chiang88960aa2024-01-19 15:02:29 +08001553 // If building for vendor with final API, then use the latest _stable_ API as "current".
1554 if config.VendorApiLevelFrozen() && (ver == "" || ver == "current") {
1555 ver = config.PlatformSdkVersion().String()
1556 }
1557 }
1558 }
1559
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001560 // For crt objects, the meaning of min_sdk_version is very different from other types of
1561 // module. For them, min_sdk_version defines the oldest version that the build system will
1562 // create versioned variants for. For example, if min_sdk_version is 16, then sdk variant of
1563 // the crt object has local variants of 16, 17, ..., up to the latest version. sdk_version
1564 // and min_sdk_version properties of the variants are set to the corresponding version
Jiyong Park5df7bd32021-08-25 16:18:46 +09001565 // numbers. However, the non-sdk variant (for apex or platform) of the crt object is left
1566 // untouched. min_sdk_version: 16 doesn't actually mean that the non-sdk variant has to
1567 // support such an old version. The version is set to the later version in case when the
1568 // non-sdk variant is for the platform, or the min_sdk_version of the containing APEX if
1569 // it's for an APEX.
1570 if ctx.mod.isCrt() && !ctx.isSdkVariant() {
1571 if ctx.isForPlatform() {
1572 ver = strconv.Itoa(android.FutureApiLevelInt)
1573 } else { // for apex
1574 ver = ctx.apexSdkVersion().String()
1575 if ver == "" { // in case when min_sdk_version was not set by the APEX
1576 ver = ctx.sdkVersion()
1577 }
1578 }
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09001579 }
1580
Jiyong Parkb35a8192020-08-10 15:59:36 +09001581 // Also make sure that minSdkVersion is not greater than sdkVersion, if they are both numbers
1582 sdkVersionInt, err := strconv.Atoi(ctx.sdkVersion())
1583 minSdkVersionInt, err2 := strconv.Atoi(ver)
1584 if err == nil && err2 == nil {
1585 if sdkVersionInt < minSdkVersionInt {
1586 return strconv.Itoa(sdkVersionInt)
1587 }
1588 }
1589 return ver
1590}
1591
1592func (ctx *moduleContextImpl) isSdkVariant() bool {
1593 return ctx.mod.IsSdkVariant()
1594}
1595
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001596func (ctx *moduleContextImpl) useVndk() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07001597 return ctx.mod.UseVndk()
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07001598}
Justin Yun8effde42017-06-23 19:24:43 +09001599
Kiyoung Kimaa394802024-01-08 12:55:45 +09001600func (ctx *moduleContextImpl) InVendorOrProduct() bool {
1601 return ctx.mod.InVendorOrProduct()
1602}
1603
Colin Cross95f1ca02020-10-29 20:47:22 -07001604func (ctx *moduleContextImpl) isNdk(config android.Config) bool {
1605 return ctx.mod.IsNdk(config)
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001606}
1607
Colin Cross127bb8b2020-12-16 16:46:01 -08001608func (ctx *moduleContextImpl) IsLlndk() bool {
1609 return ctx.mod.IsLlndk()
Logan Chienf6dbd9c2019-01-16 20:19:51 +08001610}
1611
Colin Cross127bb8b2020-12-16 16:46:01 -08001612func (ctx *moduleContextImpl) isImplementationForLLNDKPublic() bool {
1613 return ctx.mod.isImplementationForLLNDKPublic()
1614}
1615
Colin Cross3513fb12024-01-24 14:44:47 -08001616func (ctx *moduleContextImpl) isAfdoCompile(mctx ModuleContext) bool {
1617 return ctx.mod.isAfdoCompile(mctx)
Yi Kong4ef54592022-02-14 20:00:10 +08001618}
1619
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001620func (ctx *moduleContextImpl) isOrderfileCompile() bool {
1621 return ctx.mod.isOrderfileCompile()
1622}
1623
Yi Kongc702ebd2022-08-19 16:02:45 +08001624func (ctx *moduleContextImpl) isCfi() bool {
1625 return ctx.mod.isCfi()
1626}
1627
Yi Konged79fa32023-06-04 17:15:42 +09001628func (ctx *moduleContextImpl) isFuzzer() bool {
1629 return ctx.mod.isFuzzer()
1630}
1631
Pirama Arumuga Nainar1acd4472018-12-10 15:12:40 -08001632func (ctx *moduleContextImpl) isNDKStubLibrary() bool {
1633 return ctx.mod.isNDKStubLibrary()
1634}
1635
Colin Cross5271fea2021-04-27 13:06:04 -07001636func (ctx *moduleContextImpl) IsVendorPublicLibrary() bool {
1637 return ctx.mod.IsVendorPublicLibrary()
1638}
1639
Dan Willemsen8146b2f2016-03-30 21:00:30 -07001640func (ctx *moduleContextImpl) selectedStl() string {
1641 if stl := ctx.mod.stl; stl != nil {
1642 return stl.Properties.SelectedStl
1643 }
1644 return ""
1645}
1646
Ivan Lozanobd721262018-11-27 14:33:03 -08001647func (ctx *moduleContextImpl) useClangLld(actx ModuleContext) bool {
1648 return ctx.mod.linker.useClangLld(actx)
1649}
1650
Colin Crossce75d2c2016-10-06 16:12:58 -07001651func (ctx *moduleContextImpl) baseModuleName() string {
Spandan Das2b6dfb52024-01-19 00:22:22 +00001652 return ctx.mod.BaseModuleName()
Colin Crossce75d2c2016-10-06 16:12:58 -07001653}
1654
Logan Chiene274fc92019-12-03 11:18:32 -08001655func (ctx *moduleContextImpl) isForPlatform() bool {
Colin Crossff694a82023-12-13 15:54:49 -08001656 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1657 return apexInfo.IsForPlatform()
Logan Chiene274fc92019-12-03 11:18:32 -08001658}
1659
Colin Crosse07f2312020-08-13 11:24:56 -07001660func (ctx *moduleContextImpl) apexVariationName() string {
Colin Crossff694a82023-12-13 15:54:49 -08001661 apexInfo, _ := android.ModuleProvider(ctx.ctx, android.ApexInfoProvider)
1662 return apexInfo.ApexVariationName
Jiyong Park25fc6a92018-11-18 18:02:45 +09001663}
1664
Dan Albertc8060532020-07-22 22:32:17 -07001665func (ctx *moduleContextImpl) apexSdkVersion() android.ApiLevel {
Jooyung Han75568392020-03-20 04:29:24 +09001666 return ctx.mod.apexSdkVersion
Jooyung Hanccce2f22020-03-07 03:45:53 +09001667}
1668
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001669func (ctx *moduleContextImpl) bootstrap() bool {
Jiyong Park7d55b612021-06-11 17:22:09 +09001670 return ctx.mod.Bootstrap()
Jiyong Parka4b9dd02019-01-16 22:53:13 +09001671}
1672
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001673func (ctx *moduleContextImpl) nativeCoverage() bool {
1674 return ctx.mod.nativeCoverage()
1675}
1676
Colin Cross56a83212020-09-15 18:30:11 -07001677func (ctx *moduleContextImpl) directlyInAnyApex() bool {
1678 return ctx.mod.DirectlyInAnyApex()
1679}
1680
Colin Cross95b07f22020-12-16 11:06:50 -08001681func (ctx *moduleContextImpl) isPreventInstall() bool {
1682 return ctx.mod.Properties.PreventInstall
1683}
1684
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001685func (ctx *moduleContextImpl) getSharedFlags() *SharedFlags {
1686 shared := &ctx.mod.sharedFlags
1687 if shared.flagsMap == nil {
1688 shared.numSharedFlags = 0
1689 shared.flagsMap = make(map[string]string)
1690 }
1691 return shared
1692}
1693
Cindy Zhou5d5cfc12021-01-09 08:25:22 -08001694func (ctx *moduleContextImpl) isCfiAssemblySupportEnabled() bool {
1695 return ctx.mod.isCfiAssemblySupportEnabled()
1696}
1697
Colin Cross4a9e6ec2023-12-18 15:29:41 -08001698func (ctx *moduleContextImpl) notInPlatform() bool {
1699 return ctx.mod.NotInPlatform()
1700}
1701
Colin Cross635c3b02016-05-18 15:37:25 -07001702func newBaseModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001703 return &Module{
1704 hod: hod,
1705 multilib: multilib,
1706 }
1707}
1708
Colin Cross635c3b02016-05-18 15:37:25 -07001709func newModule(hod android.HostOrDeviceSupported, multilib android.Multilib) *Module {
Colin Crossca860ac2016-01-04 14:34:37 -08001710 module := newBaseModule(hod, multilib)
Dan Willemsena03cf6d2016-09-26 15:45:04 -07001711 module.features = []feature{
1712 &tidyFeature{},
1713 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001714 module.stl = &stl{}
Colin Cross16b23492016-01-06 14:41:07 -08001715 module.sanitize = &sanitize{}
Dan Willemsen581341d2017-02-09 16:16:31 -08001716 module.coverage = &coverage{}
Cory Barkera1da26f2022-06-07 20:12:06 +00001717 module.fuzzer = &fuzzer{}
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001718 module.sabi = &sabi{}
Stephen Craneba090d12017-05-09 15:44:35 -07001719 module.lto = &lto{}
Yi Kongeb8efc92021-12-09 18:06:29 +08001720 module.afdo = &afdo{}
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001721 module.orderfile = &orderfile{}
Colin Crossca860ac2016-01-04 14:34:37 -08001722 return module
1723}
1724
Colin Crossce75d2c2016-10-06 16:12:58 -07001725func (c *Module) Prebuilt() *android.Prebuilt {
1726 if p, ok := c.linker.(prebuiltLinkerInterface); ok {
1727 return p.prebuilt()
1728 }
1729 return nil
1730}
1731
Ivan Lozano3968d8f2020-12-14 11:27:52 -05001732func (c *Module) IsPrebuilt() bool {
1733 return c.Prebuilt() != nil
1734}
1735
Colin Crossce75d2c2016-10-06 16:12:58 -07001736func (c *Module) Name() string {
1737 name := c.ModuleBase.Name()
Dan Willemsen01a90592017-04-07 15:21:13 -07001738 if p, ok := c.linker.(interface {
1739 Name(string) string
1740 }); ok {
Colin Crossce75d2c2016-10-06 16:12:58 -07001741 name = p.Name(name)
1742 }
1743 return name
1744}
1745
Alex Light3d673592019-01-18 14:37:31 -08001746func (c *Module) Symlinks() []string {
1747 if p, ok := c.installer.(interface {
1748 symlinkList() []string
1749 }); ok {
1750 return p.symlinkList()
1751 }
1752 return nil
1753}
1754
Chris Parsons216e10a2020-07-09 17:12:52 -04001755func (c *Module) DataPaths() []android.DataPath {
Liz Kammer1c14a212020-05-12 15:26:55 -07001756 if p, ok := c.installer.(interface {
Chris Parsons216e10a2020-07-09 17:12:52 -04001757 dataPaths() []android.DataPath
Liz Kammer1c14a212020-05-12 15:26:55 -07001758 }); ok {
1759 return p.dataPaths()
1760 }
1761 return nil
1762}
1763
Ivan Lozanof1868af2022-04-12 13:08:36 -04001764func getNameSuffixWithVndkVersion(ctx android.ModuleContext, c LinkableInterface) string {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001765 // Returns the name suffix for product and vendor variants. If the VNDK version is not
1766 // "current", it will append the VNDK version to the name suffix.
Justin Yun5f7f7e82019-11-18 19:52:14 +09001767 var nameSuffix string
Ivan Lozanof9e21722020-12-02 09:00:51 -05001768 if c.InProduct() {
Justin Yund00f5ca2021-02-03 19:43:02 +09001769 if c.ProductSpecific() {
1770 // If the module is product specific with 'product_specific: true',
1771 // do not add a name suffix because it is a base module.
1772 return ""
1773 }
Justin Yunaf1fde42023-09-27 16:22:10 +09001774 return ProductSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001775 } else {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05001776 nameSuffix = VendorSuffix
Justin Yun5f7f7e82019-11-18 19:52:14 +09001777 }
Kiyoung Kim4e765b12024-04-04 17:33:42 +09001778 if c.VndkVersion() != "" {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001779 // add version suffix only if the module is using different vndk version than the
1780 // version in product or vendor partition.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001781 nameSuffix += "." + c.VndkVersion()
Justin Yun5f7f7e82019-11-18 19:52:14 +09001782 }
1783 return nameSuffix
1784}
1785
Ivan Lozanof1868af2022-04-12 13:08:36 -04001786func GetSubnameProperty(actx android.ModuleContext, c LinkableInterface) string {
1787 var subName = ""
Inseob Kim64c43952019-08-26 16:52:35 +09001788
1789 if c.Target().NativeBridge == android.NativeBridgeEnabled {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001790 subName += NativeBridgeSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001791 }
1792
Colin Cross127bb8b2020-12-16 16:46:01 -08001793 llndk := c.IsLlndk()
Kiyoung Kimaa394802024-01-08 12:55:45 +09001794 if llndk || (c.InVendorOrProduct() && c.HasNonSystemVariants()) {
Justin Yun5f7f7e82019-11-18 19:52:14 +09001795 // .vendor.{version} suffix is added for vendor variant or .product.{version} suffix is
1796 // added for product variant only when we have vendor and product variants with core
1797 // variant. The suffix is not added for vendor-only or product-only module.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001798 subName += getNameSuffixWithVndkVersion(actx, c)
Colin Cross5271fea2021-04-27 13:06:04 -07001799 } else if c.IsVendorPublicLibrary() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001800 subName += vendorPublicLibrarySuffix
1801 } else if c.IsVndkPrebuiltLibrary() {
Inseob Kim64c43952019-08-26 16:52:35 +09001802 // .vendor suffix is added for backward compatibility with VNDK snapshot whose names with
1803 // such suffixes are already hard-coded in prebuilts/vndk/.../Android.bp.
Ivan Lozanof1868af2022-04-12 13:08:36 -04001804 subName += VendorSuffix
Yifan Hong1b3348d2020-01-21 15:53:22 -08001805 } else if c.InRamdisk() && !c.OnlyInRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001806 subName += RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001807 } else if c.InVendorRamdisk() && !c.OnlyInVendorRamdisk() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001808 subName += VendorRamdiskSuffix
Ivan Lozano52767be2019-10-18 14:49:46 -07001809 } else if c.InRecovery() && !c.OnlyInRecovery() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001810 subName += RecoverySuffix
1811 } else if c.IsSdkVariant() && (c.SdkAndPlatformVariantVisibleToMake() || c.SplitPerApiLevel()) {
1812 subName += sdkSuffix
Dan Albert92fe7402020-07-15 13:33:30 -07001813 if c.SplitPerApiLevel() {
Ivan Lozanof1868af2022-04-12 13:08:36 -04001814 subName += "." + c.SdkVersion()
Dan Albert92fe7402020-07-15 13:33:30 -07001815 }
Spandan Dasb2b41d52023-04-13 18:15:05 +00001816 } else if c.IsStubs() && c.IsSdkVariant() {
1817 // Public API surface (NDK)
1818 // Add a suffix to this stub variant to distinguish it from the module-lib stub variant.
1819 subName = sdkSuffix
Inseob Kim64c43952019-08-26 16:52:35 +09001820 }
Ivan Lozanof1868af2022-04-12 13:08:36 -04001821
1822 return subName
Chris Parsons8d6e4332021-02-22 16:13:50 -05001823}
1824
Sam Delmerico75dbca22023-04-20 13:13:25 +00001825func moduleContextFromAndroidModuleContext(actx android.ModuleContext, c *Module) ModuleContext {
1826 ctx := &moduleContext{
1827 ModuleContext: actx,
1828 moduleContextImpl: moduleContextImpl{
1829 mod: c,
1830 },
1831 }
1832 ctx.ctx = ctx
1833 return ctx
1834}
1835
Spandan Das20fce2d2023-04-12 17:21:39 +00001836// TODO (b/277651159): Remove this allowlist
1837var (
1838 skipStubLibraryMultipleApexViolation = map[string]bool{
1839 "libclang_rt.asan": true,
1840 "libclang_rt.hwasan": true,
1841 // runtime apex
1842 "libc": true,
1843 "libc_hwasan": true,
1844 "libdl_android": true,
1845 "libm": true,
1846 "libdl": true,
Spandan Das1a0c6e12024-01-04 01:44:17 +00001847 "libz": true,
Spandan Das20fce2d2023-04-12 17:21:39 +00001848 // art apex
Martin Stjernholm75598032024-07-12 18:47:26 +01001849 // TODO(b/234351700): Remove this when com.android.art.debug is gone.
Spandan Das20fce2d2023-04-12 17:21:39 +00001850 "libandroidio": true,
1851 "libdexfile": true,
Martin Stjernholm75598032024-07-12 18:47:26 +01001852 "libdexfiled": true, // com.android.art.debug only
Spandan Das20fce2d2023-04-12 17:21:39 +00001853 "libnativebridge": true,
1854 "libnativehelper": true,
1855 "libnativeloader": true,
1856 "libsigchain": true,
1857 }
1858)
1859
1860// Returns true if a stub library could be installed in multiple apexes
1861func (c *Module) stubLibraryMultipleApexViolation(ctx android.ModuleContext) bool {
1862 // If this is not an apex variant, no check necessary
1863 if !c.InAnyApex() {
1864 return false
1865 }
1866 // If this is not a stub library, no check necessary
1867 if !c.HasStubsVariants() {
1868 return false
1869 }
1870 // Skip the allowlist
1871 // Use BaseModuleName so that this matches prebuilts.
1872 if _, exists := skipStubLibraryMultipleApexViolation[c.BaseModuleName()]; exists {
1873 return false
1874 }
1875
1876 _, aaWithoutTestApexes, _ := android.ListSetDifference(c.ApexAvailable(), c.TestApexes())
1877 // Stub libraries should not have more than one apex_available
1878 if len(aaWithoutTestApexes) > 1 {
1879 return true
1880 }
1881 // Stub libraries should not use the wildcard
1882 if aaWithoutTestApexes[0] == android.AvailableToAnyApex {
1883 return true
1884 }
1885 // Default: no violation
1886 return false
1887}
1888
Chris Parsons8d6e4332021-02-22 16:13:50 -05001889func (c *Module) GenerateAndroidBuildActions(actx android.ModuleContext) {
Ronald Braunstein6a08d492024-04-15 12:55:30 -07001890 ctx := moduleContextFromAndroidModuleContext(actx, c)
1891
Inseob Kim37e0bb02024-04-29 15:54:44 +09001892 c.logtagsPaths = android.PathsForModuleSrc(actx, c.Properties.Logtags)
1893 android.SetProvider(ctx, android.LogtagsProviderKey, &android.LogtagsInfo{
1894 Logtags: c.logtagsPaths,
1895 })
1896
Ronald Braunstein6a08d492024-04-15 12:55:30 -07001897 // If Test_only is set on a module in bp file, respect the setting, otherwise
1898 // see if is a known test module type.
1899 testOnly := c.testModule || c.testLibrary()
1900 if c.sourceProperties.Test_only != nil {
1901 testOnly = Bool(c.sourceProperties.Test_only)
1902 }
1903 // Keep before any early returns.
1904 android.SetProvider(ctx, android.TestOnlyProviderKey, android.TestModuleInformation{
1905 TestOnly: testOnly,
1906 TopLevelTarget: c.testModule,
1907 })
1908
Ivan Lozanof1868af2022-04-12 13:08:36 -04001909 c.Properties.SubName = GetSubnameProperty(actx, c)
Colin Crossff694a82023-12-13 15:54:49 -08001910 apexInfo, _ := android.ModuleProvider(actx, android.ApexInfoProvider)
Chris Parsons8d6e4332021-02-22 16:13:50 -05001911 if !apexInfo.IsForPlatform() {
1912 c.hideApexVariantFromMake = true
1913 }
1914
Chris Parsonseefc9e62021-04-02 17:36:47 -04001915 c.makeLinkType = GetMakeLinkType(actx, c)
1916
Colin Crossf18e1102017-11-16 14:33:08 -08001917 deps := c.depsToPaths(ctx)
1918 if ctx.Failed() {
1919 return
1920 }
1921
Joe Onorato37f900c2023-07-18 16:58:16 -07001922 for _, generator := range c.generators {
1923 gen := generator.GeneratorSources(ctx)
1924 deps.IncludeDirs = append(deps.IncludeDirs, gen.IncludeDirs...)
1925 deps.ReexportedDirs = append(deps.ReexportedDirs, gen.ReexportedDirs...)
1926 deps.GeneratedDeps = append(deps.GeneratedDeps, gen.Headers...)
1927 deps.ReexportedGeneratedHeaders = append(deps.ReexportedGeneratedHeaders, gen.Headers...)
1928 deps.ReexportedDeps = append(deps.ReexportedDeps, gen.Headers...)
1929 if len(deps.Objs.objFiles) == 0 {
1930 // If we are reusuing object files (which happens when we're a shared library and we're
1931 // reusing our static variant's object files), then skip adding the actual source files,
1932 // because we already have the object for it.
1933 deps.GeneratedSources = append(deps.GeneratedSources, gen.Sources...)
1934 }
1935 }
1936
1937 if ctx.Failed() {
1938 return
1939 }
1940
Spandan Das20fce2d2023-04-12 17:21:39 +00001941 if c.stubLibraryMultipleApexViolation(actx) {
1942 actx.PropertyErrorf("apex_available",
1943 "Stub libraries should have a single apex_available (test apexes excluded). Got %v", c.ApexAvailable())
1944 }
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001945 if c.Properties.Clang != nil && *c.Properties.Clang == false {
1946 ctx.PropertyErrorf("clang", "false (GCC) is no longer supported")
Alixb5f6d9e2022-04-20 23:00:58 +00001947 } else if c.Properties.Clang != nil && !ctx.DeviceConfig().BuildBrokenClangProperty() {
1948 ctx.PropertyErrorf("clang", "property is deprecated, see Changes.md file")
Dan Willemsen8536d6b2018-10-07 20:54:34 -07001949 }
1950
Colin Crossca860ac2016-01-04 14:34:37 -08001951 flags := Flags{
1952 Toolchain: c.toolchain(ctx),
Sasha Smundak2a4549e2018-11-05 16:49:08 -08001953 EmitXrefs: ctx.Config().EmitXrefRules(),
Colin Crossca860ac2016-01-04 14:34:37 -08001954 }
Joe Onorato37f900c2023-07-18 16:58:16 -07001955 for _, generator := range c.generators {
1956 flags = generator.GeneratorFlags(ctx, flags, deps)
1957 }
Colin Crossca860ac2016-01-04 14:34:37 -08001958 if c.compiler != nil {
Colin Crossf18e1102017-11-16 14:33:08 -08001959 flags = c.compiler.compilerFlags(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08001960 }
1961 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07001962 flags = c.linker.linkerFlags(ctx, flags)
Colin Crossca860ac2016-01-04 14:34:37 -08001963 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07001964 if c.stl != nil {
1965 flags = c.stl.flags(ctx, flags)
1966 }
Colin Cross16b23492016-01-06 14:41:07 -08001967 if c.sanitize != nil {
1968 flags = c.sanitize.flags(ctx, flags)
1969 }
Dan Willemsen581341d2017-02-09 16:16:31 -08001970 if c.coverage != nil {
Pirama Arumuga Nainar82fe59b2019-07-02 14:55:35 -07001971 flags, deps = c.coverage.flags(ctx, flags, deps)
Dan Willemsen581341d2017-02-09 16:16:31 -08001972 }
Cory Barkera1da26f2022-06-07 20:12:06 +00001973 if c.fuzzer != nil {
1974 flags = c.fuzzer.flags(ctx, flags)
1975 }
Stephen Craneba090d12017-05-09 15:44:35 -07001976 if c.lto != nil {
1977 flags = c.lto.flags(ctx, flags)
1978 }
Yi Kongeb8efc92021-12-09 18:06:29 +08001979 if c.afdo != nil {
1980 flags = c.afdo.flags(ctx, flags)
1981 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00001982 if c.orderfile != nil {
1983 flags = c.orderfile.flags(ctx, flags)
1984 }
Colin Crossca860ac2016-01-04 14:34:37 -08001985 for _, feature := range c.features {
1986 flags = feature.flags(ctx, flags)
1987 }
Colin Cross3f40fa42015-01-30 17:27:36 -08001988 if ctx.Failed() {
1989 return
1990 }
1991
Colin Cross4af21ed2019-11-04 09:37:55 -08001992 flags.Local.CFlags, _ = filterList(flags.Local.CFlags, config.IllegalFlags)
1993 flags.Local.CppFlags, _ = filterList(flags.Local.CppFlags, config.IllegalFlags)
1994 flags.Local.ConlyFlags, _ = filterList(flags.Local.ConlyFlags, config.IllegalFlags)
Colin Cross3f40fa42015-01-30 17:27:36 -08001995
Colin Cross4af21ed2019-11-04 09:37:55 -08001996 flags.Local.CommonFlags = append(flags.Local.CommonFlags, deps.Flags...)
Inseob Kim69378442019-06-03 19:10:47 +09001997
1998 for _, dir := range deps.IncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08001999 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-I"+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002000 }
2001 for _, dir := range deps.SystemIncludeDirs {
Colin Cross4af21ed2019-11-04 09:37:55 -08002002 flags.Local.CommonFlags = append(flags.Local.CommonFlags, "-isystem "+dir.String())
Inseob Kim69378442019-06-03 19:10:47 +09002003 }
2004
Colin Cross3e5e7782022-06-17 22:17:05 +00002005 flags.Local.LdFlags = append(flags.Local.LdFlags, deps.LdFlags...)
2006
Fabien Sanglardd61f1f42017-01-10 16:21:22 -08002007 c.flags = flags
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -07002008 // We need access to all the flags seen by a source file.
2009 if c.sabi != nil {
2010 flags = c.sabi.flags(ctx, flags)
2011 }
Dan Willemsen98ab3112019-08-27 21:20:40 -07002012
Colin Cross4af21ed2019-11-04 09:37:55 -08002013 flags.AssemblerWithCpp = inList("-xassembler-with-cpp", flags.Local.AsFlags)
Dan Willemsen98ab3112019-08-27 21:20:40 -07002014
Joe Onorato37f900c2023-07-18 16:58:16 -07002015 for _, generator := range c.generators {
2016 generator.GeneratorBuildActions(ctx, flags, deps)
2017 }
2018
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002019 var objs Objects
Colin Crossca860ac2016-01-04 14:34:37 -08002020 if c.compiler != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002021 objs = c.compiler.compile(ctx, flags, deps)
Colin Crossca860ac2016-01-04 14:34:37 -08002022 if ctx.Failed() {
2023 return
2024 }
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002025 c.kytheFiles = objs.kytheFiles
Chih-Hung Hsieh80783772021-10-11 16:46:56 -07002026 c.objFiles = objs.objFiles
2027 c.tidyFiles = objs.tidyFiles
Colin Cross3f40fa42015-01-30 17:27:36 -08002028 }
2029
Colin Crossca860ac2016-01-04 14:34:37 -08002030 if c.linker != nil {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002031 outputFile := c.linker.link(ctx, flags, deps, objs)
Colin Crossca860ac2016-01-04 14:34:37 -08002032 if ctx.Failed() {
2033 return
2034 }
Colin Cross635c3b02016-05-18 15:37:25 -07002035 c.outputFile = android.OptionalPathForPath(outputFile)
Jiyong Parkb0788572018-12-20 22:10:17 +09002036
Chris Parsons94a0bba2021-06-04 15:03:47 -04002037 c.maybeUnhideFromMake()
Colin Crossb614cd42024-10-11 12:52:21 -07002038
2039 android.SetProvider(ctx, ImplementationDepInfoProvider, &ImplementationDepInfo{
2040 ImplementationDeps: depset.New(depset.PREORDER, deps.directImplementationDeps, deps.transitiveImplementationDeps),
2041 })
Colin Crossce75d2c2016-10-06 16:12:58 -07002042 }
Ronald Braunsteina115e262024-04-09 18:07:38 -07002043
Colin Cross40213022023-12-13 15:19:49 -08002044 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: deps.GeneratedSources.Strings()})
Colin Cross5049f022015-03-18 13:28:46 -07002045
Hao Chen1c8ea5b2023-10-20 23:03:45 +00002046 if Bool(c.Properties.Cmake_snapshot_supported) {
2047 android.SetProvider(ctx, cmakeSnapshotSourcesProvider, android.GlobFiles(ctx, ctx.ModuleDir()+"/**/*", nil))
2048 }
2049
Chris Parsons94a0bba2021-06-04 15:03:47 -04002050 c.maybeInstall(ctx, apexInfo)
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002051
2052 if c.linker != nil {
2053 moduleInfoJSON := ctx.ModuleInfoJSON()
2054 c.linker.moduleInfoJSON(ctx, moduleInfoJSON)
2055 moduleInfoJSON.SharedLibs = c.Properties.AndroidMkSharedLibs
2056 moduleInfoJSON.StaticLibs = c.Properties.AndroidMkStaticLibs
2057 moduleInfoJSON.SystemSharedLibs = c.Properties.AndroidMkSystemSharedLibs
2058 moduleInfoJSON.RuntimeDependencies = c.Properties.AndroidMkRuntimeLibs
2059
2060 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkSharedLibs...)
2061 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkStaticLibs...)
2062 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkHeaderLibs...)
2063 moduleInfoJSON.Dependencies = append(moduleInfoJSON.Dependencies, c.Properties.AndroidMkWholeStaticLibs...)
2064
2065 if c.sanitize != nil && len(moduleInfoJSON.Class) > 0 &&
2066 (moduleInfoJSON.Class[0] == "STATIC_LIBRARIES" || moduleInfoJSON.Class[0] == "HEADER_LIBRARIES") {
2067 if Bool(c.sanitize.Properties.SanitizeMutated.Cfi) {
2068 moduleInfoJSON.SubName += ".cfi"
2069 }
2070 if Bool(c.sanitize.Properties.SanitizeMutated.Hwaddress) {
2071 moduleInfoJSON.SubName += ".hwasan"
2072 }
2073 if Bool(c.sanitize.Properties.SanitizeMutated.Scs) {
2074 moduleInfoJSON.SubName += ".scs"
2075 }
2076 }
2077 moduleInfoJSON.SubName += c.Properties.SubName
2078
2079 if c.Properties.IsSdkVariant && c.Properties.SdkAndPlatformVariantVisibleToMake {
2080 moduleInfoJSON.Uninstallable = true
2081 }
Colin Cross4a9e6ec2023-12-18 15:29:41 -08002082 }
Wei Lia1aa2972024-06-21 13:08:51 -07002083
2084 buildComplianceMetadataInfo(ctx, c, deps)
mrziwangabdb2932024-06-18 12:43:41 -07002085
Cole Faust96a692b2024-08-08 14:47:51 -07002086 if b, ok := c.compiler.(*baseCompiler); ok {
2087 c.hasAidl = b.hasSrcExt(ctx, ".aidl")
2088 c.hasLex = b.hasSrcExt(ctx, ".l") || b.hasSrcExt(ctx, ".ll")
2089 c.hasProto = b.hasSrcExt(ctx, ".proto")
2090 c.hasRenderscript = b.hasSrcExt(ctx, ".rscript") || b.hasSrcExt(ctx, ".fs")
2091 c.hasSysprop = b.hasSrcExt(ctx, ".sysprop")
2092 c.hasWinMsg = b.hasSrcExt(ctx, ".mc")
2093 c.hasYacc = b.hasSrcExt(ctx, ".y") || b.hasSrcExt(ctx, ".yy")
2094 }
2095
mrziwangabdb2932024-06-18 12:43:41 -07002096 c.setOutputFiles(ctx)
2097}
2098
2099func (c *Module) setOutputFiles(ctx ModuleContext) {
2100 if c.outputFile.Valid() {
2101 ctx.SetOutputFiles(android.Paths{c.outputFile.Path()}, "")
2102 } else {
2103 ctx.SetOutputFiles(android.Paths{}, "")
2104 }
2105 if c.linker != nil {
2106 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.unstrippedOutputFilePath()), "unstripped")
2107 ctx.SetOutputFiles(android.PathsIfNonNil(c.linker.strippedAllOutputFilePath()), "stripped_all")
2108 }
Wei Lia1aa2972024-06-21 13:08:51 -07002109}
2110
2111func buildComplianceMetadataInfo(ctx ModuleContext, c *Module, deps PathDeps) {
2112 // Dump metadata that can not be done in android/compliance-metadata.go
2113 complianceMetadataInfo := ctx.ComplianceMetadataInfo()
2114 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.IS_STATIC_LIB, strconv.FormatBool(ctx.static()))
2115 complianceMetadataInfo.SetStringValue(android.ComplianceMetadataProp.BUILT_FILES, c.outputFile.String())
2116
2117 // Static deps
2118 staticDeps := ctx.GetDirectDepsWithTag(StaticDepTag(false))
2119 staticDepNames := make([]string, 0, len(staticDeps))
2120 for _, dep := range staticDeps {
2121 staticDepNames = append(staticDepNames, dep.Name())
2122 }
2123
2124 staticDepPaths := make([]string, 0, len(deps.StaticLibs))
2125 for _, dep := range deps.StaticLibs {
2126 staticDepPaths = append(staticDepPaths, dep.String())
2127 }
2128 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEPS, android.FirstUniqueStrings(staticDepNames))
2129 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.STATIC_DEP_FILES, android.FirstUniqueStrings(staticDepPaths))
2130
2131 // Whole static deps
2132 wholeStaticDeps := ctx.GetDirectDepsWithTag(StaticDepTag(true))
2133 wholeStaticDepNames := make([]string, 0, len(wholeStaticDeps))
2134 for _, dep := range wholeStaticDeps {
2135 wholeStaticDepNames = append(wholeStaticDepNames, dep.Name())
2136 }
2137
2138 wholeStaticDepPaths := make([]string, 0, len(deps.WholeStaticLibs))
2139 for _, dep := range deps.WholeStaticLibs {
2140 wholeStaticDepPaths = append(wholeStaticDepPaths, dep.String())
2141 }
2142 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEPS, android.FirstUniqueStrings(wholeStaticDepNames))
2143 complianceMetadataInfo.SetListValue(android.ComplianceMetadataProp.WHOLE_STATIC_DEP_FILES, android.FirstUniqueStrings(wholeStaticDepPaths))
Chris Parsons94a0bba2021-06-04 15:03:47 -04002144}
2145
2146func (c *Module) maybeUnhideFromMake() {
2147 // If a lib is directly included in any of the APEXes or is not available to the
2148 // platform (which is often the case when the stub is provided as a prebuilt),
2149 // unhide the stubs variant having the latest version gets visible to make. In
2150 // addition, the non-stubs variant is renamed to <libname>.bootstrap. This is to
2151 // force anything in the make world to link against the stubs library. (unless it
2152 // is explicitly referenced via .bootstrap suffix or the module is marked with
2153 // 'bootstrap: true').
2154 if c.HasStubsVariants() && c.NotInPlatform() && !c.InRamdisk() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09002155 !c.InRecovery() && !c.InVendorOrProduct() && !c.static() && !c.isCoverageVariant() &&
Chris Parsons94a0bba2021-06-04 15:03:47 -04002156 c.IsStubs() && !c.InVendorRamdisk() {
2157 c.Properties.HideFromMake = false // unhide
2158 // Note: this is still non-installable
2159 }
2160}
2161
Colin Cross8ff10582023-12-07 13:10:56 -08002162// maybeInstall is called at the end of both GenerateAndroidBuildActions to run the
2163// install hooks for installable modules, like binaries and tests.
Chris Parsons94a0bba2021-06-04 15:03:47 -04002164func (c *Module) maybeInstall(ctx ModuleContext, apexInfo android.ApexInfo) {
Colin Cross1bc94122021-10-28 13:25:54 -07002165 if !proptools.BoolDefault(c.Installable(), true) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002166 // If the module has been specifically configure to not be installed then
2167 // hide from make as otherwise it will break when running inside make
2168 // as the output path to install will not be specified. Not all uninstallable
2169 // modules can be hidden from make as some are needed for resolving make side
2170 // dependencies.
2171 c.HideFromMake()
Ivan Lozanod7586b62021-04-01 09:49:36 -04002172 } else if !installable(c, apexInfo) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002173 c.SkipInstall()
2174 }
2175
2176 // Still call c.installer.install though, the installs will be stored as PackageSpecs
2177 // to allow using the outputs in a genrule.
2178 if c.installer != nil && c.outputFile.Valid() {
Colin Crossce75d2c2016-10-06 16:12:58 -07002179 c.installer.install(ctx, c.outputFile.Path())
2180 if ctx.Failed() {
2181 return
Colin Crossca860ac2016-01-04 14:34:37 -08002182 }
Dan Albertc403f7c2015-03-18 14:01:18 -07002183 }
Colin Cross3f40fa42015-01-30 17:27:36 -08002184}
2185
Colin Cross0ea8ba82019-06-06 14:33:29 -07002186func (c *Module) toolchain(ctx android.BaseModuleContext) config.Toolchain {
Colin Crossca860ac2016-01-04 14:34:37 -08002187 if c.cachedToolchain == nil {
Liz Kammer356f7d42021-01-26 09:18:53 -05002188 c.cachedToolchain = config.FindToolchainWithContext(ctx)
Colin Cross3f40fa42015-01-30 17:27:36 -08002189 }
Colin Crossca860ac2016-01-04 14:34:37 -08002190 return c.cachedToolchain
Colin Cross3f40fa42015-01-30 17:27:36 -08002191}
2192
Colin Crossca860ac2016-01-04 14:34:37 -08002193func (c *Module) begin(ctx BaseModuleContext) {
Joe Onorato37f900c2023-07-18 16:58:16 -07002194 for _, generator := range c.generators {
2195 generator.GeneratorInit(ctx)
2196 }
Colin Crossca860ac2016-01-04 14:34:37 -08002197 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002198 c.compiler.compilerInit(ctx)
Colin Cross21b9a242015-03-24 14:15:58 -07002199 }
Colin Crossca860ac2016-01-04 14:34:37 -08002200 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002201 c.linker.linkerInit(ctx)
Colin Crossca860ac2016-01-04 14:34:37 -08002202 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002203 if c.stl != nil {
2204 c.stl.begin(ctx)
2205 }
Colin Cross16b23492016-01-06 14:41:07 -08002206 if c.sanitize != nil {
2207 c.sanitize.begin(ctx)
2208 }
Dan Willemsen581341d2017-02-09 16:16:31 -08002209 if c.coverage != nil {
2210 c.coverage.begin(ctx)
2211 }
Yi Kong9723e332023-12-04 14:52:53 +09002212 if c.afdo != nil {
2213 c.afdo.begin(ctx)
2214 }
Stephen Craneba090d12017-05-09 15:44:35 -07002215 if c.lto != nil {
2216 c.lto.begin(ctx)
2217 }
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00002218 if c.orderfile != nil {
2219 c.orderfile.begin(ctx)
2220 }
Dan Albert92fe7402020-07-15 13:33:30 -07002221 if ctx.useSdk() && c.IsSdkVariant() {
Dan Albert1a246272020-07-06 14:49:35 -07002222 version, err := nativeApiLevelFromUser(ctx, ctx.sdkVersion())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002223 if err != nil {
2224 ctx.PropertyErrorf("sdk_version", err.Error())
Dan Albert1a246272020-07-06 14:49:35 -07002225 c.Properties.Sdk_version = nil
2226 } else {
2227 c.Properties.Sdk_version = StringPtr(version.String())
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002228 }
Dan Albert7fa7b2e2016-08-05 16:37:52 -07002229 }
Colin Crossca860ac2016-01-04 14:34:37 -08002230}
2231
Colin Cross37047f12016-12-13 17:06:13 -08002232func (c *Module) deps(ctx DepsContext) Deps {
Colin Crossc99deeb2016-04-11 15:06:20 -07002233 deps := Deps{}
2234
Joe Onorato37f900c2023-07-18 16:58:16 -07002235 for _, generator := range c.generators {
2236 deps = generator.GeneratorDeps(ctx, deps)
2237 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002238 if c.compiler != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002239 deps = c.compiler.compilerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002240 }
2241 if c.linker != nil {
Colin Cross42742b82016-08-01 13:20:05 -07002242 deps = c.linker.linkerDeps(ctx, deps)
Colin Crossc99deeb2016-04-11 15:06:20 -07002243 }
Colin Crossa8e07cc2016-04-04 15:07:06 -07002244 if c.stl != nil {
2245 deps = c.stl.deps(ctx, deps)
2246 }
Pirama Arumuga Nainar0b882f02018-04-23 22:44:39 +00002247 if c.coverage != nil {
2248 deps = c.coverage.deps(ctx, deps)
2249 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002250
Colin Crossb6715442017-10-24 11:13:31 -07002251 deps.WholeStaticLibs = android.LastUniqueStrings(deps.WholeStaticLibs)
2252 deps.StaticLibs = android.LastUniqueStrings(deps.StaticLibs)
2253 deps.LateStaticLibs = android.LastUniqueStrings(deps.LateStaticLibs)
2254 deps.SharedLibs = android.LastUniqueStrings(deps.SharedLibs)
2255 deps.LateSharedLibs = android.LastUniqueStrings(deps.LateSharedLibs)
2256 deps.HeaderLibs = android.LastUniqueStrings(deps.HeaderLibs)
Logan Chien43d34c32017-12-20 01:17:32 +08002257 deps.RuntimeLibs = android.LastUniqueStrings(deps.RuntimeLibs)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002258 deps.LlndkHeaderLibs = android.LastUniqueStrings(deps.LlndkHeaderLibs)
Colin Crossc99deeb2016-04-11 15:06:20 -07002259
Colin Cross516c5452024-10-28 13:45:21 -07002260 if err := checkConflictingExplicitVersions(deps.SharedLibs); err != nil {
2261 ctx.PropertyErrorf("shared_libs", "%s", err.Error())
2262 }
2263
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002264 for _, lib := range deps.ReexportSharedLibHeaders {
2265 if !inList(lib, deps.SharedLibs) {
2266 ctx.PropertyErrorf("export_shared_lib_headers", "Shared library not in shared_libs: '%s'", lib)
2267 }
2268 }
2269
2270 for _, lib := range deps.ReexportStaticLibHeaders {
Steven Morelandba407c82021-04-01 22:17:50 +00002271 if !inList(lib, deps.StaticLibs) && !inList(lib, deps.WholeStaticLibs) {
2272 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 -07002273 }
2274 }
2275
Colin Cross5950f382016-12-13 12:50:57 -08002276 for _, lib := range deps.ReexportHeaderLibHeaders {
2277 if !inList(lib, deps.HeaderLibs) {
2278 ctx.PropertyErrorf("export_header_lib_headers", "Header library not in header_libs: '%s'", lib)
2279 }
2280 }
2281
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002282 for _, gen := range deps.ReexportGeneratedHeaders {
2283 if !inList(gen, deps.GeneratedHeaders) {
2284 ctx.PropertyErrorf("export_generated_headers", "Generated header module not in generated_headers: '%s'", gen)
2285 }
2286 }
2287
Colin Crossc99deeb2016-04-11 15:06:20 -07002288 return deps
2289}
2290
Colin Cross516c5452024-10-28 13:45:21 -07002291func checkConflictingExplicitVersions(libs []string) error {
2292 withoutVersion := func(s string) string {
2293 name, _ := StubsLibNameAndVersion(s)
2294 return name
2295 }
2296 var errs []error
2297 for i, lib := range libs {
2298 libName := withoutVersion(lib)
2299 libsToCompare := libs[i+1:]
2300 j := slices.IndexFunc(libsToCompare, func(s string) bool {
2301 return withoutVersion(s) == libName
2302 })
2303 if j >= 0 {
2304 errs = append(errs, fmt.Errorf("duplicate shared libraries with different explicit versions: %q and %q",
2305 lib, libsToCompare[j]))
2306 }
2307 }
2308 return errors.Join(errs...)
2309}
2310
Dan Albert7e9d2952016-08-04 13:02:36 -07002311func (c *Module) beginMutator(actx android.BottomUpMutatorContext) {
Colin Crossca860ac2016-01-04 14:34:37 -08002312 ctx := &baseModuleContext{
Colin Cross0ea8ba82019-06-06 14:33:29 -07002313 BaseModuleContext: actx,
Colin Crossca860ac2016-01-04 14:34:37 -08002314 moduleContextImpl: moduleContextImpl{
2315 mod: c,
2316 },
2317 }
2318 ctx.ctx = ctx
2319
Colin Crossca860ac2016-01-04 14:34:37 -08002320 c.begin(ctx)
Dan Albert7e9d2952016-08-04 13:02:36 -07002321}
2322
Jiyong Park7ed9de32018-10-15 22:25:07 +09002323// Split name#version into name and version
Jiyong Park73c54ee2019-10-22 20:31:18 +09002324func StubsLibNameAndVersion(name string) (string, string) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002325 if sharp := strings.LastIndex(name, "#"); sharp != -1 && sharp != len(name)-1 {
2326 version := name[sharp+1:]
2327 libname := name[:sharp]
2328 return libname, version
2329 }
2330 return name, ""
2331}
2332
Dan Albert92fe7402020-07-15 13:33:30 -07002333func GetCrtVariations(ctx android.BottomUpMutatorContext,
2334 m LinkableInterface) []blueprint.Variation {
2335 if ctx.Os() != android.Android {
2336 return nil
2337 }
2338 if m.UseSdk() {
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002339 // Choose the CRT that best satisfies the min_sdk_version requirement of this module
2340 minSdkVersion := m.MinSdkVersion()
2341 if minSdkVersion == "" || minSdkVersion == "apex_inherit" {
2342 minSdkVersion = m.SdkVersion()
2343 }
Jooyung Han94a76ee2021-06-08 09:49:48 +09002344 apiLevel, err := android.ApiLevelFromUser(ctx, minSdkVersion)
2345 if err != nil {
2346 ctx.PropertyErrorf("min_sdk_version", err.Error())
2347 }
Colin Cross363ec762023-01-13 13:45:14 -08002348
2349 // Raise the minSdkVersion to the minimum supported for the architecture.
Colin Crossbb137a32023-01-26 09:54:42 -08002350 minApiForArch := MinApiForArch(ctx, m.Target().Arch.ArchType)
Colin Cross363ec762023-01-13 13:45:14 -08002351 if apiLevel.LessThan(minApiForArch) {
2352 apiLevel = minApiForArch
2353 }
2354
Dan Albert92fe7402020-07-15 13:33:30 -07002355 return []blueprint.Variation{
2356 {Mutator: "sdk", Variation: "sdk"},
Jooyung Han94a76ee2021-06-08 09:49:48 +09002357 {Mutator: "version", Variation: apiLevel.String()},
Dan Albert92fe7402020-07-15 13:33:30 -07002358 }
2359 }
2360 return []blueprint.Variation{
2361 {Mutator: "sdk", Variation: ""},
2362 }
2363}
2364
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002365func AddSharedLibDependenciesWithVersions(ctx android.BottomUpMutatorContext, mod LinkableInterface,
2366 variations []blueprint.Variation, depTag blueprint.DependencyTag, name, version string, far bool) {
Colin Crosse7257d22020-09-24 09:56:18 -07002367
2368 variations = append([]blueprint.Variation(nil), variations...)
2369
Liz Kammer23942242022-04-08 15:41:00 -04002370 if version != "" && canBeOrLinkAgainstVersionVariants(mod) {
Colin Crosse7257d22020-09-24 09:56:18 -07002371 // Version is explicitly specified. i.e. libFoo#30
Colin Crossb614cd42024-10-11 12:52:21 -07002372 if version == "impl" {
2373 version = ""
2374 }
Colin Crosse7257d22020-09-24 09:56:18 -07002375 variations = append(variations, blueprint.Variation{Mutator: "version", Variation: version})
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002376 if tag, ok := depTag.(libraryDependencyTag); ok {
2377 tag.explicitlyVersioned = true
Colin Crossafcdce82024-10-22 13:59:33 -07002378 // depTag is an interface that contains a concrete non-pointer struct. That makes the local
2379 // tag variable a copy of the contents of depTag, and updating it doesn't change depTag. Reassign
2380 // the modified copy to depTag.
2381 depTag = tag
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002382 } else {
2383 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
2384 }
Colin Crosse7257d22020-09-24 09:56:18 -07002385 }
Colin Crosse7257d22020-09-24 09:56:18 -07002386
Colin Cross0de8a1e2020-09-18 14:15:30 -07002387 if far {
2388 ctx.AddFarVariationDependencies(variations, depTag, name)
2389 } else {
2390 ctx.AddVariationDependencies(variations, depTag, name)
Colin Crosse7257d22020-09-24 09:56:18 -07002391 }
2392}
2393
Kiyoung Kim487689e2022-07-26 09:48:22 +09002394func GetReplaceModuleName(lib string, replaceMap map[string]string) string {
2395 if snapshot, ok := replaceMap[lib]; ok {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002396 return snapshot
2397 }
2398
2399 return lib
2400}
2401
Kiyoung Kim37693d02024-04-04 09:56:15 +09002402// FilterNdkLibs takes a list of names of shared libraries and scans it for two types
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002403// of names:
2404//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002405// 1. Name of an NDK library that refers to an ndk_library module.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002406//
2407// For each of these, it adds the name of the ndk_library module to the list of
2408// variant libs.
2409//
Kiyoung Kim37693d02024-04-04 09:56:15 +09002410// 2. Anything else (so anything that isn't an NDK library).
Kiyoung Kim487689e2022-07-26 09:48:22 +09002411//
2412// It adds these to the nonvariantLibs list.
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002413//
2414// The caller can then know to add the variantLibs dependencies differently from the
2415// nonvariantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002416func FilterNdkLibs(c LinkableInterface, config android.Config, list []string) (nonvariantLibs []string, variantLibs []string) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002417 variantLibs = []string{}
2418
2419 nonvariantLibs = []string{}
2420 for _, entry := range list {
2421 // strip #version suffix out
2422 name, _ := StubsLibNameAndVersion(entry)
Kiyoung Kim37693d02024-04-04 09:56:15 +09002423 if c.UseSdk() && inList(name, *getNDKKnownLibs(config)) {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002424 variantLibs = append(variantLibs, name+ndkLibrarySuffix)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002425 } else {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002426 nonvariantLibs = append(nonvariantLibs, entry)
2427 }
2428 }
2429 return nonvariantLibs, variantLibs
Kiyoung Kim37693d02024-04-04 09:56:15 +09002430
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002431}
2432
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002433func rewriteLibsForApiImports(c LinkableInterface, libs []string, replaceList map[string]string, config android.Config) ([]string, []string) {
2434 nonVariantLibs := []string{}
2435 variantLibs := []string{}
2436
2437 for _, lib := range libs {
2438 replaceLibName := GetReplaceModuleName(lib, replaceList)
2439 if replaceLibName == lib {
2440 // Do not handle any libs which are not in API imports
2441 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2442 } else if c.UseSdk() && inList(replaceLibName, *getNDKKnownLibs(config)) {
2443 variantLibs = append(variantLibs, replaceLibName)
2444 } else {
2445 nonVariantLibs = append(nonVariantLibs, replaceLibName)
2446 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09002447 }
2448
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002449 return nonVariantLibs, variantLibs
Kiyoung Kim487689e2022-07-26 09:48:22 +09002450}
2451
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002452func (c *Module) shouldUseApiSurface() bool {
2453 if c.Os() == android.Android && c.Target().NativeBridge != android.NativeBridgeEnabled {
2454 if GetImageVariantType(c) == vendorImageVariant || GetImageVariantType(c) == productImageVariant {
2455 // LLNDK Variant
2456 return true
2457 }
2458
2459 if c.Properties.IsSdkVariant {
2460 // NDK Variant
2461 return true
2462 }
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002463 }
2464
2465 return false
2466}
2467
Colin Cross1e676be2016-10-12 14:38:15 -07002468func (c *Module) DepsMutator(actx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002469 if !c.Enabled(actx) {
Inseob Kimeec88e12020-01-22 11:11:29 +09002470 return
2471 }
2472
Colin Cross37047f12016-12-13 17:06:13 -08002473 ctx := &depsContext{
2474 BottomUpMutatorContext: actx,
Dan Albert7e9d2952016-08-04 13:02:36 -07002475 moduleContextImpl: moduleContextImpl{
2476 mod: c,
2477 },
2478 }
2479 ctx.ctx = ctx
Colin Crossca860ac2016-01-04 14:34:37 -08002480
Colin Crossc99deeb2016-04-11 15:06:20 -07002481 deps := c.deps(ctx)
Kiyoung Kim11d91082022-10-19 19:20:57 +09002482
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002483 apiNdkLibs := []string{}
2484 apiLateNdkLibs := []string{}
2485
Yo Chiang219968c2020-09-22 18:45:04 +08002486 c.Properties.AndroidMkSystemSharedLibs = deps.SystemSharedLibs
2487
Dan Albert914449f2016-06-17 16:45:24 -07002488 variantNdkLibs := []string{}
2489 variantLateNdkLibs := []string{}
Dan Willemsenb916b802017-03-19 13:44:32 -07002490 if ctx.Os() == android.Android {
Kiyoung Kim37693d02024-04-04 09:56:15 +09002491 deps.SharedLibs, variantNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.SharedLibs)
2492 deps.LateSharedLibs, variantLateNdkLibs = FilterNdkLibs(c, ctx.Config(), deps.LateSharedLibs)
2493 deps.ReexportSharedLibHeaders, _ = FilterNdkLibs(c, ctx.Config(), deps.ReexportSharedLibHeaders)
Dan Willemsen72d39932016-07-08 23:23:48 -07002494 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002495
Colin Cross32ec36c2016-12-15 07:39:51 -08002496 for _, lib := range deps.HeaderLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002497 depTag := libraryDependencyTag{Kind: headerLibraryDependency}
Colin Cross32ec36c2016-12-15 07:39:51 -08002498 if inList(lib, deps.ReexportHeaderLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002499 depTag.reexportFlags = true
Colin Cross32ec36c2016-12-15 07:39:51 -08002500 }
Inseob Kimeec88e12020-01-22 11:11:29 +09002501
Spandan Das73bcafc2022-08-18 23:26:00 +00002502 if c.isNDKStubLibrary() {
Jiyong Parkf8fab9b2024-09-02 15:24:15 +09002503 variationExists := actx.OtherModuleDependencyVariantExists(nil, lib)
2504 if variationExists {
2505 actx.AddVariationDependencies(nil, depTag, lib)
2506 } else {
2507 // dependencies to ndk_headers fall here as ndk_headers do not have
2508 // any variants.
2509 actx.AddFarVariationDependencies([]blueprint.Variation{}, depTag, lib)
2510 }
Spandan Dasff665182024-09-11 18:48:44 +00002511 } else if c.IsStubs() {
Colin Cross7228ecd2019-11-18 16:00:16 -08002512 actx.AddFarVariationDependencies(append(ctx.Target().Variations(), c.ImageVariation()),
Colin Cross0f7d2ef2019-10-16 11:03:10 -07002513 depTag, lib)
Jiyong Park7e636d02019-01-28 16:16:54 +09002514 } else {
2515 actx.AddVariationDependencies(nil, depTag, lib)
2516 }
2517 }
2518
Dan Albertf1d14c72020-07-30 14:32:55 -07002519 if c.isNDKStubLibrary() {
2520 // NDK stubs depend on their implementation because the ABI dumps are
2521 // generated from the implementation library.
Kiyoung Kim487689e2022-07-26 09:48:22 +09002522
Spandan Das8b08aea2023-03-14 19:29:34 +00002523 actx.AddFarVariationDependencies(append(ctx.Target().Variations(),
2524 c.ImageVariation(),
2525 blueprint.Variation{Mutator: "link", Variation: "shared"},
2526 ), stubImplementation, c.BaseModuleName())
Dan Albertf1d14c72020-07-30 14:32:55 -07002527 }
2528
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002529 // If this module is an LLNDK implementation library, let it depend on LlndkHeaderLibs.
2530 if c.ImageVariation().Variation == android.CoreVariation && c.Device() &&
2531 c.Target().NativeBridge == android.NativeBridgeDisabled {
2532 actx.AddVariationDependencies(
Jihoon Kang47e91842024-06-19 00:51:16 +00002533 []blueprint.Variation{{Mutator: "image", Variation: android.VendorVariation}},
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08002534 llndkHeaderLibTag,
2535 deps.LlndkHeaderLibs...)
2536 }
2537
Jiyong Park5d1598f2019-02-25 22:14:17 +09002538 for _, lib := range deps.WholeStaticLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002539 depTag := libraryDependencyTag{Kind: staticLibraryDependency, wholeStatic: true, reexportFlags: true}
Inseob Kimeec88e12020-01-22 11:11:29 +09002540
Jiyong Park5d1598f2019-02-25 22:14:17 +09002541 actx.AddVariationDependencies([]blueprint.Variation{
2542 {Mutator: "link", Variation: "static"},
2543 }, depTag, lib)
2544 }
2545
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002546 for _, lib := range deps.StaticLibs {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002547 // Some dependencies listed in static_libs might actually be rust_ffi rlib variants.
Colin Cross6e511a92020-07-27 21:26:48 -07002548 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002549
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002550 if inList(lib, deps.ReexportStaticLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002551 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002552 }
Jiyong Parke3867542020-12-03 17:28:25 +09002553 if inList(lib, deps.ExcludeLibsForApex) {
2554 depTag.excludeInApex = true
2555 }
Dan Willemsen59339a22018-07-22 21:18:45 -07002556 actx.AddVariationDependencies([]blueprint.Variation{
2557 {Mutator: "link", Variation: "static"},
2558 }, depTag, lib)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002559 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002560
Jooyung Han75568392020-03-20 04:29:24 +09002561 // staticUnwinderDep is treated as staticDep for Q apexes
2562 // so that native libraries/binaries are linked with static unwinder
2563 // because Q libc doesn't have unwinder APIs
2564 if deps.StaticUnwinderIfLegacy {
Colin Cross6e511a92020-07-27 21:26:48 -07002565 depTag := libraryDependencyTag{Kind: staticLibraryDependency, staticUnwinder: true}
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002566 actx.AddVariationDependencies([]blueprint.Variation{
2567 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002568 }, depTag, staticUnwinder(actx))
Peter Collingbournedc4f9862020-02-12 17:13:25 -08002569 }
2570
Jiyong Park7ed9de32018-10-15 22:25:07 +09002571 // shared lib names without the #version suffix
2572 var sharedLibNames []string
2573
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002574 for _, lib := range deps.SharedLibs {
Colin Cross6e511a92020-07-27 21:26:48 -07002575 depTag := libraryDependencyTag{Kind: sharedLibraryDependency}
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002576 if inList(lib, deps.ReexportSharedLibHeaders) {
Colin Cross6e511a92020-07-27 21:26:48 -07002577 depTag.reexportFlags = true
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002578 }
Jiyong Parke3867542020-12-03 17:28:25 +09002579 if inList(lib, deps.ExcludeLibsForApex) {
2580 depTag.excludeInApex = true
2581 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09002582 if inList(lib, deps.ExcludeLibsForNonApex) {
2583 depTag.excludeInNonApex = true
2584 }
Inseob Kimc0907f12019-02-08 21:00:45 +09002585
Jiyong Park73c54ee2019-10-22 20:31:18 +09002586 name, version := StubsLibNameAndVersion(lib)
Inseob Kimc0907f12019-02-08 21:00:45 +09002587 sharedLibNames = append(sharedLibNames, name)
2588
Colin Crosse7257d22020-09-24 09:56:18 -07002589 variations := []blueprint.Variation{
2590 {Mutator: "link", Variation: "shared"},
2591 }
Spandan Dasff665182024-09-11 18:48:44 +00002592 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, name, version, false)
Dan Willemsen490a8dc2016-06-06 18:22:19 -07002593 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002594
Colin Crossfe9acfe2021-06-14 16:13:03 -07002595 for _, lib := range deps.LateStaticLibs {
2596 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency}
2597 actx.AddVariationDependencies([]blueprint.Variation{
2598 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002599 }, depTag, lib)
Colin Crossfe9acfe2021-06-14 16:13:03 -07002600 }
2601
Colin Cross3e5e7782022-06-17 22:17:05 +00002602 for _, lib := range deps.UnexportedStaticLibs {
2603 depTag := libraryDependencyTag{Kind: staticLibraryDependency, Order: lateLibraryDependency, unexportedSymbols: true}
2604 actx.AddVariationDependencies([]blueprint.Variation{
2605 {Mutator: "link", Variation: "static"},
Kiyoung Kim37693d02024-04-04 09:56:15 +09002606 }, depTag, lib)
Colin Cross3e5e7782022-06-17 22:17:05 +00002607 }
2608
Jiyong Park7ed9de32018-10-15 22:25:07 +09002609 for _, lib := range deps.LateSharedLibs {
Jiyong Park25fc6a92018-11-18 18:02:45 +09002610 if inList(lib, sharedLibNames) {
Jiyong Park7ed9de32018-10-15 22:25:07 +09002611 // This is to handle the case that some of the late shared libs (libc, libdl, libm, ...)
2612 // are added also to SharedLibs with version (e.g., libc#10). If not skipped, we will be
2613 // linking against both the stubs lib and the non-stubs lib at the same time.
2614 continue
2615 }
Colin Cross6e511a92020-07-27 21:26:48 -07002616 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency}
Colin Crosse7257d22020-09-24 09:56:18 -07002617 variations := []blueprint.Variation{
2618 {Mutator: "link", Variation: "shared"},
2619 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04002620 AddSharedLibDependenciesWithVersions(ctx, c, variations, depTag, lib, "", false)
Jiyong Park7ed9de32018-10-15 22:25:07 +09002621 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002622
Dan Willemsen59339a22018-07-22 21:18:45 -07002623 actx.AddVariationDependencies([]blueprint.Variation{
2624 {Mutator: "link", Variation: "shared"},
Chris Parsons79d66a52020-06-05 17:26:16 -04002625 }, dataLibDepTag, deps.DataLibs...)
2626
Colin Crossc8caa062021-09-24 16:50:14 -07002627 actx.AddVariationDependencies(nil, dataBinDepTag, deps.DataBins...)
2628
Chris Parsons79d66a52020-06-05 17:26:16 -04002629 actx.AddVariationDependencies([]blueprint.Variation{
2630 {Mutator: "link", Variation: "shared"},
Dan Willemsen59339a22018-07-22 21:18:45 -07002631 }, runtimeDepTag, deps.RuntimeLibs...)
Logan Chien43d34c32017-12-20 01:17:32 +08002632
Colin Cross68861832016-07-08 10:41:41 -07002633 actx.AddDependency(c, genSourceDepTag, deps.GeneratedSources...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002634
2635 for _, gen := range deps.GeneratedHeaders {
2636 depTag := genHeaderDepTag
2637 if inList(gen, deps.ReexportGeneratedHeaders) {
2638 depTag = genHeaderExportDepTag
2639 }
2640 actx.AddDependency(c, depTag, gen)
2641 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002642
Cole Faust65cb40a2024-10-21 15:41:42 -07002643 for _, gen := range deps.DeviceFirstGeneratedHeaders {
2644 depTag := genHeaderDepTag
2645 actx.AddVariationDependencies(ctx.Config().AndroidFirstDeviceTarget.Variations(), depTag, gen)
2646 }
2647
Dan Albert92fe7402020-07-15 13:33:30 -07002648 crtVariations := GetCrtVariations(ctx, c)
Colin Crossbbc941b2020-09-30 12:27:01 -07002649 actx.AddVariationDependencies(crtVariations, objDepTag, deps.ObjFiles...)
Colin Crossc465efd2021-06-11 18:00:04 -07002650 for _, crt := range deps.CrtBegin {
Dan Albert92fe7402020-07-15 13:33:30 -07002651 actx.AddVariationDependencies(crtVariations, CrtBeginDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002652 crt)
Colin Crossca860ac2016-01-04 14:34:37 -08002653 }
Colin Crossc465efd2021-06-11 18:00:04 -07002654 for _, crt := range deps.CrtEnd {
Dan Albert92fe7402020-07-15 13:33:30 -07002655 actx.AddVariationDependencies(crtVariations, CrtEndDepTag,
Kiyoung Kim37693d02024-04-04 09:56:15 +09002656 crt)
Colin Cross21b9a242015-03-24 14:15:58 -07002657 }
Dan Willemsena0790e32018-10-12 00:24:23 -07002658 if deps.DynamicLinker != "" {
2659 actx.AddDependency(c, dynamicLinkerDepTag, deps.DynamicLinker)
Dan Willemsenc77a0b32017-09-18 23:19:12 -07002660 }
Dan Albert914449f2016-06-17 16:45:24 -07002661
2662 version := ctx.sdkVersion()
Colin Cross6e511a92020-07-27 21:26:48 -07002663
2664 ndkStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002665 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002666 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002667 {Mutator: "link", Variation: "shared"},
2668 }, ndkStubDepTag, variantNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002669 actx.AddVariationDependencies([]blueprint.Variation{
2670 {Mutator: "version", Variation: version},
2671 {Mutator: "link", Variation: "shared"},
2672 }, ndkStubDepTag, apiNdkLibs...)
Colin Cross6e511a92020-07-27 21:26:48 -07002673
2674 ndkLateStubDepTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: lateLibraryDependency, ndk: true, makeSuffix: "." + version}
Dan Albert914449f2016-06-17 16:45:24 -07002675 actx.AddVariationDependencies([]blueprint.Variation{
Colin Cross5ec407b2020-09-30 11:41:33 -07002676 {Mutator: "version", Variation: version},
Dan Willemsen59339a22018-07-22 21:18:45 -07002677 {Mutator: "link", Variation: "shared"},
2678 }, ndkLateStubDepTag, variantLateNdkLibs...)
Kiyoung Kimd5d1ab12022-11-28 16:47:10 +09002679 actx.AddVariationDependencies([]blueprint.Variation{
2680 {Mutator: "version", Variation: version},
2681 {Mutator: "link", Variation: "shared"},
2682 }, ndkLateStubDepTag, apiLateNdkLibs...)
Logan Chienf3511742017-10-31 18:04:35 +08002683
Vinh Tran367d89d2023-04-28 11:21:25 -04002684 if len(deps.AidlLibs) > 0 {
2685 actx.AddDependency(
2686 c,
2687 aidlLibraryTag,
2688 deps.AidlLibs...,
2689 )
2690 }
2691
Colin Cross6362e272015-10-29 15:25:03 -07002692}
Colin Cross21b9a242015-03-24 14:15:58 -07002693
Colin Crosse40b4ea2018-10-02 22:25:58 -07002694func BeginMutator(ctx android.BottomUpMutatorContext) {
Cole Fausta963b942024-04-11 17:43:00 -07002695 if c, ok := ctx.Module().(*Module); ok && c.Enabled(ctx) {
Dan Albert7e9d2952016-08-04 13:02:36 -07002696 c.beginMutator(ctx)
2697 }
2698}
2699
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002700// Whether a module can link to another module, taking into
2701// account NDK linking.
Jooyung Han479ca172020-10-19 18:51:07 +09002702func checkLinkType(ctx android.BaseModuleContext, from LinkableInterface, to LinkableInterface,
Colin Cross6e511a92020-07-27 21:26:48 -07002703 tag blueprint.DependencyTag) {
2704
2705 switch t := tag.(type) {
2706 case dependencyTag:
2707 if t != vndkExtDepTag {
2708 return
2709 }
2710 case libraryDependencyTag:
2711 default:
2712 return
2713 }
2714
Ivan Lozanof9e21722020-12-02 09:00:51 -05002715 if from.Target().Os != android.Android {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002716 // Host code is not restricted
2717 return
2718 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002719
Ivan Lozano52767be2019-10-18 14:49:46 -07002720 if from.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002721 // Platform code can link to anything
2722 return
2723 }
Yifan Hong1b3348d2020-01-21 15:53:22 -08002724 if from.InRamdisk() {
2725 // Ramdisk code is not NDK
2726 return
2727 }
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002728 if from.InVendorRamdisk() {
2729 // Vendor ramdisk code is not NDK
2730 return
2731 }
Ivan Lozano52767be2019-10-18 14:49:46 -07002732 if from.InRecovery() {
Jiyong Parkf9332f12018-02-01 00:54:12 +09002733 // Recovery code is not NDK
2734 return
2735 }
Colin Cross31076b32020-10-23 17:22:06 -07002736 if c, ok := to.(*Module); ok {
Colin Cross31076b32020-10-23 17:22:06 -07002737 if c.StubDecorator() {
2738 // These aren't real libraries, but are the stub shared libraries that are included in
2739 // the NDK.
2740 return
2741 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002742 }
Logan Chien834b9a62019-01-14 15:39:03 +08002743
Ivan Lozano52767be2019-10-18 14:49:46 -07002744 if strings.HasPrefix(ctx.ModuleName(), "libclang_rt.") && to.Module().Name() == "libc++" {
Logan Chien834b9a62019-01-14 15:39:03 +08002745 // Bug: http://b/121358700 - Allow libclang_rt.* shared libraries (with sdk_version)
2746 // to link to libc++ (non-NDK and without sdk_version).
2747 return
2748 }
2749
Ivan Lozano52767be2019-10-18 14:49:46 -07002750 if to.SdkVersion() == "" {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002751 // NDK code linking to platform code is never okay.
2752 ctx.ModuleErrorf("depends on non-NDK-built library %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002753 ctx.OtherModuleName(to.Module()))
Dan Willemsen155d17c2019-02-06 18:30:02 -08002754 return
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002755 }
2756
2757 // At this point we know we have two NDK libraries, but we need to
2758 // check that we're not linking against anything built against a higher
2759 // API level, as it is only valid to link against older or equivalent
2760 // APIs.
2761
Inseob Kim01a28722018-04-11 09:48:45 +09002762 // Current can link against anything.
Ivan Lozano52767be2019-10-18 14:49:46 -07002763 if from.SdkVersion() != "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002764 // Otherwise we need to check.
Ivan Lozano52767be2019-10-18 14:49:46 -07002765 if to.SdkVersion() == "current" {
Inseob Kim01a28722018-04-11 09:48:45 +09002766 // Current can't be linked against by anything else.
2767 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002768 ctx.OtherModuleName(to.Module()), "current")
Inseob Kim01a28722018-04-11 09:48:45 +09002769 } else {
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002770 fromApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002771 if err != nil {
2772 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002773 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002774 from.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002775 }
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002776 toApi, err := android.ApiLevelFromUserWithConfig(ctx.Config(), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002777 if err != nil {
2778 ctx.PropertyErrorf("sdk_version",
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002779 "Invalid sdk_version value (must be int, preview or current): %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002780 to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002781 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002782
Prashanth Swaminathan6dcbd9c2023-07-18 17:55:01 -07002783 if toApi.GreaterThan(fromApi) {
Inseob Kim01a28722018-04-11 09:48:45 +09002784 ctx.ModuleErrorf("links %q built against newer API version %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002785 ctx.OtherModuleName(to.Module()), to.SdkVersion())
Inseob Kim01a28722018-04-11 09:48:45 +09002786 }
2787 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002788 }
Dan Albert202fe492017-12-15 13:56:59 -08002789
2790 // Also check that the two STL choices are compatible.
Ivan Lozano52767be2019-10-18 14:49:46 -07002791 fromStl := from.SelectedStl()
2792 toStl := to.SelectedStl()
Dan Albert202fe492017-12-15 13:56:59 -08002793 if fromStl == "" || toStl == "" {
2794 // Libraries that don't use the STL are unrestricted.
Inseob Kimda2171a2018-04-11 15:41:38 +09002795 } else if fromStl == "ndk_system" || toStl == "ndk_system" {
Dan Albert202fe492017-12-15 13:56:59 -08002796 // We can be permissive with the system "STL" since it is only the C++
2797 // ABI layer, but in the future we should make sure that everyone is
2798 // using either libc++ or nothing.
Colin Crossb60190a2018-09-04 16:28:17 -07002799 } else if getNdkStlFamily(from) != getNdkStlFamily(to) {
Dan Albert202fe492017-12-15 13:56:59 -08002800 ctx.ModuleErrorf("uses %q and depends on %q which uses incompatible %q",
Ivan Lozano52767be2019-10-18 14:49:46 -07002801 from.SelectedStl(), ctx.OtherModuleName(to.Module()),
2802 to.SelectedStl())
Dan Albert202fe492017-12-15 13:56:59 -08002803 }
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002804}
2805
Jooyung Han479ca172020-10-19 18:51:07 +09002806func checkLinkTypeMutator(ctx android.BottomUpMutatorContext) {
2807 if c, ok := ctx.Module().(*Module); ok {
2808 ctx.VisitDirectDeps(func(dep android.Module) {
2809 depTag := ctx.OtherModuleDependencyTag(dep)
2810 ccDep, ok := dep.(LinkableInterface)
2811 if ok {
2812 checkLinkType(ctx, c, ccDep, depTag)
2813 }
2814 })
2815 }
2816}
2817
Jiyong Park5fb8c102018-04-09 12:03:06 +09002818// Tests whether the dependent library is okay to be double loaded inside a single process.
Jooyung Hana70f0672019-01-18 15:20:43 +09002819// If a library has a vendor variant and is a (transitive) dependency of an LLNDK library,
2820// it is subject to be double loaded. Such lib should be explicitly marked as double_loadable: true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002821// or as vndk-sp (vndk: { enabled: true, support_system_process: true}).
Colin Crossda279cf2024-09-17 14:25:45 -07002822func checkDoubleLoadableLibraries(ctx android.BottomUpMutatorContext) {
Jooyung Hana70f0672019-01-18 15:20:43 +09002823 check := func(child, parent android.Module) bool {
2824 to, ok := child.(*Module)
2825 if !ok {
Jooyung Han479ca172020-10-19 18:51:07 +09002826 return false
Jooyung Hana70f0672019-01-18 15:20:43 +09002827 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002828
Jooyung Hana70f0672019-01-18 15:20:43 +09002829 if lib, ok := to.linker.(*libraryDecorator); !ok || !lib.shared() {
2830 return false
Jiyong Park5fb8c102018-04-09 12:03:06 +09002831 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002832
Jiyong Park0474e1f2021-01-14 14:26:06 +09002833 // These dependencies are not excercised at runtime. Tracking these will give us
2834 // false negative, so skip.
Jiyong Park1ad8e162020-12-01 23:40:09 +09002835 depTag := ctx.OtherModuleDependencyTag(child)
2836 if IsHeaderDepTag(depTag) {
2837 return false
2838 }
Jiyong Park0474e1f2021-01-14 14:26:06 +09002839 if depTag == staticVariantTag {
2840 return false
2841 }
2842 if depTag == stubImplDepTag {
2843 return false
2844 }
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002845 if depTag == android.RequiredDepTag {
2846 return false
2847 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09002848
Justin Yun63e9ec72020-10-29 16:49:43 +09002849 // Even if target lib has no vendor variant, keep checking dependency
2850 // graph in case it depends on vendor_available or product_available
2851 // but not double_loadable transtively.
2852 if !to.HasNonSystemVariants() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002853 return true
Jiyong Park5fb8c102018-04-09 12:03:06 +09002854 }
Jooyung Hana70f0672019-01-18 15:20:43 +09002855
Jiyong Park0474e1f2021-01-14 14:26:06 +09002856 // The happy path. Keep tracking dependencies until we hit a non double-loadable
2857 // one.
2858 if Bool(to.VendorProperties.Double_loadable) {
2859 return true
2860 }
2861
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09002862 if to.IsLlndk() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002863 return false
2864 }
2865
Jooyung Hana70f0672019-01-18 15:20:43 +09002866 ctx.ModuleErrorf("links a library %q which is not LL-NDK, "+
2867 "VNDK-SP, or explicitly marked as 'double_loadable:true'. "+
Jiyong Park0474e1f2021-01-14 14:26:06 +09002868 "Dependency list: %s", ctx.OtherModuleName(to), ctx.GetPathString(false))
Jooyung Hana70f0672019-01-18 15:20:43 +09002869 return false
2870 }
2871 if module, ok := ctx.Module().(*Module); ok {
2872 if lib, ok := module.linker.(*libraryDecorator); ok && lib.shared() {
Jiyong Park0474e1f2021-01-14 14:26:06 +09002873 if lib.hasLLNDKStubs() {
Jooyung Hana70f0672019-01-18 15:20:43 +09002874 ctx.WalkDeps(check)
2875 }
Jiyong Park5fb8c102018-04-09 12:03:06 +09002876 }
2877 }
2878}
2879
Yu Liue4312402023-01-18 09:15:31 -08002880func findApexSdkVersion(ctx android.BaseModuleContext, apexInfo android.ApexInfo) android.ApiLevel {
2881 // For the dependency from platform to apex, use the latest stubs
2882 apexSdkVersion := android.FutureApiLevel
2883 if !apexInfo.IsForPlatform() {
2884 apexSdkVersion = apexInfo.MinSdkVersion
2885 }
2886
2887 if android.InList("hwaddress", ctx.Config().SanitizeDevice()) {
2888 // In hwasan build, we override apexSdkVersion to the FutureApiLevel(10000)
2889 // so that even Q(29/Android10) apexes could use the dynamic unwinder by linking the newer stubs(e.g libc(R+)).
2890 // (b/144430859)
2891 apexSdkVersion = android.FutureApiLevel
2892 }
2893
2894 return apexSdkVersion
2895}
2896
Colin Crossc99deeb2016-04-11 15:06:20 -07002897// Convert dependencies to paths. Returns a PathDeps containing paths
Colin Cross635c3b02016-05-18 15:37:25 -07002898func (c *Module) depsToPaths(ctx android.ModuleContext) PathDeps {
Colin Crossca860ac2016-01-04 14:34:37 -08002899 var depPaths PathDeps
Colin Crossca860ac2016-01-04 14:34:37 -08002900
Colin Cross0de8a1e2020-09-18 14:15:30 -07002901 var directStaticDeps []StaticLibraryInfo
2902 var directSharedDeps []SharedLibraryInfo
Jeff Gaston294356f2017-09-27 17:05:30 -07002903
Colin Cross0de8a1e2020-09-18 14:15:30 -07002904 reexportExporter := func(exporter FlagExporterInfo) {
2905 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, exporter.IncludeDirs...)
2906 depPaths.ReexportedSystemDirs = append(depPaths.ReexportedSystemDirs, exporter.SystemIncludeDirs...)
2907 depPaths.ReexportedFlags = append(depPaths.ReexportedFlags, exporter.Flags...)
2908 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, exporter.Deps...)
2909 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders, exporter.GeneratedHeaders...)
Inseob Kim69378442019-06-03 19:10:47 +09002910 }
2911
Colin Crossff694a82023-12-13 15:54:49 -08002912 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Yu Liue4312402023-01-18 09:15:31 -08002913 c.apexSdkVersion = findApexSdkVersion(ctx, apexInfo)
Jooyung Hande34d232020-07-23 13:04:15 +09002914
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002915 skipModuleList := map[string]bool{}
2916
Colin Crossd11fcda2017-10-23 17:59:01 -07002917 ctx.VisitDirectDeps(func(dep android.Module) {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002918 depName := ctx.OtherModuleName(dep)
2919 depTag := ctx.OtherModuleDependencyTag(dep)
Dan Albert9e10cd42016-08-03 14:12:14 -07002920
Kiyoung Kim76b06f32023-02-06 22:08:13 +09002921 if _, ok := skipModuleList[depName]; ok {
2922 // skip this module because original module or API imported module matching with this should be used instead.
2923 return
2924 }
2925
Dan Willemsen47450072021-10-19 20:24:49 -07002926 if depTag == android.DarwinUniversalVariantTag {
2927 depPaths.DarwinSecondArchOutput = dep.(*Module).OutputFile()
2928 return
2929 }
2930
Vinh Tran367d89d2023-04-28 11:21:25 -04002931 if depTag == aidlLibraryTag {
Colin Cross313aa542023-12-13 13:47:44 -08002932 if aidlLibraryInfo, ok := android.OtherModuleProvider(ctx, dep, aidl_library.AidlLibraryProvider); ok {
Vinh Tran367d89d2023-04-28 11:21:25 -04002933 depPaths.AidlLibraryInfos = append(
2934 depPaths.AidlLibraryInfos,
Colin Cross313aa542023-12-13 13:47:44 -08002935 aidlLibraryInfo,
Vinh Tran367d89d2023-04-28 11:21:25 -04002936 )
2937 }
2938 }
2939
Ivan Lozano52767be2019-10-18 14:49:46 -07002940 ccDep, ok := dep.(LinkableInterface)
2941 if !ok {
2942
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002943 // handling for a few module types that aren't cc Module but that are also supported
2944 switch depTag {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002945 case genSourceDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002946 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Dan Willemsenb40aab62016-04-20 14:21:14 -07002947 depPaths.GeneratedSources = append(depPaths.GeneratedSources,
2948 genRule.GeneratedSourceFiles()...)
2949 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002950 ctx.ModuleErrorf("module %q is not a gensrcs or genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002951 }
Colin Crosse90bfd12017-04-26 16:59:26 -07002952 // Support exported headers from a generated_sources dependency
2953 fallthrough
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002954 case genHeaderDepTag, genHeaderExportDepTag:
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002955 if genRule, ok := dep.(genrule.SourceFileGenerator); ok {
Inseob Kimd110f872019-12-06 13:15:38 +09002956 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps,
Dan Willemsen9da9d492018-02-21 18:28:18 -08002957 genRule.GeneratedDeps()...)
Jiyong Park74955042019-10-22 20:19:51 +09002958 dirs := genRule.GeneratedHeaderDirs()
Inseob Kim69378442019-06-03 19:10:47 +09002959 depPaths.IncludeDirs = append(depPaths.IncludeDirs, dirs...)
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002960 if depTag == genHeaderExportDepTag {
Inseob Kim69378442019-06-03 19:10:47 +09002961 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, dirs...)
Inseob Kimd110f872019-12-06 13:15:38 +09002962 depPaths.ReexportedGeneratedHeaders = append(depPaths.ReexportedGeneratedHeaders,
2963 genRule.GeneratedSourceFiles()...)
Inseob Kim69378442019-06-03 19:10:47 +09002964 depPaths.ReexportedDeps = append(depPaths.ReexportedDeps, genRule.GeneratedDeps()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002965 // 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 +09002966 c.sabi.Properties.ReexportedIncludes = append(c.sabi.Properties.ReexportedIncludes, dirs.Strings()...)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07002967
Dan Willemsenb3454ab2016-09-28 17:34:58 -07002968 }
Dan Willemsenb40aab62016-04-20 14:21:14 -07002969 } else {
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002970 ctx.ModuleErrorf("module %q is not a genrule", depName)
Dan Willemsenb40aab62016-04-20 14:21:14 -07002971 }
Colin Crosscef792e2021-06-11 18:01:26 -07002972 case CrtBeginDepTag:
2973 depPaths.CrtBegin = append(depPaths.CrtBegin, android.OutputFileForModule(ctx, dep, ""))
2974 case CrtEndDepTag:
2975 depPaths.CrtEnd = append(depPaths.CrtEnd, android.OutputFileForModule(ctx, dep, ""))
Colin Crossca860ac2016-01-04 14:34:37 -08002976 }
Colin Crossc99deeb2016-04-11 15:06:20 -07002977 return
2978 }
2979
Colin Crossfe17f6f2019-03-28 19:30:56 -07002980 if depTag == android.ProtoPluginDepTag {
2981 return
2982 }
2983
Jiyong Park8bcf3c62024-03-18 18:37:10 +09002984 if depTag == android.RequiredDepTag {
2985 return
2986 }
2987
Colin Crossd11fcda2017-10-23 17:59:01 -07002988 if dep.Target().Os != ctx.Os() {
Steven Morelandaaae81f2024-08-27 22:55:48 +00002989 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 -07002990 return
2991 }
Colin Crossd11fcda2017-10-23 17:59:01 -07002992 if dep.Target().Arch.ArchType != ctx.Arch().ArchType {
Jooyung Han61b66e92020-03-21 14:21:46 +00002993 ctx.ModuleErrorf("Arch mismatch between %q(%v) and %q(%v)",
2994 ctx.ModuleName(), ctx.Arch().ArchType, depName, dep.Target().Arch.ArchType)
Colin Crossa1ad8d12016-06-01 17:09:44 -07002995 return
2996 }
2997
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -07002998 if depTag == reuseObjTag {
Colin Crossa717db72020-10-23 14:53:06 -07002999 // Skip reused objects for stub libraries, they use their own stub object file instead.
3000 // The reuseObjTag dependency still exists because the LinkageMutator runs before the
3001 // version mutator, so the stubs variant is created from the shared variant that
3002 // already has the reuseObjTag dependency on the static variant.
Colin Cross31076b32020-10-23 17:22:06 -07003003 if !c.library.buildStubs() {
Colin Cross313aa542023-12-13 13:47:44 -08003004 staticAnalogue, _ := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003005 objs := staticAnalogue.ReuseObjects
3006 depPaths.Objs = depPaths.Objs.Append(objs)
Colin Cross313aa542023-12-13 13:47:44 -08003007 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossa717db72020-10-23 14:53:06 -07003008 reexportExporter(depExporterInfo)
3009 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003010 return
Jiyong Parke4bb9862019-02-01 00:31:10 +09003011 }
3012
Hsin-Yi Chen715142a2024-03-27 16:31:16 +08003013 if depTag == llndkHeaderLibTag {
3014 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3015 depPaths.LlndkIncludeDirs = append(depPaths.LlndkIncludeDirs, depExporterInfo.IncludeDirs...)
3016 depPaths.LlndkSystemIncludeDirs = append(depPaths.LlndkSystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3017 }
3018
Colin Cross6e511a92020-07-27 21:26:48 -07003019 linkFile := ccDep.OutputFile()
3020
3021 if libDepTag, ok := depTag.(libraryDependencyTag); ok {
3022 // Only use static unwinder for legacy (min_sdk_version = 29) apexes (b/144430859)
Dan Albertc8060532020-07-22 22:32:17 -07003023 if libDepTag.staticUnwinder && c.apexSdkVersion.GreaterThan(android.SdkVersion_Android10) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003024 return
3025 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -08003026
Jiyong Parke3867542020-12-03 17:28:25 +09003027 if !apexInfo.IsForPlatform() && libDepTag.excludeInApex {
3028 return
3029 }
Jooyung Han9ffbe832023-11-28 22:31:35 +09003030 if apexInfo.IsForPlatform() && libDepTag.excludeInNonApex {
3031 return
3032 }
Jiyong Parke3867542020-12-03 17:28:25 +09003033
Colin Cross313aa542023-12-13 13:47:44 -08003034 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
Colin Crossc99deeb2016-04-11 15:06:20 -07003035
Colin Cross6e511a92020-07-27 21:26:48 -07003036 var ptr *android.Paths
3037 var depPtr *android.Paths
Colin Crossc99deeb2016-04-11 15:06:20 -07003038
Colin Cross6e511a92020-07-27 21:26:48 -07003039 depFile := android.OptionalPath{}
Colin Cross26c34ed2016-09-30 17:10:16 -07003040
Colin Cross6e511a92020-07-27 21:26:48 -07003041 switch {
3042 case libDepTag.header():
Colin Cross313aa542023-12-13 13:47:44 -08003043 if _, isHeaderLib := android.OtherModuleProvider(ctx, dep, HeaderLibraryInfoProvider); !isHeaderLib {
Colin Cross649d8172020-12-10 12:30:21 -08003044 if !ctx.Config().AllowMissingDependencies() {
3045 ctx.ModuleErrorf("module %q is not a header library", depName)
3046 } else {
3047 ctx.AddMissingDependencies([]string{depName})
3048 }
3049 return
3050 }
Colin Cross6e511a92020-07-27 21:26:48 -07003051 case libDepTag.shared():
Colin Cross313aa542023-12-13 13:47:44 -08003052 if _, isSharedLib := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider); !isSharedLib {
Colin Cross0de8a1e2020-09-18 14:15:30 -07003053 if !ctx.Config().AllowMissingDependencies() {
3054 ctx.ModuleErrorf("module %q is not a shared library", depName)
3055 } else {
3056 ctx.AddMissingDependencies([]string{depName})
3057 }
3058 return
3059 }
Jiyong Parke3867542020-12-03 17:28:25 +09003060
Jiyong Park7d55b612021-06-11 17:22:09 +09003061 sharedLibraryInfo, returnedDepExporterInfo := ChooseStubOrImpl(ctx, dep)
3062 depExporterInfo = returnedDepExporterInfo
Colin Cross0de8a1e2020-09-18 14:15:30 -07003063
Jiyong Park1ad8e162020-12-01 23:40:09 +09003064 // Stubs lib doesn't link to the shared lib dependencies. Don't set
3065 // linkFile, depFile, and ptr.
3066 if c.IsStubs() {
3067 break
3068 }
3069
Colin Cross0de8a1e2020-09-18 14:15:30 -07003070 linkFile = android.OptionalPathForPath(sharedLibraryInfo.SharedLibrary)
3071 depFile = sharedLibraryInfo.TableOfContents
3072
Colin Crossb614cd42024-10-11 12:52:21 -07003073 if !sharedLibraryInfo.IsStubs {
3074 depPaths.directImplementationDeps = append(depPaths.directImplementationDeps, android.OutputFileForModule(ctx, dep, ""))
3075 if info, ok := android.OtherModuleProvider(ctx, dep, ImplementationDepInfoProvider); ok {
3076 depPaths.transitiveImplementationDeps = append(depPaths.transitiveImplementationDeps, info.ImplementationDeps)
3077 }
3078 }
3079
Colin Cross6e511a92020-07-27 21:26:48 -07003080 ptr = &depPaths.SharedLibs
3081 switch libDepTag.Order {
3082 case earlyLibraryDependency:
3083 ptr = &depPaths.EarlySharedLibs
3084 depPtr = &depPaths.EarlySharedLibsDeps
3085 case normalLibraryDependency:
3086 ptr = &depPaths.SharedLibs
3087 depPtr = &depPaths.SharedLibsDeps
Colin Cross0de8a1e2020-09-18 14:15:30 -07003088 directSharedDeps = append(directSharedDeps, sharedLibraryInfo)
Colin Cross6e511a92020-07-27 21:26:48 -07003089 case lateLibraryDependency:
3090 ptr = &depPaths.LateSharedLibs
3091 depPtr = &depPaths.LateSharedLibsDeps
3092 default:
3093 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
Colin Crossc99deeb2016-04-11 15:06:20 -07003094 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003095
Colin Cross6e511a92020-07-27 21:26:48 -07003096 case libDepTag.static():
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003097 if ccDep.RustLibraryInterface() {
3098 rlibDep := RustRlibDep{LibPath: linkFile.Path(), CrateName: ccDep.CrateName(), LinkDirs: ccDep.ExportedCrateLinkDirs()}
3099 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, rlibDep)
3100 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3101 if libDepTag.wholeStatic {
3102 depPaths.ReexportedDirs = append(depPaths.ReexportedDirs, depExporterInfo.IncludeDirs...)
3103 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, rlibDep)
Jiyong Park1ad8e162020-12-01 23:40:09 +09003104
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003105 // If whole_static, track this as we want to make sure that in a final linkage for a shared library,
3106 // exported functions from the rust generated staticlib still exported.
3107 if c.CcLibrary() && c.Shared() {
3108 c.WholeRustStaticlib = true
3109 }
Colin Cross6e511a92020-07-27 21:26:48 -07003110 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003111
Colin Cross6e511a92020-07-27 21:26:48 -07003112 } else {
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003113 staticLibraryInfo, isStaticLib := android.OtherModuleProvider(ctx, dep, StaticLibraryInfoProvider)
3114 if !isStaticLib {
3115 if !ctx.Config().AllowMissingDependencies() {
3116 ctx.ModuleErrorf("module %q is not a static library", depName)
3117 } else {
3118 ctx.AddMissingDependencies([]string{depName})
3119 }
3120 return
Inseob Kimeec88e12020-01-22 11:11:29 +09003121 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003122
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003123 // Stubs lib doesn't link to the static lib dependencies. Don't set
3124 // linkFile, depFile, and ptr.
3125 if c.IsStubs() {
3126 break
3127 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04003128
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003129 linkFile = android.OptionalPathForPath(staticLibraryInfo.StaticLibrary)
3130 if libDepTag.wholeStatic {
3131 ptr = &depPaths.WholeStaticLibs
3132 if len(staticLibraryInfo.Objects.objFiles) > 0 {
3133 depPaths.WholeStaticLibObjs = depPaths.WholeStaticLibObjs.Append(staticLibraryInfo.Objects)
3134 } else {
3135 // This case normally catches prebuilt static
3136 // libraries, but it can also occur when
3137 // AllowMissingDependencies is on and the
3138 // dependencies has no sources of its own
3139 // but has a whole_static_libs dependency
3140 // on a missing library. We want to depend
3141 // on the .a file so that there is something
3142 // in the dependency tree that contains the
3143 // error rule for the missing transitive
3144 // dependency.
3145 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts, linkFile.Path())
3146 }
3147 depPaths.WholeStaticLibsFromPrebuilts = append(depPaths.WholeStaticLibsFromPrebuilts,
3148 staticLibraryInfo.WholeStaticLibsFromPrebuilts...)
3149 } else {
3150 switch libDepTag.Order {
3151 case earlyLibraryDependency:
3152 panic(fmt.Errorf("early static libs not supported"))
3153 case normalLibraryDependency:
3154 // static dependencies will be handled separately so they can be ordered
3155 // using transitive dependencies.
3156 ptr = nil
3157 directStaticDeps = append(directStaticDeps, staticLibraryInfo)
3158 case lateLibraryDependency:
3159 ptr = &depPaths.LateStaticLibs
3160 default:
3161 panic(fmt.Errorf("unexpected library dependency order %d", libDepTag.Order))
3162 }
3163 }
3164
3165 // Collect any exported Rust rlib deps from static libraries which have been included as whole_static_libs
3166 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3167
3168 if libDepTag.unexportedSymbols {
3169 depPaths.LdFlags = append(depPaths.LdFlags,
3170 "-Wl,--exclude-libs="+staticLibraryInfo.StaticLibrary.Base())
3171 }
Colin Cross3e5e7782022-06-17 22:17:05 +00003172 }
Inseob Kimeec88e12020-01-22 11:11:29 +09003173 }
3174
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003175 if libDepTag.static() && !libDepTag.wholeStatic && !ccDep.RustLibraryInterface() {
Colin Cross6e511a92020-07-27 21:26:48 -07003176 if !ccDep.CcLibraryInterface() || !ccDep.Static() {
3177 ctx.ModuleErrorf("module %q not a static library", depName)
3178 return
3179 }
Logan Chien43d34c32017-12-20 01:17:32 +08003180
Colin Cross6e511a92020-07-27 21:26:48 -07003181 // When combining coverage files for shared libraries and executables, coverage files
3182 // in static libraries act as if they were whole static libraries. The same goes for
3183 // source based Abi dump files.
3184 if c, ok := ccDep.(*Module); ok {
3185 staticLib := c.linker.(libraryInterface)
3186 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
3187 staticLib.objs().coverageFiles...)
3188 depPaths.StaticLibObjs.sAbiDumpFiles = append(depPaths.StaticLibObjs.sAbiDumpFiles,
3189 staticLib.objs().sAbiDumpFiles...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003190 } else {
Colin Cross6e511a92020-07-27 21:26:48 -07003191 // Handle non-CC modules here
3192 depPaths.StaticLibObjs.coverageFiles = append(depPaths.StaticLibObjs.coverageFiles,
Colin Cross0de8a1e2020-09-18 14:15:30 -07003193 ccDep.CoverageFiles()...)
Jiyong Parkde866cb2018-12-07 23:08:36 +09003194 }
3195 }
3196
Colin Cross6e511a92020-07-27 21:26:48 -07003197 if ptr != nil {
3198 if !linkFile.Valid() {
3199 if !ctx.Config().AllowMissingDependencies() {
3200 ctx.ModuleErrorf("module %q missing output file", depName)
3201 } else {
3202 ctx.AddMissingDependencies([]string{depName})
3203 }
3204 return
3205 }
3206 *ptr = append(*ptr, linkFile.Path())
3207 }
3208
3209 if depPtr != nil {
3210 dep := depFile
3211 if !dep.Valid() {
3212 dep = linkFile
3213 }
3214 *depPtr = append(*depPtr, dep.Path())
3215 }
3216
Colin Cross0de8a1e2020-09-18 14:15:30 -07003217 depPaths.IncludeDirs = append(depPaths.IncludeDirs, depExporterInfo.IncludeDirs...)
3218 depPaths.SystemIncludeDirs = append(depPaths.SystemIncludeDirs, depExporterInfo.SystemIncludeDirs...)
3219 depPaths.GeneratedDeps = append(depPaths.GeneratedDeps, depExporterInfo.Deps...)
3220 depPaths.Flags = append(depPaths.Flags, depExporterInfo.Flags...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003221 depPaths.RustRlibDeps = append(depPaths.RustRlibDeps, depExporterInfo.RustRlibDeps...)
3222
3223 // Only re-export RustRlibDeps for cc static libs
3224 if c.static() {
3225 depPaths.ReexportedRustRlibDeps = append(depPaths.ReexportedRustRlibDeps, depExporterInfo.RustRlibDeps...)
3226 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07003227
3228 if libDepTag.reexportFlags {
3229 reexportExporter(depExporterInfo)
3230 // Add these re-exported flags to help header-abi-dumper to infer the abi exported by a library.
3231 // Re-exported shared library headers must be included as well since they can help us with type information
3232 // about template instantiations (instantiated from their headers).
Colin Cross0de8a1e2020-09-18 14:15:30 -07003233 c.sabi.Properties.ReexportedIncludes = append(
3234 c.sabi.Properties.ReexportedIncludes, depExporterInfo.IncludeDirs.Strings()...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003235 c.sabi.Properties.ReexportedSystemIncludes = append(
3236 c.sabi.Properties.ReexportedSystemIncludes, depExporterInfo.SystemIncludeDirs.Strings()...)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003237 }
3238
Spandan Das3faa7922024-02-26 19:42:32 +00003239 makeLibName := MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName()) + libDepTag.makeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003240 switch {
3241 case libDepTag.header():
Colin Cross370173e2020-07-29 12:48:33 -07003242 c.Properties.AndroidMkHeaderLibs = append(
3243 c.Properties.AndroidMkHeaderLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003244 case libDepTag.shared():
Colin Cross31076b32020-10-23 17:22:06 -07003245 if lib := moduleLibraryInterface(dep); lib != nil {
3246 if lib.buildStubs() && dep.(android.ApexModule).InAnyApex() {
Colin Cross6e511a92020-07-27 21:26:48 -07003247 // Add the dependency to the APEX(es) providing the library so that
3248 // m <module> can trigger building the APEXes as well.
Colin Cross313aa542023-12-13 13:47:44 -08003249 depApexInfo, _ := android.OtherModuleProvider(ctx, dep, android.ApexInfoProvider)
Jiyong Parkab50b072021-05-12 17:13:56 +09003250 for _, an := range depApexInfo.InApexVariants {
Colin Cross6e511a92020-07-27 21:26:48 -07003251 c.Properties.ApexesProvidingSharedLibs = append(
3252 c.Properties.ApexesProvidingSharedLibs, an)
3253 }
3254 }
3255 }
3256
3257 // Note: the order of libs in this list is not important because
3258 // they merely serve as Make dependencies and do not affect this lib itself.
Colin Cross370173e2020-07-29 12:48:33 -07003259 c.Properties.AndroidMkSharedLibs = append(
3260 c.Properties.AndroidMkSharedLibs, makeLibName)
Colin Cross6e511a92020-07-27 21:26:48 -07003261 case libDepTag.static():
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04003262 if !ccDep.RustLibraryInterface() {
3263 if libDepTag.wholeStatic {
3264 c.Properties.AndroidMkWholeStaticLibs = append(
3265 c.Properties.AndroidMkWholeStaticLibs, makeLibName)
3266 } else {
3267 c.Properties.AndroidMkStaticLibs = append(
3268 c.Properties.AndroidMkStaticLibs, makeLibName)
3269 }
Colin Cross6e511a92020-07-27 21:26:48 -07003270 }
3271 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09003272 } else if !c.IsStubs() {
3273 // Stubs lib doesn't link to the runtime lib, object, crt, etc. dependencies.
3274
Colin Cross6e511a92020-07-27 21:26:48 -07003275 switch depTag {
3276 case runtimeDepTag:
3277 c.Properties.AndroidMkRuntimeLibs = append(
Spandan Das3faa7922024-02-26 19:42:32 +00003278 c.Properties.AndroidMkRuntimeLibs, MakeLibName(ctx, c, ccDep, ccDep.BaseModuleName())+libDepTag.makeSuffix)
Colin Cross6e511a92020-07-27 21:26:48 -07003279 case objDepTag:
3280 depPaths.Objs.objFiles = append(depPaths.Objs.objFiles, linkFile.Path())
3281 case CrtBeginDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003282 depPaths.CrtBegin = append(depPaths.CrtBegin, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003283 case CrtEndDepTag:
Colin Crossc465efd2021-06-11 18:00:04 -07003284 depPaths.CrtEnd = append(depPaths.CrtEnd, linkFile.Path())
Colin Cross6e511a92020-07-27 21:26:48 -07003285 case dynamicLinkerDepTag:
3286 depPaths.DynamicLinker = linkFile
3287 }
Jiyong Park27b188b2017-07-18 13:23:39 +09003288 }
Colin Crossca860ac2016-01-04 14:34:37 -08003289 })
3290
Jeff Gaston294356f2017-09-27 17:05:30 -07003291 // use the ordered dependencies as this module's dependencies
Colin Cross0de8a1e2020-09-18 14:15:30 -07003292 orderedStaticPaths, transitiveStaticLibs := orderStaticModuleDeps(directStaticDeps, directSharedDeps)
3293 depPaths.TranstiveStaticLibrariesForOrdering = transitiveStaticLibs
3294 depPaths.StaticLibs = append(depPaths.StaticLibs, orderedStaticPaths...)
Jeff Gaston294356f2017-09-27 17:05:30 -07003295
Colin Crossdd84e052017-05-17 13:44:16 -07003296 // Dedup exported flags from dependencies
Colin Crossb6715442017-10-24 11:13:31 -07003297 depPaths.Flags = android.FirstUniqueStrings(depPaths.Flags)
Jiyong Park74955042019-10-22 20:19:51 +09003298 depPaths.IncludeDirs = android.FirstUniquePaths(depPaths.IncludeDirs)
3299 depPaths.SystemIncludeDirs = android.FirstUniquePaths(depPaths.SystemIncludeDirs)
Inseob Kimd110f872019-12-06 13:15:38 +09003300 depPaths.GeneratedDeps = android.FirstUniquePaths(depPaths.GeneratedDeps)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003301 depPaths.RustRlibDeps = android.FirstUniqueFunc(depPaths.RustRlibDeps, EqRustRlibDeps)
3302
Jiyong Park74955042019-10-22 20:19:51 +09003303 depPaths.ReexportedDirs = android.FirstUniquePaths(depPaths.ReexportedDirs)
3304 depPaths.ReexportedSystemDirs = android.FirstUniquePaths(depPaths.ReexportedSystemDirs)
Colin Crossb6715442017-10-24 11:13:31 -07003305 depPaths.ReexportedFlags = android.FirstUniqueStrings(depPaths.ReexportedFlags)
Inseob Kim69378442019-06-03 19:10:47 +09003306 depPaths.ReexportedDeps = android.FirstUniquePaths(depPaths.ReexportedDeps)
Inseob Kimd110f872019-12-06 13:15:38 +09003307 depPaths.ReexportedGeneratedHeaders = android.FirstUniquePaths(depPaths.ReexportedGeneratedHeaders)
Ivan Lozano0a468a42024-05-13 21:03:34 -04003308 depPaths.ReexportedRustRlibDeps = android.FirstUniqueFunc(depPaths.ReexportedRustRlibDeps, EqRustRlibDeps)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003309
3310 if c.sabi != nil {
Inseob Kim69378442019-06-03 19:10:47 +09003311 c.sabi.Properties.ReexportedIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedIncludes)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08003312 c.sabi.Properties.ReexportedSystemIncludes = android.FirstUniqueStrings(c.sabi.Properties.ReexportedSystemIncludes)
Dan Willemsenfe92c962017-08-29 12:28:37 -07003313 }
Colin Crossdd84e052017-05-17 13:44:16 -07003314
Colin Crossca860ac2016-01-04 14:34:37 -08003315 return depPaths
3316}
3317
Spandan Das604f3762023-03-16 22:51:40 +00003318func ShouldUseStubForApex(ctx android.ModuleContext, dep android.Module) bool {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003319 inVendorOrProduct := false
Jiyong Park7d55b612021-06-11 17:22:09 +09003320 bootstrap := false
3321 if linkable, ok := ctx.Module().(LinkableInterface); !ok {
3322 panic(fmt.Errorf("Not a Linkable module: %q", ctx.ModuleName()))
3323 } else {
Kiyoung Kimaa394802024-01-08 12:55:45 +09003324 inVendorOrProduct = linkable.InVendorOrProduct()
Jiyong Park7d55b612021-06-11 17:22:09 +09003325 bootstrap = linkable.Bootstrap()
3326 }
3327
Colin Crossff694a82023-12-13 15:54:49 -08003328 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003329
3330 useStubs := false
3331
Kiyoung Kimaa394802024-01-08 12:55:45 +09003332 if lib := moduleLibraryInterface(dep); lib.buildStubs() && inVendorOrProduct { // LLNDK
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003333 if !apexInfo.IsForPlatform() {
3334 // For platform libraries, use current version of LLNDK
3335 // If this is for use_vendor apex we will apply the same rules
3336 // of apex sdk enforcement below to choose right version.
3337 useStubs = true
3338 }
3339 } else if apexInfo.IsForPlatform() || apexInfo.UsePlatformApis {
3340 // If not building for APEX or the containing APEX allows the use of
3341 // platform APIs, use stubs only when it is from an APEX (and not from
3342 // platform) However, for host, ramdisk, vendor_ramdisk, recovery or
3343 // bootstrap modules, always link to non-stub variant
3344 isNotInPlatform := dep.(android.ApexModule).NotInPlatform()
3345
Spandan Dasff665182024-09-11 18:48:44 +00003346 useStubs = isNotInPlatform && !bootstrap
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003347 } else {
Colin Crossea91a172024-11-05 16:14:05 -08003348 // If building for APEX, always use stubs (can be bypassed by depending on <dep>#impl)
3349 useStubs = true
Kiyoung Kim76b06f32023-02-06 22:08:13 +09003350 }
3351
3352 return useStubs
3353}
3354
3355// ChooseStubOrImpl determines whether a given dependency should be redirected to the stub variant
3356// of the dependency or not, and returns the SharedLibraryInfo and FlagExporterInfo for the right
3357// dependency. The stub variant is selected when the dependency crosses a boundary where each side
3358// has different level of updatability. For example, if a library foo in an APEX depends on a
3359// library bar which provides stable interface and exists in the platform, foo uses the stub variant
3360// of bar. If bar doesn't provide a stable interface (i.e. buildStubs() == false) or is in the
3361// same APEX as foo, the non-stub variant of bar is used.
3362func ChooseStubOrImpl(ctx android.ModuleContext, dep android.Module) (SharedLibraryInfo, FlagExporterInfo) {
3363 depTag := ctx.OtherModuleDependencyTag(dep)
3364 libDepTag, ok := depTag.(libraryDependencyTag)
3365 if !ok || !libDepTag.shared() {
3366 panic(fmt.Errorf("Unexpected dependency tag: %T", depTag))
3367 }
3368
Colin Cross313aa542023-12-13 13:47:44 -08003369 sharedLibraryInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryInfoProvider)
3370 depExporterInfo, _ := android.OtherModuleProvider(ctx, dep, FlagExporterInfoProvider)
3371 sharedLibraryStubsInfo, _ := android.OtherModuleProvider(ctx, dep, SharedLibraryStubsProvider)
Jiyong Park7d55b612021-06-11 17:22:09 +09003372
3373 if !libDepTag.explicitlyVersioned && len(sharedLibraryStubsInfo.SharedStubLibraries) > 0 {
Jiyong Park7d55b612021-06-11 17:22:09 +09003374 // when to use (unspecified) stubs, use the latest one.
Spandan Das604f3762023-03-16 22:51:40 +00003375 if ShouldUseStubForApex(ctx, dep) {
Jiyong Park7d55b612021-06-11 17:22:09 +09003376 stubs := sharedLibraryStubsInfo.SharedStubLibraries
3377 toUse := stubs[len(stubs)-1]
3378 sharedLibraryInfo = toUse.SharedLibraryInfo
3379 depExporterInfo = toUse.FlagExporterInfo
3380 }
3381 }
3382 return sharedLibraryInfo, depExporterInfo
3383}
3384
Colin Cross0de8a1e2020-09-18 14:15:30 -07003385// orderStaticModuleDeps rearranges the order of the static library dependencies of the module
3386// to match the topological order of the dependency tree, including any static analogues of
Colin Crossa14fb6a2024-10-23 16:57:06 -07003387// direct shared libraries. It returns the ordered static dependencies, and a depset.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07003388// of the transitive dependencies.
Colin Crossa14fb6a2024-10-23 16:57:06 -07003389func orderStaticModuleDeps(staticDeps []StaticLibraryInfo, sharedDeps []SharedLibraryInfo) (ordered android.Paths, transitive depset.DepSet[android.Path]) {
3390 transitiveStaticLibsBuilder := depset.NewBuilder[android.Path](depset.TOPOLOGICAL)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003391 var staticPaths android.Paths
3392 for _, staticDep := range staticDeps {
3393 staticPaths = append(staticPaths, staticDep.StaticLibrary)
3394 transitiveStaticLibsBuilder.Transitive(staticDep.TransitiveStaticLibrariesForOrdering)
3395 }
3396 for _, sharedDep := range sharedDeps {
Colin Crossa14fb6a2024-10-23 16:57:06 -07003397 transitiveStaticLibsBuilder.Transitive(sharedDep.TransitiveStaticLibrariesForOrdering)
Colin Cross0de8a1e2020-09-18 14:15:30 -07003398 }
3399 transitiveStaticLibs := transitiveStaticLibsBuilder.Build()
3400
3401 orderedTransitiveStaticLibs := transitiveStaticLibs.ToList()
3402
3403 // reorder the dependencies based on transitive dependencies
3404 staticPaths = android.FirstUniquePaths(staticPaths)
3405 _, orderedStaticPaths := android.FilterPathList(orderedTransitiveStaticLibs, staticPaths)
3406
3407 if len(orderedStaticPaths) != len(staticPaths) {
3408 missing, _ := android.FilterPathList(staticPaths, orderedStaticPaths)
3409 panic(fmt.Errorf("expected %d ordered static paths , got %d, missing %q %q %q", len(staticPaths), len(orderedStaticPaths), missing, orderedStaticPaths, staticPaths))
3410 }
3411
3412 return orderedStaticPaths, transitiveStaticLibs
3413}
3414
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003415// BaseLibName trims known prefixes and suffixes
3416func BaseLibName(depName string) string {
Colin Cross6e511a92020-07-27 21:26:48 -07003417 libName := strings.TrimSuffix(depName, llndkLibrarySuffix)
3418 libName = strings.TrimSuffix(libName, vendorPublicLibrarySuffix)
Paul Duffind23c7262020-12-11 18:13:08 +00003419 libName = android.RemoveOptionalPrebuiltPrefix(libName)
Colin Cross6e511a92020-07-27 21:26:48 -07003420 return libName
3421}
3422
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003423func MakeLibName(ctx android.ModuleContext, c LinkableInterface, ccDep LinkableInterface, depName string) string {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04003424 libName := BaseLibName(depName)
Colin Cross127bb8b2020-12-16 16:46:01 -08003425 ccDepModule, _ := ccDep.(*Module)
3426 isLLndk := ccDepModule != nil && ccDepModule.IsLlndk()
Justin Yuncbca3732021-02-03 19:24:13 +09003427 nonSystemVariantsExist := ccDep.HasNonSystemVariants() || isLLndk
Colin Cross6e511a92020-07-27 21:26:48 -07003428
Justin Yuncbca3732021-02-03 19:24:13 +09003429 if ccDepModule != nil {
Colin Cross6e511a92020-07-27 21:26:48 -07003430 // Use base module name for snapshots when exporting to Makefile.
Ivan Lozanod1dec542021-05-26 15:33:11 -04003431 if snapshotPrebuilt, ok := ccDepModule.linker.(SnapshotInterface); ok {
Justin Yuncbca3732021-02-03 19:24:13 +09003432 baseName := ccDepModule.BaseModuleName()
Colin Cross6e511a92020-07-27 21:26:48 -07003433
Ivan Lozanod1dec542021-05-26 15:33:11 -04003434 return baseName + snapshotPrebuilt.SnapshotAndroidMkSuffix()
Colin Cross6e511a92020-07-27 21:26:48 -07003435 }
3436 }
3437
Kiyoung Kim22152f62024-05-24 10:45:28 +09003438 if ccDep.InVendorOrProduct() && nonSystemVariantsExist {
Justin Yuncbca3732021-02-03 19:24:13 +09003439 // The vendor and product modules in Make will have been renamed to not conflict with the
3440 // core module, so update the dependency name here accordingly.
Ivan Lozanoc08897c2021-04-02 12:41:32 -04003441 return libName + ccDep.SubName()
Colin Cross6e511a92020-07-27 21:26:48 -07003442 } else if ccDep.InRamdisk() && !ccDep.OnlyInRamdisk() {
Matthew Maurerc6868382021-07-13 14:12:37 -07003443 return libName + RamdiskSuffix
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003444 } else if ccDep.InVendorRamdisk() && !ccDep.OnlyInVendorRamdisk() {
Ivan Lozanoe6d30982021-02-05 10:57:43 -05003445 return libName + VendorRamdiskSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003446 } else if ccDep.InRecovery() && !ccDep.OnlyInRecovery() {
Matthew Maurer460ee942021-02-11 12:31:46 -08003447 return libName + RecoverySuffix
Ivan Lozanof9e21722020-12-02 09:00:51 -05003448 } else if ccDep.Target().NativeBridge == android.NativeBridgeEnabled {
Matthew Maurera61e31f2021-05-27 11:09:11 -07003449 return libName + NativeBridgeSuffix
Colin Cross6e511a92020-07-27 21:26:48 -07003450 } else {
3451 return libName
3452 }
3453}
3454
Colin Crossca860ac2016-01-04 14:34:37 -08003455func (c *Module) InstallInData() bool {
3456 if c.installer == nil {
3457 return false
3458 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003459 return c.installer.inData()
3460}
3461
3462func (c *Module) InstallInSanitizerDir() bool {
3463 if c.installer == nil {
3464 return false
3465 }
3466 if c.sanitize != nil && c.sanitize.inSanitizerDir() {
Colin Cross94610402016-08-29 13:41:32 -07003467 return true
3468 }
Vishwath Mohan1dd88392017-03-29 22:00:18 -07003469 return c.installer.inSanitizerDir()
Colin Crossca860ac2016-01-04 14:34:37 -08003470}
3471
Yifan Hong1b3348d2020-01-21 15:53:22 -08003472func (c *Module) InstallInRamdisk() bool {
3473 return c.InRamdisk()
3474}
3475
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003476func (c *Module) InstallInVendorRamdisk() bool {
3477 return c.InVendorRamdisk()
3478}
3479
Jiyong Parkf9332f12018-02-01 00:54:12 +09003480func (c *Module) InstallInRecovery() bool {
Ivan Lozano52767be2019-10-18 14:49:46 -07003481 return c.InRecovery()
Jiyong Parkf9332f12018-02-01 00:54:12 +09003482}
3483
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00003484func (c *Module) MakeUninstallable() {
3485 if c.installer == nil {
3486 c.ModuleBase.MakeUninstallable()
3487 return
3488 }
3489 c.installer.makeUninstallable(c)
3490}
3491
Dan Willemsen4aa75ca2016-09-28 16:18:03 -07003492func (c *Module) HostToolPath() android.OptionalPath {
3493 if c.installer == nil {
3494 return android.OptionalPath{}
3495 }
3496 return c.installer.hostToolPath()
3497}
3498
Nan Zhangd4e641b2017-07-12 12:55:28 -07003499func (c *Module) IntermPathForModuleOut() android.OptionalPath {
3500 return c.outputFile
3501}
3502
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00003503func (c *Module) static() bool {
3504 if static, ok := c.linker.(interface {
3505 static() bool
3506 }); ok {
3507 return static.static()
3508 }
3509 return false
3510}
3511
Jiyong Park379de2f2018-12-19 02:47:14 +09003512func (c *Module) staticBinary() bool {
3513 if static, ok := c.linker.(interface {
3514 staticBinary() bool
3515 }); ok {
3516 return static.staticBinary()
3517 }
3518 return false
3519}
3520
Evgenii Stepanov193ac2e2020-04-28 15:09:12 -07003521func (c *Module) testBinary() bool {
3522 if test, ok := c.linker.(interface {
3523 testBinary() bool
3524 }); ok {
3525 return test.testBinary()
3526 }
3527 return false
3528}
3529
Jingwen Chen537242c2022-08-24 11:53:27 +00003530func (c *Module) testLibrary() bool {
3531 if test, ok := c.linker.(interface {
3532 testLibrary() bool
3533 }); ok {
3534 return test.testLibrary()
3535 }
3536 return false
3537}
3538
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003539func (c *Module) benchmarkBinary() bool {
3540 if b, ok := c.linker.(interface {
3541 benchmarkBinary() bool
3542 }); ok {
3543 return b.benchmarkBinary()
3544 }
3545 return false
3546}
3547
3548func (c *Module) fuzzBinary() bool {
3549 if f, ok := c.linker.(interface {
3550 fuzzBinary() bool
3551 }); ok {
3552 return f.fuzzBinary()
3553 }
3554 return false
3555}
3556
Ivan Lozano3968d8f2020-12-14 11:27:52 -05003557// Header returns true if the module is a header-only variant. (See cc/library.go header()).
3558func (c *Module) Header() bool {
Jiyong Park1d1119f2019-07-29 21:27:18 +09003559 if h, ok := c.linker.(interface {
3560 header() bool
3561 }); ok {
3562 return h.header()
3563 }
3564 return false
3565}
3566
Ivan Lozanod7586b62021-04-01 09:49:36 -04003567func (c *Module) Binary() bool {
Inseob Kim7f283f42020-06-01 21:53:49 +09003568 if b, ok := c.linker.(interface {
3569 binary() bool
3570 }); ok {
3571 return b.binary()
3572 }
3573 return false
3574}
3575
Justin Yun5e035862021-06-29 20:50:37 +09003576func (c *Module) StaticExecutable() bool {
3577 if b, ok := c.linker.(*binaryDecorator); ok {
3578 return b.static()
3579 }
3580 return false
3581}
3582
Ivan Lozanod7586b62021-04-01 09:49:36 -04003583func (c *Module) Object() bool {
Inseob Kim1042d292020-06-01 23:23:05 +09003584 if o, ok := c.linker.(interface {
3585 object() bool
3586 }); ok {
3587 return o.object()
3588 }
3589 return false
3590}
3591
Kiyoung Kim37693d02024-04-04 09:56:15 +09003592func (m *Module) Dylib() bool {
3593 return false
3594}
3595
3596func (m *Module) Rlib() bool {
3597 return false
3598}
3599
Ivan Lozanof9e21722020-12-02 09:00:51 -05003600func GetMakeLinkType(actx android.ModuleContext, c LinkableInterface) string {
Kiyoung Kim8487c0b2024-01-11 16:03:13 +09003601 if c.InVendorOrProduct() {
Colin Cross127bb8b2020-12-16 16:46:01 -08003602 if c.IsLlndk() {
Ivan Lozanof9e21722020-12-02 09:00:51 -05003603 return "native:vndk"
Jooyung Han38002912019-05-16 04:01:54 +09003604 }
Ivan Lozanof9e21722020-12-02 09:00:51 -05003605 if c.InProduct() {
Justin Yun5f7f7e82019-11-18 19:52:14 +09003606 return "native:product"
3607 }
Jooyung Han38002912019-05-16 04:01:54 +09003608 return "native:vendor"
Yifan Hong1b3348d2020-01-21 15:53:22 -08003609 } else if c.InRamdisk() {
3610 return "native:ramdisk"
Yifan Hong60e0cfb2020-10-21 15:17:56 -07003611 } else if c.InVendorRamdisk() {
3612 return "native:vendor_ramdisk"
Ivan Lozano52767be2019-10-18 14:49:46 -07003613 } else if c.InRecovery() {
Colin Crossb60190a2018-09-04 16:28:17 -07003614 return "native:recovery"
Ivan Lozanof9e21722020-12-02 09:00:51 -05003615 } else if c.Target().Os == android.Android && c.SdkVersion() != "" {
Colin Crossb60190a2018-09-04 16:28:17 -07003616 return "native:ndk:none:none"
3617 // TODO(b/114741097): use the correct ndk stl once build errors have been fixed
3618 //family, link := getNdkStlFamilyAndLinkType(c)
3619 //return fmt.Sprintf("native:ndk:%s:%s", family, link)
3620 } else {
3621 return "native:platform"
3622 }
3623}
3624
Jiyong Park9d452992018-10-03 00:38:19 +09003625// Overrides ApexModule.IsInstallabeToApex()
Colin Cross3a02c7b2024-05-21 13:46:22 -07003626// Only shared/runtime libraries .
Jiyong Park9d452992018-10-03 00:38:19 +09003627func (c *Module) IsInstallableToApex() bool {
Colin Cross31076b32020-10-23 17:22:06 -07003628 if lib := c.library; lib != nil {
Jiyong Park73c54ee2019-10-22 20:31:18 +09003629 // Stub libs and prebuilt libs in a versioned SDK are not
3630 // installable to APEX even though they are shared libs.
Paul Duffin458a15b2022-11-25 12:18:24 +00003631 return lib.shared() && !lib.buildStubs()
Jiyong Park9d452992018-10-03 00:38:19 +09003632 }
3633 return false
3634}
3635
Jiyong Parka90ca002019-10-07 15:47:24 +09003636func (c *Module) AvailableFor(what string) bool {
3637 if linker, ok := c.linker.(interface {
3638 availableFor(string) bool
3639 }); ok {
3640 return c.ApexModuleBase.AvailableFor(what) || linker.availableFor(what)
3641 } else {
3642 return c.ApexModuleBase.AvailableFor(what)
3643 }
3644}
3645
Paul Duffin0cb37b92020-03-04 14:52:46 +00003646func (c *Module) EverInstallable() bool {
3647 return c.installer != nil &&
3648 // Check to see whether the module is actually ever installable.
3649 c.installer.everInstallable()
3650}
3651
Ivan Lozanod7586b62021-04-01 09:49:36 -04003652func (c *Module) PreventInstall() bool {
3653 return c.Properties.PreventInstall
3654}
3655
3656func (c *Module) Installable() *bool {
Colin Cross1bc94122021-10-28 13:25:54 -07003657 if c.library != nil {
3658 if i := c.library.installable(); i != nil {
3659 return i
3660 }
3661 }
Ivan Lozanod7586b62021-04-01 09:49:36 -04003662 return c.Properties.Installable
3663}
3664
3665func installable(c LinkableInterface, apexInfo android.ApexInfo) bool {
Paul Duffin0cb37b92020-03-04 14:52:46 +00003666 ret := c.EverInstallable() &&
3667 // Check to see whether the module has been configured to not be installed.
Ivan Lozanod7586b62021-04-01 09:49:36 -04003668 proptools.BoolDefault(c.Installable(), true) &&
3669 !c.PreventInstall() && c.OutputFile().Valid()
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003670
3671 // The platform variant doesn't need further condition. Apex variants however might not
3672 // be installable because it will likely to be included in the APEX and won't appear
3673 // in the system partition.
Colin Cross56a83212020-09-15 18:30:11 -07003674 if apexInfo.IsForPlatform() {
Jiyong Parkfe9a4302020-01-07 16:59:44 +09003675 return ret
3676 }
3677
3678 // Special case for modules that are configured to be installed to /data, which includes
3679 // test modules. For these modules, both APEX and non-APEX variants are considered as
3680 // installable. This is because even the APEX variants won't be included in the APEX, but
3681 // will anyway be installed to /data/*.
3682 // See b/146995717
3683 if c.InstallInData() {
3684 return ret
3685 }
3686
3687 return false
Inseob Kim1f086e22019-05-09 13:29:15 +09003688}
3689
Logan Chien41eabe62019-04-10 13:33:58 +08003690func (c *Module) AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer) {
3691 if c.linker != nil {
3692 if library, ok := c.linker.(*libraryDecorator); ok {
3693 library.androidMkWriteAdditionalDependenciesForSourceAbiDiff(w)
3694 }
3695 }
3696}
3697
Jiyong Park45bf82e2020-12-15 22:29:02 +09003698var _ android.ApexModule = (*Module)(nil)
3699
3700// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003701func (c *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Colin Cross6e511a92020-07-27 21:26:48 -07003702 depTag := ctx.OtherModuleDependencyTag(dep)
3703 libDepTag, isLibDepTag := depTag.(libraryDependencyTag)
3704
3705 if cc, ok := dep.(*Module); ok {
3706 if cc.HasStubsVariants() {
3707 if isLibDepTag && libDepTag.shared() {
3708 // dynamic dep to a stubs lib crosses APEX boundary
3709 return false
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003710 }
Colin Cross6e511a92020-07-27 21:26:48 -07003711 if IsRuntimeDepTag(depTag) {
3712 // runtime dep to a stubs lib also crosses APEX boundary
Jiyong Parkd7536ba2020-01-16 17:14:23 +09003713 return false
3714 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003715 }
Zhijun Heec285872021-04-24 10:47:08 -07003716 if cc.IsLlndk() {
3717 return false
3718 }
Colin Crossaac32222020-07-29 12:51:56 -07003719 if isLibDepTag && c.static() && libDepTag.shared() {
Colin Cross6e511a92020-07-27 21:26:48 -07003720 // shared_lib dependency from a static lib is considered as crossing
3721 // the APEX boundary because the dependency doesn't actually is
3722 // linked; the dependency is used only during the compilation phase.
3723 return false
3724 }
Jiyong Parke3867542020-12-03 17:28:25 +09003725
3726 if isLibDepTag && libDepTag.excludeInApex {
3727 return false
3728 }
Colin Cross6e511a92020-07-27 21:26:48 -07003729 }
Colin Crossc1b36442021-05-06 13:42:48 -07003730 if depTag == stubImplDepTag {
3731 // We don't track from an implementation library to its stubs.
Jiyong Park7d95a512020-05-10 15:16:24 +09003732 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003733 }
Jiyong Park12177fc2021-01-05 14:37:15 +09003734 if depTag == staticVariantTag {
3735 // This dependency is for optimization (reuse *.o from the static lib). It doesn't
3736 // actually mean that the static lib (and its dependencies) are copied into the
3737 // APEX.
3738 return false
3739 }
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09003740 return true
3741}
3742
Jiyong Park45bf82e2020-12-15 22:29:02 +09003743// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003744func (c *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3745 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003746 // We ignore libclang_rt.* prebuilt libs since they declare sdk_version: 14(b/121358700)
3747 if strings.HasPrefix(ctx.OtherModuleName(c), "libclang_rt") {
3748 return nil
3749 }
Jooyung Han749dc692020-04-15 11:03:39 +09003750 // We don't check for prebuilt modules
3751 if _, ok := c.linker.(prebuiltLinkerInterface); ok {
3752 return nil
3753 }
Kiyoung Kim487689e2022-07-26 09:48:22 +09003754
Jooyung Han749dc692020-04-15 11:03:39 +09003755 minSdkVersion := c.MinSdkVersion()
3756 if minSdkVersion == "apex_inherit" {
3757 return nil
3758 }
3759 if minSdkVersion == "" {
3760 // JNI libs within APK-in-APEX fall into here
3761 // Those are okay to set sdk_version instead
3762 // We don't have to check if this is a SDK variant because
3763 // non-SDK variant resets sdk_version, which works too.
3764 minSdkVersion = c.SdkVersion()
3765 }
Dan Albertc8060532020-07-22 22:32:17 -07003766 if minSdkVersion == "" {
3767 return fmt.Errorf("neither min_sdk_version nor sdk_version specificed")
3768 }
3769 // Not using nativeApiLevelFromUser because the context here is not
3770 // necessarily a native context.
3771 ver, err := android.ApiLevelFromUser(ctx, minSdkVersion)
Jooyung Han749dc692020-04-15 11:03:39 +09003772 if err != nil {
3773 return err
3774 }
Dan Albertc8060532020-07-22 22:32:17 -07003775
Colin Cross8ca61c12022-10-06 21:00:14 -07003776 // A dependency only needs to support a min_sdk_version at least
3777 // as high as the api level that the architecture was introduced in.
3778 // This allows introducing new architectures in the platform that
3779 // need to be included in apexes that normally require an older
3780 // min_sdk_version.
Colin Crossbb137a32023-01-26 09:54:42 -08003781 minApiForArch := MinApiForArch(ctx, c.Target().Arch.ArchType)
Colin Cross8ca61c12022-10-06 21:00:14 -07003782 if sdkVersion.LessThan(minApiForArch) {
3783 sdkVersion = minApiForArch
3784 }
3785
Dan Albertc8060532020-07-22 22:32:17 -07003786 if ver.GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09003787 return fmt.Errorf("newer SDK(%v)", ver)
3788 }
3789 return nil
3790}
3791
Paul Duffinb5769c12021-05-12 16:16:51 +01003792// Implements android.ApexModule
3793func (c *Module) AlwaysRequiresPlatformApexVariant() bool {
3794 // stub libraries and native bridge libraries are always available to platform
3795 return c.IsStubs() || c.Target().NativeBridge == android.NativeBridgeEnabled
3796}
3797
Inseob Kima1888ce2022-10-04 14:42:02 +09003798func (c *Module) overriddenModules() []string {
3799 if o, ok := c.linker.(overridable); ok {
3800 return o.overriddenModules()
3801 }
3802 return nil
3803}
3804
Liz Kammer35ca77e2021-12-22 15:31:40 -05003805type moduleType int
3806
3807const (
3808 unknownType moduleType = iota
3809 binary
3810 object
3811 fullLibrary
3812 staticLibrary
3813 sharedLibrary
3814 headerLibrary
Jingwen Chen537242c2022-08-24 11:53:27 +00003815 testBin // testBinary already declared
Spandan Das1278c2c2022-08-19 18:17:28 +00003816 ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05003817)
3818
3819func (c *Module) typ() moduleType {
Jingwen Chen537242c2022-08-24 11:53:27 +00003820 if c.testBinary() {
3821 // testBinary is also a binary, so this comes before the c.Binary()
3822 // conditional. A testBinary has additional implicit dependencies and
3823 // other test-only semantics.
3824 return testBin
3825 } else if c.Binary() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003826 return binary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003827 } else if c.Object() {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003828 return object
Jingwen Chen537242c2022-08-24 11:53:27 +00003829 } else if c.testLibrary() {
3830 // TODO(b/244431896) properly convert cc_test_library to its own macro. This
3831 // will let them add implicit compile deps on gtest, for example.
3832 //
Liz Kammerefc51d92023-04-21 15:11:25 -04003833 // For now, treat them as regular libraries.
3834 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003835 } else if c.CcLibrary() {
Chris Parsons58852a02021-12-09 18:10:18 -05003836 static := false
3837 shared := false
3838 if library, ok := c.linker.(*libraryDecorator); ok {
3839 static = library.MutatedProperties.BuildStatic
3840 shared = library.MutatedProperties.BuildShared
3841 } else if library, ok := c.linker.(*prebuiltLibraryLinker); ok {
3842 static = library.MutatedProperties.BuildStatic
3843 shared = library.MutatedProperties.BuildShared
3844 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003845 if static && shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003846 return fullLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003847 } else if !static && !shared {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003848 return headerLibrary
Liz Kammerbe46fcc2021-11-01 15:32:43 -04003849 } else if static {
Liz Kammer35ca77e2021-12-22 15:31:40 -05003850 return staticLibrary
3851 }
3852 return sharedLibrary
Spandan Das1278c2c2022-08-19 18:17:28 +00003853 } else if c.isNDKStubLibrary() {
3854 return ndkLibrary
Liz Kammer35ca77e2021-12-22 15:31:40 -05003855 }
3856 return unknownType
3857}
3858
Colin Crosscfad1192015-11-02 16:43:11 -08003859// Defaults
Colin Crossca860ac2016-01-04 14:34:37 -08003860type Defaults struct {
Colin Cross635c3b02016-05-18 15:37:25 -07003861 android.ModuleBase
Colin Cross1f44a3a2017-07-07 14:33:33 -07003862 android.DefaultsModuleBase
Jiyong Park9d452992018-10-03 00:38:19 +09003863 android.ApexModuleBase
Colin Crosscfad1192015-11-02 16:43:11 -08003864}
3865
Patrice Arrudac249c712019-03-19 17:00:29 -07003866// cc_defaults provides a set of properties that can be inherited by other cc
3867// modules. A module can use the properties from a cc_defaults using
3868// `defaults: ["<:default_module_name>"]`. Properties of both modules are
3869// merged (when possible) by prepending the default module's values to the
3870// depending module's values.
Colin Cross36242852017-06-23 15:06:31 -07003871func defaultsFactory() android.Module {
Colin Crosse1d764e2016-08-18 14:18:32 -07003872 return DefaultsFactory()
3873}
3874
Colin Cross36242852017-06-23 15:06:31 -07003875func DefaultsFactory(props ...interface{}) android.Module {
Colin Crossca860ac2016-01-04 14:34:37 -08003876 module := &Defaults{}
Colin Crosscfad1192015-11-02 16:43:11 -08003877
Colin Cross36242852017-06-23 15:06:31 -07003878 module.AddProperties(props...)
3879 module.AddProperties(
Colin Crossca860ac2016-01-04 14:34:37 -08003880 &BaseProperties{},
Dan Willemsen3e5bdf22017-09-13 18:37:08 -07003881 &VendorProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003882 &BaseCompilerProperties{},
3883 &BaseLinkerProperties{},
Paul Duffina37832a2019-07-18 12:31:26 +01003884 &ObjectLinkerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003885 &LibraryProperties{},
Colin Crosse1bb5d02019-09-24 14:55:04 -07003886 &StaticProperties{},
3887 &SharedProperties{},
Colin Cross919281a2016-04-05 16:42:05 -07003888 &FlagExporterProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003889 &BinaryLinkerProperties{},
Trevor Radcliffef389cb42022-03-24 21:06:14 +00003890 &TestLinkerProperties{},
3891 &TestInstallerProperties{},
Colin Crossb916a382016-07-29 17:28:03 -07003892 &TestBinaryProperties{},
Colin Cross43287652020-06-30 10:15:07 -07003893 &BenchmarkProperties{},
hamzehc0a671f2021-07-22 12:05:08 -07003894 &fuzz.FuzzProperties{},
Colin Crossca860ac2016-01-04 14:34:37 -08003895 &StlProperties{},
Colin Cross16b23492016-01-06 14:41:07 -08003896 &SanitizeProperties{},
Colin Cross665dce92016-04-28 14:50:03 -07003897 &StripProperties{},
Dan Willemsen7424d612016-09-01 13:45:39 -07003898 &InstallerProperties{},
Dan Willemsena03cf6d2016-09-26 15:45:04 -07003899 &TidyProperties{},
Dan Willemsen581341d2017-02-09 16:16:31 -08003900 &CoverageProperties{},
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08003901 &SAbiProperties{},
Stephen Craneba090d12017-05-09 15:44:35 -07003902 &LTOProperties{},
Yi Kongeb8efc92021-12-09 18:06:29 +08003903 &AfdoProperties{},
Sharjeel Khanc6a93d82023-07-18 21:01:11 +00003904 &OrderfileProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003905 &android.ProtoProperties{},
Ivan Lozanobc9e4212020-09-25 16:08:34 -04003906 // RustBindgenProperties is included here so that cc_defaults can be used for rust_bindgen modules.
3907 &RustBindgenClangProperties{},
Yu-Chi Cheng24b2b0f2021-06-23 15:56:39 -07003908 &prebuiltLinkerProperties{},
Colin Crosse1d764e2016-08-18 14:18:32 -07003909 )
Colin Crosscfad1192015-11-02 16:43:11 -08003910
Jooyung Hancc372c52019-09-25 15:18:44 +09003911 android.InitDefaultsModule(module)
Colin Cross36242852017-06-23 15:06:31 -07003912
3913 return module
Colin Crosscfad1192015-11-02 16:43:11 -08003914}
3915
Jiyong Park2286afd2020-06-16 21:58:53 +09003916func (c *Module) IsSdkVariant() bool {
Lukacs T. Berki2063a0d2021-06-17 09:32:36 +02003917 return c.Properties.IsSdkVariant
Jiyong Park2286afd2020-06-16 21:58:53 +09003918}
3919
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003920func kytheExtractAllFactory() android.Singleton {
3921 return &kytheExtractAllSingleton{}
3922}
3923
3924type kytheExtractAllSingleton struct {
3925}
3926
3927func (ks *kytheExtractAllSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3928 var xrefTargets android.Paths
3929 ctx.VisitAllModules(func(module android.Module) {
3930 if ccModule, ok := module.(xref); ok {
3931 xrefTargets = append(xrefTargets, ccModule.XrefCcFiles()...)
3932 }
3933 })
3934 // TODO(asmundak): Perhaps emit a rule to output a warning if there were no xrefTargets
3935 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003936 ctx.Phony("xref_cxx", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003937 }
3938}
3939
Jihoon Kangf78a8902022-09-01 22:47:07 +00003940func (c *Module) Partition() string {
3941 if p, ok := c.installer.(interface {
3942 getPartition() string
3943 }); ok {
3944 return p.getPartition()
3945 }
3946 return ""
3947}
3948
Spandan Das2b6dfb52024-01-19 00:22:22 +00003949type sourceModuleName interface {
3950 sourceModuleName() string
3951}
3952
3953func (c *Module) BaseModuleName() string {
3954 if smn, ok := c.linker.(sourceModuleName); ok && smn.sourceModuleName() != "" {
3955 // if the prebuilt module sets a source_module_name in Android.bp, use that
3956 return smn.sourceModuleName()
3957 }
3958 return c.ModuleBase.BaseModuleName()
3959}
3960
Spandan Dase20c56c2024-07-23 21:34:24 +00003961func (c *Module) stubsSymbolFilePath() android.Path {
3962 if library, ok := c.linker.(*libraryDecorator); ok {
3963 return library.stubsSymbolFilePath
3964 }
3965 return android.OptionalPath{}.Path()
3966}
3967
Colin Cross06a931b2015-10-28 17:23:31 -07003968var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003969var BoolDefault = proptools.BoolDefault
Nan Zhang0007d812017-11-07 10:57:05 -08003970var BoolPtr = proptools.BoolPtr
3971var String = proptools.String
3972var StringPtr = proptools.StringPtr