blob: 2aea33cbe528a3982fee67a05fc19924679cf94d [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
Alessandro Astone10e9d432020-10-01 12:59:27 +0200199 // list of plain cc flags to be used for any module that links against this module.
200 Export_cflags []string `android:"arch_variant"`
201
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700202 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900203 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700204 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900205 // export_include_dirs, that will be applied to
206 // vendor or product variant of this library.
207 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800208 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700209 }
210 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700211}
212
213func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000214 RegisterLibraryBuildComponents(android.InitRegistrationContext)
215}
216
217func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
218 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
219 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
220 ctx.RegisterModuleType("cc_library", LibraryFactory)
221 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
222 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700223}
224
Patrice Arruda83c89e02019-03-25 15:32:39 -0700225// cc_library creates both static and/or shared libraries for a device and/or
226// host. By default, a cc_library has a single variant that targets the device.
227// Specifying `host_supported: true` also creates a library that targets the
228// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700229func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800230 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000231 // Can be used as both a static and a shared library.
232 module.sdkMemberTypes = []android.SdkMemberType{
233 sharedLibrarySdkMemberType,
234 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000235 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000236 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700237 return module.Init()
238}
239
Patrice Arruda83c89e02019-03-25 15:32:39 -0700240// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700241func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800242 module, library := NewLibrary(android.HostAndDeviceSupported)
243 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000244 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700245 return module.Init()
246}
247
Patrice Arruda83c89e02019-03-25 15:32:39 -0700248// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700249func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800250 module, library := NewLibrary(android.HostAndDeviceSupported)
251 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000252 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700253 return module.Init()
254}
255
Patrice Arruda83c89e02019-03-25 15:32:39 -0700256// cc_library_host_static creates a static library that is linkable to a host
257// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700258func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800259 module, library := NewLibrary(android.HostSupported)
260 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000261 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700262 return module.Init()
263}
264
Patrice Arruda83c89e02019-03-25 15:32:39 -0700265// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700266func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800267 module, library := NewLibrary(android.HostSupported)
268 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000269 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700270 return module.Init()
271}
272
Chris Parsons3c27ca32020-11-20 12:42:07 -0500273// flagExporter is a separated portion of libraryDecorator pertaining to exported
274// include paths and flags. Keeping this dependency-related information separate
275// from the rest of library information is helpful in keeping data more structured
276// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700277type flagExporter struct {
278 Properties FlagExporterProperties
279
Ivan Lozano0a468a42024-05-13 21:03:34 -0400280 dirs android.Paths // Include directories to be included with -I
281 systemDirs android.Paths // System include directories to be included with -isystem
282 flags []string // Exported raw flags.
283 deps android.Paths
284 headers android.Paths
285 rustRlibDeps []RustRlibDep
Colin Cross4d9c2d12016-07-29 12:48:20 -0700286}
287
Chris Parsons3c27ca32020-11-20 12:42:07 -0500288// exportedIncludes returns the effective include paths for this module and
289// any module that links against this module. This is obtained from
290// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700291func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900292 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800293 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700294 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900295 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
296 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
297 }
Aleks Todorovc9becde2024-06-10 12:51:53 +0100298 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs.GetOrDefault(ctx, nil))
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700299}
300
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +0800301func (f *flagExporter) exportedSystemIncludes(ctx ModuleContext) android.Paths {
302 return android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)
303}
304
Chris Parsons3c27ca32020-11-20 12:42:07 -0500305// exportIncludes registers the include directories and system include directories to be exported
306// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900307func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900308 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900309 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700310}
311
Alessandro Astone10e9d432020-10-01 12:59:27 +0200312func (f *flagExporter) exportExtraFlags(ctx ModuleContext) {
313 f.flags = append(f.flags, f.Properties.Export_cflags...)
314}
315
Chris Parsons3c27ca32020-11-20 12:42:07 -0500316// exportIncludesAsSystem registers the include directories and system include directories to be
317// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900318func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900319 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900320 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900321 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900322}
323
Chris Parsons3c27ca32020-11-20 12:42:07 -0500324// reexportDirs registers the given directories as include directories to be exported transitively
325// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900326func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900327 f.dirs = append(f.dirs, dirs...)
328}
329
Chris Parsons3c27ca32020-11-20 12:42:07 -0500330// reexportSystemDirs registers the given directories as system include directories
331// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900332func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900333 f.systemDirs = append(f.systemDirs, dirs...)
334}
335
Chris Parsons3c27ca32020-11-20 12:42:07 -0500336// reexportFlags registers the flags to be exported transitively to modules depending on this
337// module.
Inseob Kim69378442019-06-03 19:10:47 +0900338func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800339 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
340 panic(fmt.Errorf("Exporting invalid flag %q: "+
341 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900342 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700343 f.flags = append(f.flags, flags...)
344}
345
Inseob Kim69378442019-06-03 19:10:47 +0900346func (f *flagExporter) reexportDeps(deps ...android.Path) {
347 f.deps = append(f.deps, deps...)
348}
349
Ivan Lozano0a468a42024-05-13 21:03:34 -0400350func (f *flagExporter) reexportRustStaticDeps(deps ...RustRlibDep) {
351 f.rustRlibDeps = append(f.rustRlibDeps, deps...)
352}
353
Inseob Kimd110f872019-12-06 13:15:38 +0900354// addExportedGeneratedHeaders does nothing but collects generated header files.
355// This can be differ to exportedDeps which may contain phony files to minimize ninja.
356func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
357 f.headers = append(f.headers, headers...)
358}
359
Colin Cross0de8a1e2020-09-18 14:15:30 -0700360func (f *flagExporter) setProvider(ctx android.ModuleContext) {
Colin Cross40213022023-12-13 15:19:49 -0800361 android.SetProvider(ctx, FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400362 // Comes from Export_include_dirs property, and those of exported transitive deps
363 IncludeDirs: android.FirstUniquePaths(f.dirs),
364 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700365 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400366 // Used in very few places as a one-off way of adding extra defines.
367 Flags: f.flags,
368 // Used sparingly, for extra files that need to be explicitly exported to dependers,
369 // or for phony files to minimize ninja.
370 Deps: f.deps,
Ivan Lozano0a468a42024-05-13 21:03:34 -0400371 // Used for exporting rlib deps of static libraries to dependents.
372 RustRlibDeps: f.rustRlibDeps,
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400373 // For exported generated headers, such as exported aidl headers, proto headers, or
374 // sysprop headers.
375 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700376 })
Inseob Kim69378442019-06-03 19:10:47 +0900377}
378
Colin Crossb916a382016-07-29 17:28:03 -0700379// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
380// functionality: static vs. shared linkage, reusing object files for shared libraries
381type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800382 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700383 StaticProperties StaticProperties
384 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800385 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700386
387 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900388 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700389
Colin Cross26c34ed2016-09-30 17:10:16 -0700390 // table-of-contents file to optimize out relinking when possible
391 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700392
Colin Cross4d9c2d12016-07-29 12:48:20 -0700393 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400394 flagExporterInfo *FlagExporterInfo
395 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700396
Colin Cross4d9c2d12016-07-29 12:48:20 -0700397 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800398 objects Objects
399 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700400
401 // Uses the module's name if empty, but can be overridden. Does not include
402 // shlib suffix.
403 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700404
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800405 sabi *sabi
406
Dan Willemsen581341d2017-02-09 16:16:31 -0800407 // Output archive of gcno coverage information files
408 coverageOutputFile android.OptionalPath
409
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800410 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800411 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000412
Colin Cross0875c522017-11-28 17:34:01 -0800413 // Location of the static library in the sysroot. Empty if the library is
414 // not included in the NDK.
415 ndkSysrootPath android.Path
416
Colin Crossb60190a2018-09-04 16:28:17 -0700417 // Location of the linked, unstripped library for shared libraries
418 unstrippedOutputFile android.Path
Wei Li5f5d2712023-12-11 15:40:29 -0800419 // Location of the linked, stripped library for shared libraries, strip: "all"
420 strippedAllOutputFile android.Path
Colin Crossb60190a2018-09-04 16:28:17 -0700421
Dan Willemsen569edc52018-11-19 09:33:29 -0800422 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000423 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800424
Colin Cross8e21aa52020-09-28 18:28:02 -0700425 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900426
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800427 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900428
Colin Cross5ec407b2020-09-30 11:41:33 -0700429 skipAPIDefine bool
430
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100431 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700432 *baseCompiler
433 *baseLinker
434 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900435
sophiez4c4f8032021-08-16 22:54:00 -0700436 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900437}
438
Chris Parsons3c27ca32020-11-20 12:42:07 -0500439// linkerProps returns the list of properties structs relevant for this library. (For example, if
440// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -0700441func (library *libraryDecorator) linkerProps() []interface{} {
442 var props []interface{}
443 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700444 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700445 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -0800446 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700447 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -0700448 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700449
450 if library.MutatedProperties.BuildShared {
451 props = append(props, &library.SharedProperties)
452 }
453 if library.MutatedProperties.BuildStatic {
454 props = append(props, &library.StaticProperties)
455 }
456
457 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -0700458}
459
Chris Parsons3c27ca32020-11-20 12:42:07 -0500460// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
461// library, or that are implied by attributes of this library (such as whether this library is a
462// shared library).
Colin Crossb916a382016-07-29 17:28:03 -0700463func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -0700464 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700465
Colin Crossb916a382016-07-29 17:28:03 -0700466 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
467 // all code is position independent, and then those warnings get promoted to
468 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -0700469 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800470 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -0700471 }
472
473 if library.static() {
Cole Fauste96c16a2024-06-13 14:51:14 -0700474 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags.GetOrDefault(ctx, nil)...)
Colin Crossa48ab5b2017-02-14 15:28:44 -0800475 } else if library.shared() {
Cole Fauste96c16a2024-06-13 14:51:14 -0700476 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags.GetOrDefault(ctx, nil)...)
Colin Crossb916a382016-07-29 17:28:03 -0700477 }
478
Colin Crossa48ab5b2017-02-14 15:28:44 -0800479 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700480 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700481 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -0700482 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700483 f = append(f,
484 "-nostdlib",
485 "-Wl,--gc-sections",
486 )
487 }
488
489 if ctx.Darwin() {
490 f = append(f,
491 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -0700492 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
493 )
Colin Cross7863cf52016-10-20 10:47:21 -0700494 if ctx.Arch().ArchType == android.X86 {
495 f = append(f,
496 "-read_only_relocs suppress",
497 )
498 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700499 } else {
Josh Gao75a50a22019-06-07 17:58:59 -0700500 f = append(f, "-shared")
501 if !ctx.Windows() {
502 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
503 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700504 }
505
Colin Cross4af21ed2019-11-04 09:37:55 -0800506 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700507 }
508
509 return flags
510}
511
Chris Parsons3c27ca32020-11-20 12:42:07 -0500512// compilerFlags takes a Flags and augments it to contain compile flags from global values,
513// per-target values, module type values, per-module Blueprints properties, extra flags from
514// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -0800515func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700516 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700517 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -0700518 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -0800519 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
520 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700521 }
522
Jiyong Park7ed9de32018-10-15 22:25:07 +0900523 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -0800524 if ctx.IsLlndk() {
525 // LLNDK libraries ignore most of the properties on the cc_library and use the
526 // LLNDK-specific properties instead.
527 // Wipe all the module-local properties, leaving only the global properties.
528 flags.Local = LocalOrGlobalFlags{}
529 }
Jiyong Park7ed9de32018-10-15 22:25:07 +0900530 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +0900531 // Remove -include <file> when compiling stubs. Otherwise, the force included
532 // headers might cause conflicting types error with the symbols in the
533 // generated stubs source code. e.g.
534 // double acos(double); // in header
535 // void acos() {} // in the generated source code
536 removeInclude := func(flags []string) []string {
537 ret := flags[:0]
538 for _, f := range flags {
539 if strings.HasPrefix(f, "-include ") {
540 continue
541 }
542 ret = append(ret, f)
543 }
544 return ret
545 }
Colin Cross4af21ed2019-11-04 09:37:55 -0800546 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
547 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +0900548
Jiyong Park7ed9de32018-10-15 22:25:07 +0900549 flags = addStubLibraryCompilerFlags(flags)
550 }
551 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -0700552}
553
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +0800554func (library *libraryDecorator) getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties {
555 m := ctx.Module().(*Module)
556 variantProps := &library.Properties.Target.Platform.Header_abi_checker
557 if m.InVendor() {
558 variantProps = &library.Properties.Target.Vendor.Header_abi_checker
559 } else if m.InProduct() {
560 variantProps = &library.Properties.Target.Product.Header_abi_checker
561 }
562 props := library.Properties.Header_abi_checker
563 err := proptools.AppendProperties(&props, variantProps, nil)
564 if err != nil {
565 ctx.ModuleErrorf("Cannot merge headerAbiCheckerProperties: %s", err.Error())
566 }
567 return props
Logan Chien41eabe62019-04-10 13:33:58 +0800568}
569
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700570func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -0800571 if ctx.IsLlndk() {
Jooyung Han33eb6152024-03-11 15:46:48 +0900572 vendorApiLevel := ctx.Config().VendorApiLevel()
573 if vendorApiLevel == "" {
574 // TODO(b/321892570): Some tests relying on old fixtures which
575 // doesn't set vendorApiLevel. Needs to fix them.
576 vendorApiLevel = ctx.Config().PlatformSdkVersion().String()
577 }
Colin Cross127bb8b2020-12-16 16:46:01 -0800578 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
Dan Albertf1d14c72020-07-30 14:32:55 -0700579 nativeAbiResult := parseNativeAbiDefinition(ctx,
580 String(library.Properties.Llndk.Symbol_file),
Jooyung Han33eb6152024-03-11 15:46:48 +0900581 android.ApiLevelOrPanic(ctx, vendorApiLevel), "--llndk")
Dan Albertf1d14c72020-07-30 14:32:55 -0700582 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -0800583 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -0700584 library.versionScriptPath = android.OptionalPathForPath(
585 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -0800586 }
587 return objs
588 }
Colin Cross5271fea2021-04-27 13:06:04 -0700589 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -0700590 nativeAbiResult := parseNativeAbiDefinition(ctx,
591 String(library.Properties.Vendor_public_library.Symbol_file),
592 android.FutureApiLevel, "")
593 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -0700594 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -0700595 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -0700596 }
597 return objs
598 }
Jiyong Park7ed9de32018-10-15 22:25:07 +0900599 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +0900600 symbolFile := String(library.Properties.Stubs.Symbol_file)
601 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
602 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
603 return Objects{}
604 }
Jiyong Park85cc35a2022-07-17 11:30:47 +0900605 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
606 // systemapi, respectively. The former is for symbols defined in platform libraries
607 // and the latter is for symbols defined in APEXes.
Spandan Das934c97d2023-01-18 23:54:13 +0000608 // A single library can contain either # apex or # systemapi, but not both.
609 // The stub generator (ndkstubgen) is additive, so passing _both_ of these to it should be a no-op.
610 // However, having this distinction helps guard accidental
611 // promotion or demotion of API and also helps the API review process b/191371676
Jiyong Park85cc35a2022-07-17 11:30:47 +0900612 var flag string
613 if ctx.Module().(android.ApexModule).NotInPlatform() {
614 flag = "--apex"
615 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +0900616 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +0900617 }
Jiyong Parkaa27c082022-09-26 21:16:09 +0900618 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
619 // the stub so that it is mandated that all symbols are explicitly marked with
620 // either apex or systemapi.
621 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
622 flag = flag + " --no-ndk"
623 }
Dan Albertf1d14c72020-07-30 14:32:55 -0700624 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +0900625 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -0700626 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
627 library.versionScriptPath = android.OptionalPathForPath(
628 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -0700629
630 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -0700631 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -0700632 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
633 }
634
Jiyong Park7ed9de32018-10-15 22:25:07 +0900635 return objs
636 }
637
Colin Cross5950f382016-12-13 12:50:57 -0800638 if !library.buildShared() && !library.buildStatic() {
639 if len(library.baseCompiler.Properties.Srcs) > 0 {
640 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
641 }
Colin Crosse1bb5d02019-09-24 14:55:04 -0700642 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -0800643 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
644 }
Colin Crosse1bb5d02019-09-24 14:55:04 -0700645 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -0800646 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
647 }
648 return Objects{}
649 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800650 if library.sabi.shouldCreateSourceAbiDump() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +0800651 dirs := library.exportedIncludeDirsForAbiCheck(ctx)
652 flags.SAbiFlags = make([]string, 0, len(dirs))
653 for _, dir := range dirs {
654 flags.SAbiFlags = append(flags.SAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800655 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800656 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -0700657 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800658 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800659 flags.SAbiDump = true
660 }
661 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700662 objs := library.baseCompiler.compile(ctx, flags, deps)
663 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -0700664 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -0700665
Colin Cross4d9c2d12016-07-29 12:48:20 -0700666 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -0700667 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700668 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
669 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800670 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700671 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -0800672 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -0700673 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700674 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
675 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800676 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700677 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -0700678 }
679
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700680 return objs
Colin Crossb916a382016-07-29 17:28:03 -0700681}
682
683type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -0700684 versionedInterface
685
Colin Crossb916a382016-07-29 17:28:03 -0700686 static() bool
Inseob Kimae553032019-05-14 18:52:49 +0900687 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700688 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -0700689 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -0700690 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -0700691
692 // Returns true if the build options for the module have selected a static or shared build
693 buildStatic() bool
694 buildShared() bool
695
696 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -0800697 setStatic()
698 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +0800699
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +0800700 // Gets the ABI properties for vendor, product, or platform variant
701 getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800702
Logan Chien41eabe62019-04-10 13:33:58 +0800703 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
704 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +0900705
706 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -0700707
708 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -0700709
710 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -0700711}
712
Colin Crossc88c2722020-09-28 17:32:47 -0700713type versionedInterface interface {
714 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900715 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -0700716 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +0000717 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -0700718 setStubsVersion(string)
719 stubsVersion() string
720
Colin Cross3572cf72020-10-01 15:58:11 -0700721 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -0700722 setAllStubsVersions([]string)
723 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -0700724
725 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -0800726 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -0700727 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -0700728 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -0700729}
730
731var _ libraryInterface = (*libraryDecorator)(nil)
732var _ versionedInterface = (*libraryDecorator)(nil)
733
Justin Yun6977e8a2020-10-29 18:24:11 +0900734func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -0700735 name := library.libName
736 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +0100737 name = String(library.Properties.Stem)
738 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +0900739 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +0100740 }
Colin Crossb916a382016-07-29 17:28:03 -0700741 }
742
Colin Cross0fd6a412019-08-16 14:22:10 -0700743 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +0900744 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -0700745 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +0900746 } else if inProduct {
747 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -0700748 }
749 if suffix == "" {
750 suffix = String(library.Properties.Suffix)
751 }
752
Jooyung Han0302a842019-10-30 18:43:49 +0900753 return name + suffix
754}
755
Chris Parsons3c27ca32020-11-20 12:42:07 -0500756// getLibName returns the actual canonical name of the library (the name which
757// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +0900758func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +0900759 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -0700760
Colin Crossb916a382016-07-29 17:28:03 -0700761 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
762 if !strings.HasSuffix(name, "-host") {
763 name = name + "-host"
764 }
765 }
766
Inseob Kim0ce291e2019-07-04 14:38:27 +0900767 return name
Colin Crossb916a382016-07-29 17:28:03 -0700768}
769
Jiyong Parkda732bd2018-11-02 18:23:15 +0900770var versioningMacroNamesListMutex sync.Mutex
771
Colin Crossb916a382016-07-29 17:28:03 -0700772func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
773 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -0700774 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700775 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -0700776 }
777 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -0700778 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +0900779 // Let baseLinker know whether this variant is for stubs or not, so that
780 // it can omit things that are not required for linking stubs.
781 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +0900782
783 if library.buildStubs() {
784 macroNames := versioningMacroNamesList(ctx.Config())
785 myName := versioningMacroName(ctx.ModuleName())
786 versioningMacroNamesListMutex.Lock()
787 defer versioningMacroNamesListMutex.Unlock()
788 if (*macroNames)[myName] == "" {
789 (*macroNames)[myName] = ctx.ModuleName()
790 } else if (*macroNames)[myName] != ctx.ModuleName() {
791 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
792 }
793 }
Colin Crossb916a382016-07-29 17:28:03 -0700794}
795
dimitry0345ad82018-12-05 16:28:14 +0100796func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -0800797 if ctx.IsLlndk() {
798 // LLNDK libraries ignore most of the properties on the cc_library and use the
799 // LLNDK-specific properties instead.
800 return deps
801 }
802
dimitry0345ad82018-12-05 16:28:14 +0100803 deps = library.baseCompiler.compilerDeps(ctx, deps)
804
dimitry0345ad82018-12-05 16:28:14 +0100805 return deps
806}
807
Colin Cross37047f12016-12-13 17:06:13 -0800808func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -0800809 if ctx.IsLlndk() {
810 // LLNDK libraries ignore most of the properties on the cc_library and use the
811 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -0800812 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
813 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -0800814 return deps
815 }
Colin Cross5271fea2021-04-27 13:06:04 -0700816 if ctx.IsVendorPublicLibrary() {
817 headers := library.Properties.Vendor_public_library.Export_public_headers
818 deps.HeaderLibs = append([]string(nil), headers...)
819 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
820 return deps
821 }
Colin Cross127bb8b2020-12-16 16:46:01 -0800822
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800823 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +0000824 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700825 if library.StaticProperties.Static.System_shared_libs != nil {
826 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800827 }
828 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +0000829 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700830 if library.SharedProperties.Shared.System_shared_libs != nil {
831 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800832 }
833 }
834
Colin Crossb916a382016-07-29 17:28:03 -0700835 deps = library.baseLinker.linkerDeps(ctx, deps)
836
837 if library.static() {
838 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -0700839 library.StaticProperties.Static.Whole_static_libs...)
840 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
841 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -0800842
Colin Crosse1bb5d02019-09-24 14:55:04 -0700843 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
844 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -0800845 } else if library.shared() {
Alex Márquez Pérez Muñíz Díaz Puras Thaureaux01ec55e2023-01-30 22:53:04 +0000846 if library.baseLinker.Properties.crt() {
Colin Crossd1a28132021-06-21 17:34:47 -0700847 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
848 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Kalesh Singhf4ffe0a2024-01-29 13:01:51 -0800849
850 }
851 if library.baseLinker.Properties.crtPadSegment() {
852 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtPadSegmentSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700853 }
Colin Crosse1bb5d02019-09-24 14:55:04 -0700854 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
855 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
856 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -0800857
Colin Crosse1bb5d02019-09-24 14:55:04 -0700858 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
859 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Hsin-Yi Chen715142a2024-03-27 16:31:16 +0800860
861 deps.LlndkHeaderLibs = append(deps.LlndkHeaderLibs, library.Properties.Llndk.Export_llndk_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700862 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900863 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +0900864 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
865 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
866 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +0000867 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
868 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +0900869 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900870 if ctx.inProduct() {
871 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
872 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
873 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
874 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
875 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
876 }
Jiyong Parkf9332f12018-02-01 00:54:12 +0900877 if ctx.inRecovery() {
878 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
879 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
880 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +0000881 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
882 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900883 }
Yifan Hongcf4832c2020-01-21 17:04:13 -0800884 if ctx.inRamdisk() {
885 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
886 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
887 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
888 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
889 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
890 }
Yifan Hong6da33c22020-10-27 15:01:21 -0700891 if ctx.inVendorRamdisk() {
892 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
893 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
894 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
895 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
896 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
897 }
Colin Cross2383f3b2018-02-06 14:40:13 -0800898
Colin Cross4d9c2d12016-07-29 12:48:20 -0700899 return deps
900}
901
Paul Duffin13f02712020-03-06 12:30:43 +0000902func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
903 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
904 var properties StaticOrSharedProperties
905 if library.static() {
906 properties = library.StaticProperties.Static
907 } else if library.shared() {
908 properties = library.SharedProperties.Shared
909 }
910
911 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +0000912
913 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
914 // either input list doesn't come out as nil.
915 if specifiedDeps.systemSharedLibs == nil {
916 specifiedDeps.systemSharedLibs = properties.System_shared_libs
917 } else {
918 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
919 }
Paul Duffin13f02712020-03-06 12:30:43 +0000920
921 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +0000922 if len(specifiedDeps.systemSharedLibs) > 0 {
923 // Skip this if systemSharedLibs is either nil or [], to ensure they are
924 // retained.
925 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
926 }
Paul Duffin13f02712020-03-06 12:30:43 +0000927 return specifiedDeps
928}
929
Colin Cross4a9e6ec2023-12-18 15:29:41 -0800930func (library *libraryDecorator) moduleInfoJSON(ctx ModuleContext, moduleInfoJSON *android.ModuleInfoJSON) {
931 if library.static() {
932 moduleInfoJSON.Class = []string{"STATIC_LIBRARIES"}
933 moduleInfoJSON.Uninstallable = true
934 } else if library.shared() {
935 moduleInfoJSON.Class = []string{"SHARED_LIBRARIES"}
936 } else if library.header() {
937 moduleInfoJSON.Class = []string{"HEADER_LIBRARIES"}
938 moduleInfoJSON.Uninstallable = true
939 }
940
941 if library.buildStubs() && library.stubsVersion() != "" {
942 moduleInfoJSON.SubName += "." + library.stubsVersion()
943 }
944
945 // If a library providing a stub is included in an APEX, the private APIs of the library
946 // is accessible only inside the APEX. From outside of the APEX, clients can only use the
947 // public APIs via the stub. To enforce this, the (latest version of the) stub gets the
948 // name of the library. The impl library instead gets the `.bootstrap` suffix to so that
949 // they can be exceptionally used directly when APEXes are not available (e.g. during the
950 // very early stage in the boot process).
951 if len(library.Properties.Stubs.Versions) > 0 && !ctx.Host() && ctx.notInPlatform() &&
952 !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && !ctx.useVndk() && !ctx.static() {
953 if library.buildStubs() && library.isLatestStubVersion() {
954 moduleInfoJSON.SubName = ""
955 }
956 if !library.buildStubs() {
957 moduleInfoJSON.SubName = ".bootstrap"
958 }
959 }
960
961 library.baseLinker.moduleInfoJSON(ctx, moduleInfoJSON)
962}
963
Colin Crossb916a382016-07-29 17:28:03 -0700964func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700965 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700966
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700967 library.objects = deps.WholeStaticLibObjs.Copy()
968 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800969 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700970
Inseob Kim0ce291e2019-07-04 14:38:27 +0900971 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -0800972 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -0800973 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700974
Dan Willemsen569edc52018-11-19 09:33:29 -0800975 if Bool(library.baseLinker.Properties.Use_version_lib) {
976 if ctx.Host() {
977 versionedOutputFile := outputFile
978 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
979 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
980 } else {
981 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000982 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -0800983 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
984 }
Colin Cross86803cf2018-02-15 14:12:26 -0800985 }
986
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -0800987 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -0800988
Chris Parsonsbf4f55f2020-11-23 17:02:44 -0500989 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -0700990
Colin Cross4d9c2d12016-07-29 12:48:20 -0700991 ctx.CheckbuildFile(outputFile)
992
Colin Cross649d8172020-12-10 12:30:21 -0800993 if library.static() {
Colin Cross40213022023-12-13 15:19:49 -0800994 android.SetProvider(ctx, StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800995 StaticLibrary: outputFile,
996 ReuseObjects: library.reuseObjects,
997 Objects: library.objects,
998 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700999
Colin Crossc85750b2022-04-21 12:50:51 -07001000 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder[android.Path](android.TOPOLOGICAL).
Colin Cross649d8172020-12-10 12:30:21 -08001001 Direct(outputFile).
1002 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1003 Build(),
1004 })
1005 }
1006
1007 if library.header() {
Colin Cross40213022023-12-13 15:19:49 -08001008 android.SetProvider(ctx, HeaderLibraryInfoProvider, HeaderLibraryInfo{})
Colin Cross649d8172020-12-10 12:30:21 -08001009 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001010
Colin Cross4d9c2d12016-07-29 12:48:20 -07001011 return outputFile
1012}
1013
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001014func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1015 if ctx.Module().(*Module).IsSdkVariant() {
1016 // The NDK sysroot timestamp file depends on all the NDK
1017 // sysroot header and shared library files.
1018 return android.Paths{getNdkBaseTimestampFile(ctx)}
1019 }
1020 return nil
1021}
1022
Colin Crossb916a382016-07-29 17:28:03 -07001023func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001024 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001025
1026 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001027 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001028 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001029
Colin Cross2383f3b2018-02-06 14:40:13 -08001030 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1031 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1032 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001033 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001034 if unexportedSymbols.Valid() {
1035 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1036 }
1037 if forceNotWeakSymbols.Valid() {
1038 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1039 }
1040 if forceWeakSymbols.Valid() {
1041 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1042 }
1043 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001044 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001045 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001046 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1047 }
1048 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001049 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001050 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1051 }
1052 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001053 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001054 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1055 }
1056 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001057 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001058 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001059 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001060 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001061 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001062
1063 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1064 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001065 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001066
Josh Gao75a50a22019-06-07 17:58:59 -07001067 var implicitOutputs android.WritablePaths
1068 if ctx.Windows() {
1069 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1070
Colin Cross4af21ed2019-11-04 09:37:55 -08001071 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001072 implicitOutputs = append(implicitOutputs, importLibraryPath)
1073 }
1074
Colin Cross4d9c2d12016-07-29 12:48:20 -07001075 builderFlags := flagsToBuilderFlags(flags)
1076
Dan Willemsen47450072021-10-19 20:24:49 -07001077 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1078 fatOutputFile := outputFile
1079 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1080 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1081 }
1082
Colin Crossb496cfd2018-09-10 16:50:05 -07001083 // Optimize out relinking against shared libraries whose interface hasn't changed by
1084 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001085 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001086 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001087 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001088
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001089 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001090 needsStrip := library.stripper.NeedsStrip(ctx)
1091 if library.buildStubs() {
1092 // No need to strip stubs libraries
1093 needsStrip = false
1094 }
1095 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001096 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001097 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001098 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001099 strippedOutputFile := outputFile
1100 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001101 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001102 }
Colin Crossb60190a2018-09-04 16:28:17 -07001103 library.unstrippedOutputFile = outputFile
1104
Colin Crossd7227f92019-09-05 14:26:33 -07001105 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001106
Dan Willemsen569edc52018-11-19 09:33:29 -08001107 if Bool(library.baseLinker.Properties.Use_version_lib) {
1108 if ctx.Host() {
1109 versionedOutputFile := outputFile
1110 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1111 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1112 } else {
1113 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001114 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001115
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001116 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001117 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001118 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001119 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001120 }
1121
1122 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1123 }
Colin Cross86803cf2018-02-15 14:12:26 -08001124 }
1125
Wei Li5f5d2712023-12-11 15:40:29 -08001126 // Generate an output file for dist as if strip: "all" is set on the module.
1127 // Currently this is for layoutlib release process only.
1128 for _, dist := range ctx.Module().(*Module).Dists() {
1129 if dist.Tag != nil && *dist.Tag == "stripped_all" {
1130 strippedAllOutputFile := android.PathForModuleOut(ctx, "stripped_all", fileName)
1131 transformStrip(ctx, outputFile, strippedAllOutputFile, StripFlags{Toolchain: flags.Toolchain})
1132 library.strippedAllOutputFile = strippedAllOutputFile
1133 break
1134 }
1135 }
1136
Jiyong Park64a44f22019-01-18 14:37:08 +09001137 sharedLibs := deps.EarlySharedLibs
1138 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001139 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1140
Jiyong Park64a44f22019-01-18 14:37:08 +09001141 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001142 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1143 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Ivan Lozano0a468a42024-05-13 21:03:34 -04001144
1145 if generatedLib := generateRustStaticlib(ctx, deps.RustRlibDeps); generatedLib != nil {
1146 deps.StaticLibs = append(deps.StaticLibs, generatedLib)
1147 }
1148
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001149 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Ivan Lozano0a468a42024-05-13 21:03:34 -04001150 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs, linkerDeps, deps.CrtBegin,
1151 deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001152
Dan Willemsen581341d2017-02-09 16:16:31 -08001153 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1154 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001155 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1156 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1157
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001158 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001159 library.linkSAbiDumpFiles(ctx, deps, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001160
Colin Crossc85750b2022-04-21 12:50:51 -07001161 var transitiveStaticLibrariesForOrdering *android.DepSet[android.Path]
Colin Cross0de8a1e2020-09-18 14:15:30 -07001162 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
Colin Cross313aa542023-12-13 13:47:44 -08001163 s, _ := android.OtherModuleProvider(ctx, static[0], StaticLibraryInfoProvider)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001164 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001165 }
1166
Colin Cross40213022023-12-13 15:19:49 -08001167 android.SetProvider(ctx, SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001168 TableOfContents: android.OptionalPathForPath(tocFile),
1169 SharedLibrary: unstrippedOutputFile,
1170 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1171 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001172 })
1173
Sam Delmerico75dbca22023-04-20 13:13:25 +00001174 addStubDependencyProviders(ctx)
1175
1176 return unstrippedOutputFile
1177}
1178
1179func addStubDependencyProviders(ctx ModuleContext) {
Colin Cross0de8a1e2020-09-18 14:15:30 -07001180 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1181 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001182 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001183 for _, stub := range stubs {
Colin Cross313aa542023-12-13 13:47:44 -08001184 stubInfo, _ := android.OtherModuleProvider(ctx, stub, SharedLibraryInfoProvider)
1185 flagInfo, _ := android.OtherModuleProvider(ctx, stub, FlagExporterInfoProvider)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001186 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001187 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001188 SharedLibraryInfo: stubInfo,
1189 FlagExporterInfo: flagInfo,
1190 })
1191 }
Colin Cross40213022023-12-13 15:19:49 -08001192 android.SetProvider(ctx, SharedLibraryStubsProvider, SharedLibraryStubsInfo{
Chris Parsons3c27ca32020-11-20 12:42:07 -05001193 SharedStubLibraries: stubsInfo,
Sam Delmerico75dbca22023-04-20 13:13:25 +00001194 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001195 })
1196 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001197}
1198
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001199func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1200 return library.unstrippedOutputFile
1201}
1202
Wei Li5f5d2712023-12-11 15:40:29 -08001203func (library *libraryDecorator) strippedAllOutputFilePath() android.Path {
1204 return library.strippedAllOutputFile
1205}
1206
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001207func (library *libraryDecorator) disableStripping() {
1208 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1209}
1210
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001211func (library *libraryDecorator) nativeCoverage() bool {
1212 if library.header() || library.buildStubs() {
1213 return false
1214 }
1215 return true
1216}
1217
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001218func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1219 return library.coverageOutputFile
1220}
1221
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001222func (library *libraryDecorator) exportedIncludeDirsForAbiCheck(ctx ModuleContext) []string {
1223 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx).Strings()
1224 exportIncludeDirs = append(exportIncludeDirs, library.sabi.Properties.ReexportedIncludes...)
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001225 exportSystemIncludeDirs := library.flagExporter.exportedSystemIncludes(ctx).Strings()
1226 exportSystemIncludeDirs = append(exportSystemIncludeDirs, library.sabi.Properties.ReexportedSystemIncludes...)
1227 // The ABI checker does not distinguish normal and system headers.
1228 return append(exportIncludeDirs, exportSystemIncludeDirs...)
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001229}
1230
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001231func (library *libraryDecorator) llndkIncludeDirsForAbiCheck(ctx ModuleContext, deps PathDeps) []string {
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001232 var includeDirs, systemIncludeDirs []string
1233
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001234 // The ABI checker does not need the preprocess which adds macro guards to function declarations.
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001235 preprocessedDirs := android.PathsForModuleSrc(ctx, library.Properties.Llndk.Export_preprocessed_headers).Strings()
1236 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1237 systemIncludeDirs = append(systemIncludeDirs, preprocessedDirs...)
1238 } else {
1239 includeDirs = append(includeDirs, preprocessedDirs...)
1240 }
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001241
1242 if library.Properties.Llndk.Override_export_include_dirs != nil {
1243 includeDirs = append(includeDirs, android.PathsForModuleSrc(
1244 ctx, library.Properties.Llndk.Override_export_include_dirs).Strings()...)
1245 } else {
1246 includeDirs = append(includeDirs, library.flagExporter.exportedIncludes(ctx).Strings()...)
1247 // Ignore library.sabi.Properties.ReexportedIncludes because
1248 // LLNDK does not reexport the implementation's dependencies, such as export_header_libs.
1249 }
1250
Hsin-Yi Chen5f228b02024-04-02 12:38:47 +08001251 systemIncludeDirs = append(systemIncludeDirs,
1252 library.flagExporter.exportedSystemIncludes(ctx).Strings()...)
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001253 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1254 systemIncludeDirs = append(systemIncludeDirs, includeDirs...)
1255 includeDirs = nil
1256 }
1257 // Header libs.
1258 includeDirs = append(includeDirs, deps.LlndkIncludeDirs.Strings()...)
1259 systemIncludeDirs = append(systemIncludeDirs, deps.LlndkSystemIncludeDirs.Strings()...)
1260 // The ABI checker does not distinguish normal and system headers.
1261 return append(includeDirs, systemIncludeDirs...)
1262}
1263
1264func (library *libraryDecorator) linkLlndkSAbiDumpFiles(ctx ModuleContext,
1265 deps PathDeps, sAbiDumpFiles android.Paths, soFile android.Path, libFileName string,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001266 excludeSymbolVersions, excludeSymbolTags []string,
1267 vendorApiLevel string) android.Path {
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001268 // NDK symbols in version 34 are LLNDK symbols. Those in version 35 are not.
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001269 return transformDumpToLinkedDump(ctx,
1270 sAbiDumpFiles, soFile, libFileName+".llndk",
1271 library.llndkIncludeDirsForAbiCheck(ctx, deps),
1272 android.OptionalPathForModuleSrc(ctx, library.Properties.Llndk.Symbol_file),
1273 append([]string{"*_PLATFORM", "*_PRIVATE"}, excludeSymbolVersions...),
1274 append([]string{"platform-only"}, excludeSymbolTags...),
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001275 []string{"llndk=" + vendorApiLevel}, "34", true /* isLlndk */)
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001276}
1277
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001278func (library *libraryDecorator) linkApexSAbiDumpFiles(ctx ModuleContext,
1279 deps PathDeps, sAbiDumpFiles android.Paths, soFile android.Path, libFileName string,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001280 excludeSymbolVersions, excludeSymbolTags []string,
1281 sdkVersion string) android.Path {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001282 return transformDumpToLinkedDump(ctx,
1283 sAbiDumpFiles, soFile, libFileName+".apex",
1284 library.exportedIncludeDirsForAbiCheck(ctx),
1285 android.OptionalPathForModuleSrc(ctx, library.Properties.Stubs.Symbol_file),
1286 append([]string{"*_PLATFORM", "*_PRIVATE"}, excludeSymbolVersions...),
1287 append([]string{"platform-only"}, excludeSymbolTags...),
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001288 []string{"apex", "systemapi"}, sdkVersion, false /* isLlndk */)
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001289}
1290
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001291func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1292 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001293
1294 currentArchType := ctx.Arch().ArchType
1295 primaryArchType := ctx.Config().DevicePrimaryArchType()
1296 archName := currentArchType.String()
1297 if currentArchType != primaryArchType {
1298 archName += "_" + primaryArchType.String()
1299 }
1300
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001301 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001302 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001303}
1304
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001305// Return the previous and current SDK versions for cross-version ABI diff.
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001306func crossVersionAbiDiffSdkVersions(ctx ModuleContext, dumpDir string) (int, int) {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001307 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001308
1309 if ctx.Config().PlatformSdkFinal() {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001310 return sdkVersionInt - 1, sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001311 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001312 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1313 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1314 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001315 versionedDumpDir := android.ExistentPathForSource(ctx,
1316 dumpDir, ctx.Config().PlatformSdkVersion().String())
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001317 if versionedDumpDir.Valid() {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001318 return sdkVersionInt, sdkVersionInt + 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001319 } else {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001320 return sdkVersionInt - 1, sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001321 }
1322 }
1323}
1324
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001325// Return the SDK version for same-version ABI diff.
1326func currRefAbiDumpSdkVersion(ctx ModuleContext) string {
Hsin-Yi Chen27bafd02024-01-08 18:38:42 +08001327 if ctx.Config().PlatformSdkFinal() {
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001328 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1329 // so choose PLATFORM_SDK_VERSION as the current version.
1330 return ctx.Config().PlatformSdkVersion().String()
1331 } else {
1332 return "current"
1333 }
1334}
1335
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001336// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001337func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext,
1338 sourceDump, referenceDump android.Path,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001339 baseName, nameExt string, isLlndk, allowExtensions bool,
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001340 sourceVersion, errorMessage string) {
1341
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001342 extraFlags := []string{"-target-version", sourceVersion}
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001343 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
1344 if Bool(headerAbiChecker.Check_all_apis) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001345 extraFlags = append(extraFlags, "-check-all-apis")
1346 } else {
1347 extraFlags = append(extraFlags,
1348 "-allow-unreferenced-changes",
1349 "-allow-unreferenced-elf-symbol-changes")
1350 }
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001351 if isLlndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001352 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1353 }
1354 if allowExtensions {
1355 extraFlags = append(extraFlags, "-allow-extensions")
1356 }
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001357 extraFlags = append(extraFlags, headerAbiChecker.Diff_flags...)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001358
1359 library.sAbiDiff = append(
1360 library.sAbiDiff,
1361 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1362 baseName, nameExt, extraFlags, errorMessage))
1363}
1364
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001365func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext,
1366 sourceDump, referenceDump android.Path,
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001367 baseName, nameExt string, isLlndk bool, sourceVersion, prevDumpDir string) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001368
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001369 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 +08001370
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001371 library.sourceAbiDiff(ctx, sourceDump, referenceDump, baseName, nameExt,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001372 isLlndk, true /* allowExtensions */, sourceVersion, errorMessage)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001373}
1374
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001375func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext,
1376 sourceDump, referenceDump android.Path,
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001377 baseName, nameExt string, isLlndk bool, lsdumpTagName string) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001378
1379 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001380 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
1381
1382 targetRelease := ctx.Config().Getenv("TARGET_RELEASE")
1383 if targetRelease != "" {
1384 errorMessage += " --release " + targetRelease
1385 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001386
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001387 library.sourceAbiDiff(ctx, sourceDump, referenceDump, baseName, nameExt,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001388 isLlndk, false /* allowExtensions */, "current", errorMessage)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001389}
1390
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001391func (library *libraryDecorator) optInAbiDiff(ctx android.ModuleContext,
1392 sourceDump, referenceDump android.Path,
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001393 baseName, nameExt string, refDumpDir string, lsdumpTagName string) {
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001394
1395 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001396 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
1397
1398 targetRelease := ctx.Config().Getenv("TARGET_RELEASE")
1399 if targetRelease != "" {
1400 errorMessage += " --release " + targetRelease
1401 }
1402
Hsin-Yi Chen8b85d812023-06-29 16:51:27 +08001403 // Most opt-in libraries do not have dumps for all default architectures.
1404 if ctx.Config().HasDeviceProduct() {
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001405 errorMessage += " --product " + ctx.Config().DeviceProduct()
Hsin-Yi Chen8b85d812023-06-29 16:51:27 +08001406 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001407
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001408 library.sourceAbiDiff(ctx, sourceDump, referenceDump, baseName, nameExt,
Hsin-Yi Chen6fd28952024-05-02 15:37:30 +08001409 false /* isLlndk */, false /* allowExtensions */, "current", errorMessage)
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001410}
1411
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001412func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, deps PathDeps, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001413 if library.sabi.shouldCreateSourceAbiDump() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001414 exportedIncludeDirs := library.exportedIncludeDirsForAbiCheck(ctx)
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001415 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001416 currSdkVersion := currRefAbiDumpSdkVersion(ctx)
1417 currVendorVersion := ctx.Config().VendorApiLevel()
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001418
1419 // Generate source dumps.
1420 implDump := transformDumpToLinkedDump(ctx,
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001421 objs.sAbiDumpFiles, soFile, fileName,
1422 exportedIncludeDirs,
Hsin-Yi Chen843c0632023-09-25 15:26:30 +08001423 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
1424 headerAbiChecker.Exclude_symbol_versions,
1425 headerAbiChecker.Exclude_symbol_tags,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001426 []string{} /* includeSymbolTags */, currSdkVersion, false /* isLlndk */)
Hsin-Yi Chen843c0632023-09-25 15:26:30 +08001427
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001428 var llndkDump, apexVariantDump android.Path
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001429 tags := classifySourceAbiDump(ctx)
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001430 optInTags := []lsdumpTag{}
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001431 for _, tag := range tags {
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001432 if tag == llndkLsdumpTag && currVendorVersion != "" {
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001433 if llndkDump == nil {
1434 // TODO(b/323447559): Evaluate if replacing sAbiDumpFiles with implDump is faster
1435 llndkDump = library.linkLlndkSAbiDumpFiles(ctx,
1436 deps, objs.sAbiDumpFiles, soFile, fileName,
1437 headerAbiChecker.Exclude_symbol_versions,
Hsin-Yi Chenf6fc5252024-04-15 15:43:21 +08001438 headerAbiChecker.Exclude_symbol_tags,
1439 currVendorVersion)
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001440 }
1441 addLsdumpPath(string(tag) + ":" + llndkDump.String())
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001442 } else if tag == apexLsdumpTag {
1443 if apexVariantDump == nil {
1444 apexVariantDump = library.linkApexSAbiDumpFiles(ctx,
1445 deps, objs.sAbiDumpFiles, soFile, fileName,
1446 headerAbiChecker.Exclude_symbol_versions,
1447 headerAbiChecker.Exclude_symbol_tags,
1448 currSdkVersion)
1449 }
1450 addLsdumpPath(string(tag) + ":" + apexVariantDump.String())
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001451 } else {
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001452 if tag.dirName() == "" {
1453 optInTags = append(optInTags, tag)
1454 }
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001455 addLsdumpPath(string(tag) + ":" + implDump.String())
1456 }
1457 }
1458
1459 // Diff source dumps and reference dumps.
1460 for _, tag := range tags {
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001461 dumpDirName := tag.dirName()
1462 if dumpDirName == "" {
1463 continue
1464 }
1465 dumpDir := filepath.Join("prebuilts", "abi-dumps", dumpDirName)
1466 isLlndk := (tag == llndkLsdumpTag)
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001467 isApex := (tag == apexLsdumpTag)
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001468 binderBitness := ctx.DeviceConfig().BinderBitness()
1469 nameExt := ""
1470 if isLlndk {
1471 nameExt = "llndk"
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001472 } else if isApex {
1473 nameExt = "apex"
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001474 }
1475 // Check against the previous version.
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001476 var prevVersion, currVersion string
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001477 sourceDump := implDump
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001478 // If this release config does not define VendorApiLevel, fall back to the old policy.
1479 if isLlndk && currVendorVersion != "" {
1480 prevVersion = ctx.Config().PrevVendorApiLevel()
1481 currVersion = currVendorVersion
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001482 // LLNDK dumps are generated by different rules after trunk stable.
1483 if android.IsTrunkStableVendorApiLevel(prevVersion) {
1484 sourceDump = llndkDump
1485 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001486 } else {
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001487 prevVersionInt, currVersionInt := crossVersionAbiDiffSdkVersions(ctx, dumpDir)
1488 prevVersion = strconv.Itoa(prevVersionInt)
1489 currVersion = strconv.Itoa(currVersionInt)
1490 // APEX dumps are generated by different rules after trunk stable.
1491 if isApex && prevVersionInt > 34 {
1492 sourceDump = apexVariantDump
1493 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001494 }
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001495 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1496 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
1497 if prevDumpFile.Valid() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001498 library.crossVersionAbiDiff(ctx, sourceDump, prevDumpFile.Path(),
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001499 fileName, nameExt+prevVersion, isLlndk, currVersion, prevDumpDir)
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001500 }
1501 // Check against the current version.
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001502 sourceDump = implDump
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001503 if isLlndk && currVendorVersion != "" {
1504 currVersion = currVendorVersion
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001505 if android.IsTrunkStableVendorApiLevel(currVersion) {
1506 sourceDump = llndkDump
1507 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001508 } else {
1509 currVersion = currSdkVersion
Hsin-Yi Chen98da0212024-04-14 19:08:17 +08001510 if isApex && (!ctx.Config().PlatformSdkFinal() ||
1511 ctx.Config().PlatformSdkVersion().FinalInt() > 34) {
1512 sourceDump = apexVariantDump
1513 }
Hsin-Yi Chen2c4a9772024-02-05 17:37:27 +08001514 }
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001515 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1516 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
1517 if currDumpFile.Valid() {
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001518 library.sameVersionAbiDiff(ctx, sourceDump, currDumpFile.Path(),
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001519 fileName, nameExt, isLlndk, string(tag))
Hsin-Yi Chen362c1882024-02-06 15:43:17 +08001520 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001521 }
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001522
1523 // Assert that a module is tagged with at most one of platformLsdumpTag, productLsdumpTag, or vendorLsdumpTag.
1524 if len(headerAbiChecker.Ref_dump_dirs) > 0 && len(optInTags) != 1 {
1525 ctx.ModuleErrorf("Expect exactly one opt-in lsdump tag when ref_dump_dirs are specified: %s", optInTags)
1526 return
1527 }
Hsin-Yi Chen3d5c6792024-04-22 11:47:57 +08001528 // Ensure that a module tagged with only platformLsdumpTag has ref_dump_dirs.
1529 // Android.bp in vendor projects should be cleaned up before this is enforced for vendorLsdumpTag and productLsdumpTag.
1530 if len(headerAbiChecker.Ref_dump_dirs) == 0 && len(tags) == 1 && tags[0] == platformLsdumpTag {
1531 ctx.ModuleErrorf("header_abi_checker is explicitly enabled, but no ref_dump_dirs are specified.")
1532 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001533 // Check against the opt-in reference dumps.
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001534 for i, optInDumpDir := range headerAbiChecker.Ref_dump_dirs {
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001535 optInDumpDirPath := android.PathForModuleSrc(ctx, optInDumpDir)
1536 // Ref_dump_dirs are not versioned.
1537 // They do not contain subdir for binder bitness because 64-bit binder has been mandatory.
1538 optInDumpFile := getRefAbiDumpFile(ctx, optInDumpDirPath.String(), fileName)
1539 if !optInDumpFile.Valid() {
1540 continue
1541 }
Hsin-Yi Chenaf369882024-03-29 20:10:36 +08001542 library.optInAbiDiff(ctx,
Hsin-Yi Chen64b2d032024-03-29 19:12:35 +08001543 implDump, optInDumpFile.Path(),
Hsin-Yi Chend5919c12024-02-19 15:15:30 +08001544 fileName, "opt"+strconv.Itoa(i), optInDumpDirPath.String(), string(optInTags[0]))
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001545 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001546 }
1547}
1548
Inseob Kimcc12d902021-05-14 20:15:55 +09001549func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001550 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1551 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1552
Colin Cross127bb8b2020-12-16 16:46:01 -08001553 for _, header := range srcFiles {
1554 headerDir := filepath.Dir(header.String())
1555 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1556 if err != nil {
1557 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1558 srcDir.String(), headerDir, err)
1559 continue
1560 }
1561
1562 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1563 }
1564
Inseob Kimcc12d902021-05-14 20:15:55 +09001565 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001566}
1567
Chris Parsons3c27ca32020-11-20 12:42:07 -05001568// link registers actions to link this library, and sets various fields
1569// on this library to reflect information that should be exported up the build
1570// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07001571func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001572 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001573
Colin Cross127bb8b2020-12-16 16:46:01 -08001574 if ctx.IsLlndk() {
1575 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
1576 // This is the vendor variant of an LLNDK library with preprocessed headers.
1577 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
1578
1579 var timestampFiles android.Paths
1580 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09001581 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
1582 timestampFiles = append(timestampFiles, timestampFile)
1583 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001584 }
1585
1586 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1587 library.reexportSystemDirs(genHeaderOutDir)
1588 } else {
1589 library.reexportDirs(genHeaderOutDir)
1590 }
1591
1592 library.reexportDeps(timestampFiles...)
1593 }
1594
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001595 // override the module's export_include_dirs with llndk.override_export_include_dirs
1596 // if it is set.
1597 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
Aleks Todorovc9becde2024-06-10 12:51:53 +01001598 library.flagExporter.Properties.Export_include_dirs = proptools.NewConfigurable[[]string](
1599 nil,
1600 []proptools.ConfigurableCase[[]string]{
1601 proptools.NewConfigurableCase[[]string](nil, &override),
1602 },
1603 )
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001604 }
1605
Colin Cross127bb8b2020-12-16 16:46:01 -08001606 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1607 library.flagExporter.Properties.Export_system_include_dirs = append(
1608 library.flagExporter.Properties.Export_system_include_dirs,
Aleks Todorovc9becde2024-06-10 12:51:53 +01001609 library.flagExporter.Properties.Export_include_dirs.GetOrDefault(ctx, nil)...)
1610 library.flagExporter.Properties.Export_include_dirs = proptools.NewConfigurable[[]string](nil, nil)
Colin Cross127bb8b2020-12-16 16:46:01 -08001611 }
1612 }
1613
Colin Cross5271fea2021-04-27 13:06:04 -07001614 if ctx.IsVendorPublicLibrary() {
1615 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
1616 // if it is set.
1617 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
Aleks Todorovc9becde2024-06-10 12:51:53 +01001618 library.flagExporter.Properties.Export_include_dirs = proptools.NewConfigurable[[]string](
1619 nil,
1620 []proptools.ConfigurableCase[[]string]{
1621 proptools.NewConfigurableCase[[]string](nil, &override),
1622 },
1623 )
Colin Cross5271fea2021-04-27 13:06:04 -07001624 }
1625 }
1626
Chris Parsons3c27ca32020-11-20 12:42:07 -05001627 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
1628 // of this library), together with `objs` (.o files created by compiling this
1629 // library).
Colin Crossad59e752017-11-16 14:29:11 -08001630 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001631 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08001632 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001633 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001634 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001635 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001636 }
1637
Chris Parsons3c27ca32020-11-20 12:42:07 -05001638 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09001639 library.exportIncludes(ctx)
Alessandro Astone10e9d432020-10-01 12:59:27 +02001640 library.exportExtraFlags(ctx)
Inseob Kim69378442019-06-03 19:10:47 +09001641 library.reexportDirs(deps.ReexportedDirs...)
1642 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
1643 library.reexportFlags(deps.ReexportedFlags...)
1644 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09001645 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001646
Ivan Lozano0a468a42024-05-13 21:03:34 -04001647 if library.static() && len(deps.ReexportedRustRlibDeps) > 0 {
1648 library.reexportRustStaticDeps(deps.ReexportedRustRlibDeps...)
1649 }
1650
Chris Parsons3c27ca32020-11-20 12:42:07 -05001651 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001652 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Vinh Tran367d89d2023-04-28 11:21:25 -04001653 if library.baseCompiler.hasAidl(deps) {
Vinh Tran09581952023-05-16 16:03:20 -04001654 if library.baseCompiler.hasSrcExt(".aidl") {
1655 dir := android.PathForModuleGen(ctx, "aidl")
1656 library.reexportDirs(dir)
1657 }
1658 if len(deps.AidlLibraryInfos) > 0 {
1659 dir := android.PathForModuleGen(ctx, "aidl_library")
1660 library.reexportDirs(dir)
1661 }
Inseob Kimd110f872019-12-06 13:15:38 +09001662
Paul Duffin33056e82021-02-19 13:49:08 +00001663 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
1664 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07001665 }
1666 }
1667
Chris Parsons3c27ca32020-11-20 12:42:07 -05001668 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001669 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001670 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09001671 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07001672 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09001673 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07001674 }
Jiyong Park74955042019-10-22 20:19:51 +09001675 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09001676 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09001677
Paul Duffin33056e82021-02-19 13:49:08 +00001678 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
1679 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07001680 }
1681 }
1682
Inseob Kim07def122020-11-23 14:43:02 +09001683 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09001684 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09001685 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001686 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09001687 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
1688
Inseob Kim07def122020-11-23 14:43:02 +09001689 // If the owner is different from the user, expose public header. That is,
1690 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09001691 // 2) if the owner is platform and the client is vendor
1692 // We don't care Platform -> Vendor dependency as it's already forbidden.
1693 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09001694 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001695 }
1696 }
1697
Paul Duffin37e0de52021-02-19 17:05:39 +00001698 // Make sure to only export headers which are within the include directory.
1699 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
1700 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
1701 return isRel
1702 })
1703
Chris Parsons3c27ca32020-11-20 12:42:07 -05001704 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09001705 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00001706 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00001707 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09001708 }
1709
Chris Parsons3c27ca32020-11-20 12:42:07 -05001710 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09001711 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09001712
Chris Parsons3c27ca32020-11-20 12:42:07 -05001713 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07001714 library.flagExporter.setProvider(ctx)
1715
Colin Cross4d9c2d12016-07-29 12:48:20 -07001716 return out
1717}
1718
Jiyong Park892a98f2020-12-14 09:20:00 +09001719func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001720 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09001721 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09001722 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
1723 if err != nil {
1724 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
1725 }
1726 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09001727 }
1728}
1729
Chris Parsons3c27ca32020-11-20 12:42:07 -05001730// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07001731func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001732 return library.MutatedProperties.BuildStatic &&
1733 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001734}
1735
Chris Parsons3c27ca32020-11-20 12:42:07 -05001736// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07001737func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001738 return library.MutatedProperties.BuildShared &&
1739 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001740}
1741
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001742func (library *libraryDecorator) objs() Objects {
1743 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001744}
1745
Colin Cross0de8a1e2020-09-18 14:15:30 -07001746func (library *libraryDecorator) reuseObjs() Objects {
1747 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001748}
1749
Colin Cross26c34ed2016-09-30 17:10:16 -07001750func (library *libraryDecorator) toc() android.OptionalPath {
1751 return library.tocFile
1752}
1753
Jiyong Parkf1194352019-02-25 11:05:47 +09001754func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
1755 dir := library.baseInstaller.installDir(ctx)
1756 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
Florian Mayer95cd6db2023-03-23 17:48:07 -07001757 // libc_hwasan has relative_install_dir set, which would mess up the dir.Base() logic.
1758 // hardcode here because it's the only target, if we have other targets that use this
1759 // we can generalise this.
1760 var target string
1761 if ctx.baseModuleName() == "libc_hwasan" {
1762 target = "/" + filepath.Join("apex", "com.android.runtime", "lib64", "bionic", "hwasan", file.Base())
1763 } else {
1764 base := dir.Base()
1765 target = "/" + filepath.Join("apex", "com.android.runtime", base, "bionic", file.Base())
1766 }
Jiyong Parkf1194352019-02-25 11:05:47 +09001767 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001768 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09001769}
1770
Colin Crossb916a382016-07-29 17:28:03 -07001771func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07001772 if library.shared() {
Kiyoung Kim9f26fcf2024-05-27 17:25:52 +09001773 if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09001774 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
1775 // The original path becomes a symlink to the corresponding file in the
1776 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07001777 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07001778 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001779 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01001780 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09001781 library.installSymlinkToRuntimeApex(ctx, file)
1782 }
Jiyong Park429660f2019-01-16 22:31:11 +09001783 library.baseInstaller.subDir = "bootstrap"
1784 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001785 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001786 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001787 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09001788 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001789
Colin Cross4d9c2d12016-07-29 12:48:20 -07001790 library.baseInstaller.install(ctx, file)
1791 }
Dan Albertf563d252017-10-13 00:29:00 -07001792
Dan Albert281f22b2017-12-13 15:03:47 -08001793 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Kiyoung Kimaa394802024-01-08 12:55:45 +09001794 !ctx.InVendorOrProduct() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09001795 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08001796 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albert4048bb02023-04-03 20:19:07 +00001797 installPath := getUnversionedLibraryInstallPath(ctx).Join(ctx, file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07001798
1799 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
1800 Rule: android.Cp,
1801 Description: "install " + installPath.Base(),
1802 Output: installPath,
1803 Input: file,
1804 })
1805
Colin Cross0875c522017-11-28 17:34:01 -08001806 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07001807 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001808}
1809
Paul Duffin0cb37b92020-03-04 14:52:46 +00001810func (library *libraryDecorator) everInstallable() bool {
1811 // Only shared and static libraries are installed. Header libraries (which are
1812 // neither static or shared) are not installed.
1813 return library.shared() || library.static()
1814}
1815
Chris Parsons3c27ca32020-11-20 12:42:07 -05001816// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07001817func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001818 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07001819}
1820
Chris Parsons3c27ca32020-11-20 12:42:07 -05001821// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001822func (library *libraryDecorator) shared() bool {
1823 return library.MutatedProperties.VariantIsShared
1824}
1825
Chris Parsons3c27ca32020-11-20 12:42:07 -05001826// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001827func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001828 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001829 return !library.static() && !library.shared()
1830}
1831
Chris Parsons3c27ca32020-11-20 12:42:07 -05001832// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001833func (library *libraryDecorator) setStatic() {
1834 library.MutatedProperties.VariantIsStatic = true
1835 library.MutatedProperties.VariantIsShared = false
1836}
1837
Chris Parsons3c27ca32020-11-20 12:42:07 -05001838// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001839func (library *libraryDecorator) setShared() {
1840 library.MutatedProperties.VariantIsStatic = false
1841 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07001842}
1843
Chris Parsons3c27ca32020-11-20 12:42:07 -05001844// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08001845func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001846 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08001847}
1848
Chris Parsons3c27ca32020-11-20 12:42:07 -05001849// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08001850func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001851 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08001852}
1853
Chris Parsons3c27ca32020-11-20 12:42:07 -05001854// HeaderOnly disables building this library as a shared or static library;
1855// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08001856func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001857 library.MutatedProperties.BuildShared = false
1858 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08001859}
1860
Colin Cross127bb8b2020-12-16 16:46:01 -08001861// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
1862func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07001863 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001864}
1865
Colin Cross203b4212021-04-26 17:19:41 -07001866// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07001867func (library *libraryDecorator) hasLLNDKHeaders() bool {
1868 return Bool(library.Properties.Llndk.Llndk_headers)
1869}
1870
Colin Cross5271fea2021-04-27 13:06:04 -07001871// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
1872// vendor public library stubs.
1873func (library *libraryDecorator) hasVendorPublicLibrary() bool {
1874 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
1875}
1876
Colin Cross0477b422020-10-13 18:43:54 -07001877func (library *libraryDecorator) implementationModuleName(name string) string {
1878 return name
1879}
1880
Jiyong Park7ed9de32018-10-15 22:25:07 +09001881func (library *libraryDecorator) buildStubs() bool {
1882 return library.MutatedProperties.BuildStubs
1883}
1884
Jiyong Parka034b832019-08-27 14:02:19 +09001885func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001886 if props := library.getHeaderAbiCheckerProperties(ctx); props.Symbol_file != nil {
1887 return props.Symbol_file
Jiyong Parka034b832019-08-27 14:02:19 +09001888 }
Colin Cross31076b32020-10-23 17:22:06 -07001889 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09001890 return library.Properties.Stubs.Symbol_file
1891 }
Hsin-Yi Chenf1f276c2024-03-11 20:02:34 +08001892 // TODO(b/309880485): Distinguish platform, NDK, LLNDK, and APEX version scripts.
1893 if library.baseLinker.Properties.Version_script != nil {
1894 return library.baseLinker.Properties.Version_script
1895 }
Jiyong Parka034b832019-08-27 14:02:19 +09001896 return nil
1897}
1898
Colin Crossc88c2722020-09-28 17:32:47 -07001899func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001900 // Just having stubs.symbol_file is enough to create a stub variant. In that case
1901 // the stub for the future API level is created.
1902 return library.Properties.Stubs.Symbol_file != nil ||
1903 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07001904}
1905
Alan Stokes73feba32022-11-14 12:21:24 +00001906func (library *libraryDecorator) isStubsImplementationRequired() bool {
1907 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
1908}
1909
Colin Cross3572cf72020-10-01 15:58:11 -07001910func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001911 if !library.hasStubsVariants() {
1912 return nil
1913 }
1914
Kiyoung Kimaa394802024-01-08 12:55:45 +09001915 if library.hasLLNDKStubs() && ctx.Module().(*Module).InVendorOrProduct() {
Jooyung Han5e8994e2024-03-12 14:12:12 +09001916 // LLNDK libraries only need a single stubs variant (""), which is
1917 // added automatically in createVersionVariations().
1918 return nil
Colin Crossc1b36442021-05-06 13:42:48 -07001919 }
1920
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001921 // Future API level is implicitly added if there isn't
Jooyung Han5e8994e2024-03-12 14:12:12 +09001922 versions := addCurrentVersionIfNotPresent(library.Properties.Stubs.Versions)
1923 normalizeVersions(ctx, versions)
1924 return versions
Sam Delmerico75dbca22023-04-20 13:13:25 +00001925}
1926
1927func addCurrentVersionIfNotPresent(vers []string) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001928 if inList(android.FutureApiLevel.String(), vers) {
1929 return vers
1930 }
1931 // In some cases, people use the raw value "10000" in the versions property.
1932 // We shouldn't add the future API level in that case, otherwise there will
1933 // be two identical versions.
1934 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
1935 return vers
1936 }
1937 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07001938}
1939
1940func (library *libraryDecorator) setStubsVersion(version string) {
1941 library.MutatedProperties.StubsVersion = version
1942}
1943
Jiyong Park7ed9de32018-10-15 22:25:07 +09001944func (library *libraryDecorator) stubsVersion() string {
1945 return library.MutatedProperties.StubsVersion
1946}
1947
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001948func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07001949 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001950 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07001951}
1952
1953func (library *libraryDecorator) setAllStubsVersions(versions []string) {
1954 library.MutatedProperties.AllStubsVersions = versions
1955}
1956
1957func (library *libraryDecorator) allStubsVersions() []string {
1958 return library.MutatedProperties.AllStubsVersions
1959}
1960
Jooyung Hanad4c1872020-02-27 17:56:44 +09001961func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001962 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09001963}
1964
Jiyong Parka90ca002019-10-07 15:47:24 +09001965func (library *libraryDecorator) availableFor(what string) bool {
1966 var list []string
1967 if library.static() {
1968 list = library.StaticProperties.Static.Apex_available
1969 } else if library.shared() {
1970 list = library.SharedProperties.Shared.Apex_available
1971 }
1972 if len(list) == 0 {
1973 return false
1974 }
1975 return android.CheckAvailableForApex(what, list)
1976}
1977
Colin Cross1bc94122021-10-28 13:25:54 -07001978func (library *libraryDecorator) installable() *bool {
1979 if library.static() {
1980 return library.StaticProperties.Static.Installable
1981 } else if library.shared() {
1982 return library.SharedProperties.Shared.Installable
1983 }
1984 return nil
1985}
1986
Jingwen Chen8ac7d7d2023-03-20 11:05:16 +00001987func (library *libraryDecorator) makeUninstallable(mod *Module) {
1988 if library.static() && library.buildStatic() && !library.buildStubs() {
1989 // If we're asked to make a static library uninstallable we don't do
1990 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
1991 // for these entries. This is done to still get the make targets for NOTICE
1992 // files from notice_files.mk, which other libraries might depend on.
1993 return
1994 }
1995 mod.ModuleBase.MakeUninstallable()
1996}
1997
Jihoon Kangf78a8902022-09-01 22:47:07 +00001998func (library *libraryDecorator) getPartition() string {
1999 return library.path.Partition()
2000}
2001
Colin Crossceaa5322021-09-28 16:37:50 -07002002func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2003 return library.apiListCoverageXmlPath
2004}
2005
Inseob Kima1888ce2022-10-04 14:42:02 +09002006func (library *libraryDecorator) overriddenModules() []string {
2007 return library.Properties.Overrides
2008}
2009
2010var _ overridable = (*libraryDecorator)(nil)
2011
Colin Cross571cccf2019-02-04 11:22:08 -08002012var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2013
Chris Parsons3c27ca32020-11-20 12:42:07 -05002014// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2015// and values are the module name responsible for registering the version macro name.
2016//
2017// Version macros are used when building against stubs, to provide version information about
2018// the stub. Only stub libraries should have an entry in this list.
2019//
2020// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2021// that headers from libFoo can be conditionally compiled (this may hide APIs
2022// that are not available for the version).
2023//
2024// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002025func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002026 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002027 m := make(map[string]string)
2028 return &m
2029 }).(*map[string]string)
2030}
2031
2032// alphanumeric and _ characters are preserved.
2033// other characters are all converted to _
2034var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2035
Chris Parsons3c27ca32020-11-20 12:42:07 -05002036// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002037func versioningMacroName(moduleName string) string {
2038 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002039 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002040 return "__" + macroName + "_API__"
2041}
2042
Chris Parsons3c27ca32020-11-20 12:42:07 -05002043// NewLibrary builds and returns a new Module corresponding to a C++ library.
2044// Individual module implementations which comprise a C++ library (or something like
2045// a C++ library) should call this function, set some fields on the result, and
2046// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002047func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002048 module := newModule(hod, android.MultilibBoth)
2049
Colin Crossb916a382016-07-29 17:28:03 -07002050 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002051 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002052 BuildShared: true,
2053 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002054 },
Colin Crossb916a382016-07-29 17:28:03 -07002055 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002056 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002057 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002058 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002059 }
2060
Colin Crossb916a382016-07-29 17:28:03 -07002061 module.compiler = library
2062 module.linker = library
2063 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002064 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002065
2066 return module, library
2067}
2068
Colin Cross10d22312017-05-03 11:01:58 -07002069// connects a shared library to a static library in order to reuse its .o files to avoid
2070// compiling source files twice.
2071func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2072 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2073 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002074
2075 // Check libraries in addition to cflags, since libraries may be exporting different
2076 // include directories.
Cole Fauste96c16a2024-06-13 14:51:14 -07002077 if len(staticCompiler.StaticProperties.Static.Cflags.GetOrDefault(mctx, nil)) == 0 &&
2078 len(sharedCompiler.SharedProperties.Shared.Cflags.GetOrDefault(mctx, nil)) == 0 &&
Colin Crosse1bb5d02019-09-24 14:55:04 -07002079 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2080 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2081 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2082 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2083 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2084 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002085 // Compare System_shared_libs properties with nil because empty lists are
2086 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002087 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2088 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002089
2090 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2091 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2092 sharedCompiler.baseCompiler.Properties.Srcs
2093 sharedCompiler.baseCompiler.Properties.Srcs = nil
2094 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2095 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002096
2097 // This dep is just to reference static variant from shared variant
2098 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002099 }
2100}
2101
Chris Parsons3c27ca32020-11-20 12:42:07 -05002102// LinkageMutator adds "static" or "shared" variants for modules depending
2103// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002104func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002105 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002106 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002107 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002108 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002109 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002110 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002111
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002112 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002113 buildStatic := library.buildStatic()
2114 buildShared := library.buildShared()
2115 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002116 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2117 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2118 // all the variants of the cc_library also exist on the prebuilt.
2119 modules := mctx.CreateLocalVariations("static", "shared")
2120 static := modules[0].(*Module)
2121 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002122
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002123 static.linker.(prebuiltLibraryInterface).setStatic()
2124 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002125
Colin Cross127bb8b2020-12-16 16:46:01 -08002126 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002127 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002128 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002129 mctx.AliasVariation("static")
2130 }
2131
Colin Cross127bb8b2020-12-16 16:46:01 -08002132 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002133 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2134 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002135 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002136 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2137 }
2138 } else {
2139 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002140 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002141
Ivan Lozano0a468a42024-05-13 21:03:34 -04002142 } else if library, ok := mctx.Module().(LinkableInterface); ok && (library.CcLibraryInterface() || library.RustLibraryInterface()) {
Ivan Lozano2b262972019-11-21 12:30:50 -08002143 // Non-cc.Modules may need an empty variant for their mutators.
2144 variations := []string{}
2145 if library.NonCcVariants() {
2146 variations = append(variations, "")
2147 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002148 isLLNDK := false
2149 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002150 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002151 }
2152 buildStatic := library.BuildStaticVariant() && !isLLNDK
2153 buildShared := library.BuildSharedVariant()
2154 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002155 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002156
2157 modules := mctx.CreateLocalVariations(variations...)
2158 static := modules[0].(LinkableInterface)
2159 shared := modules[1].(LinkableInterface)
2160
2161 static.SetStatic()
2162 shared.SetShared()
2163
2164 if _, ok := library.(*Module); ok {
2165 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2166 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002167 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002168 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002169 variations := append([]string{"static"}, variations...)
2170
2171 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002172 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002173 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002174 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002175 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002176
Ivan Lozano2b262972019-11-21 12:30:50 -08002177 modules := mctx.CreateLocalVariations(variations...)
2178 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002179 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002180 } else if len(variations) > 0 {
2181 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002182 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002183 }
Colin Crossb916a382016-07-29 17:28:03 -07002184 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002185}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002186
Chris Parsons3c27ca32020-11-20 12:42:07 -05002187// normalizeVersions modifies `versions` in place, so that each raw version
2188// string becomes its normalized canonical form.
2189// Validates that the versions in `versions` are specified in least to greatest order.
Colin Cross8ff10582023-12-07 13:10:56 -08002190func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002191 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002192 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002193 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002194 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002195 ctx.PropertyErrorf("versions", "%s", err.Error())
2196 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002197 }
Dan Albertc8060532020-07-22 22:32:17 -07002198 if i > 0 && ver.LessThanOrEqualTo(previous) {
2199 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2200 }
2201 versions[i] = ver.String()
2202 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002203 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002204}
2205
Jooyung Han61b66e92020-03-21 14:21:46 +00002206func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002207 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2208 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002209 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002210
Colin Cross127bb8b2020-12-16 16:46:01 -08002211 m := mctx.Module().(*Module)
2212 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002213 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002214 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002215
Colin Crossd1f898e2020-08-18 18:35:15 -07002216 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002217 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002218
Kiyoung Kimee58c932022-10-25 22:59:41 +09002219 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002220 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002221 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002222 c.sanitize = nil
2223 c.stl = nil
2224 c.Properties.PreventInstall = true
2225 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002226 isLatest := i == (len(versions) - 1)
2227 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002228
2229 if variants[i] != "" {
2230 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2231 // implementation module to the stubs module.
2232 c.Properties.HideFromMake = true
2233 lib.setStubsVersion(variants[i])
2234 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2235 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002236 }
2237 }
Colin Cross094faa52020-08-06 17:38:25 -07002238 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002239 latestVersion := ""
2240 if len(versions) > 0 {
2241 latestVersion = versions[len(versions)-1]
2242 }
2243 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002244}
2245
Colin Crossbbc941b2020-09-30 12:27:01 -07002246func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2247 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2248 if err != nil {
2249 mctx.PropertyErrorf("min_sdk_version", err.Error())
2250 return
2251 }
2252
2253 versionStrs := ndkLibraryVersions(mctx, from)
2254 modules := mctx.CreateLocalVariations(versionStrs...)
2255
2256 for i, module := range modules {
2257 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002258 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002259 }
2260}
2261
Liz Kammer23942242022-04-08 15:41:00 -04002262func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002263 Host() bool
2264 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002265 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002266}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002267 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002268}
2269
Liz Kammer23942242022-04-08 15:41:00 -04002270func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002271 Host() bool
2272 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002273 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002274 CcLibraryInterface() bool
2275 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002276}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002277 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002278 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002279}
2280
Colin Cross127bb8b2020-12-16 16:46:01 -08002281func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002282 if m, ok := module.(*Module); ok {
2283 return m.library
2284 }
2285 return nil
2286}
2287
Liz Kammer23942242022-04-08 15:41:00 -04002288// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2289func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2290 if !library.buildShared() || !canBeVersionVariant(module) {
2291 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002292 }
Liz Kammer23942242022-04-08 15:41:00 -04002293 versions := library.stubsVersions(mctx)
Liz Kammer23942242022-04-08 15:41:00 -04002294 if mctx.Failed() {
2295 return
2296 }
2297 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2298 // depend on the implementation library and haven't been mutated yet.
2299 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002300}
Jooyung Han61b66e92020-03-21 14:21:46 +00002301
Colin Crossd1f898e2020-08-18 18:35:15 -07002302// versionMutator splits a module into the mandatory non-stubs variant
2303// (which is unnamed) and zero or more stubs variants.
2304func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002305 if mctx.Os() != android.Android {
2306 return
2307 }
2308
2309 m, ok := mctx.Module().(*Module)
2310 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2311 setStubsVersions(mctx, library, m)
2312
Colin Cross31076b32020-10-23 17:22:06 -07002313 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002314 return
2315 }
2316
Liz Kammer23942242022-04-08 15:41:00 -04002317 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002318 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002319 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2320 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002321 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002322}
Colin Crossd7227f92019-09-05 14:26:33 -07002323
2324// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2325// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2326// that the linked output file should be written to.
2327// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2328func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2329 inject *bool, fileName string) android.ModuleOutPath {
2330 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2331 injectBoringSSLHash := Bool(inject)
2332 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002333 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002334 if cc, ok := dep.(*Module); ok {
2335 if library, ok := cc.linker.(*libraryDecorator); ok {
2336 if Bool(library.Properties.Inject_bssl_hash) {
2337 injectBoringSSLHash = true
2338 }
2339 }
2340 }
2341 }
2342 })
2343 if injectBoringSSLHash {
2344 hashedOutputfile := outputFile
2345 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2346
Colin Crossf1a035e2020-11-16 17:32:30 -08002347 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002348 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002349 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002350 FlagWithInput("-in-object ", outputFile).
2351 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002352 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002353 }
2354
2355 return outputFile
2356}