blob: 4373b46b424441577915cb1462f619acd1f8e8d8 [file] [log] [blame]
Colin Cross4d9c2d12016-07-29 12:48:20 -07001// Copyright 2016 Google Inc. All rights reserved.
2//
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
17import (
Inseob Kim69378442019-06-03 19:10:47 +090018 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080019 "io"
Jiyong Parkf1194352019-02-25 11:05:47 +090020 "path/filepath"
Jiyong Parkda732bd2018-11-02 18:23:15 +090021 "regexp"
Jooyung Han11b0fbd2021-02-05 02:28:22 +090022 "strconv"
Colin Cross4d9c2d12016-07-29 12:48:20 -070023 "strings"
Jiyong Parkda732bd2018-11-02 18:23:15 +090024 "sync"
Colin Cross4d9c2d12016-07-29 12:48:20 -070025
Colin Cross4d9c2d12016-07-29 12:48:20 -070026 "android/soong/android"
Kiyoung Kimaa394802024-01-08 12:55:45 +090027
Chris Parsons51f8c392021-08-03 21:01:05 -040028 "github.com/google/blueprint"
29 "github.com/google/blueprint/pathtools"
Spandan Das4238c652022-09-09 01:38:47 +000030 "github.com/google/blueprint/proptools"
Colin Cross4d9c2d12016-07-29 12:48:20 -070031)
32
Liz Kammer2b376bc2022-01-12 12:00:49 -050033// LibraryProperties is a collection of properties shared by cc library rules/cc.
Colin Crossb916a382016-07-29 17:28:03 -070034type LibraryProperties struct {
Colin Cross4d9c2d12016-07-29 12:48:20 -070035 // local file name to pass to the linker as -unexported_symbols_list
Colin Cross27b922f2019-03-04 22:35:41 -080036 Unexported_symbols_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070037 // local file name to pass to the linker as -force_symbols_not_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080038 Force_symbols_not_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070039 // local file name to pass to the linker as -force_symbols_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080040 Force_symbols_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070041
42 // rename host libraries to prevent overlap with system installed libraries
43 Unique_host_soname *bool
44
Dan Willemsene1240db2016-11-03 14:28:51 -070045 Aidl struct {
46 // export headers generated from .aidl sources
Nan Zhang0007d812017-11-07 10:57:05 -080047 Export_aidl_headers *bool
Dan Willemsene1240db2016-11-03 14:28:51 -070048 }
49
Colin Cross0c461f12016-10-20 16:11:43 -070050 Proto struct {
51 // export headers generated from .proto sources
Nan Zhang0007d812017-11-07 10:57:05 -080052 Export_proto_headers *bool
Colin Cross0c461f12016-10-20 16:11:43 -070053 }
Dan Albertf563d252017-10-13 00:29:00 -070054
Inseob Kimc0907f12019-02-08 21:00:45 +090055 Sysprop struct {
56 // Whether platform owns this sysprop library.
57 Platform *bool
Inseob Kimb3f22ca2019-03-05 12:40:24 +090058 } `blueprint:"mutated"`
Inseob Kimc0907f12019-02-08 21:00:45 +090059
Nan Zhang0007d812017-11-07 10:57:05 -080060 Static_ndk_lib *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090061
Florian Mayer6dab96c2020-12-31 11:39:48 +000062 // Generate stubs to make this library accessible to APEXes.
Jiyong Park7ed9de32018-10-15 22:25:07 +090063 Stubs struct {
64 // Relative path to the symbol map. The symbol map provides the list of
65 // symbols that are exported for stubs variant of this library.
Colin Cross27b922f2019-03-04 22:35:41 -080066 Symbol_file *string `android:"path"`
Jiyong Park7ed9de32018-10-15 22:25:07 +090067
Jiyong Parkd4a3a132021-03-17 20:21:35 +090068 // List versions to generate stubs libs for. The version name "current" is always
69 // implicitly added.
Jiyong Park7ed9de32018-10-15 22:25:07 +090070 Versions []string
Alan Stokes73feba32022-11-14 12:21:24 +000071
72 // Whether to not require the implementation of the library to be installed if a
73 // client of the stubs is installed. Defaults to true; set to false if the
74 // implementation is made available by some other means, e.g. in a Microdroid
75 // virtual machine.
76 Implementation_installable *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090077 }
dimitryd95964a2018-11-07 13:43:34 +010078
79 // set the name of the output
80 Stem *string `android:"arch_variant"`
81
Colin Cross0fd6a412019-08-16 14:22:10 -070082 // set suffix of the name of the output
83 Suffix *string `android:"arch_variant"`
84
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +080085 // Properties for ABI compatibility checker.
86 Header_abi_checker headerAbiCheckerProperties
87
Colin Cross0fd6a412019-08-16 14:22:10 -070088 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +090089 Vendor, Product struct {
Colin Cross0fd6a412019-08-16 14:22:10 -070090 // set suffix of the name of the output
91 Suffix *string `android:"arch_variant"`
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +080092
93 Header_abi_checker headerAbiCheckerProperties
Jooyung Han85707de2023-12-01 14:21:13 +090094
95 // Disable stubs for vendor/product variants
96 // This is a workaround to keep `stubs` only for "core" variant (not product/vendor).
97 // It would be nice if we could put `stubs` into a `target: { core: {} }`
98 // block but it's not supported in soong yet. This could be removed/simplified once we have
99 // a better syntax.
100 No_stubs bool
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +0800101 }
102
103 Platform struct {
104 Header_abi_checker headerAbiCheckerProperties
Colin Cross0fd6a412019-08-16 14:22:10 -0700105 }
106 }
107
dimitryd95964a2018-11-07 13:43:34 +0100108 // Names of modules to be overridden. Listed modules can only be other shared libraries
109 // (in Make or Soong).
110 // This does not completely prevent installation of the overridden libraries, but if both
111 // binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
112 // from PRODUCT_PACKAGES.
113 Overrides []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800114
Pete Bentley803e1612019-08-06 22:19:59 +0100115 // Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
116 Inject_bssl_hash *bool `android:"arch_variant"`
Colin Cross0477b422020-10-13 18:43:54 -0700117
Colin Cross127bb8b2020-12-16 16:46:01 -0800118 // If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
119 // the module pointed to by llndk_stubs if it is set.
120 Llndk llndkLibraryProperties
Colin Cross5271fea2021-04-27 13:06:04 -0700121
122 // If this is a vendor public library, properties to describe the vendor public library stubs.
123 Vendor_public_library vendorPublicLibraryProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800124}
Colin Cross0c461f12016-10-20 16:11:43 -0700125
Chris Parsons3c27ca32020-11-20 12:42:07 -0500126// StaticProperties is a properties stanza to affect only attributes of the "static" variants of a
127// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700128type StaticProperties struct {
129 Static StaticOrSharedProperties `android:"arch_variant"`
130}
131
Chris Parsons3c27ca32020-11-20 12:42:07 -0500132// SharedProperties is a properties stanza to affect only attributes of the "shared" variants of a
133// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700134type SharedProperties struct {
135 Shared StaticOrSharedProperties `android:"arch_variant"`
136}
137
Chris Parsons3c27ca32020-11-20 12:42:07 -0500138// StaticOrSharedProperties is an embedded struct representing properties to affect attributes of
139// either only the "static" variants or only the "shared" variants of a library module. These override
140// the base properties of the same name.
141// Use `StaticProperties` or `SharedProperties`, depending on which variant is needed.
142// `StaticOrSharedProperties` exists only to avoid duplication.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700143type StaticOrSharedProperties struct {
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700144 Srcs []string `android:"path,arch_variant"`
145
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700146 Tidy_disabled_srcs []string `android:"path,arch_variant"`
147
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800148 Tidy_timeout_srcs []string `android:"path,arch_variant"`
149
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700150 Sanitized Sanitized `android:"arch_variant"`
151
Cole Fauste96c16a2024-06-13 14:51:14 -0700152 Cflags proptools.Configurable[[]string] `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700153
Colin Cross6b8f4252021-07-22 11:39:44 -0700154 Enabled *bool `android:"arch_variant"`
155 Whole_static_libs []string `android:"arch_variant"`
156 Static_libs []string `android:"arch_variant"`
157 Shared_libs []string `android:"arch_variant"`
158 System_shared_libs []string `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700159
160 Export_shared_lib_headers []string `android:"arch_variant"`
161 Export_static_lib_headers []string `android:"arch_variant"`
Jiyong Parka90ca002019-10-07 15:47:24 +0900162
163 Apex_available []string `android:"arch_variant"`
Colin Cross1bc94122021-10-28 13:25:54 -0700164
165 Installable *bool `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700166}
167
Colin Crossa48ab5b2017-02-14 15:28:44 -0800168type LibraryMutatedProperties struct {
Colin Crossb916a382016-07-29 17:28:03 -0700169 // Build a static variant
170 BuildStatic bool `blueprint:"mutated"`
171 // Build a shared variant
172 BuildShared bool `blueprint:"mutated"`
173 // This variant is shared
174 VariantIsShared bool `blueprint:"mutated"`
175 // This variant is static
176 VariantIsStatic bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900177
178 // This variant is a stubs lib
179 BuildStubs bool `blueprint:"mutated"`
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900180 // This variant is the latest version
181 IsLatestVersion bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900182 // Version of the stubs lib
183 StubsVersion string `blueprint:"mutated"`
Colin Crossd1f898e2020-08-18 18:35:15 -0700184 // List of all stubs versions associated with an implementation lib
185 AllStubsVersions []string `blueprint:"mutated"`
Colin Crossb916a382016-07-29 17:28:03 -0700186}
187
188type FlagExporterProperties struct {
189 // list of directories relative to the Blueprints file that will
Dan Willemsen273af7f2016-11-03 15:53:42 -0700190 // be added to the include path (using -I) for this module and any module that links
Colin Cross5d195602017-10-17 16:15:50 -0700191 // against this module. Directories listed in export_include_dirs do not need to be
192 // listed in local_include_dirs.
Aleks Todorovc9becde2024-06-10 12:51:53 +0100193 Export_include_dirs proptools.Configurable[[]string] `android:"arch_variant,variant_prepend"`
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700194
Jiyong Park73c54ee2019-10-22 20:31:18 +0900195 // list of directories that will be added to the system include path
196 // using -isystem for this module and any module that links against this module.
Colin Cross0ed579e2021-06-29 00:51:12 +0000197 Export_system_include_dirs []string `android:"arch_variant,variant_prepend"`
Jiyong Park73c54ee2019-10-22 20:31:18 +0900198
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700199 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900200 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700201 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900202 // export_include_dirs, that will be applied to
203 // vendor or product variant of this library.
204 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800205 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700206 }
207 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700208}
209
210func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000211 RegisterLibraryBuildComponents(android.InitRegistrationContext)
212}
213
214func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
215 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
216 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
217 ctx.RegisterModuleType("cc_library", LibraryFactory)
218 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
219 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700220}
221
Patrice Arruda83c89e02019-03-25 15:32:39 -0700222// cc_library creates both static and/or shared libraries for a device and/or
223// host. By default, a cc_library has a single variant that targets the device.
224// Specifying `host_supported: true` also creates a library that targets the
225// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700226func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800227 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000228 // Can be used as both a static and a shared library.
229 module.sdkMemberTypes = []android.SdkMemberType{
230 sharedLibrarySdkMemberType,
231 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000232 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000233 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700234 return module.Init()
235}
236
Patrice Arruda83c89e02019-03-25 15:32:39 -0700237// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700238func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800239 module, library := NewLibrary(android.HostAndDeviceSupported)
240 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000241 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700242 return module.Init()
243}
244
Patrice Arruda83c89e02019-03-25 15:32:39 -0700245// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700246func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800247 module, library := NewLibrary(android.HostAndDeviceSupported)
248 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000249 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700250 return module.Init()
251}
252
Patrice Arruda83c89e02019-03-25 15:32:39 -0700253// cc_library_host_static creates a static library that is linkable to a host
254// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700255func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800256 module, library := NewLibrary(android.HostSupported)
257 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000258 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700259 return module.Init()
260}
261
Patrice Arruda83c89e02019-03-25 15:32:39 -0700262// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700263func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800264 module, library := NewLibrary(android.HostSupported)
265 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000266 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700267 return module.Init()
268}
269
Chris Parsons3c27ca32020-11-20 12:42:07 -0500270// flagExporter is a separated portion of libraryDecorator pertaining to exported
271// include paths and flags. Keeping this dependency-related information separate
272// from the rest of library information is helpful in keeping data more structured
273// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700274type flagExporter struct {
275 Properties FlagExporterProperties
276
Ivan Lozano0a468a42024-05-13 21:03:34 -0400277 dirs android.Paths // Include directories to be included with -I
278 systemDirs android.Paths // System include directories to be included with -isystem
279 flags []string // Exported raw flags.
280 deps android.Paths
281 headers android.Paths
282 rustRlibDeps []RustRlibDep
Colin Cross4d9c2d12016-07-29 12:48:20 -0700283}
284
Chris Parsons3c27ca32020-11-20 12:42:07 -0500285// exportedIncludes returns the effective include paths for this module and
286// any module that links against this module. This is obtained from
287// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700288func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900289 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800290 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700291 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900292 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
293 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
294 }
Aleks Todorovc9becde2024-06-10 12:51:53 +0100295 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs.GetOrDefault(ctx, nil))
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700296}
297
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +0800298func (f *flagExporter) exportedSystemIncludes(ctx ModuleContext) android.Paths {
299 return android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)
300}
301
Chris Parsons3c27ca32020-11-20 12:42:07 -0500302// exportIncludes registers the include directories and system include directories to be exported
303// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900304func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900305 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900306 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700307}
308
Chris Parsons3c27ca32020-11-20 12:42:07 -0500309// exportIncludesAsSystem registers the include directories and system include directories to be
310// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900311func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900312 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900313 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900314 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900315}
316
Chris Parsons3c27ca32020-11-20 12:42:07 -0500317// reexportDirs registers the given directories as include directories to be exported transitively
318// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900319func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900320 f.dirs = append(f.dirs, dirs...)
321}
322
Chris Parsons3c27ca32020-11-20 12:42:07 -0500323// reexportSystemDirs registers the given directories as system include directories
324// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900325func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900326 f.systemDirs = append(f.systemDirs, dirs...)
327}
328
Chris Parsons3c27ca32020-11-20 12:42:07 -0500329// reexportFlags registers the flags to be exported transitively to modules depending on this
330// module.
Inseob Kim69378442019-06-03 19:10:47 +0900331func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800332 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
333 panic(fmt.Errorf("Exporting invalid flag %q: "+
334 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900335 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700336 f.flags = append(f.flags, flags...)
337}
338
Inseob Kim69378442019-06-03 19:10:47 +0900339func (f *flagExporter) reexportDeps(deps ...android.Path) {
340 f.deps = append(f.deps, deps...)
341}
342
Ivan Lozano0a468a42024-05-13 21:03:34 -0400343func (f *flagExporter) reexportRustStaticDeps(deps ...RustRlibDep) {
344 f.rustRlibDeps = append(f.rustRlibDeps, deps...)
345}
346
Inseob Kimd110f872019-12-06 13:15:38 +0900347// addExportedGeneratedHeaders does nothing but collects generated header files.
348// This can be differ to exportedDeps which may contain phony files to minimize ninja.
349func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
350 f.headers = append(f.headers, headers...)
351}
352
Colin Cross0de8a1e2020-09-18 14:15:30 -0700353func (f *flagExporter) setProvider(ctx android.ModuleContext) {
Colin Cross40213022023-12-13 15:19:49 -0800354 android.SetProvider(ctx, FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400355 // Comes from Export_include_dirs property, and those of exported transitive deps
356 IncludeDirs: android.FirstUniquePaths(f.dirs),
357 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700358 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400359 // Used in very few places as a one-off way of adding extra defines.
360 Flags: f.flags,
361 // Used sparingly, for extra files that need to be explicitly exported to dependers,
362 // or for phony files to minimize ninja.
363 Deps: f.deps,
Ivan Lozano0a468a42024-05-13 21:03:34 -0400364 // Used for exporting rlib deps of static libraries to dependents.
365 RustRlibDeps: f.rustRlibDeps,
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400366 // For exported generated headers, such as exported aidl headers, proto headers, or
367 // sysprop headers.
368 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700369 })
Inseob Kim69378442019-06-03 19:10:47 +0900370}
371
Colin Crossb916a382016-07-29 17:28:03 -0700372// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
373// functionality: static vs. shared linkage, reusing object files for shared libraries
374type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800375 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700376 StaticProperties StaticProperties
377 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800378 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700379
380 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900381 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700382
Colin Cross26c34ed2016-09-30 17:10:16 -0700383 // table-of-contents file to optimize out relinking when possible
384 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700385
Colin Cross4d9c2d12016-07-29 12:48:20 -0700386 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400387 flagExporterInfo *FlagExporterInfo
388 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700389
Colin Cross4d9c2d12016-07-29 12:48:20 -0700390 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800391 objects Objects
392 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700393
394 // Uses the module's name if empty, but can be overridden. Does not include
395 // shlib suffix.
396 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700397
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800398 sabi *sabi
399
Dan Willemsen581341d2017-02-09 16:16:31 -0800400 // Output archive of gcno coverage information files
401 coverageOutputFile android.OptionalPath
402
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800403 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800404 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000405
Colin Cross0875c522017-11-28 17:34:01 -0800406 // Location of the static library in the sysroot. Empty if the library is
407 // not included in the NDK.
408 ndkSysrootPath android.Path
409
Colin Crossb60190a2018-09-04 16:28:17 -0700410 // Location of the linked, unstripped library for shared libraries
411 unstrippedOutputFile android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800412 // Location of the linked, stripped library for shared libraries, strip: "all"
413 strippedAllOutputFile android.Path
Colin Crossb60190a2018-09-04 16:28:17 -0700414
Dan Willemsen569edc52018-11-19 09:33:29 -0800415 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000416 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800417
Colin Cross8e21aa52020-09-28 18:28:02 -0700418 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900419
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800420 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900421
Colin Cross5ec407b2020-09-30 11:41:33 -0700422 skipAPIDefine bool
423
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100424 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700425 *baseCompiler
426 *baseLinker
427 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900428
sophiez4c4f8032021-08-16 22:54:00 -0700429 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900430}
431
Chris Parsons3c27ca32020-11-20 12:42:07 -0500432// linkerProps returns the list of properties structs relevant for this library. (For example, if
433// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -0700434func (library *libraryDecorator) linkerProps() []interface{} {
435 var props []interface{}
436 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700437 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700438 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -0800439 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700440 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -0700441 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700442
443 if library.MutatedProperties.BuildShared {
444 props = append(props, &library.SharedProperties)
445 }
446 if library.MutatedProperties.BuildStatic {
447 props = append(props, &library.StaticProperties)
448 }
449
450 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -0700451}
452
Chris Parsons3c27ca32020-11-20 12:42:07 -0500453// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
454// library, or that are implied by attributes of this library (such as whether this library is a
455// shared library).
Colin Crossb916a382016-07-29 17:28:03 -0700456func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -0700457 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700458
Colin Crossb916a382016-07-29 17:28:03 -0700459 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
460 // all code is position independent, and then those warnings get promoted to
461 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -0700462 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800463 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -0700464 }
465
466 if library.static() {
Cole Fauste96c16a2024-06-13 14:51:14 -0700467 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags.GetOrDefault(ctx, nil)...)
Colin Crossa48ab5b2017-02-14 15:28:44 -0800468 } else if library.shared() {
Cole Fauste96c16a2024-06-13 14:51:14 -0700469 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags.GetOrDefault(ctx, nil)...)
Colin Crossb916a382016-07-29 17:28:03 -0700470 }
471
Colin Crossa48ab5b2017-02-14 15:28:44 -0800472 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700473 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700474 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -0700475 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700476 f = append(f,
477 "-nostdlib",
478 "-Wl,--gc-sections",
479 )
480 }
481
482 if ctx.Darwin() {
483 f = append(f,
484 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -0700485 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
486 )
Colin Cross7863cf52016-10-20 10:47:21 -0700487 if ctx.Arch().ArchType == android.X86 {
488 f = append(f,
489 "-read_only_relocs suppress",
490 )
491 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700492 } else {
Josh Gao75a50a22019-06-07 17:58:59 -0700493 f = append(f, "-shared")
494 if !ctx.Windows() {
495 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
496 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700497 }
498
Colin Cross4af21ed2019-11-04 09:37:55 -0800499 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700500 }
501
502 return flags
503}
504
Chris Parsons3c27ca32020-11-20 12:42:07 -0500505// compilerFlags takes a Flags and augments it to contain compile flags from global values,
506// per-target values, module type values, per-module Blueprints properties, extra flags from
507// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -0800508func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700509 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700510 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -0700511 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -0800512 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
513 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700514 }
515
Jiyong Park7ed9de32018-10-15 22:25:07 +0900516 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -0800517 if ctx.IsLlndk() {
518 // LLNDK libraries ignore most of the properties on the cc_library and use the
519 // LLNDK-specific properties instead.
520 // Wipe all the module-local properties, leaving only the global properties.
521 flags.Local = LocalOrGlobalFlags{}
522 }
Jiyong Park7ed9de32018-10-15 22:25:07 +0900523 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +0900524 // Remove -include <file> when compiling stubs. Otherwise, the force included
525 // headers might cause conflicting types error with the symbols in the
526 // generated stubs source code. e.g.
527 // double acos(double); // in header
528 // void acos() {} // in the generated source code
529 removeInclude := func(flags []string) []string {
530 ret := flags[:0]
531 for _, f := range flags {
532 if strings.HasPrefix(f, "-include ") {
533 continue
534 }
535 ret = append(ret, f)
536 }
537 return ret
538 }
Colin Cross4af21ed2019-11-04 09:37:55 -0800539 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
540 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +0900541
Jiyong Park7ed9de32018-10-15 22:25:07 +0900542 flags = addStubLibraryCompilerFlags(flags)
543 }
544 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -0700545}
546
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +0800547func (library *libraryDecorator) getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties {
548 m := ctx.Module().(*Module)
549 variantProps := &library.Properties.Target.Platform.Header_abi_checker
550 if m.InVendor() {
551 variantProps = &library.Properties.Target.Vendor.Header_abi_checker
552 } else if m.InProduct() {
553 variantProps = &library.Properties.Target.Product.Header_abi_checker
554 }
555 props := library.Properties.Header_abi_checker
556 err := proptools.AppendProperties(&props, variantProps, nil)
557 if err != nil {
558 ctx.ModuleErrorf("Cannot merge headerAbiCheckerProperties: %s", err.Error())
559 }
560 return props
Logan Chien41eabe62019-04-10 13:33:58 +0800561}
562
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700563func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -0800564 if ctx.IsLlndk() {
Jooyung Han33eb6152024-03-11 15:46:48 +0900565 vendorApiLevel := ctx.Config().VendorApiLevel()
566 if vendorApiLevel == "" {
567 // TODO(b/321892570): Some tests relying on old fixtures which
568 // doesn't set vendorApiLevel. Needs to fix them.
569 vendorApiLevel = ctx.Config().PlatformSdkVersion().String()
570 }
Colin Cross127bb8b2020-12-16 16:46:01 -0800571 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
Dan Albertf1d14c72020-07-30 14:32:55 -0700572 nativeAbiResult := parseNativeAbiDefinition(ctx,
573 String(library.Properties.Llndk.Symbol_file),
Jooyung Han33eb6152024-03-11 15:46:48 +0900574 android.ApiLevelOrPanic(ctx, vendorApiLevel), "--llndk")
Dan Albertf1d14c72020-07-30 14:32:55 -0700575 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -0800576 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -0700577 library.versionScriptPath = android.OptionalPathForPath(
578 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -0800579 }
580 return objs
581 }
Colin Cross5271fea2021-04-27 13:06:04 -0700582 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -0700583 nativeAbiResult := parseNativeAbiDefinition(ctx,
584 String(library.Properties.Vendor_public_library.Symbol_file),
585 android.FutureApiLevel, "")
586 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -0700587 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -0700588 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -0700589 }
590 return objs
591 }
Jiyong Park7ed9de32018-10-15 22:25:07 +0900592 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +0900593 symbolFile := String(library.Properties.Stubs.Symbol_file)
594 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
595 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
596 return Objects{}
597 }
Jiyong Park85cc35a2022-07-17 11:30:47 +0900598 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
599 // systemapi, respectively. The former is for symbols defined in platform libraries
600 // and the latter is for symbols defined in APEXes.
Spandan Das934c97d2023-01-18 23:54:13 +0000601 // A single library can contain either # apex or # systemapi, but not both.
602 // The stub generator (ndkstubgen) is additive, so passing _both_ of these to it should be a no-op.
603 // However, having this distinction helps guard accidental
604 // promotion or demotion of API and also helps the API review process b/191371676
Jiyong Park85cc35a2022-07-17 11:30:47 +0900605 var flag string
606 if ctx.Module().(android.ApexModule).NotInPlatform() {
607 flag = "--apex"
608 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +0900609 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +0900610 }
Jiyong Parkaa27c082022-09-26 21:16:09 +0900611 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
612 // the stub so that it is mandated that all symbols are explicitly marked with
613 // either apex or systemapi.
614 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
615 flag = flag + " --no-ndk"
616 }
Dan Albertf1d14c72020-07-30 14:32:55 -0700617 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +0900618 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -0700619 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
620 library.versionScriptPath = android.OptionalPathForPath(
621 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -0700622
623 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -0700624 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -0700625 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
626 }
627
Jiyong Park7ed9de32018-10-15 22:25:07 +0900628 return objs
629 }
630
Colin Cross5950f382016-12-13 12:50:57 -0800631 if !library.buildShared() && !library.buildStatic() {
632 if len(library.baseCompiler.Properties.Srcs) > 0 {
633 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
634 }
Colin Crosse1bb5d02019-09-24 14:55:04 -0700635 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -0800636 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
637 }
Colin Crosse1bb5d02019-09-24 14:55:04 -0700638 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -0800639 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
640 }
641 return Objects{}
642 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800643 if library.sabi.shouldCreateSourceAbiDump() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +0800644 dirs := library.exportedIncludeDirsForAbiCheck(ctx)
645 flags.SAbiFlags = make([]string, 0, len(dirs))
646 for _, dir := range dirs {
647 flags.SAbiFlags = append(flags.SAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800648 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800649 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -0700650 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800651 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800652 flags.SAbiDump = true
653 }
654 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700655 objs := library.baseCompiler.compile(ctx, flags, deps)
656 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -0700657 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -0700658
Colin Cross4d9c2d12016-07-29 12:48:20 -0700659 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -0700660 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700661 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
662 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800663 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700664 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -0800665 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -0700666 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700667 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
668 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800669 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700670 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -0700671 }
672
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700673 return objs
Colin Crossb916a382016-07-29 17:28:03 -0700674}
675
676type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -0700677 versionedInterface
678
Colin Crossb916a382016-07-29 17:28:03 -0700679 static() bool
Inseob Kimae553032019-05-14 18:52:49 +0900680 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700681 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -0700682 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -0700683 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -0700684
685 // Returns true if the build options for the module have selected a static or shared build
686 buildStatic() bool
687 buildShared() bool
688
689 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -0800690 setStatic()
691 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +0800692
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +0800693 // Gets the ABI properties for vendor, product, or platform variant
694 getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800695
Logan Chien41eabe62019-04-10 13:33:58 +0800696 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
697 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +0900698
699 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -0700700
701 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -0700702
703 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -0700704}
705
Colin Crossc88c2722020-09-28 17:32:47 -0700706type versionedInterface interface {
707 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900708 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -0700709 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +0000710 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -0700711 setStubsVersion(string)
712 stubsVersion() string
713
Colin Cross3572cf72020-10-01 15:58:11 -0700714 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -0700715 setAllStubsVersions([]string)
716 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -0700717
718 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -0800719 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -0700720 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700721 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -0700722}
723
724var _ libraryInterface = (*libraryDecorator)(nil)
725var _ versionedInterface = (*libraryDecorator)(nil)
726
Justin Yun6977e8a2020-10-29 18:24:11 +0900727func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -0700728 name := library.libName
729 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +0100730 name = String(library.Properties.Stem)
731 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +0900732 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +0100733 }
Colin Crossb916a382016-07-29 17:28:03 -0700734 }
735
Colin Cross0fd6a412019-08-16 14:22:10 -0700736 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +0900737 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -0700738 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +0900739 } else if inProduct {
740 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -0700741 }
742 if suffix == "" {
743 suffix = String(library.Properties.Suffix)
744 }
745
Jooyung Han0302a842019-10-30 18:43:49 +0900746 return name + suffix
747}
748
Chris Parsons3c27ca32020-11-20 12:42:07 -0500749// getLibName returns the actual canonical name of the library (the name which
750// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +0900751func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +0900752 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -0700753
Colin Crossb916a382016-07-29 17:28:03 -0700754 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
755 if !strings.HasSuffix(name, "-host") {
756 name = name + "-host"
757 }
758 }
759
Inseob Kim0ce291e2019-07-04 14:38:27 +0900760 return name
Colin Crossb916a382016-07-29 17:28:03 -0700761}
762
Jiyong Parkda732bd2018-11-02 18:23:15 +0900763var versioningMacroNamesListMutex sync.Mutex
764
Colin Crossb916a382016-07-29 17:28:03 -0700765func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
766 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -0700767 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700768 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -0700769 }
770 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -0700771 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +0900772 // Let baseLinker know whether this variant is for stubs or not, so that
773 // it can omit things that are not required for linking stubs.
774 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +0900775
776 if library.buildStubs() {
777 macroNames := versioningMacroNamesList(ctx.Config())
778 myName := versioningMacroName(ctx.ModuleName())
779 versioningMacroNamesListMutex.Lock()
780 defer versioningMacroNamesListMutex.Unlock()
781 if (*macroNames)[myName] == "" {
782 (*macroNames)[myName] = ctx.ModuleName()
783 } else if (*macroNames)[myName] != ctx.ModuleName() {
784 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
785 }
786 }
Colin Crossb916a382016-07-29 17:28:03 -0700787}
788
dimitry0345ad82018-12-05 16:28:14 +0100789func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -0800790 if ctx.IsLlndk() {
791 // LLNDK libraries ignore most of the properties on the cc_library and use the
792 // LLNDK-specific properties instead.
793 return deps
794 }
795
dimitry0345ad82018-12-05 16:28:14 +0100796 deps = library.baseCompiler.compilerDeps(ctx, deps)
797
dimitry0345ad82018-12-05 16:28:14 +0100798 return deps
799}
800
Colin Cross37047f12016-12-13 17:06:13 -0800801func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -0800802 if ctx.IsLlndk() {
803 // LLNDK libraries ignore most of the properties on the cc_library and use the
804 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -0800805 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
806 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -0800807 return deps
808 }
Colin Cross5271fea2021-04-27 13:06:04 -0700809 if ctx.IsVendorPublicLibrary() {
810 headers := library.Properties.Vendor_public_library.Export_public_headers
811 deps.HeaderLibs = append([]string(nil), headers...)
812 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
813 return deps
814 }
Colin Cross127bb8b2020-12-16 16:46:01 -0800815
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800816 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +0000817 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700818 if library.StaticProperties.Static.System_shared_libs != nil {
819 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800820 }
821 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +0000822 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700823 if library.SharedProperties.Shared.System_shared_libs != nil {
824 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800825 }
826 }
827
Colin Crossb916a382016-07-29 17:28:03 -0700828 deps = library.baseLinker.linkerDeps(ctx, deps)
829
830 if library.static() {
831 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -0700832 library.StaticProperties.Static.Whole_static_libs...)
833 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
834 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -0800835
Colin Crosse1bb5d02019-09-24 14:55:04 -0700836 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
837 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -0800838 } else if library.shared() {
Alex Márquez Pérez Muñíz Díaz Puras Thaureaux01ec55e2023-01-30 22:53:04 +0000839 if library.baseLinker.Properties.crt() {
Colin Crossd1a28132021-06-21 17:34:47 -0700840 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
841 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Kalesh Singhf4ffe0a2024-01-29 13:01:51 -0800842
843 }
844 if library.baseLinker.Properties.crtPadSegment() {
845 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtPadSegmentSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700846 }
Colin Crosse1bb5d02019-09-24 14:55:04 -0700847 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
848 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
849 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -0800850
Colin Crosse1bb5d02019-09-24 14:55:04 -0700851 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
852 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800853
854 deps.LlndkHeaderLibs = append(deps.LlndkHeaderLibs, library.Properties.Llndk.Export_llndk_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700855 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900856 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +0900857 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
858 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
859 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +0000860 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
861 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +0900862 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900863 if ctx.inProduct() {
864 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
865 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
866 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
867 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
868 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
869 }
Jiyong Parkf9332f12018-02-01 00:54:12 +0900870 if ctx.inRecovery() {
871 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
872 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
873 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +0000874 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
875 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900876 }
Yifan Hongcf4832c2020-01-21 17:04:13 -0800877 if ctx.inRamdisk() {
878 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
879 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
880 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
881 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
882 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
883 }
Yifan Hong6da33c22020-10-27 15:01:21 -0700884 if ctx.inVendorRamdisk() {
885 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
886 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
887 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
888 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
889 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
890 }
Colin Cross2383f3b2018-02-06 14:40:13 -0800891
Colin Cross4d9c2d12016-07-29 12:48:20 -0700892 return deps
893}
894
Paul Duffin13f02712020-03-06 12:30:43 +0000895func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
896 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
897 var properties StaticOrSharedProperties
898 if library.static() {
899 properties = library.StaticProperties.Static
900 } else if library.shared() {
901 properties = library.SharedProperties.Shared
902 }
903
904 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +0000905
906 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
907 // either input list doesn't come out as nil.
908 if specifiedDeps.systemSharedLibs == nil {
909 specifiedDeps.systemSharedLibs = properties.System_shared_libs
910 } else {
911 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
912 }
Paul Duffin13f02712020-03-06 12:30:43 +0000913
914 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +0000915 if len(specifiedDeps.systemSharedLibs) > 0 {
916 // Skip this if systemSharedLibs is either nil or [], to ensure they are
917 // retained.
918 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
919 }
Paul Duffin13f02712020-03-06 12:30:43 +0000920 return specifiedDeps
921}
922
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800923func (library *libraryDecorator) moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON) {
924 if library.static() {
925 moduleInfoJSON.Class = []string{"STATIC_LIBRARIES"}
926 moduleInfoJSON.Uninstallable = true
927 } else if library.shared() {
928 moduleInfoJSON.Class = []string{"SHARED_LIBRARIES"}
929 } else if library.header() {
930 moduleInfoJSON.Class = []string{"HEADER_LIBRARIES"}
931 moduleInfoJSON.Uninstallable = true
932 }
933
934 if library.buildStubs() && library.stubsVersion() != "" {
935 moduleInfoJSON.SubName += "." + library.stubsVersion()
936 }
937
938 // If a library providing a stub is included in an APEX, the private APIs of the library
939 // is accessible only inside the APEX. From outside of the APEX, clients can only use the
940 // public APIs via the stub. To enforce this, the (latest version of the) stub gets the
941 // name of the library. The impl library instead gets the `.bootstrap` suffix to so that
942 // they can be exceptionally used directly when APEXes are not available (e.g. during the
943 // very early stage in the boot process).
944 if len(library.Properties.Stubs.Versions) > 0 && !ctx.Host() && ctx.notInPlatform() &&
945 !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && !ctx.useVndk() && !ctx.static() {
946 if library.buildStubs() && library.isLatestStubVersion() {
947 moduleInfoJSON.SubName = ""
948 }
949 if !library.buildStubs() {
950 moduleInfoJSON.SubName = ".bootstrap"
951 }
952 }
953
954 library.baseLinker.moduleInfoJSON(ctx, moduleInfoJSON)
955}
956
Colin Crossb916a382016-07-29 17:28:03 -0700957func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700958 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700959
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700960 library.objects = deps.WholeStaticLibObjs.Copy()
961 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800962 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700963
Inseob Kim0ce291e2019-07-04 14:38:27 +0900964 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -0800965 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -0800966 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700967
Dan Willemsen569edc52018-11-19 09:33:29 -0800968 if Bool(library.baseLinker.Properties.Use_version_lib) {
969 if ctx.Host() {
970 versionedOutputFile := outputFile
971 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
972 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
973 } else {
974 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000975 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -0800976 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
977 }
Colin Cross86803cf2018-02-15 14:12:26 -0800978 }
979
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800980 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -0800981
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500982 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -0700983
Colin Cross4d9c2d12016-07-29 12:48:20 -0700984 ctx.CheckbuildFile(outputFile)
985
Colin Cross649d8172020-12-10 12:30:21 -0800986 if library.static() {
Colin Cross40213022023-12-13 15:19:49 -0800987 android.SetProvider(ctx, StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800988 StaticLibrary: outputFile,
989 ReuseObjects: library.reuseObjects,
990 Objects: library.objects,
991 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700992
Colin Crossc85750b2022-04-21 12:50:51 -0700993 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
Colin Cross649d8172020-12-10 12:30:21 -0800994 Direct(outputFile).
995 Transitive(deps.TranstiveStaticLibrariesForOrdering).
996 Build(),
997 })
998 }
999
1000 if library.header() {
Colin Cross40213022023-12-13 15:19:49 -08001001 android.SetProvider(ctx, HeaderLibraryInfoProvider, HeaderLibraryInfo{})
Colin Cross649d8172020-12-10 12:30:21 -08001002 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001003
Colin Cross4d9c2d12016-07-29 12:48:20 -07001004 return outputFile
1005}
1006
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001007func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1008 if ctx.Module().(*Module).IsSdkVariant() {
1009 // The NDK sysroot timestamp file depends on all the NDK
1010 // sysroot header and shared library files.
1011 return android.Paths{getNdkBaseTimestampFile(ctx)}
1012 }
1013 return nil
1014}
1015
Colin Crossb916a382016-07-29 17:28:03 -07001016func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001017 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001018
1019 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001020 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001021 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001022
Colin Cross2383f3b2018-02-06 14:40:13 -08001023 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1024 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1025 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001026 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001027 if unexportedSymbols.Valid() {
1028 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1029 }
1030 if forceNotWeakSymbols.Valid() {
1031 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1032 }
1033 if forceWeakSymbols.Valid() {
1034 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1035 }
1036 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001037 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001038 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001039 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1040 }
1041 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001042 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001043 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1044 }
1045 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001046 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001047 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1048 }
1049 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001050 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001051 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001052 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001053 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001054 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001055
1056 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1057 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001058 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001059
Josh Gao75a50a22019-06-07 17:58:59 -07001060 var implicitOutputs android.WritablePaths
1061 if ctx.Windows() {
1062 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1063
Colin Cross4af21ed2019-11-04 09:37:55 -08001064 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001065 implicitOutputs = append(implicitOutputs, importLibraryPath)
1066 }
1067
Colin Cross4d9c2d12016-07-29 12:48:20 -07001068 builderFlags := flagsToBuilderFlags(flags)
1069
Dan Willemsen47450072021-10-19 20:24:49 -07001070 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1071 fatOutputFile := outputFile
1072 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1073 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1074 }
1075
Colin Crossb496cfd2018-09-10 16:50:05 -07001076 // Optimize out relinking against shared libraries whose interface hasn't changed by
1077 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001078 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001079 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001080 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001081
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001082 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001083 needsStrip := library.stripper.NeedsStrip(ctx)
1084 if library.buildStubs() {
1085 // No need to strip stubs libraries
1086 needsStrip = false
1087 }
1088 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001089 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001090 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001091 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001092 strippedOutputFile := outputFile
1093 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001094 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001095 }
Colin Crossb60190a2018-09-04 16:28:17 -07001096 library.unstrippedOutputFile = outputFile
1097
Colin Crossd7227f92019-09-05 14:26:33 -07001098 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001099
Dan Willemsen569edc52018-11-19 09:33:29 -08001100 if Bool(library.baseLinker.Properties.Use_version_lib) {
1101 if ctx.Host() {
1102 versionedOutputFile := outputFile
1103 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1104 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1105 } else {
1106 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001107 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001108
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001109 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001110 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001111 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001112 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001113 }
1114
1115 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1116 }
Colin Cross86803cf2018-02-15 14:12:26 -08001117 }
1118
Wei Li5f5d2712023-12-11 15:40:29 -08001119 // Generate an output file for dist as if strip: "all" is set on the module.
1120 // Currently this is for layoutlib release process only.
1121 for _, dist := range ctx.Module().(*Module).Dists() {
1122 if dist.Tag != nil && *dist.Tag == "stripped_all" {
1123 strippedAllOutputFile := android.PathForModuleOut(ctx, "stripped_all", fileName)
1124 transformStrip(ctx, outputFile, strippedAllOutputFile, StripFlags{Toolchain: flags.Toolchain})
1125 library.strippedAllOutputFile = strippedAllOutputFile
1126 break
1127 }
1128 }
1129
Jiyong Park64a44f22019-01-18 14:37:08 +09001130 sharedLibs := deps.EarlySharedLibs
1131 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001132 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1133
Jiyong Park64a44f22019-01-18 14:37:08 +09001134 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001135 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1136 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04001137
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04001138 if generatedLib := generateRustStaticlib(ctx, deps.RustRlibDeps); generatedLib != nil && !library.buildStubs() {
1139 if ctx.Module().(*Module).WholeRustStaticlib {
1140 deps.WholeStaticLibs = append(deps.WholeStaticLibs, generatedLib)
1141 } else {
1142 deps.StaticLibs = append(deps.StaticLibs, generatedLib)
1143 }
Ivan Lozano0a468a42024-05-13 21:03:34 -04001144 }
1145
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001146 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Ivan Lozano0a468a42024-05-13 21:03:34 -04001147 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs, linkerDeps, deps.CrtBegin,
1148 deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001149
Dan Willemsen581341d2017-02-09 16:16:31 -08001150 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1151 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001152 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1153 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1154
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001155 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001156 library.linkSAbiDumpFiles(ctx, deps, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001157
Colin Crossc85750b2022-04-21 12:50:51 -07001158 var transitiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -07001159 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
Colin Cross313aa542023-12-13 13:47:44 -08001160 s, _ := android.OtherModuleProvider(ctx, static[0], StaticLibraryInfoProvider)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001161 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001162 }
1163
Colin Cross40213022023-12-13 15:19:49 -08001164 android.SetProvider(ctx, SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001165 TableOfContents: android.OptionalPathForPath(tocFile),
1166 SharedLibrary: unstrippedOutputFile,
1167 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1168 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001169 })
1170
Sam Delmerico75dbca22023-04-20 13:13:25 +00001171 addStubDependencyProviders(ctx)
1172
1173 return unstrippedOutputFile
1174}
1175
1176func addStubDependencyProviders(ctx ModuleContext) {
Colin Cross0de8a1e2020-09-18 14:15:30 -07001177 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1178 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001179 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001180 for _, stub := range stubs {
Colin Cross313aa542023-12-13 13:47:44 -08001181 stubInfo, _ := android.OtherModuleProvider(ctx, stub, SharedLibraryInfoProvider)
1182 flagInfo, _ := android.OtherModuleProvider(ctx, stub, FlagExporterInfoProvider)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001183 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001184 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001185 SharedLibraryInfo: stubInfo,
1186 FlagExporterInfo: flagInfo,
1187 })
1188 }
Colin Cross40213022023-12-13 15:19:49 -08001189 android.SetProvider(ctx, SharedLibraryStubsProvider, SharedLibraryStubsInfo{
Chris Parsons3c27ca32020-11-20 12:42:07 -05001190 SharedStubLibraries: stubsInfo,
Sam Delmerico75dbca22023-04-20 13:13:25 +00001191 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001192 })
1193 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001194}
1195
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001196func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1197 return library.unstrippedOutputFile
1198}
1199
Wei Li5f5d2712023-12-11 15:40:29 -08001200func (library *libraryDecorator) strippedAllOutputFilePath() android.Path {
1201 return library.strippedAllOutputFile
1202}
1203
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001204func (library *libraryDecorator) disableStripping() {
1205 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1206}
1207
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001208func (library *libraryDecorator) nativeCoverage() bool {
1209 if library.header() || library.buildStubs() {
1210 return false
1211 }
1212 return true
1213}
1214
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001215func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1216 return library.coverageOutputFile
1217}
1218
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001219func (library *libraryDecorator) exportedIncludeDirsForAbiCheck(ctx ModuleContext) []string {
1220 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx).Strings()
1221 exportIncludeDirs = append(exportIncludeDirs, library.sabi.Properties.ReexportedIncludes...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001222 exportSystemIncludeDirs := library.flagExporter.exportedSystemIncludes(ctx).Strings()
1223 exportSystemIncludeDirs = append(exportSystemIncludeDirs, library.sabi.Properties.ReexportedSystemIncludes...)
1224 // The ABI checker does not distinguish normal and system headers.
1225 return append(exportIncludeDirs, exportSystemIncludeDirs...)
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001226}
1227
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001228func (library *libraryDecorator) llndkIncludeDirsForAbiCheck(ctx ModuleContext, deps PathDeps) []string {
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001229 var includeDirs, systemIncludeDirs []string
1230
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001231 // The ABI checker does not need the preprocess which adds macro guards to function declarations.
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001232 preprocessedDirs := android.PathsForModuleSrc(ctx, library.Properties.Llndk.Export_preprocessed_headers).Strings()
1233 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1234 systemIncludeDirs = append(systemIncludeDirs, preprocessedDirs...)
1235 } else {
1236 includeDirs = append(includeDirs, preprocessedDirs...)
1237 }
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001238
1239 if library.Properties.Llndk.Override_export_include_dirs != nil {
1240 includeDirs = append(includeDirs, android.PathsForModuleSrc(
1241 ctx, library.Properties.Llndk.Override_export_include_dirs).Strings()...)
1242 } else {
1243 includeDirs = append(includeDirs, library.flagExporter.exportedIncludes(ctx).Strings()...)
1244 // Ignore library.sabi.Properties.ReexportedIncludes because
1245 // LLNDK does not reexport the implementation's dependencies, such as export_header_libs.
1246 }
1247
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001248 systemIncludeDirs = append(systemIncludeDirs,
1249 library.flagExporter.exportedSystemIncludes(ctx).Strings()...)
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001250 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1251 systemIncludeDirs = append(systemIncludeDirs, includeDirs...)
1252 includeDirs = nil
1253 }
1254 // Header libs.
1255 includeDirs = append(includeDirs, deps.LlndkIncludeDirs.Strings()...)
1256 systemIncludeDirs = append(systemIncludeDirs, deps.LlndkSystemIncludeDirs.Strings()...)
1257 // The ABI checker does not distinguish normal and system headers.
1258 return append(includeDirs, systemIncludeDirs...)
1259}
1260
1261func (library *libraryDecorator) linkLlndkSAbiDumpFiles(ctx ModuleContext,
1262 deps PathDeps, sAbiDumpFiles android.Paths, soFile android.Path, libFileName string,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001263 excludeSymbolVersions, excludeSymbolTags []string,
1264 vendorApiLevel string) android.Path {
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001265 // NDK symbols in version 34 are LLNDK symbols. Those in version 35 are not.
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001266 return transformDumpToLinkedDump(ctx,
1267 sAbiDumpFiles, soFile, libFileName+".llndk",
1268 library.llndkIncludeDirsForAbiCheck(ctx, deps),
1269 android.OptionalPathForModuleSrc(ctx, library.Properties.Llndk.Symbol_file),
1270 append([]string{"*_PLATFORM", "*_PRIVATE"}, excludeSymbolVersions...),
1271 append([]string{"platform-only"}, excludeSymbolTags...),
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001272 []string{"llndk=" + vendorApiLevel}, "34", true /* isLlndk */)
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001273}
1274
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001275func (library *libraryDecorator) linkApexSAbiDumpFiles(ctx ModuleContext,
1276 deps PathDeps, sAbiDumpFiles android.Paths, soFile android.Path, libFileName string,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001277 excludeSymbolVersions, excludeSymbolTags []string,
1278 sdkVersion string) android.Path {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001279 return transformDumpToLinkedDump(ctx,
1280 sAbiDumpFiles, soFile, libFileName+".apex",
1281 library.exportedIncludeDirsForAbiCheck(ctx),
1282 android.OptionalPathForModuleSrc(ctx, library.Properties.Stubs.Symbol_file),
1283 append([]string{"*_PLATFORM", "*_PRIVATE"}, excludeSymbolVersions...),
1284 append([]string{"platform-only"}, excludeSymbolTags...),
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001285 []string{"apex", "systemapi"}, sdkVersion, false /* isLlndk */)
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001286}
1287
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001288func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1289 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001290
1291 currentArchType := ctx.Arch().ArchType
1292 primaryArchType := ctx.Config().DevicePrimaryArchType()
1293 archName := currentArchType.String()
1294 if currentArchType != primaryArchType {
1295 archName += "_" + primaryArchType.String()
1296 }
1297
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001298 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001299 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001300}
1301
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001302// Return the previous and current SDK versions for cross-version ABI diff.
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001303func crossVersionAbiDiffSdkVersions(ctx ModuleContext, dumpDir string) (int, int) {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001304 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001305
1306 if ctx.Config().PlatformSdkFinal() {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001307 return sdkVersionInt - 1, sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001308 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001309 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1310 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1311 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001312 versionedDumpDir := android.ExistentPathForSource(ctx,
1313 dumpDir, ctx.Config().PlatformSdkVersion().String())
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001314 if versionedDumpDir.Valid() {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001315 return sdkVersionInt, sdkVersionInt + 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001316 } else {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001317 return sdkVersionInt - 1, sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001318 }
1319 }
1320}
1321
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001322// Return the SDK version for same-version ABI diff.
1323func currRefAbiDumpSdkVersion(ctx ModuleContext) string {
Hsin-Yi Chen27bafd02024-01-08 18:38:42 +08001324 if ctx.Config().PlatformSdkFinal() {
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001325 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1326 // so choose PLATFORM_SDK_VERSION as the current version.
1327 return ctx.Config().PlatformSdkVersion().String()
1328 } else {
1329 return "current"
1330 }
1331}
1332
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001333// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001334func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext,
1335 sourceDump, referenceDump android.Path,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001336 baseName, nameExt string, isLlndk, allowExtensions bool,
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001337 sourceVersion, errorMessage string) {
1338
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001339 extraFlags := []string{"-target-version", sourceVersion}
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001340 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
1341 if Bool(headerAbiChecker.Check_all_apis) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001342 extraFlags = append(extraFlags, "-check-all-apis")
1343 } else {
1344 extraFlags = append(extraFlags,
1345 "-allow-unreferenced-changes",
1346 "-allow-unreferenced-elf-symbol-changes")
1347 }
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001348 if isLlndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001349 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1350 }
1351 if allowExtensions {
1352 extraFlags = append(extraFlags, "-allow-extensions")
1353 }
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001354 extraFlags = append(extraFlags, headerAbiChecker.Diff_flags...)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001355
1356 library.sAbiDiff = append(
1357 library.sAbiDiff,
1358 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1359 baseName, nameExt, extraFlags, errorMessage))
1360}
1361
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001362func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext,
1363 sourceDump, referenceDump android.Path,
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001364 baseName, nameExt string, isLlndk bool, sourceVersion, prevDumpDir string) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001365
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001366 errorMessage := "error: Please follow https://android.googlesource.com/platform/development/+/main/vndk/tools/header-checker/README.md#configure-cross_version-abi-check to resolve the difference between your source code and the ABI dumps in " + prevDumpDir
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001367
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001368 library.sourceAbiDiff(ctx, sourceDump, referenceDump, baseName, nameExt,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001369 isLlndk, true /* allowExtensions */, sourceVersion, errorMessage)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001370}
1371
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001372func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext,
1373 sourceDump, referenceDump android.Path,
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001374 baseName, nameExt string, isLlndk bool, lsdumpTagName string) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001375
1376 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001377 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py --lib " + libName + " --lib-variant " + lsdumpTagName
1378
1379 targetRelease := ctx.Config().Getenv("TARGET_RELEASE")
1380 if targetRelease != "" {
1381 errorMessage += " --release " + targetRelease
1382 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001383
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001384 library.sourceAbiDiff(ctx, sourceDump, referenceDump, baseName, nameExt,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001385 isLlndk, false /* allowExtensions */, "current", errorMessage)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001386}
1387
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001388func (library *libraryDecorator) optInAbiDiff(ctx android.ModuleContext,
1389 sourceDump, referenceDump android.Path,
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001390 baseName, nameExt string, refDumpDir string, lsdumpTagName string) {
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001391
1392 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001393 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py --lib " + libName + " --lib-variant " + lsdumpTagName + " --ref-dump-dir $$ANDROID_BUILD_TOP/" + refDumpDir
1394
1395 targetRelease := ctx.Config().Getenv("TARGET_RELEASE")
1396 if targetRelease != "" {
1397 errorMessage += " --release " + targetRelease
1398 }
1399
Hsin-Yi Chen8b85d812023-06-29 16:51:27 +08001400 // Most opt-in libraries do not have dumps for all default architectures.
1401 if ctx.Config().HasDeviceProduct() {
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001402 errorMessage += " --product " + ctx.Config().DeviceProduct()
Hsin-Yi Chen8b85d812023-06-29 16:51:27 +08001403 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001404
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001405 library.sourceAbiDiff(ctx, sourceDump, referenceDump, baseName, nameExt,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001406 false /* isLlndk */, false /* allowExtensions */, "current", errorMessage)
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001407}
1408
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001409func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, deps PathDeps, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001410 if library.sabi.shouldCreateSourceAbiDump() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001411 exportedIncludeDirs := library.exportedIncludeDirsForAbiCheck(ctx)
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001412 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001413 currSdkVersion := currRefAbiDumpSdkVersion(ctx)
1414 currVendorVersion := ctx.Config().VendorApiLevel()
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001415
1416 // Generate source dumps.
1417 implDump := transformDumpToLinkedDump(ctx,
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001418 objs.sAbiDumpFiles, soFile, fileName,
1419 exportedIncludeDirs,
Hsin-Yi Chen843c0632023-09-25 15:26:30 +08001420 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
1421 headerAbiChecker.Exclude_symbol_versions,
1422 headerAbiChecker.Exclude_symbol_tags,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001423 []string{} /* includeSymbolTags */, currSdkVersion, false /* isLlndk */)
Hsin-Yi Chen843c0632023-09-25 15:26:30 +08001424
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001425 var llndkDump, apexVariantDump android.Path
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001426 tags := classifySourceAbiDump(ctx)
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001427 optInTags := []lsdumpTag{}
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001428 for _, tag := range tags {
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001429 if tag == llndkLsdumpTag && currVendorVersion != "" {
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001430 if llndkDump == nil {
1431 // TODO(b/323447559): Evaluate if replacing sAbiDumpFiles with implDump is faster
1432 llndkDump = library.linkLlndkSAbiDumpFiles(ctx,
1433 deps, objs.sAbiDumpFiles, soFile, fileName,
1434 headerAbiChecker.Exclude_symbol_versions,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001435 headerAbiChecker.Exclude_symbol_tags,
1436 currVendorVersion)
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001437 }
1438 addLsdumpPath(string(tag) + ":" + llndkDump.String())
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001439 } else if tag == apexLsdumpTag {
1440 if apexVariantDump == nil {
1441 apexVariantDump = library.linkApexSAbiDumpFiles(ctx,
1442 deps, objs.sAbiDumpFiles, soFile, fileName,
1443 headerAbiChecker.Exclude_symbol_versions,
1444 headerAbiChecker.Exclude_symbol_tags,
1445 currSdkVersion)
1446 }
1447 addLsdumpPath(string(tag) + ":" + apexVariantDump.String())
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001448 } else {
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001449 if tag.dirName() == "" {
1450 optInTags = append(optInTags, tag)
1451 }
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001452 addLsdumpPath(string(tag) + ":" + implDump.String())
1453 }
1454 }
1455
1456 // Diff source dumps and reference dumps.
1457 for _, tag := range tags {
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001458 dumpDirName := tag.dirName()
1459 if dumpDirName == "" {
1460 continue
1461 }
1462 dumpDir := filepath.Join("prebuilts", "abi-dumps", dumpDirName)
1463 isLlndk := (tag == llndkLsdumpTag)
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001464 isApex := (tag == apexLsdumpTag)
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001465 binderBitness := ctx.DeviceConfig().BinderBitness()
1466 nameExt := ""
1467 if isLlndk {
1468 nameExt = "llndk"
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001469 } else if isApex {
1470 nameExt = "apex"
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001471 }
1472 // Check against the previous version.
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001473 var prevVersion, currVersion string
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001474 sourceDump := implDump
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001475 // If this release config does not define VendorApiLevel, fall back to the old policy.
1476 if isLlndk && currVendorVersion != "" {
1477 prevVersion = ctx.Config().PrevVendorApiLevel()
1478 currVersion = currVendorVersion
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001479 // LLNDK dumps are generated by different rules after trunk stable.
1480 if android.IsTrunkStableVendorApiLevel(prevVersion) {
1481 sourceDump = llndkDump
1482 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001483 } else {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001484 prevVersionInt, currVersionInt := crossVersionAbiDiffSdkVersions(ctx, dumpDir)
1485 prevVersion = strconv.Itoa(prevVersionInt)
1486 currVersion = strconv.Itoa(currVersionInt)
1487 // APEX dumps are generated by different rules after trunk stable.
1488 if isApex && prevVersionInt > 34 {
1489 sourceDump = apexVariantDump
1490 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001491 }
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001492 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1493 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
1494 if prevDumpFile.Valid() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001495 library.crossVersionAbiDiff(ctx, sourceDump, prevDumpFile.Path(),
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001496 fileName, nameExt+prevVersion, isLlndk, currVersion, prevDumpDir)
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001497 }
1498 // Check against the current version.
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001499 sourceDump = implDump
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001500 if isLlndk && currVendorVersion != "" {
1501 currVersion = currVendorVersion
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001502 if android.IsTrunkStableVendorApiLevel(currVersion) {
1503 sourceDump = llndkDump
1504 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001505 } else {
1506 currVersion = currSdkVersion
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001507 if isApex && (!ctx.Config().PlatformSdkFinal() ||
1508 ctx.Config().PlatformSdkVersion().FinalInt() > 34) {
1509 sourceDump = apexVariantDump
1510 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001511 }
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001512 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1513 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
1514 if currDumpFile.Valid() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001515 library.sameVersionAbiDiff(ctx, sourceDump, currDumpFile.Path(),
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001516 fileName, nameExt, isLlndk, string(tag))
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001517 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001518 }
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001519
1520 // Assert that a module is tagged with at most one of platformLsdumpTag, productLsdumpTag, or vendorLsdumpTag.
1521 if len(headerAbiChecker.Ref_dump_dirs) > 0 && len(optInTags) != 1 {
1522 ctx.ModuleErrorf("Expect exactly one opt-in lsdump tag when ref_dump_dirs are specified: %s", optInTags)
1523 return
1524 }
Hsin-Yi Chen3d5c6792024-04-22 11:47:57 +08001525 // Ensure that a module tagged with only platformLsdumpTag has ref_dump_dirs.
1526 // Android.bp in vendor projects should be cleaned up before this is enforced for vendorLsdumpTag and productLsdumpTag.
1527 if len(headerAbiChecker.Ref_dump_dirs) == 0 && len(tags) == 1 && tags[0] == platformLsdumpTag {
1528 ctx.ModuleErrorf("header_abi_checker is explicitly enabled, but no ref_dump_dirs are specified.")
1529 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001530 // Check against the opt-in reference dumps.
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001531 for i, optInDumpDir := range headerAbiChecker.Ref_dump_dirs {
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001532 optInDumpDirPath := android.PathForModuleSrc(ctx, optInDumpDir)
1533 // Ref_dump_dirs are not versioned.
1534 // They do not contain subdir for binder bitness because 64-bit binder has been mandatory.
1535 optInDumpFile := getRefAbiDumpFile(ctx, optInDumpDirPath.String(), fileName)
1536 if !optInDumpFile.Valid() {
1537 continue
1538 }
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001539 library.optInAbiDiff(ctx,
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001540 implDump, optInDumpFile.Path(),
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001541 fileName, "opt"+strconv.Itoa(i), optInDumpDirPath.String(), string(optInTags[0]))
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001542 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001543 }
1544}
1545
Inseob Kimcc12d902021-05-14 20:15:55 +09001546func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001547 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1548 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1549
Colin Cross127bb8b2020-12-16 16:46:01 -08001550 for _, header := range srcFiles {
1551 headerDir := filepath.Dir(header.String())
1552 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1553 if err != nil {
1554 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1555 srcDir.String(), headerDir, err)
1556 continue
1557 }
1558
1559 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1560 }
1561
Inseob Kimcc12d902021-05-14 20:15:55 +09001562 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001563}
1564
Chris Parsons3c27ca32020-11-20 12:42:07 -05001565// link registers actions to link this library, and sets various fields
1566// on this library to reflect information that should be exported up the build
1567// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07001568func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001569 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001570
Colin Cross127bb8b2020-12-16 16:46:01 -08001571 if ctx.IsLlndk() {
1572 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
1573 // This is the vendor variant of an LLNDK library with preprocessed headers.
1574 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
1575
1576 var timestampFiles android.Paths
1577 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09001578 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
1579 timestampFiles = append(timestampFiles, timestampFile)
1580 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001581 }
1582
1583 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1584 library.reexportSystemDirs(genHeaderOutDir)
1585 } else {
1586 library.reexportDirs(genHeaderOutDir)
1587 }
1588
1589 library.reexportDeps(timestampFiles...)
1590 }
1591
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001592 // override the module's export_include_dirs with llndk.override_export_include_dirs
1593 // if it is set.
1594 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
Aleks Todorovc9becde2024-06-10 12:51:53 +01001595 library.flagExporter.Properties.Export_include_dirs = proptools.NewConfigurable[[]string](
1596 nil,
1597 []proptools.ConfigurableCase[[]string]{
1598 proptools.NewConfigurableCase[[]string](nil, &override),
1599 },
1600 )
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001601 }
1602
Colin Cross127bb8b2020-12-16 16:46:01 -08001603 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1604 library.flagExporter.Properties.Export_system_include_dirs = append(
1605 library.flagExporter.Properties.Export_system_include_dirs,
Aleks Todorovc9becde2024-06-10 12:51:53 +01001606 library.flagExporter.Properties.Export_include_dirs.GetOrDefault(ctx, nil)...)
1607 library.flagExporter.Properties.Export_include_dirs = proptools.NewConfigurable[[]string](nil, nil)
Colin Cross127bb8b2020-12-16 16:46:01 -08001608 }
1609 }
1610
Colin Cross5271fea2021-04-27 13:06:04 -07001611 if ctx.IsVendorPublicLibrary() {
1612 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
1613 // if it is set.
1614 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
Aleks Todorovc9becde2024-06-10 12:51:53 +01001615 library.flagExporter.Properties.Export_include_dirs = proptools.NewConfigurable[[]string](
1616 nil,
1617 []proptools.ConfigurableCase[[]string]{
1618 proptools.NewConfigurableCase[[]string](nil, &override),
1619 },
1620 )
Colin Cross5271fea2021-04-27 13:06:04 -07001621 }
1622 }
1623
Chris Parsons3c27ca32020-11-20 12:42:07 -05001624 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
1625 // of this library), together with `objs` (.o files created by compiling this
1626 // library).
Colin Crossad59e752017-11-16 14:29:11 -08001627 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001628 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08001629 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001630 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001631 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001632 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001633 }
1634
Chris Parsons3c27ca32020-11-20 12:42:07 -05001635 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09001636 library.exportIncludes(ctx)
1637 library.reexportDirs(deps.ReexportedDirs...)
1638 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
1639 library.reexportFlags(deps.ReexportedFlags...)
1640 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09001641 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001642
Ivan Lozano0a468a42024-05-13 21:03:34 -04001643 if library.static() && len(deps.ReexportedRustRlibDeps) > 0 {
1644 library.reexportRustStaticDeps(deps.ReexportedRustRlibDeps...)
1645 }
1646
Chris Parsons3c27ca32020-11-20 12:42:07 -05001647 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001648 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Vinh Tran367d89d2023-04-28 11:21:25 -04001649 if library.baseCompiler.hasAidl(deps) {
Vinh Tran09581952023-05-16 16:03:20 -04001650 if library.baseCompiler.hasSrcExt(".aidl") {
1651 dir := android.PathForModuleGen(ctx, "aidl")
1652 library.reexportDirs(dir)
1653 }
1654 if len(deps.AidlLibraryInfos) > 0 {
1655 dir := android.PathForModuleGen(ctx, "aidl_library")
1656 library.reexportDirs(dir)
1657 }
Inseob Kimd110f872019-12-06 13:15:38 +09001658
Paul Duffin33056e82021-02-19 13:49:08 +00001659 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
1660 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07001661 }
1662 }
1663
Chris Parsons3c27ca32020-11-20 12:42:07 -05001664 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001665 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001666 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09001667 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07001668 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09001669 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07001670 }
Jiyong Park74955042019-10-22 20:19:51 +09001671 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09001672 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09001673
Paul Duffin33056e82021-02-19 13:49:08 +00001674 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
1675 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07001676 }
1677 }
1678
Inseob Kim07def122020-11-23 14:43:02 +09001679 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09001680 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09001681 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001682 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09001683 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
1684
Inseob Kim07def122020-11-23 14:43:02 +09001685 // If the owner is different from the user, expose public header. That is,
1686 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09001687 // 2) if the owner is platform and the client is vendor
1688 // We don't care Platform -> Vendor dependency as it's already forbidden.
1689 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09001690 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001691 }
1692 }
1693
Paul Duffin37e0de52021-02-19 17:05:39 +00001694 // Make sure to only export headers which are within the include directory.
1695 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
1696 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
1697 return isRel
1698 })
1699
Chris Parsons3c27ca32020-11-20 12:42:07 -05001700 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09001701 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00001702 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00001703 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09001704 }
1705
Chris Parsons3c27ca32020-11-20 12:42:07 -05001706 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09001707 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09001708
Chris Parsons3c27ca32020-11-20 12:42:07 -05001709 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07001710 library.flagExporter.setProvider(ctx)
1711
Colin Cross4d9c2d12016-07-29 12:48:20 -07001712 return out
1713}
1714
Jiyong Park892a98f2020-12-14 09:20:00 +09001715func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001716 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09001717 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09001718 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
1719 if err != nil {
1720 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
1721 }
1722 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09001723 }
1724}
1725
Chris Parsons3c27ca32020-11-20 12:42:07 -05001726// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07001727func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001728 return library.MutatedProperties.BuildStatic &&
1729 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001730}
1731
Chris Parsons3c27ca32020-11-20 12:42:07 -05001732// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07001733func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001734 return library.MutatedProperties.BuildShared &&
1735 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001736}
1737
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001738func (library *libraryDecorator) objs() Objects {
1739 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001740}
1741
Colin Cross0de8a1e2020-09-18 14:15:30 -07001742func (library *libraryDecorator) reuseObjs() Objects {
1743 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001744}
1745
Colin Cross26c34ed2016-09-30 17:10:16 -07001746func (library *libraryDecorator) toc() android.OptionalPath {
1747 return library.tocFile
1748}
1749
Jiyong Parkf1194352019-02-25 11:05:47 +09001750func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
1751 dir := library.baseInstaller.installDir(ctx)
1752 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
Florian Mayer95cd6db2023-03-23 17:48:07 -07001753 // libc_hwasan has relative_install_dir set, which would mess up the dir.Base() logic.
1754 // hardcode here because it's the only target, if we have other targets that use this
1755 // we can generalise this.
1756 var target string
1757 if ctx.baseModuleName() == "libc_hwasan" {
1758 target = "/" + filepath.Join("apex", "com.android.runtime", "lib64", "bionic", "hwasan", file.Base())
1759 } else {
1760 base := dir.Base()
1761 target = "/" + filepath.Join("apex", "com.android.runtime", base, "bionic", file.Base())
1762 }
Jiyong Parkf1194352019-02-25 11:05:47 +09001763 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001764 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09001765}
1766
Colin Crossb916a382016-07-29 17:28:03 -07001767func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07001768 if library.shared() {
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09001769 if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09001770 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
1771 // The original path becomes a symlink to the corresponding file in the
1772 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07001773 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07001774 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001775 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01001776 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09001777 library.installSymlinkToRuntimeApex(ctx, file)
1778 }
Jiyong Park429660f2019-01-16 22:31:11 +09001779 library.baseInstaller.subDir = "bootstrap"
1780 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001781 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001782 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001783 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09001784 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001785
Colin Cross4d9c2d12016-07-29 12:48:20 -07001786 library.baseInstaller.install(ctx, file)
1787 }
Dan Albertf563d252017-10-13 00:29:00 -07001788
Dan Albert281f22b2017-12-13 15:03:47 -08001789 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001790 !ctx.InVendorOrProduct() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09001791 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08001792 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albert4048bb02023-04-03 20:19:07 +00001793 installPath := getUnversionedLibraryInstallPath(ctx).Join(ctx, file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07001794
1795 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
1796 Rule: android.Cp,
1797 Description: "install " + installPath.Base(),
1798 Output: installPath,
1799 Input: file,
1800 })
1801
Colin Cross0875c522017-11-28 17:34:01 -08001802 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07001803 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001804}
1805
Paul Duffin0cb37b92020-03-04 14:52:46 +00001806func (library *libraryDecorator) everInstallable() bool {
1807 // Only shared and static libraries are installed. Header libraries (which are
1808 // neither static or shared) are not installed.
1809 return library.shared() || library.static()
1810}
1811
Chris Parsons3c27ca32020-11-20 12:42:07 -05001812// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07001813func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001814 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07001815}
1816
Chris Parsons3c27ca32020-11-20 12:42:07 -05001817// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001818func (library *libraryDecorator) shared() bool {
1819 return library.MutatedProperties.VariantIsShared
1820}
1821
Chris Parsons3c27ca32020-11-20 12:42:07 -05001822// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001823func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001824 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001825 return !library.static() && !library.shared()
1826}
1827
Chris Parsons3c27ca32020-11-20 12:42:07 -05001828// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001829func (library *libraryDecorator) setStatic() {
1830 library.MutatedProperties.VariantIsStatic = true
1831 library.MutatedProperties.VariantIsShared = false
1832}
1833
Chris Parsons3c27ca32020-11-20 12:42:07 -05001834// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001835func (library *libraryDecorator) setShared() {
1836 library.MutatedProperties.VariantIsStatic = false
1837 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07001838}
1839
Chris Parsons3c27ca32020-11-20 12:42:07 -05001840// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08001841func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001842 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08001843}
1844
Chris Parsons3c27ca32020-11-20 12:42:07 -05001845// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08001846func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001847 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08001848}
1849
Chris Parsons3c27ca32020-11-20 12:42:07 -05001850// HeaderOnly disables building this library as a shared or static library;
1851// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08001852func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001853 library.MutatedProperties.BuildShared = false
1854 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08001855}
1856
Colin Cross127bb8b2020-12-16 16:46:01 -08001857// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
1858func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07001859 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001860}
1861
Colin Cross203b4212021-04-26 17:19:41 -07001862// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07001863func (library *libraryDecorator) hasLLNDKHeaders() bool {
1864 return Bool(library.Properties.Llndk.Llndk_headers)
1865}
1866
Colin Cross5271fea2021-04-27 13:06:04 -07001867// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
1868// vendor public library stubs.
1869func (library *libraryDecorator) hasVendorPublicLibrary() bool {
1870 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
1871}
1872
Colin Cross0477b422020-10-13 18:43:54 -07001873func (library *libraryDecorator) implementationModuleName(name string) string {
1874 return name
1875}
1876
Jiyong Park7ed9de32018-10-15 22:25:07 +09001877func (library *libraryDecorator) buildStubs() bool {
1878 return library.MutatedProperties.BuildStubs
1879}
1880
Jiyong Parka034b832019-08-27 14:02:19 +09001881func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001882 if props := library.getHeaderAbiCheckerProperties(ctx); props.Symbol_file != nil {
1883 return props.Symbol_file
Jiyong Parka034b832019-08-27 14:02:19 +09001884 }
Colin Cross31076b32020-10-23 17:22:06 -07001885 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09001886 return library.Properties.Stubs.Symbol_file
1887 }
Hsin-Yi Chenf1f276c2024-03-11 20:02:34 +08001888 // TODO(b/309880485): Distinguish platform, NDK, LLNDK, and APEX version scripts.
1889 if library.baseLinker.Properties.Version_script != nil {
1890 return library.baseLinker.Properties.Version_script
1891 }
Jiyong Parka034b832019-08-27 14:02:19 +09001892 return nil
1893}
1894
Colin Crossc88c2722020-09-28 17:32:47 -07001895func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001896 // Just having stubs.symbol_file is enough to create a stub variant. In that case
1897 // the stub for the future API level is created.
1898 return library.Properties.Stubs.Symbol_file != nil ||
1899 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07001900}
1901
Alan Stokes73feba32022-11-14 12:21:24 +00001902func (library *libraryDecorator) isStubsImplementationRequired() bool {
1903 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
1904}
1905
Colin Cross3572cf72020-10-01 15:58:11 -07001906func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001907 if !library.hasStubsVariants() {
1908 return nil
1909 }
1910
Kiyoung Kimaa394802024-01-08 12:55:45 +09001911 if library.hasLLNDKStubs() && ctx.Module().(*Module).InVendorOrProduct() {
Jooyung Han5e8994e2024-03-12 14:12:12 +09001912 // LLNDK libraries only need a single stubs variant (""), which is
1913 // added automatically in createVersionVariations().
1914 return nil
Colin Crossc1b36442021-05-06 13:42:48 -07001915 }
1916
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001917 // Future API level is implicitly added if there isn't
Jooyung Han5e8994e2024-03-12 14:12:12 +09001918 versions := addCurrentVersionIfNotPresent(library.Properties.Stubs.Versions)
1919 normalizeVersions(ctx, versions)
1920 return versions
Sam Delmerico75dbca22023-04-20 13:13:25 +00001921}
1922
1923func addCurrentVersionIfNotPresent(vers []string) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001924 if inList(android.FutureApiLevel.String(), vers) {
1925 return vers
1926 }
1927 // In some cases, people use the raw value "10000" in the versions property.
1928 // We shouldn't add the future API level in that case, otherwise there will
1929 // be two identical versions.
1930 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
1931 return vers
1932 }
1933 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07001934}
1935
1936func (library *libraryDecorator) setStubsVersion(version string) {
1937 library.MutatedProperties.StubsVersion = version
1938}
1939
Jiyong Park7ed9de32018-10-15 22:25:07 +09001940func (library *libraryDecorator) stubsVersion() string {
1941 return library.MutatedProperties.StubsVersion
1942}
1943
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001944func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07001945 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001946 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07001947}
1948
1949func (library *libraryDecorator) setAllStubsVersions(versions []string) {
1950 library.MutatedProperties.AllStubsVersions = versions
1951}
1952
1953func (library *libraryDecorator) allStubsVersions() []string {
1954 return library.MutatedProperties.AllStubsVersions
1955}
1956
Jooyung Hanad4c1872020-02-27 17:56:44 +09001957func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001958 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09001959}
1960
Jiyong Parka90ca002019-10-07 15:47:24 +09001961func (library *libraryDecorator) availableFor(what string) bool {
1962 var list []string
1963 if library.static() {
1964 list = library.StaticProperties.Static.Apex_available
1965 } else if library.shared() {
1966 list = library.SharedProperties.Shared.Apex_available
1967 }
1968 if len(list) == 0 {
1969 return false
1970 }
1971 return android.CheckAvailableForApex(what, list)
1972}
1973
Colin Cross1bc94122021-10-28 13:25:54 -07001974func (library *libraryDecorator) installable() *bool {
1975 if library.static() {
1976 return library.StaticProperties.Static.Installable
1977 } else if library.shared() {
1978 return library.SharedProperties.Shared.Installable
1979 }
1980 return nil
1981}
1982
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00001983func (library *libraryDecorator) makeUninstallable(mod *Module) {
1984 if library.static() && library.buildStatic() && !library.buildStubs() {
1985 // If we're asked to make a static library uninstallable we don't do
1986 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
1987 // for these entries. This is done to still get the make targets for NOTICE
1988 // files from notice_files.mk, which other libraries might depend on.
1989 return
1990 }
1991 mod.ModuleBase.MakeUninstallable()
1992}
1993
Jihoon Kangf78a8902022-09-01 22:47:07 +00001994func (library *libraryDecorator) getPartition() string {
1995 return library.path.Partition()
1996}
1997
Colin Crossceaa5322021-09-28 16:37:50 -07001998func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
1999 return library.apiListCoverageXmlPath
2000}
2001
Inseob Kima1888ce2022-10-04 14:42:02 +09002002func (library *libraryDecorator) overriddenModules() []string {
2003 return library.Properties.Overrides
2004}
2005
2006var _ overridable = (*libraryDecorator)(nil)
2007
Colin Cross571cccf2019-02-04 11:22:08 -08002008var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2009
Chris Parsons3c27ca32020-11-20 12:42:07 -05002010// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2011// and values are the module name responsible for registering the version macro name.
2012//
2013// Version macros are used when building against stubs, to provide version information about
2014// the stub. Only stub libraries should have an entry in this list.
2015//
2016// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2017// that headers from libFoo can be conditionally compiled (this may hide APIs
2018// that are not available for the version).
2019//
2020// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002021func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002022 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002023 m := make(map[string]string)
2024 return &m
2025 }).(*map[string]string)
2026}
2027
2028// alphanumeric and _ characters are preserved.
2029// other characters are all converted to _
2030var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2031
Chris Parsons3c27ca32020-11-20 12:42:07 -05002032// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002033func versioningMacroName(moduleName string) string {
2034 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002035 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002036 return "__" + macroName + "_API__"
2037}
2038
Chris Parsons3c27ca32020-11-20 12:42:07 -05002039// NewLibrary builds and returns a new Module corresponding to a C++ library.
2040// Individual module implementations which comprise a C++ library (or something like
2041// a C++ library) should call this function, set some fields on the result, and
2042// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002043func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002044 module := newModule(hod, android.MultilibBoth)
2045
Colin Crossb916a382016-07-29 17:28:03 -07002046 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002047 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002048 BuildShared: true,
2049 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002050 },
Colin Crossb916a382016-07-29 17:28:03 -07002051 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002052 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002053 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002054 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002055 }
2056
Colin Crossb916a382016-07-29 17:28:03 -07002057 module.compiler = library
2058 module.linker = library
2059 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002060 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002061
2062 return module, library
2063}
2064
Colin Cross10d22312017-05-03 11:01:58 -07002065// connects a shared library to a static library in order to reuse its .o files to avoid
2066// compiling source files twice.
2067func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2068 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2069 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002070
2071 // Check libraries in addition to cflags, since libraries may be exporting different
2072 // include directories.
Cole Fauste96c16a2024-06-13 14:51:14 -07002073 if len(staticCompiler.StaticProperties.Static.Cflags.GetOrDefault(mctx, nil)) == 0 &&
2074 len(sharedCompiler.SharedProperties.Shared.Cflags.GetOrDefault(mctx, nil)) == 0 &&
Colin Crosse1bb5d02019-09-24 14:55:04 -07002075 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2076 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2077 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2078 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2079 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2080 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002081 // Compare System_shared_libs properties with nil because empty lists are
2082 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002083 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2084 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002085
2086 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2087 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2088 sharedCompiler.baseCompiler.Properties.Srcs
2089 sharedCompiler.baseCompiler.Properties.Srcs = nil
2090 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2091 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002092
2093 // This dep is just to reference static variant from shared variant
2094 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002095 }
2096}
2097
Chris Parsons3c27ca32020-11-20 12:42:07 -05002098// LinkageMutator adds "static" or "shared" variants for modules depending
2099// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002100func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002101 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002102 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002103 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002104 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002105 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002106 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002107
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002108 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002109 buildStatic := library.buildStatic()
2110 buildShared := library.buildShared()
2111 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002112 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2113 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2114 // all the variants of the cc_library also exist on the prebuilt.
2115 modules := mctx.CreateLocalVariations("static", "shared")
2116 static := modules[0].(*Module)
2117 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002118
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002119 static.linker.(prebuiltLibraryInterface).setStatic()
2120 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002121
Colin Cross127bb8b2020-12-16 16:46:01 -08002122 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002123 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002124 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002125 mctx.AliasVariation("static")
2126 }
2127
Colin Cross127bb8b2020-12-16 16:46:01 -08002128 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002129 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2130 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002131 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002132 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2133 }
2134 } else {
2135 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002136 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002137
Ivan Lozano0a468a42024-05-13 21:03:34 -04002138 } else if library, ok := mctx.Module().(LinkableInterface); ok && (library.CcLibraryInterface() || library.RustLibraryInterface()) {
Ivan Lozano2b262972019-11-21 12:30:50 -08002139 // Non-cc.Modules may need an empty variant for their mutators.
2140 variations := []string{}
2141 if library.NonCcVariants() {
2142 variations = append(variations, "")
2143 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002144 isLLNDK := false
2145 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002146 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002147 }
2148 buildStatic := library.BuildStaticVariant() && !isLLNDK
2149 buildShared := library.BuildSharedVariant()
2150 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002151 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002152
2153 modules := mctx.CreateLocalVariations(variations...)
2154 static := modules[0].(LinkableInterface)
2155 shared := modules[1].(LinkableInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002156 static.SetStatic()
2157 shared.SetShared()
2158
2159 if _, ok := library.(*Module); ok {
2160 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2161 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002162 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002163 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002164 variations := append([]string{"static"}, variations...)
2165
2166 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002167 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002168 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002169 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002170 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002171
Ivan Lozano2b262972019-11-21 12:30:50 -08002172 modules := mctx.CreateLocalVariations(variations...)
2173 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002174 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002175 } else if len(variations) > 0 {
2176 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002177 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002178 }
Ivan Lozanofd47b1a2024-05-17 14:13:41 -04002179 if library.BuildRlibVariant() && library.IsRustFFI() && !buildStatic {
2180 // Rust modules do not build static libs, but rlibs are used as if they
2181 // were via `static_libs`. Thus we need to alias the BuildRlibVariant
2182 // to "static" for Rust FFI libraries.
2183 mctx.CreateAliasVariation("static", "")
2184 }
Colin Crossb916a382016-07-29 17:28:03 -07002185 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002186}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002187
Chris Parsons3c27ca32020-11-20 12:42:07 -05002188// normalizeVersions modifies `versions` in place, so that each raw version
2189// string becomes its normalized canonical form.
2190// Validates that the versions in `versions` are specified in least to greatest order.
Colin Cross8ff10582023-12-07 13:10:56 -08002191func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002192 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002193 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002194 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002195 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002196 ctx.PropertyErrorf("versions", "%s", err.Error())
2197 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002198 }
Dan Albertc8060532020-07-22 22:32:17 -07002199 if i > 0 && ver.LessThanOrEqualTo(previous) {
2200 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2201 }
2202 versions[i] = ver.String()
2203 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002204 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002205}
2206
Jooyung Han61b66e92020-03-21 14:21:46 +00002207func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002208 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2209 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002210 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002211
Colin Cross127bb8b2020-12-16 16:46:01 -08002212 m := mctx.Module().(*Module)
2213 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002214 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002215 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002216
Colin Crossd1f898e2020-08-18 18:35:15 -07002217 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002218 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002219
Kiyoung Kimee58c932022-10-25 22:59:41 +09002220 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002221 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002222 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002223 c.sanitize = nil
2224 c.stl = nil
2225 c.Properties.PreventInstall = true
2226 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002227 isLatest := i == (len(versions) - 1)
2228 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002229
2230 if variants[i] != "" {
2231 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2232 // implementation module to the stubs module.
2233 c.Properties.HideFromMake = true
2234 lib.setStubsVersion(variants[i])
2235 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2236 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002237 }
2238 }
Colin Cross094faa52020-08-06 17:38:25 -07002239 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002240 latestVersion := ""
2241 if len(versions) > 0 {
2242 latestVersion = versions[len(versions)-1]
2243 }
2244 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002245}
2246
Colin Crossbbc941b2020-09-30 12:27:01 -07002247func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2248 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2249 if err != nil {
2250 mctx.PropertyErrorf("min_sdk_version", err.Error())
2251 return
2252 }
2253
2254 versionStrs := ndkLibraryVersions(mctx, from)
2255 modules := mctx.CreateLocalVariations(versionStrs...)
2256
2257 for i, module := range modules {
2258 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002259 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002260 }
2261}
2262
Liz Kammer23942242022-04-08 15:41:00 -04002263func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002264 Host() bool
2265 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002266 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002267}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002268 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002269}
2270
Liz Kammer23942242022-04-08 15:41:00 -04002271func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002272 Host() bool
2273 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002274 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002275 CcLibraryInterface() bool
2276 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002277}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002278 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002279 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002280}
2281
Colin Cross127bb8b2020-12-16 16:46:01 -08002282func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002283 if m, ok := module.(*Module); ok {
2284 return m.library
2285 }
2286 return nil
2287}
2288
Liz Kammer23942242022-04-08 15:41:00 -04002289// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2290func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2291 if !library.buildShared() || !canBeVersionVariant(module) {
2292 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002293 }
Liz Kammer23942242022-04-08 15:41:00 -04002294 versions := library.stubsVersions(mctx)
Liz Kammer23942242022-04-08 15:41:00 -04002295 if mctx.Failed() {
2296 return
2297 }
2298 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2299 // depend on the implementation library and haven't been mutated yet.
2300 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002301}
Jooyung Han61b66e92020-03-21 14:21:46 +00002302
Colin Crossd1f898e2020-08-18 18:35:15 -07002303// versionMutator splits a module into the mandatory non-stubs variant
2304// (which is unnamed) and zero or more stubs variants.
2305func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002306 if mctx.Os() != android.Android {
2307 return
2308 }
2309
2310 m, ok := mctx.Module().(*Module)
2311 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2312 setStubsVersions(mctx, library, m)
2313
Colin Cross31076b32020-10-23 17:22:06 -07002314 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002315 return
2316 }
2317
Liz Kammer23942242022-04-08 15:41:00 -04002318 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002319 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002320 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2321 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002322 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002323}
Colin Crossd7227f92019-09-05 14:26:33 -07002324
2325// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2326// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2327// that the linked output file should be written to.
2328// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2329func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2330 inject *bool, fileName string) android.ModuleOutPath {
2331 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2332 injectBoringSSLHash := Bool(inject)
2333 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002334 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002335 if cc, ok := dep.(*Module); ok {
2336 if library, ok := cc.linker.(*libraryDecorator); ok {
2337 if Bool(library.Properties.Inject_bssl_hash) {
2338 injectBoringSSLHash = true
2339 }
2340 }
2341 }
2342 }
2343 })
2344 if injectBoringSSLHash {
2345 hashedOutputfile := outputFile
2346 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2347
Colin Crossf1a035e2020-11-16 17:32:30 -08002348 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002349 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002350 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002351 FlagWithInput("-in-object ", outputFile).
2352 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002353 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002354 }
2355
2356 return outputFile
2357}