blob: fe1d00d011a48a350d5c9d59bd080e3884052620 [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"
Rupert Shuttleworth095081c2021-03-25 09:06:03 +000027 "android/soong/bazel"
Chris Parsons94a0bba2021-06-04 15:03:47 -040028 "android/soong/bazel/cquery"
Dan Albertea4b7b92018-04-25 16:05:30 -070029 "android/soong/cc/config"
Liz Kammer2ada09a2021-08-11 00:17:36 -040030
Chris Parsons51f8c392021-08-03 21:01:05 -040031 "github.com/google/blueprint"
32 "github.com/google/blueprint/pathtools"
Spandan Das4238c652022-09-09 01:38:47 +000033 "github.com/google/blueprint/proptools"
Colin Cross4d9c2d12016-07-29 12:48:20 -070034)
35
Liz Kammer2b376bc2022-01-12 12:00:49 -050036// LibraryProperties is a collection of properties shared by cc library rules/cc.
Colin Crossb916a382016-07-29 17:28:03 -070037type LibraryProperties struct {
Colin Cross4d9c2d12016-07-29 12:48:20 -070038 // local file name to pass to the linker as -unexported_symbols_list
Colin Cross27b922f2019-03-04 22:35:41 -080039 Unexported_symbols_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070040 // local file name to pass to the linker as -force_symbols_not_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080041 Force_symbols_not_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070042 // local file name to pass to the linker as -force_symbols_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080043 Force_symbols_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070044
45 // rename host libraries to prevent overlap with system installed libraries
46 Unique_host_soname *bool
47
Dan Willemsene1240db2016-11-03 14:28:51 -070048 Aidl struct {
49 // export headers generated from .aidl sources
Nan Zhang0007d812017-11-07 10:57:05 -080050 Export_aidl_headers *bool
Dan Willemsene1240db2016-11-03 14:28:51 -070051 }
52
Colin Cross0c461f12016-10-20 16:11:43 -070053 Proto struct {
54 // export headers generated from .proto sources
Nan Zhang0007d812017-11-07 10:57:05 -080055 Export_proto_headers *bool
Colin Cross0c461f12016-10-20 16:11:43 -070056 }
Dan Albertf563d252017-10-13 00:29:00 -070057
Inseob Kimc0907f12019-02-08 21:00:45 +090058 Sysprop struct {
59 // Whether platform owns this sysprop library.
60 Platform *bool
Inseob Kimb3f22ca2019-03-05 12:40:24 +090061 } `blueprint:"mutated"`
Inseob Kimc0907f12019-02-08 21:00:45 +090062
Nan Zhang0007d812017-11-07 10:57:05 -080063 Static_ndk_lib *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090064
Florian Mayer6dab96c2020-12-31 11:39:48 +000065 // Generate stubs to make this library accessible to APEXes.
Jiyong Park7ed9de32018-10-15 22:25:07 +090066 Stubs struct {
67 // Relative path to the symbol map. The symbol map provides the list of
68 // symbols that are exported for stubs variant of this library.
Colin Cross27b922f2019-03-04 22:35:41 -080069 Symbol_file *string `android:"path"`
Jiyong Park7ed9de32018-10-15 22:25:07 +090070
Jiyong Parkd4a3a132021-03-17 20:21:35 +090071 // List versions to generate stubs libs for. The version name "current" is always
72 // implicitly added.
Jiyong Park7ed9de32018-10-15 22:25:07 +090073 Versions []string
Alan Stokes73feba32022-11-14 12:21:24 +000074
75 // Whether to not require the implementation of the library to be installed if a
76 // client of the stubs is installed. Defaults to true; set to false if the
77 // implementation is made available by some other means, e.g. in a Microdroid
78 // virtual machine.
79 Implementation_installable *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090080 }
dimitryd95964a2018-11-07 13:43:34 +010081
82 // set the name of the output
83 Stem *string `android:"arch_variant"`
84
Colin Cross0fd6a412019-08-16 14:22:10 -070085 // set suffix of the name of the output
86 Suffix *string `android:"arch_variant"`
87
88 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"`
92 }
93 }
94
dimitryd95964a2018-11-07 13:43:34 +010095 // Names of modules to be overridden. Listed modules can only be other shared libraries
96 // (in Make or Soong).
97 // This does not completely prevent installation of the overridden libraries, but if both
98 // binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
99 // from PRODUCT_PACKAGES.
100 Overrides []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800101
102 // Properties for ABI compatibility checker
103 Header_abi_checker struct {
Logan Chien41eabe62019-04-10 13:33:58 +0800104 // Enable ABI checks (even if this is not an LLNDK/VNDK lib)
105 Enabled *bool
106
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800107 // Path to a symbol file that specifies the symbols to be included in the generated
108 // ABI dump file
Colin Cross27b922f2019-03-04 22:35:41 -0800109 Symbol_file *string `android:"path"`
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800110
111 // Symbol versions that should be ignored from the symbol file
112 Exclude_symbol_versions []string
113
114 // Symbol tags that should be ignored from the symbol file
115 Exclude_symbol_tags []string
Logan Chien2a65dda2019-10-01 15:58:07 -0700116
117 // Run checks on all APIs (in addition to the ones referred by
118 // one of exported ELF symbols.)
119 Check_all_apis *bool
Hsin-Yi Chen6ad1e4b2022-05-19 15:17:54 +0800120
121 // Extra flags passed to header-abi-diff
122 Diff_flags []string
Hsin-Yi Chenf3630122022-11-17 14:29:43 +0800123
124 // Opt-in reference dump directories
125 Ref_dump_dirs []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800126 }
Vic Yang6cd1be82019-06-24 16:08:48 -0700127
Pete Bentley803e1612019-08-06 22:19:59 +0100128 // Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
129 Inject_bssl_hash *bool `android:"arch_variant"`
Colin Cross0477b422020-10-13 18:43:54 -0700130
Colin Cross127bb8b2020-12-16 16:46:01 -0800131 // If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
132 // the module pointed to by llndk_stubs if it is set.
133 Llndk llndkLibraryProperties
Colin Cross5271fea2021-04-27 13:06:04 -0700134
135 // If this is a vendor public library, properties to describe the vendor public library stubs.
136 Vendor_public_library vendorPublicLibraryProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800137}
Colin Cross0c461f12016-10-20 16:11:43 -0700138
Chris Parsons3c27ca32020-11-20 12:42:07 -0500139// StaticProperties is a properties stanza to affect only attributes of the "static" variants of a
140// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700141type StaticProperties struct {
142 Static StaticOrSharedProperties `android:"arch_variant"`
143}
144
Chris Parsons3c27ca32020-11-20 12:42:07 -0500145// SharedProperties is a properties stanza to affect only attributes of the "shared" variants of a
146// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700147type SharedProperties struct {
148 Shared StaticOrSharedProperties `android:"arch_variant"`
149}
150
Chris Parsons3c27ca32020-11-20 12:42:07 -0500151// StaticOrSharedProperties is an embedded struct representing properties to affect attributes of
152// either only the "static" variants or only the "shared" variants of a library module. These override
153// the base properties of the same name.
154// Use `StaticProperties` or `SharedProperties`, depending on which variant is needed.
155// `StaticOrSharedProperties` exists only to avoid duplication.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700156type StaticOrSharedProperties struct {
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700157 Srcs []string `android:"path,arch_variant"`
158
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700159 Tidy_disabled_srcs []string `android:"path,arch_variant"`
160
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800161 Tidy_timeout_srcs []string `android:"path,arch_variant"`
162
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700163 Sanitized Sanitized `android:"arch_variant"`
164
Colin Crosse1bb5d02019-09-24 14:55:04 -0700165 Cflags []string `android:"arch_variant"`
166
Colin Cross6b8f4252021-07-22 11:39:44 -0700167 Enabled *bool `android:"arch_variant"`
168 Whole_static_libs []string `android:"arch_variant"`
169 Static_libs []string `android:"arch_variant"`
170 Shared_libs []string `android:"arch_variant"`
171 System_shared_libs []string `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700172
173 Export_shared_lib_headers []string `android:"arch_variant"`
174 Export_static_lib_headers []string `android:"arch_variant"`
Jiyong Parka90ca002019-10-07 15:47:24 +0900175
176 Apex_available []string `android:"arch_variant"`
Colin Cross1bc94122021-10-28 13:25:54 -0700177
178 Installable *bool `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700179}
180
Colin Crossa48ab5b2017-02-14 15:28:44 -0800181type LibraryMutatedProperties struct {
Colin Crossb916a382016-07-29 17:28:03 -0700182 // Build a static variant
183 BuildStatic bool `blueprint:"mutated"`
184 // Build a shared variant
185 BuildShared bool `blueprint:"mutated"`
186 // This variant is shared
187 VariantIsShared bool `blueprint:"mutated"`
188 // This variant is static
189 VariantIsStatic bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900190
191 // This variant is a stubs lib
192 BuildStubs bool `blueprint:"mutated"`
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900193 // This variant is the latest version
194 IsLatestVersion bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900195 // Version of the stubs lib
196 StubsVersion string `blueprint:"mutated"`
Colin Crossd1f898e2020-08-18 18:35:15 -0700197 // List of all stubs versions associated with an implementation lib
198 AllStubsVersions []string `blueprint:"mutated"`
Colin Crossb916a382016-07-29 17:28:03 -0700199}
200
201type FlagExporterProperties struct {
202 // list of directories relative to the Blueprints file that will
Dan Willemsen273af7f2016-11-03 15:53:42 -0700203 // be added to the include path (using -I) for this module and any module that links
Colin Cross5d195602017-10-17 16:15:50 -0700204 // against this module. Directories listed in export_include_dirs do not need to be
205 // listed in local_include_dirs.
Colin Cross0ed579e2021-06-29 00:51:12 +0000206 Export_include_dirs []string `android:"arch_variant,variant_prepend"`
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700207
Jiyong Park73c54ee2019-10-22 20:31:18 +0900208 // list of directories that will be added to the system include path
209 // using -isystem for this module and any module that links against this module.
Colin Cross0ed579e2021-06-29 00:51:12 +0000210 Export_system_include_dirs []string `android:"arch_variant,variant_prepend"`
Jiyong Park73c54ee2019-10-22 20:31:18 +0900211
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700212 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900213 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700214 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900215 // export_include_dirs, that will be applied to
216 // vendor or product variant of this library.
217 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800218 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700219 }
220 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700221}
222
223func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000224 RegisterLibraryBuildComponents(android.InitRegistrationContext)
225}
226
227func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
228 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
229 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
230 ctx.RegisterModuleType("cc_library", LibraryFactory)
231 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
232 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700233}
234
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +0000235// TODO(b/199902614): Can this be factored to share with the other Attributes?
Jingwen Chen63930982021-03-24 10:04:33 -0400236// For bp2build conversion.
237type bazelCcLibraryAttributes struct {
Chris Parsons08648312021-05-06 16:23:19 -0400238 // Attributes pertaining to both static and shared variants.
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000239 Srcs bazel.LabelListAttribute
240 Srcs_c bazel.LabelListAttribute
241 Srcs_as bazel.LabelListAttribute
242
243 Copts bazel.StringListAttribute
244 Cppflags bazel.StringListAttribute
245 Conlyflags bazel.StringListAttribute
246 Asflags bazel.StringListAttribute
247
Liz Kammer7a210ac2021-09-22 15:52:58 -0400248 Hdrs bazel.LabelListAttribute
249
Liz Kammer12615db2021-09-28 09:19:17 -0400250 Deps bazel.LabelListAttribute
251 Implementation_deps bazel.LabelListAttribute
252 Dynamic_deps bazel.LabelListAttribute
253 Implementation_dynamic_deps bazel.LabelListAttribute
254 Whole_archive_deps bazel.LabelListAttribute
255 Implementation_whole_archive_deps bazel.LabelListAttribute
256 System_dynamic_deps bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -0400257
Liz Kammer5fad5012021-09-09 14:08:21 -0400258 Export_includes bazel.StringListAttribute
259 Export_system_includes bazel.StringListAttribute
Liz Kammer35687bc2021-09-10 10:07:07 -0400260 Local_includes bazel.StringListAttribute
261 Absolute_includes bazel.StringListAttribute
Liz Kammer5fad5012021-09-09 14:08:21 -0400262 Linkopts bazel.StringListAttribute
263 Use_libcrt bazel.BoolAttribute
264 Rtti bazel.BoolAttribute
Jingwen Chen5b11ab12021-10-11 17:44:33 +0000265
266 Stl *string
267 Cpp_std *string
Chris Parsons79bd2b72021-11-29 17:52:41 -0500268 C_std *string
Chris Parsons990c4f42021-05-25 12:10:58 -0400269
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000270 // This is shared only.
Liz Kammerd2871182021-10-04 13:54:37 -0400271 Link_crt bazel.BoolAttribute
272 Additional_linker_inputs bazel.LabelListAttribute
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000273
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000274 // Common properties shared between both shared and static variants.
275 Shared staticOrSharedAttributes
276 Static staticOrSharedAttributes
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000277
278 Strip stripAttributes
Liz Kammer0eae52e2021-10-06 10:32:26 -0400279
280 Features bazel.StringListAttribute
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000281}
282
Vinh Tran9f6796a2022-08-16 13:10:31 -0400283type aidlLibraryAttributes struct {
284 Srcs bazel.LabelListAttribute
285 Include_dir *string
286}
287
288type ccAidlLibraryAttributes struct {
Vinh Tran395a1e92022-09-16 18:27:29 -0400289 Deps bazel.LabelListAttribute
290 Implementation_dynamic_deps bazel.LabelListAttribute
Vinh Tran9f6796a2022-08-16 13:10:31 -0400291}
292
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000293type stripAttributes struct {
294 Keep_symbols bazel.BoolAttribute
295 Keep_symbols_and_debug_frame bazel.BoolAttribute
296 Keep_symbols_list bazel.StringListAttribute
297 All bazel.BoolAttribute
298 None bazel.BoolAttribute
Jingwen Chen63930982021-03-24 10:04:33 -0400299}
300
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +0000301func stripAttrsFromLinkerAttrs(la *linkerAttributes) stripAttributes {
302 return stripAttributes{
303 Keep_symbols: la.stripKeepSymbols,
304 Keep_symbols_and_debug_frame: la.stripKeepSymbolsAndDebugFrame,
305 Keep_symbols_list: la.stripKeepSymbolsList,
306 All: la.stripAll,
307 None: la.stripNone,
308 }
309}
310
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400311func libraryBp2Build(ctx android.TopDownMutatorContext, m *Module) {
Jingwen Chen179856a2021-05-03 09:15:48 +0000312 // For some cc_library modules, their static variants are ready to be
313 // converted, but not their shared variants. For these modules, delegate to
314 // the cc_library_static bp2build converter temporarily instead.
Chris Parsonsad876012022-08-20 14:48:32 -0400315 if android.GetBp2BuildAllowList().GenerateCcLibraryStaticOnly(ctx.Module().Name()) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400316 sharedOrStaticLibraryBp2Build(ctx, m, true)
Jingwen Chen179856a2021-05-03 09:15:48 +0000317 return
318 }
319
Jingwen Chen53681ef2021-04-29 08:15:13 +0000320 sharedAttrs := bp2BuildParseSharedProps(ctx, m)
321 staticAttrs := bp2BuildParseStaticProps(ctx, m)
Liz Kammere6583482021-10-19 13:56:10 -0400322 baseAttributes := bp2BuildParseBaseProps(ctx, m)
323 compilerAttrs := baseAttributes.compilerAttributes
324 linkerAttrs := baseAttributes.linkerAttributes
Liz Kammer54549442022-05-11 13:55:06 -0400325 exportedIncludes := bp2BuildParseExportedIncludes(ctx, m, &compilerAttrs.includes)
Jingwen Chen63930982021-03-24 10:04:33 -0400326
Liz Kammer9abd62d2021-05-21 08:37:59 -0400327 srcs := compilerAttrs.srcs
Jingwen Chen53681ef2021-04-29 08:15:13 +0000328
Liz Kammer12615db2021-09-28 09:19:17 -0400329 sharedAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
330 staticAttrs.Deps.Add(baseAttributes.protoDependency)
331
Chris Parsons69fa9f92021-07-13 11:47:44 -0400332 asFlags := compilerAttrs.asFlags
333 if compilerAttrs.asSrcs.IsEmpty() && sharedAttrs.Srcs_as.IsEmpty() && staticAttrs.Srcs_as.IsEmpty() {
334 // Skip asflags for BUILD file simplicity if there are no assembly sources.
335 asFlags = bazel.MakeStringListAttribute(nil)
336 }
337
Chris Parsons77acf2e2021-12-03 17:27:16 -0500338 staticCommonAttrs := staticOrSharedAttributes{
339 Srcs: *srcs.Clone().Append(staticAttrs.Srcs),
340 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(staticAttrs.Srcs_c),
341 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(staticAttrs.Srcs_as),
342 Copts: *compilerAttrs.copts.Clone().Append(staticAttrs.Copts),
343 Hdrs: *compilerAttrs.hdrs.Clone().Append(staticAttrs.Hdrs),
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000344
Chris Parsons77acf2e2021-12-03 17:27:16 -0500345 Deps: *linkerAttrs.deps.Clone().Append(staticAttrs.Deps),
346 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(staticAttrs.Implementation_deps),
347 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(staticAttrs.Dynamic_deps),
348 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(staticAttrs.Implementation_dynamic_deps),
349 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
350 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(staticAttrs.Whole_archive_deps),
351 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(staticAttrs.System_dynamic_deps),
Cole Faust6b29f592022-08-09 09:50:56 -0700352 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liufc603162022-03-01 15:44:08 -0800353 sdkAttributes: bp2BuildParseSdkAttributes(m),
Yu Liuf01a0f02022-12-07 15:45:30 -0800354 Native_coverage: baseAttributes.Native_coverage,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500355 }
356
357 sharedCommonAttrs := staticOrSharedAttributes{
358 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
359 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
360 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
361 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
362 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
363
Liz Kammer84b0ecb2022-09-14 10:49:13 -0400364 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
365 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
366 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
367 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
368 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
369 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
370 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
371 Runtime_deps: linkerAttrs.runtimeDeps,
372 sdkAttributes: bp2BuildParseSdkAttributes(m),
Yu Liuf01a0f02022-12-07 15:45:30 -0800373 Native_coverage: baseAttributes.Native_coverage,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500374 }
375
376 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
377 staticOrSharedAttributes: staticCommonAttrs,
378
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000379 Cppflags: compilerAttrs.cppFlags,
380 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400381 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000382
Liz Kammer1263d9b2021-12-10 14:28:20 -0500383 Export_includes: exportedIncludes.Includes,
384 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
385 Export_system_includes: exportedIncludes.SystemIncludes,
386 Local_includes: compilerAttrs.localIncludes,
387 Absolute_includes: compilerAttrs.absoluteIncludes,
388 Use_libcrt: linkerAttrs.useLibcrt,
389 Rtti: compilerAttrs.rtti,
390 Stl: compilerAttrs.stl,
391 Cpp_std: compilerAttrs.cppStd,
392 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500393
Cole Faust5fa4e962022-08-22 14:31:04 -0700394 Features: baseAttributes.features,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500395 }
396
397 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
398 staticOrSharedAttributes: sharedCommonAttrs,
399 Cppflags: compilerAttrs.cppFlags,
400 Conlyflags: compilerAttrs.conlyFlags,
401 Asflags: asFlags,
402
Liz Kammer1263d9b2021-12-10 14:28:20 -0500403 Export_includes: exportedIncludes.Includes,
404 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
405 Export_system_includes: exportedIncludes.SystemIncludes,
406 Local_includes: compilerAttrs.localIncludes,
407 Absolute_includes: compilerAttrs.absoluteIncludes,
408 Linkopts: linkerAttrs.linkopts,
409 Link_crt: linkerAttrs.linkCrt,
410 Use_libcrt: linkerAttrs.useLibcrt,
411 Rtti: compilerAttrs.rtti,
412 Stl: compilerAttrs.stl,
413 Cpp_std: compilerAttrs.cppStd,
414 C_std: compilerAttrs.cStd,
Yu Liua79c9462022-03-22 16:35:22 -0700415 Use_version_lib: linkerAttrs.useVersionLib,
Chris Parsons990c4f42021-05-25 12:10:58 -0400416
Liz Kammerd2871182021-10-04 13:54:37 -0400417 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000418
Yu Liu56ccb1a2022-11-12 10:47:07 -0800419 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
420 Features: baseAttributes.features,
421 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, m),
Vinh Tran99270ea2022-11-28 11:15:23 -0500422
423 Fdo_profile: compilerAttrs.fdoProfile,
Wei Li81852ca2022-07-27 00:22:06 -0700424 }
Jingwen Chen0ee88a62022-01-07 14:55:29 +0000425
Wei Li81852ca2022-07-27 00:22:06 -0700426 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
Yu Liu56ccb1a2022-11-12 10:47:07 -0800427 sharedTargetAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Jingwen Chen63930982021-03-24 10:04:33 -0400428 }
429
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -0500430 sharedTargetAttrs.Suffix = compilerAttrs.suffix
431
Yu Liu75be7b92022-02-01 09:54:09 -0800432 for axis, configToProps := range m.GetArchVariantProperties(ctx, &LibraryProperties{}) {
433 for config, props := range configToProps {
434 if props, ok := props.(*LibraryProperties); ok {
435 if props.Inject_bssl_hash != nil {
436 // This is an edge case applies only to libcrypto
Sam Delmericofae47f92022-08-08 13:35:08 -0400437 if m.Name() == "libcrypto" || m.Name() == "libcrypto_for_testing" {
Yu Liu75be7b92022-02-01 09:54:09 -0800438 sharedTargetAttrs.Inject_bssl_hash.SetSelectValue(axis, config, props.Inject_bssl_hash)
439 } else {
440 ctx.PropertyErrorf("inject_bssl_hash", "only applies to libcrypto")
441 }
442 }
443 }
444 }
445 }
446
Chris Parsons77acf2e2021-12-03 17:27:16 -0500447 staticProps := bazel.BazelTargetModuleProperties{
448 Rule_class: "cc_library_static",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500449 Bzl_load_location: "//build/bazel/rules/cc:cc_library_static.bzl",
Chris Parsons77acf2e2021-12-03 17:27:16 -0500450 }
451 sharedProps := bazel.BazelTargetModuleProperties{
452 Rule_class: "cc_library_shared",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500453 Bzl_load_location: "//build/bazel/rules/cc:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400454 }
455
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000456 tags := android.ApexAvailableTags(m)
Chris Parsons58852a02021-12-09 18:10:18 -0500457 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000458 android.CommonAttributes{
459 Name: m.Name() + "_bp2build_cc_library_static",
460 Tags: tags,
461 },
Chris Parsons58852a02021-12-09 18:10:18 -0500462 staticTargetAttrs, staticAttrs.Enabled)
463 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000464 android.CommonAttributes{
465 Name: m.Name(),
466 Tags: tags,
467 },
Chris Parsons58852a02021-12-09 18:10:18 -0500468 sharedTargetAttrs, sharedAttrs.Enabled)
Wei Li81852ca2022-07-27 00:22:06 -0700469
Trevor Radcliffe087af542022-09-16 15:36:10 +0000470 createStubsBazelTargetIfNeeded(ctx, m, compilerAttrs, exportedIncludes, baseAttributes)
471}
472
473func createStubsBazelTargetIfNeeded(ctx android.TopDownMutatorContext, m *Module, compilerAttrs compilerAttributes, exportedIncludes BazelIncludes, baseAttributes baseAttributes) {
Wei Li81852ca2022-07-27 00:22:06 -0700474 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
475 stubSuitesProps := bazel.BazelTargetModuleProperties{
476 Rule_class: "cc_stub_suite",
477 Bzl_load_location: "//build/bazel/rules/cc:cc_stub_library.bzl",
478 }
479 soname := m.Name() + ".so"
480 stubSuitesAttrs := &bazelCcStubSuiteAttributes{
481 Symbol_file: compilerAttrs.stubsSymbolFile,
482 Versions: compilerAttrs.stubsVersions,
483 Export_includes: exportedIncludes.Includes,
484 Soname: &soname,
485 Source_library: *bazel.MakeLabelAttribute(":" + m.Name()),
486 Deps: baseAttributes.deps,
487 }
488 ctx.CreateBazelTargetModule(stubSuitesProps,
489 android.CommonAttributes{Name: m.Name() + "_stub_libs"},
490 stubSuitesAttrs)
491 }
Jingwen Chen63930982021-03-24 10:04:33 -0400492}
493
Spandan Das4238c652022-09-09 01:38:47 +0000494func apiContributionBp2Build(ctx android.TopDownMutatorContext, module *Module) {
495 apiSurfaces := make([]string, 0)
496 apiHeaders := make([]string, 0)
497 // systemapi (non-null `stubs` property)
498 if module.HasStubsVariants() {
499 apiSurfaces = append(apiSurfaces, android.SystemApi.String())
500 apiIncludes := getSystemApiIncludes(ctx, module)
501 if !apiIncludes.isEmpty() {
502 createApiHeaderTarget(ctx, apiIncludes)
503 apiHeaders = append(apiHeaders, apiIncludes.name)
504 }
505 }
506 // vendorapi (non-null `llndk` property)
507 if module.HasLlndkStubs() {
508 apiSurfaces = append(apiSurfaces, android.VendorApi.String())
509 apiIncludes := getVendorApiIncludes(ctx, module)
510 if !apiIncludes.isEmpty() {
511 createApiHeaderTarget(ctx, apiIncludes)
512 apiHeaders = append(apiHeaders, apiIncludes.name)
513 }
514 }
515 // create a target only if this module contributes to an api surface
516 // TODO: Currently this does not distinguish systemapi-only headers and vendrorapi-only headers
517 // TODO: Update so that systemapi-only headers do not get exported to vendorapi (and vice-versa)
518 if len(apiSurfaces) > 0 {
519 props := bazel.BazelTargetModuleProperties{
520 Rule_class: "cc_api_contribution",
521 Bzl_load_location: "//build/bazel/rules/apis:cc_api_contribution.bzl",
522 }
523 attrs := &bazelCcApiContributionAttributes{
524 Library_name: module.Name(),
525 Api_surfaces: bazel.MakeStringListAttribute(apiSurfaces),
526 Api: apiLabelAttribute(ctx, module),
527 Hdrs: bazel.MakeLabelListAttribute(
528 bazel.MakeLabelListFromTargetNames(apiHeaders),
529 ),
530 }
531 ctx.CreateBazelTargetModule(
532 props,
533 android.CommonAttributes{
534 Name: android.ApiContributionTargetName(module.Name()),
535 SkipData: proptools.BoolPtr(true),
536 },
537 attrs,
538 )
539 }
540}
541
542// Native apis are versioned in a single .map.txt for all api surfaces
543// Pick any one of the .map.txt files
544func apiLabelAttribute(ctx android.TopDownMutatorContext, module *Module) bazel.LabelAttribute {
545 var apiFile *string
546 linker := module.linker.(*libraryDecorator)
547 if llndkApi := linker.Properties.Llndk.Symbol_file; llndkApi != nil {
548 apiFile = llndkApi
549 } else if systemApi := linker.Properties.Stubs.Symbol_file; systemApi != nil {
550 apiFile = systemApi
551 } else {
552 ctx.ModuleErrorf("API surface library does not have any API file")
553 }
554 apiLabel := android.BazelLabelForModuleSrcSingle(ctx, proptools.String(apiFile)).Label
555 return *bazel.MakeLabelAttribute(apiLabel)
556}
557
558// wrapper struct to flatten the arch and os specific export_include_dirs
559// flattening is necessary since we want to export apis of all arches even when we build for x86 (e.g.)
560type bazelCcApiLibraryHeadersAttributes struct {
561 bazelCcLibraryHeadersAttributes
562
563 Arch *string
564}
565
566func (a *bazelCcApiLibraryHeadersAttributes) isEmpty() bool {
567 return a.Export_includes.IsEmpty() &&
568 a.Export_system_includes.IsEmpty() &&
569 a.Deps.IsEmpty()
570}
571
572type apiIncludes struct {
573 name string // name of the Bazel target in the generated bp2build workspace
574 attrs bazelCcApiLibraryHeadersAttributes
575}
576
577func (includes *apiIncludes) isEmpty() bool {
578 return includes.attrs.isEmpty()
579}
580
581func (includes *apiIncludes) addDep(name string) {
582 l := bazel.Label{Label: ":" + name}
583 ll := bazel.MakeLabelList([]bazel.Label{l})
584 lla := bazel.MakeLabelListAttribute(ll)
585 includes.attrs.Deps.Append(lla)
586}
587
588func getSystemApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
589 flagProps := c.library.(*libraryDecorator).flagExporter.Properties
590 linkProps := c.library.(*libraryDecorator).baseLinker.Properties
591 includes := android.FirstUniqueStrings(flagProps.Export_include_dirs)
592 systemIncludes := android.FirstUniqueStrings(flagProps.Export_system_include_dirs)
593 headerLibs := android.FirstUniqueStrings(linkProps.Export_header_lib_headers)
594 attrs := bazelCcLibraryHeadersAttributes{
595 Export_includes: bazel.MakeStringListAttribute(includes),
596 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
597 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, headerLibs)),
598 }
599
600 return apiIncludes{
601 name: c.Name() + ".systemapi.headers",
602 attrs: bazelCcApiLibraryHeadersAttributes{
603 bazelCcLibraryHeadersAttributes: attrs,
604 },
605 }
606}
607
608func getVendorApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
609 baseProps := c.library.(*libraryDecorator).flagExporter.Properties
610 llndkProps := c.library.(*libraryDecorator).Properties.Llndk
611 includes := baseProps.Export_include_dirs
612 systemIncludes := baseProps.Export_system_include_dirs
613 // LLNDK can override the base includes
614 if llndkIncludes := llndkProps.Override_export_include_dirs; llndkIncludes != nil {
615 includes = llndkIncludes
616 }
617 if proptools.Bool(llndkProps.Export_headers_as_system) {
618 systemIncludes = append(systemIncludes, includes...)
619 includes = nil
620 }
621
622 attrs := bazelCcLibraryHeadersAttributes{
623 Export_includes: bazel.MakeStringListAttribute(includes),
624 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
625 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, llndkProps.Export_llndk_headers)),
626 }
627 return apiIncludes{
628 name: c.Name() + ".vendorapi.headers",
629 attrs: bazelCcApiLibraryHeadersAttributes{
630 bazelCcLibraryHeadersAttributes: attrs,
631 },
632 }
633}
634
Patrice Arruda83c89e02019-03-25 15:32:39 -0700635// cc_library creates both static and/or shared libraries for a device and/or
636// host. By default, a cc_library has a single variant that targets the device.
637// Specifying `host_supported: true` also creates a library that targets the
638// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700639func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800640 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000641 // Can be used as both a static and a shared library.
642 module.sdkMemberTypes = []android.SdkMemberType{
643 sharedLibrarySdkMemberType,
644 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000645 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000646 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400647 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400648 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700649 return module.Init()
650}
651
Patrice Arruda83c89e02019-03-25 15:32:39 -0700652// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700653func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800654 module, library := NewLibrary(android.HostAndDeviceSupported)
655 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000656 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400657 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400658 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700659 return module.Init()
660}
661
Patrice Arruda83c89e02019-03-25 15:32:39 -0700662// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700663func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800664 module, library := NewLibrary(android.HostAndDeviceSupported)
665 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000666 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400667 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000668 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700669 return module.Init()
670}
671
Patrice Arruda83c89e02019-03-25 15:32:39 -0700672// cc_library_host_static creates a static library that is linkable to a host
673// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700674func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800675 module, library := NewLibrary(android.HostSupported)
676 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000677 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000678 module.bazelable = true
679 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700680 return module.Init()
681}
682
Patrice Arruda83c89e02019-03-25 15:32:39 -0700683// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700684func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800685 module, library := NewLibrary(android.HostSupported)
686 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000687 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800688 module.bazelable = true
689 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700690 return module.Init()
691}
692
Chris Parsons3c27ca32020-11-20 12:42:07 -0500693// flagExporter is a separated portion of libraryDecorator pertaining to exported
694// include paths and flags. Keeping this dependency-related information separate
695// from the rest of library information is helpful in keeping data more structured
696// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700697type flagExporter struct {
698 Properties FlagExporterProperties
699
Chris Parsons3c27ca32020-11-20 12:42:07 -0500700 dirs android.Paths // Include directories to be included with -I
701 systemDirs android.Paths // System include directories to be included with -isystem
702 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900703 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900704 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700705}
706
Chris Parsons3c27ca32020-11-20 12:42:07 -0500707// exportedIncludes returns the effective include paths for this module and
708// any module that links against this module. This is obtained from
709// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700710func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900711 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800712 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700713 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900714 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
715 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
716 }
717 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700718}
719
Chris Parsons3c27ca32020-11-20 12:42:07 -0500720// exportIncludes registers the include directories and system include directories to be exported
721// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900722func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900723 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900724 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700725}
726
Chris Parsons3c27ca32020-11-20 12:42:07 -0500727// exportIncludesAsSystem registers the include directories and system include directories to be
728// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900729func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900730 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900731 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900732 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900733}
734
Chris Parsons3c27ca32020-11-20 12:42:07 -0500735// reexportDirs registers the given directories as include directories to be exported transitively
736// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900737func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900738 f.dirs = append(f.dirs, dirs...)
739}
740
Chris Parsons3c27ca32020-11-20 12:42:07 -0500741// reexportSystemDirs registers the given directories as system include directories
742// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900743func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900744 f.systemDirs = append(f.systemDirs, dirs...)
745}
746
Chris Parsons3c27ca32020-11-20 12:42:07 -0500747// reexportFlags registers the flags to be exported transitively to modules depending on this
748// module.
Inseob Kim69378442019-06-03 19:10:47 +0900749func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800750 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
751 panic(fmt.Errorf("Exporting invalid flag %q: "+
752 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900753 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700754 f.flags = append(f.flags, flags...)
755}
756
Inseob Kim69378442019-06-03 19:10:47 +0900757func (f *flagExporter) reexportDeps(deps ...android.Path) {
758 f.deps = append(f.deps, deps...)
759}
760
Inseob Kimd110f872019-12-06 13:15:38 +0900761// addExportedGeneratedHeaders does nothing but collects generated header files.
762// This can be differ to exportedDeps which may contain phony files to minimize ninja.
763func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
764 f.headers = append(f.headers, headers...)
765}
766
Colin Cross0de8a1e2020-09-18 14:15:30 -0700767func (f *flagExporter) setProvider(ctx android.ModuleContext) {
768 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400769 // Comes from Export_include_dirs property, and those of exported transitive deps
770 IncludeDirs: android.FirstUniquePaths(f.dirs),
771 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700772 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400773 // Used in very few places as a one-off way of adding extra defines.
774 Flags: f.flags,
775 // Used sparingly, for extra files that need to be explicitly exported to dependers,
776 // or for phony files to minimize ninja.
777 Deps: f.deps,
778 // For exported generated headers, such as exported aidl headers, proto headers, or
779 // sysprop headers.
780 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700781 })
Inseob Kim69378442019-06-03 19:10:47 +0900782}
783
Colin Crossb916a382016-07-29 17:28:03 -0700784// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
785// functionality: static vs. shared linkage, reusing object files for shared libraries
786type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800787 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700788 StaticProperties StaticProperties
789 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800790 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700791
792 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900793 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700794
Colin Cross26c34ed2016-09-30 17:10:16 -0700795 // table-of-contents file to optimize out relinking when possible
796 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700797
Colin Cross4d9c2d12016-07-29 12:48:20 -0700798 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400799 flagExporterInfo *FlagExporterInfo
800 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700801
Colin Cross4d9c2d12016-07-29 12:48:20 -0700802 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800803 objects Objects
804 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700805
806 // Uses the module's name if empty, but can be overridden. Does not include
807 // shlib suffix.
808 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700809
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800810 sabi *sabi
811
Dan Willemsen581341d2017-02-09 16:16:31 -0800812 // Output archive of gcno coverage information files
813 coverageOutputFile android.OptionalPath
814
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800815 // linked Source Abi Dump
816 sAbiOutputFile android.OptionalPath
817
818 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800819 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000820
Colin Cross0875c522017-11-28 17:34:01 -0800821 // Location of the static library in the sysroot. Empty if the library is
822 // not included in the NDK.
823 ndkSysrootPath android.Path
824
Colin Crossb60190a2018-09-04 16:28:17 -0700825 // Location of the linked, unstripped library for shared libraries
826 unstrippedOutputFile android.Path
827
Dan Willemsen569edc52018-11-19 09:33:29 -0800828 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000829 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800830
Colin Cross8e21aa52020-09-28 18:28:02 -0700831 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900832
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800833 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900834
Vic Yangefd249e2018-11-12 20:19:56 -0800835 // If useCoreVariant is true, the vendor variant of a VNDK library is
836 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800837 useCoreVariant bool
838 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800839
Colin Cross5ec407b2020-09-30 11:41:33 -0700840 skipAPIDefine bool
841
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100842 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700843 *baseCompiler
844 *baseLinker
845 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900846
847 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700848
849 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900850}
851
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400852type ccLibraryBazelHandler struct {
Chris Parsons808d84c2021-03-09 20:43:32 -0500853 module *Module
854}
855
Chris Parsons6ce2cf92022-05-20 10:54:17 -0400856var _ BazelHandler = (*ccLibraryBazelHandler)(nil)
857
Chris Parsons94a0bba2021-06-04 15:03:47 -0400858// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
859// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400860func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400861 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400862 if len(rootStaticArchives) != 1 {
863 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsonsf874e462022-05-10 13:50:12 -0400864 return
Chris Parsons944e7d02021-03-11 11:08:46 -0500865 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400866 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500867 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
868
Chris Parsons94a0bba2021-06-04 15:03:47 -0400869 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500870 objFiles := make(android.Paths, len(objPaths))
871 for i, objPath := range objPaths {
872 objFiles[i] = android.PathForBazelOut(ctx, objPath)
873 }
874 objects := Objects{
875 objFiles: objFiles,
876 }
877
878 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
879 StaticLibrary: outputFilePath,
880 ReuseObjects: objects,
881 Objects: objects,
882
Chris Parsons94a0bba2021-06-04 15:03:47 -0400883 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500884 // static libraries with deps.
885 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
886 Direct(outputFilePath).
887 Build(),
888 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400889
Chris Parsonsf874e462022-05-10 13:50:12 -0400890 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400891}
892
893// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
894// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400895func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400896 rootDynamicLibraries := ccInfo.RootDynamicLibraries
897
898 if len(rootDynamicLibraries) != 1 {
899 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
Chris Parsonsf874e462022-05-10 13:50:12 -0400900 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400901 }
902 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
903 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
904
Sasha Smundakedd16662022-10-07 14:44:50 -0700905 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = android.PathForBazelOut(ctx, ccInfo.UnstrippedOutput)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400906
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000907 var tocFile android.OptionalPath
908 if len(ccInfo.TocFile) > 0 {
909 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
910 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400911 handler.module.linker.(*libraryDecorator).tocFile = tocFile
912
Yu Liu24214aa2022-11-22 12:30:59 -0800913 if len(ccInfo.AbiDiffFiles) > 0 {
914 handler.module.linker.(*libraryDecorator).sAbiDiff = android.PathsForBazelOut(ctx, ccInfo.AbiDiffFiles)
915 }
916
Chris Parsons94a0bba2021-06-04 15:03:47 -0400917 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
918 TableOfContents: tocFile,
919 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000920 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400921 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000922 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400923 })
Chris Parsons94a0bba2021-06-04 15:03:47 -0400924}
925
Chris Parsonsf874e462022-05-10 13:50:12 -0400926func (handler *ccLibraryBazelHandler) QueueBazelCall(ctx android.BaseModuleContext, label string) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400927 bazelCtx := ctx.Config().BazelContext
Chris Parsonsf874e462022-05-10 13:50:12 -0400928 bazelCtx.QueueBazelRequest(label, cquery.GetCcInfo, android.GetConfigKey(ctx))
929}
930
931func (handler *ccLibraryBazelHandler) ProcessBazelQueryResponse(ctx android.ModuleContext, label string) {
932 bazelCtx := ctx.Config().BazelContext
933 ccInfo, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400934 if err != nil {
935 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
Chris Parsonsf874e462022-05-10 13:50:12 -0400936 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400937 }
938
939 if handler.module.static() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400940 handler.generateStaticBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400941 } else if handler.module.Shared() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400942 handler.generateSharedBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400943 } else {
Chris Parsonsf874e462022-05-10 13:50:12 -0400944 ctx.ModuleErrorf("Unhandled bazel case for %s (neither shared nor static!)", ctx.ModuleName())
Chris Parsons94a0bba2021-06-04 15:03:47 -0400945 }
946
947 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
948 handler.module.maybeUnhideFromMake()
949
Chris Parsonseefc9e62021-04-02 17:36:47 -0400950 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
951 // Dependencies on this library will expect collectedSnapshotHeaders to
952 // be set, otherwise validation will fail. For now, set this to an empty
953 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400954 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400955 // implementation.
956 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
957 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500958}
959
Chris Parsons94a0bba2021-06-04 15:03:47 -0400960func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
961 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
962 // flag exporters consolidates properties like includes, flags, dependencies that should be
963 // exported from this module to other modules
964 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
965 // Store flag info to be passed along to androidmk
966 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
967 library.flagExporterInfo = &flagExporterInfo
968}
969
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400970func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900971 ret := android.Paths{}
972
973 // Headers in the source tree should be globbed. On the contrast, generated headers
974 // can't be globbed, and they should be manually collected.
975 // So, we first filter out intermediate directories (which contains generated headers)
976 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400977 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900978 dir := path.String()
979 // Skip if dir is for generated headers
Spandan Das925cb2a2022-11-03 16:34:12 +0000980 if strings.HasPrefix(dir, ctx.Config().OutDir()) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900981 continue
982 }
Yu Liu1175c052022-08-15 10:21:31 -0700983
984 // Filter out the generated headers from bazel.
985 if strings.HasPrefix(dir, android.PathForBazelOut(ctx, "bazel-out").String()) {
986 continue
987 }
988
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900989 // libeigen wrongly exports the root directory "external/eigen". But only two
990 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
991 // some of them have no extension. So we need special treatment for libeigen in order
992 // to glob correctly.
993 if dir == "external/eigen" {
994 // Only these two directories contains exported headers.
995 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
Liz Kammer0ea79982022-02-07 08:51:47 -0500996 globDir := "external/eigen/" + subdir + "/**/*"
997 glob, err := ctx.GlobWithDeps(globDir, nil)
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900998 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500999 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001000 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +09001001 }
1002 for _, header := range glob {
1003 if strings.HasSuffix(header, "/") {
1004 continue
1005 }
1006 ext := filepath.Ext(header)
1007 if ext != "" && ext != ".h" {
1008 continue
1009 }
1010 ret = append(ret, android.PathForSource(ctx, header))
1011 }
1012 }
1013 continue
1014 }
Liz Kammer0ea79982022-02-07 08:51:47 -05001015 globDir := dir + "/**/*"
1016 glob, err := ctx.GlobWithDeps(globDir, nil)
Colin Crossec118d02021-01-22 18:05:59 +00001017 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -05001018 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001019 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001020 }
Colin Crossec118d02021-01-22 18:05:59 +00001021 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -07001022 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +00001023 if isLibcxx {
1024 // Glob all files under this special directory, because of C++ headers with no
1025 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -07001026 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001027 continue
1028 }
Colin Crossec118d02021-01-22 18:05:59 +00001029 } else {
1030 // Filter out only the files with extensions that are headers.
1031 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001032 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +00001033 if strings.HasSuffix(header, ext) {
1034 found = true
1035 break
1036 }
1037 }
1038 if !found {
1039 continue
1040 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001041 }
Jose Galmes0d736912021-03-30 11:00:06 -07001042 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001043 }
1044 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001045 return ret
1046}
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001047
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001048func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
1049 ret := android.Paths{}
1050 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001051 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
1052 if strings.HasSuffix(header.Base(), "-phony") {
1053 continue
1054 }
1055 ret = append(ret, header)
1056 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001057 return ret
1058}
1059
1060// collectHeadersForSnapshot collects all exported headers from library.
1061// It globs header files in the source tree for exported include directories,
1062// and tracks generated header files separately.
1063//
1064// This is to be called from GenerateAndroidBuildActions, and then collected
1065// header files can be retrieved by snapshotHeaders().
1066func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
1067 ret := android.Paths{}
1068
1069 // Headers in the source tree should be globbed. On the contrast, generated headers
1070 // can't be globbed, and they should be manually collected.
1071 // So, we first filter out intermediate directories (which contains generated headers)
1072 // from exported directories, and then glob headers under remaining directories.
1073 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
1074
1075 // Collect generated headers
1076 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001077
1078 l.collectedSnapshotHeaders = ret
1079}
1080
1081// This returns all exported header files, both generated ones and headers from source tree.
1082// collectHeadersForSnapshot() must be called before calling this.
1083func (l *libraryDecorator) snapshotHeaders() android.Paths {
1084 if l.collectedSnapshotHeaders == nil {
1085 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
1086 }
1087 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -07001088}
1089
Chris Parsons3c27ca32020-11-20 12:42:07 -05001090// linkerProps returns the list of properties structs relevant for this library. (For example, if
1091// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -07001092func (library *libraryDecorator) linkerProps() []interface{} {
1093 var props []interface{}
1094 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001095 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001096 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -08001097 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001098 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -07001099 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001100
1101 if library.MutatedProperties.BuildShared {
1102 props = append(props, &library.SharedProperties)
1103 }
1104 if library.MutatedProperties.BuildStatic {
1105 props = append(props, &library.StaticProperties)
1106 }
1107
1108 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -07001109}
1110
Chris Parsons3c27ca32020-11-20 12:42:07 -05001111// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
1112// library, or that are implied by attributes of this library (such as whether this library is a
1113// shared library).
Colin Crossb916a382016-07-29 17:28:03 -07001114func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -07001115 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001116
Colin Crossb916a382016-07-29 17:28:03 -07001117 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
1118 // all code is position independent, and then those warnings get promoted to
1119 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -07001120 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001121 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -07001122 }
1123
1124 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001125 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001126 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001127 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -07001128 }
1129
Colin Crossa48ab5b2017-02-14 15:28:44 -08001130 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001131 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001132 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -07001133 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001134 f = append(f,
1135 "-nostdlib",
1136 "-Wl,--gc-sections",
1137 )
1138 }
1139
1140 if ctx.Darwin() {
1141 f = append(f,
1142 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -07001143 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
1144 )
Colin Cross7863cf52016-10-20 10:47:21 -07001145 if ctx.Arch().ArchType == android.X86 {
1146 f = append(f,
1147 "-read_only_relocs suppress",
1148 )
1149 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001150 } else {
Josh Gao75a50a22019-06-07 17:58:59 -07001151 f = append(f, "-shared")
1152 if !ctx.Windows() {
1153 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
1154 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001155 }
1156
Colin Cross4af21ed2019-11-04 09:37:55 -08001157 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001158 }
1159
1160 return flags
1161}
1162
Chris Parsons3c27ca32020-11-20 12:42:07 -05001163// compilerFlags takes a Flags and augments it to contain compile flags from global values,
1164// per-target values, module type values, per-module Blueprints properties, extra flags from
1165// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -08001166func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001167 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001168 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -07001169 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -08001170 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
1171 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001172 }
1173
Jiyong Park7ed9de32018-10-15 22:25:07 +09001174 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -08001175 if ctx.IsLlndk() {
1176 // LLNDK libraries ignore most of the properties on the cc_library and use the
1177 // LLNDK-specific properties instead.
1178 // Wipe all the module-local properties, leaving only the global properties.
1179 flags.Local = LocalOrGlobalFlags{}
1180 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001181 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +09001182 // Remove -include <file> when compiling stubs. Otherwise, the force included
1183 // headers might cause conflicting types error with the symbols in the
1184 // generated stubs source code. e.g.
1185 // double acos(double); // in header
1186 // void acos() {} // in the generated source code
1187 removeInclude := func(flags []string) []string {
1188 ret := flags[:0]
1189 for _, f := range flags {
1190 if strings.HasPrefix(f, "-include ") {
1191 continue
1192 }
1193 ret = append(ret, f)
1194 }
1195 return ret
1196 }
Colin Cross4af21ed2019-11-04 09:37:55 -08001197 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
1198 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +09001199
Jiyong Park7ed9de32018-10-15 22:25:07 +09001200 flags = addStubLibraryCompilerFlags(flags)
1201 }
1202 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -07001203}
1204
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001205func (library *libraryDecorator) headerAbiCheckerEnabled() bool {
1206 return Bool(library.Properties.Header_abi_checker.Enabled)
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001207}
1208
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001209func (library *libraryDecorator) headerAbiCheckerExplicitlyDisabled() bool {
1210 return !BoolDefault(library.Properties.Header_abi_checker.Enabled, true)
Logan Chien41eabe62019-04-10 13:33:58 +08001211}
1212
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001213func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -08001214 if ctx.IsLlndk() {
1215 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
1216 vndkVer := ctx.Module().(*Module).VndkVersion()
1217 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
1218 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
1219 vndkVer = "current"
1220 }
1221 if library.stubsVersion() != "" {
1222 vndkVer = library.stubsVersion()
1223 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001224 nativeAbiResult := parseNativeAbiDefinition(ctx,
1225 String(library.Properties.Llndk.Symbol_file),
1226 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
1227 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -08001228 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001229 library.versionScriptPath = android.OptionalPathForPath(
1230 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -08001231 }
1232 return objs
1233 }
Colin Cross5271fea2021-04-27 13:06:04 -07001234 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -07001235 nativeAbiResult := parseNativeAbiDefinition(ctx,
1236 String(library.Properties.Vendor_public_library.Symbol_file),
1237 android.FutureApiLevel, "")
1238 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001239 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001240 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001241 }
1242 return objs
1243 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001244 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001245 symbolFile := String(library.Properties.Stubs.Symbol_file)
1246 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1247 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1248 return Objects{}
1249 }
Jiyong Park85cc35a2022-07-17 11:30:47 +09001250 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
1251 // systemapi, respectively. The former is for symbols defined in platform libraries
1252 // and the latter is for symbols defined in APEXes.
Spandan Das934c97d2023-01-18 23:54:13 +00001253 // A single library can contain either # apex or # systemapi, but not both.
1254 // The stub generator (ndkstubgen) is additive, so passing _both_ of these to it should be a no-op.
1255 // However, having this distinction helps guard accidental
1256 // promotion or demotion of API and also helps the API review process b/191371676
Jiyong Park85cc35a2022-07-17 11:30:47 +09001257 var flag string
1258 if ctx.Module().(android.ApexModule).NotInPlatform() {
1259 flag = "--apex"
1260 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +09001261 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +09001262 }
Jiyong Parkaa27c082022-09-26 21:16:09 +09001263 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
1264 // the stub so that it is mandated that all symbols are explicitly marked with
1265 // either apex or systemapi.
1266 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
1267 flag = flag + " --no-ndk"
1268 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001269 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +09001270 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -07001271 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1272 library.versionScriptPath = android.OptionalPathForPath(
1273 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001274
1275 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001276 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001277 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1278 }
1279
Jiyong Park7ed9de32018-10-15 22:25:07 +09001280 return objs
1281 }
1282
Colin Cross5950f382016-12-13 12:50:57 -08001283 if !library.buildShared() && !library.buildStatic() {
1284 if len(library.baseCompiler.Properties.Srcs) > 0 {
1285 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1286 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001287 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001288 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1289 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001290 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001291 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1292 }
1293 return Objects{}
1294 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001295 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001296 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001297 var SourceAbiFlags []string
1298 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001299 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001300 }
Inseob Kim69378442019-06-03 19:10:47 +09001301 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1302 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001303 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001304 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001305 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001306 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001307 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001308 flags.SAbiDump = true
1309 }
1310 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001311 objs := library.baseCompiler.compile(ctx, flags, deps)
1312 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001313 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001314
Colin Cross4d9c2d12016-07-29 12:48:20 -07001315 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001316 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001317 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1318 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001319 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001320 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001321 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001322 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001323 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1324 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001325 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001326 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001327 }
1328
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001329 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001330}
1331
1332type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001333 versionedInterface
1334
Colin Crossb916a382016-07-29 17:28:03 -07001335 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001336 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001337 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001338 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001339 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001340
1341 // Returns true if the build options for the module have selected a static or shared build
1342 buildStatic() bool
1343 buildShared() bool
1344
1345 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001346 setStatic()
1347 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001348
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001349 // Check whether header_abi_checker is enabled or explicitly disabled.
1350 headerAbiCheckerEnabled() bool
1351 headerAbiCheckerExplicitlyDisabled() bool
1352
Logan Chien41eabe62019-04-10 13:33:58 +08001353 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1354 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001355
1356 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001357
1358 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001359
1360 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001361}
1362
Colin Crossc88c2722020-09-28 17:32:47 -07001363type versionedInterface interface {
1364 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001365 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001366 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +00001367 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001368 setStubsVersion(string)
1369 stubsVersion() string
1370
Colin Cross3572cf72020-10-01 15:58:11 -07001371 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001372 setAllStubsVersions([]string)
1373 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001374
1375 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001376 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001377 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001378 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001379}
1380
1381var _ libraryInterface = (*libraryDecorator)(nil)
1382var _ versionedInterface = (*libraryDecorator)(nil)
1383
Justin Yun6977e8a2020-10-29 18:24:11 +09001384func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001385 name := library.libName
1386 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001387 name = String(library.Properties.Stem)
1388 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001389 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001390 }
Colin Crossb916a382016-07-29 17:28:03 -07001391 }
1392
Colin Cross0fd6a412019-08-16 14:22:10 -07001393 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001394 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001395 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001396 } else if inProduct {
1397 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001398 }
1399 if suffix == "" {
1400 suffix = String(library.Properties.Suffix)
1401 }
1402
Jooyung Han0302a842019-10-30 18:43:49 +09001403 return name + suffix
1404}
1405
Chris Parsons3c27ca32020-11-20 12:42:07 -05001406// getLibName returns the actual canonical name of the library (the name which
1407// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001408func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001409 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001410
Ivan Lozanof9e21722020-12-02 09:00:51 -05001411 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001412 // vndk-ext lib should have the same name with original lib
1413 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1414 originalName := module.(*Module).outputFile.Path()
1415 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1416 })
Logan Chienf3511742017-10-31 18:04:35 +08001417 }
1418
Colin Crossb916a382016-07-29 17:28:03 -07001419 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1420 if !strings.HasSuffix(name, "-host") {
1421 name = name + "-host"
1422 }
1423 }
1424
Inseob Kim0ce291e2019-07-04 14:38:27 +09001425 return name
Colin Crossb916a382016-07-29 17:28:03 -07001426}
1427
Jiyong Parkda732bd2018-11-02 18:23:15 +09001428var versioningMacroNamesListMutex sync.Mutex
1429
Colin Crossb916a382016-07-29 17:28:03 -07001430func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1431 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001432 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001433 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001434 }
1435 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001436 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001437 // Let baseLinker know whether this variant is for stubs or not, so that
1438 // it can omit things that are not required for linking stubs.
1439 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001440
1441 if library.buildStubs() {
1442 macroNames := versioningMacroNamesList(ctx.Config())
1443 myName := versioningMacroName(ctx.ModuleName())
1444 versioningMacroNamesListMutex.Lock()
1445 defer versioningMacroNamesListMutex.Unlock()
1446 if (*macroNames)[myName] == "" {
1447 (*macroNames)[myName] = ctx.ModuleName()
1448 } else if (*macroNames)[myName] != ctx.ModuleName() {
1449 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1450 }
1451 }
Colin Crossb916a382016-07-29 17:28:03 -07001452}
1453
dimitry0345ad82018-12-05 16:28:14 +01001454func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001455 if ctx.IsLlndk() {
1456 // LLNDK libraries ignore most of the properties on the cc_library and use the
1457 // LLNDK-specific properties instead.
1458 return deps
1459 }
1460
dimitry0345ad82018-12-05 16:28:14 +01001461 deps = library.baseCompiler.compilerDeps(ctx, deps)
1462
dimitry0345ad82018-12-05 16:28:14 +01001463 return deps
1464}
1465
Colin Cross37047f12016-12-13 17:06:13 -08001466func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001467 if ctx.IsLlndk() {
1468 // LLNDK libraries ignore most of the properties on the cc_library and use the
1469 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001470 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1471 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001472 return deps
1473 }
Colin Cross5271fea2021-04-27 13:06:04 -07001474 if ctx.IsVendorPublicLibrary() {
1475 headers := library.Properties.Vendor_public_library.Export_public_headers
1476 deps.HeaderLibs = append([]string(nil), headers...)
1477 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1478 return deps
1479 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001480
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001481 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001482 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001483 if library.StaticProperties.Static.System_shared_libs != nil {
1484 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001485 }
1486 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001487 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001488 if library.SharedProperties.Shared.System_shared_libs != nil {
1489 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001490 }
1491 }
1492
Colin Crossb916a382016-07-29 17:28:03 -07001493 deps = library.baseLinker.linkerDeps(ctx, deps)
1494
1495 if library.static() {
1496 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001497 library.StaticProperties.Static.Whole_static_libs...)
1498 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1499 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001500
Colin Crosse1bb5d02019-09-24 14:55:04 -07001501 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1502 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001503 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001504 if !Bool(library.baseLinker.Properties.Nocrt) {
1505 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1506 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001507 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001508 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1509 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1510 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001511
Colin Crosse1bb5d02019-09-24 14:55:04 -07001512 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1513 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001514 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001515 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001516 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1517 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1518 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001519 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1520 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001521 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001522 if ctx.inProduct() {
1523 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1524 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1525 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1526 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1527 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1528 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001529 if ctx.inRecovery() {
1530 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1531 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1532 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001533 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1534 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001535 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001536 if ctx.inRamdisk() {
1537 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1538 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1539 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1540 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1541 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1542 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001543 if ctx.inVendorRamdisk() {
1544 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1545 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1546 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1547 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1548 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1549 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001550
Colin Cross4d9c2d12016-07-29 12:48:20 -07001551 return deps
1552}
1553
Paul Duffin13f02712020-03-06 12:30:43 +00001554func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1555 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1556 var properties StaticOrSharedProperties
1557 if library.static() {
1558 properties = library.StaticProperties.Static
1559 } else if library.shared() {
1560 properties = library.SharedProperties.Shared
1561 }
1562
1563 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001564
1565 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1566 // either input list doesn't come out as nil.
1567 if specifiedDeps.systemSharedLibs == nil {
1568 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1569 } else {
1570 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1571 }
Paul Duffin13f02712020-03-06 12:30:43 +00001572
1573 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001574 if len(specifiedDeps.systemSharedLibs) > 0 {
1575 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1576 // retained.
1577 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1578 }
Paul Duffin13f02712020-03-06 12:30:43 +00001579 return specifiedDeps
1580}
1581
Colin Crossb916a382016-07-29 17:28:03 -07001582func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001583 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001584
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001585 library.objects = deps.WholeStaticLibObjs.Copy()
1586 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001587 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001588
Inseob Kim0ce291e2019-07-04 14:38:27 +09001589 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001590 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001591 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001592
Dan Willemsen569edc52018-11-19 09:33:29 -08001593 if Bool(library.baseLinker.Properties.Use_version_lib) {
1594 if ctx.Host() {
1595 versionedOutputFile := outputFile
1596 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1597 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1598 } else {
1599 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001600 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001601 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1602 }
Colin Cross86803cf2018-02-15 14:12:26 -08001603 }
1604
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001605 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001606
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001607 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001608
Colin Cross4d9c2d12016-07-29 12:48:20 -07001609 ctx.CheckbuildFile(outputFile)
1610
Colin Cross649d8172020-12-10 12:30:21 -08001611 if library.static() {
1612 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001613 StaticLibrary: outputFile,
1614 ReuseObjects: library.reuseObjects,
1615 Objects: library.objects,
1616 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001617
Colin Cross649d8172020-12-10 12:30:21 -08001618 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1619 Direct(outputFile).
1620 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1621 Build(),
1622 })
1623 }
1624
1625 if library.header() {
1626 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1627 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001628
Colin Cross4d9c2d12016-07-29 12:48:20 -07001629 return outputFile
1630}
1631
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001632func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1633 if ctx.Module().(*Module).IsSdkVariant() {
1634 // The NDK sysroot timestamp file depends on all the NDK
1635 // sysroot header and shared library files.
1636 return android.Paths{getNdkBaseTimestampFile(ctx)}
1637 }
1638 return nil
1639}
1640
Colin Crossb916a382016-07-29 17:28:03 -07001641func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001642 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001643
1644 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001645 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001646 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001647
Colin Cross2383f3b2018-02-06 14:40:13 -08001648 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1649 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1650 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001651 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001652 if unexportedSymbols.Valid() {
1653 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1654 }
1655 if forceNotWeakSymbols.Valid() {
1656 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1657 }
1658 if forceWeakSymbols.Valid() {
1659 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1660 }
1661 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001662 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001663 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001664 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1665 }
1666 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001667 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001668 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1669 }
1670 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001671 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001672 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1673 }
1674 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001675 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001676 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001677 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001678 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001679 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001680
1681 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1682 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001683 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001684
Josh Gao75a50a22019-06-07 17:58:59 -07001685 var implicitOutputs android.WritablePaths
1686 if ctx.Windows() {
1687 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1688
Colin Cross4af21ed2019-11-04 09:37:55 -08001689 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001690 implicitOutputs = append(implicitOutputs, importLibraryPath)
1691 }
1692
Colin Cross4d9c2d12016-07-29 12:48:20 -07001693 builderFlags := flagsToBuilderFlags(flags)
1694
Dan Willemsen47450072021-10-19 20:24:49 -07001695 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1696 fatOutputFile := outputFile
1697 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1698 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1699 }
1700
Colin Crossb496cfd2018-09-10 16:50:05 -07001701 // Optimize out relinking against shared libraries whose interface hasn't changed by
1702 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001703 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001704 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001705 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001706
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001707 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001708 needsStrip := library.stripper.NeedsStrip(ctx)
1709 if library.buildStubs() {
1710 // No need to strip stubs libraries
1711 needsStrip = false
1712 }
1713 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001714 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001715 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001716 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001717 strippedOutputFile := outputFile
1718 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001719 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001720 }
Colin Crossb60190a2018-09-04 16:28:17 -07001721 library.unstrippedOutputFile = outputFile
1722
Colin Crossd7227f92019-09-05 14:26:33 -07001723 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001724
Dan Willemsen569edc52018-11-19 09:33:29 -08001725 if Bool(library.baseLinker.Properties.Use_version_lib) {
1726 if ctx.Host() {
1727 versionedOutputFile := outputFile
1728 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1729 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1730 } else {
1731 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001732 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001733
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001734 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001735 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001736 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001737 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001738 }
1739
1740 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1741 }
Colin Cross86803cf2018-02-15 14:12:26 -08001742 }
1743
Jiyong Park64a44f22019-01-18 14:37:08 +09001744 sharedLibs := deps.EarlySharedLibs
1745 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001746 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1747
Jiyong Park64a44f22019-01-18 14:37:08 +09001748 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001749 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1750 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001751 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001752 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001753 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001754
Dan Willemsen581341d2017-02-09 16:16:31 -08001755 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1756 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001757 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1758 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1759
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001760 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001761 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001762
Liz Kammeref6dfea2021-06-08 15:37:09 -04001763 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001764 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1765 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001766 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001767 }
1768
1769 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001770 TableOfContents: android.OptionalPathForPath(tocFile),
1771 SharedLibrary: unstrippedOutputFile,
1772 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1773 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001774 })
1775
1776 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1777 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001778 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001779 for _, stub := range stubs {
1780 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1781 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001782 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001783 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001784 SharedLibraryInfo: stubInfo,
1785 FlagExporterInfo: flagInfo,
1786 })
1787 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001788 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1789 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001790
Colin Cross127bb8b2020-12-16 16:46:01 -08001791 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001792 })
1793 }
1794
1795 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001796}
1797
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001798func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1799 return library.unstrippedOutputFile
1800}
1801
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001802func (library *libraryDecorator) disableStripping() {
1803 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1804}
1805
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001806func (library *libraryDecorator) nativeCoverage() bool {
1807 if library.header() || library.buildStubs() {
1808 return false
1809 }
1810 return true
1811}
1812
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001813func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1814 return library.coverageOutputFile
1815}
1816
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001817func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1818 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001819
1820 currentArchType := ctx.Arch().ArchType
1821 primaryArchType := ctx.Config().DevicePrimaryArchType()
1822 archName := currentArchType.String()
1823 if currentArchType != primaryArchType {
1824 archName += "_" + primaryArchType.String()
1825 }
1826
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001827 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001828 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001829}
1830
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001831func getRefAbiDumpDir(isNdk, isVndk bool) string {
1832 var dirName string
1833 if isNdk {
1834 dirName = "ndk"
1835 } else if isVndk {
1836 dirName = "vndk"
1837 } else {
1838 dirName = "platform"
1839 }
1840 return filepath.Join("prebuilts", "abi-dumps", dirName)
1841}
Logan Chien7eefdc42018-07-11 18:10:41 +08001842
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001843func prevRefAbiDumpVersion(ctx ModuleContext, dumpDir string) int {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001844 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
1845 sdkVersionStr := ctx.Config().PlatformSdkVersion().String()
1846
1847 if ctx.Config().PlatformSdkFinal() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001848 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001849 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001850 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1851 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1852 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001853 versionedDumpDir := android.ExistentPathForSource(ctx, dumpDir, sdkVersionStr)
1854 if versionedDumpDir.Valid() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001855 return sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001856 } else {
Mu-Le Lee13043932022-08-27 08:55:25 +00001857 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001858 }
1859 }
1860}
1861
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001862func currRefAbiDumpVersion(ctx ModuleContext, isVndk bool) string {
1863 if isVndk {
1864 // Each version of VNDK is independent, so follow the VNDK version which is the codename or PLATFORM_SDK_VERSION.
1865 return ctx.Module().(*Module).VndkVersion()
1866 } else if ctx.Config().PlatformSdkFinal() {
1867 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1868 // so choose PLATFORM_SDK_VERSION as the current version.
1869 return ctx.Config().PlatformSdkVersion().String()
1870 } else {
1871 return "current"
1872 }
1873}
1874
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001875// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
1876func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1877 baseName, nameExt string, isLlndkOrNdk, allowExtensions bool,
1878 sourceVersion, errorMessage string) {
1879
1880 sourceDump := library.sAbiOutputFile.Path()
1881
1882 extraFlags := []string{"-target-version", sourceVersion}
1883 if Bool(library.Properties.Header_abi_checker.Check_all_apis) {
1884 extraFlags = append(extraFlags, "-check-all-apis")
1885 } else {
1886 extraFlags = append(extraFlags,
1887 "-allow-unreferenced-changes",
1888 "-allow-unreferenced-elf-symbol-changes")
1889 }
1890 if isLlndkOrNdk {
1891 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1892 }
1893 if allowExtensions {
1894 extraFlags = append(extraFlags, "-allow-extensions")
1895 }
1896 extraFlags = append(extraFlags, library.Properties.Header_abi_checker.Diff_flags...)
1897
1898 library.sAbiDiff = append(
1899 library.sAbiDiff,
1900 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1901 baseName, nameExt, extraFlags, errorMessage))
1902}
1903
1904func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1905 baseName string, isLlndkOrNdk bool, sourceVersion, prevVersion string) {
1906
1907 errorMessage := "error: Please follow https://android.googlesource.com/platform/development/+/master/vndk/tools/header-checker/README.md#configure-cross_version-abi-check to resolve the ABI difference between your source code and version " + prevVersion + "."
1908
1909 library.sourceAbiDiff(ctx, referenceDump, baseName, prevVersion,
1910 isLlndkOrNdk, /* allowExtensions */ true, sourceVersion, errorMessage)
1911}
1912
1913func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1914 baseName string, isLlndkOrNdk, allowExtensions bool) {
1915
1916 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1917 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName
1918
1919 library.sourceAbiDiff(ctx, referenceDump, baseName, /* nameExt */ "",
1920 isLlndkOrNdk, allowExtensions, "current", errorMessage)
1921}
1922
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001923func (library *libraryDecorator) optInAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1924 baseName, nameExt string, isLlndkOrNdk bool, refDumpDir string) {
1925
1926 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1927 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName + " -ref-dump-dir $$ANDROID_BUILD_TOP/" + refDumpDir
1928
1929 library.sourceAbiDiff(ctx, referenceDump, baseName, nameExt,
1930 isLlndkOrNdk, /* allowExtensions */ false, "current", errorMessage)
1931}
1932
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001933func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001934 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001935 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001936 var SourceAbiFlags []string
1937 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001938 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1939 }
Inseob Kim69378442019-06-03 19:10:47 +09001940 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1941 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001942 }
1943 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001944 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001945 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001946 library.Properties.Header_abi_checker.Exclude_symbol_versions,
1947 library.Properties.Header_abi_checker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001948
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001949 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001950
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001951 // The logic must be consistent with classifySourceAbiDump.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001952 isVndk := ctx.useVndk() && ctx.isVndk()
Hsin-Yi Chen7584bda2022-11-08 22:51:02 +08001953 isNdk := ctx.isNdk(ctx.Config())
1954 isLlndk := ctx.isImplementationForLLNDKPublic()
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001955 dumpDir := getRefAbiDumpDir(isNdk, isVndk)
1956 binderBitness := ctx.DeviceConfig().BinderBitness()
Mu-Le Lee13043932022-08-27 08:55:25 +00001957 // If NDK or PLATFORM library, check against previous version ABI.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001958 if !isVndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001959 prevVersionInt := prevRefAbiDumpVersion(ctx, dumpDir)
1960 prevVersion := strconv.Itoa(prevVersionInt)
1961 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1962 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001963 if prevDumpFile.Valid() {
1964 library.crossVersionAbiDiff(ctx, prevDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001965 fileName, isLlndk || isNdk,
1966 strconv.Itoa(prevVersionInt+1), prevVersion)
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001967 }
1968 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001969 // Check against the current version.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001970 currVersion := currRefAbiDumpVersion(ctx, isVndk)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001971 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1972 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001973 if currDumpFile.Valid() {
1974 library.sameVersionAbiDiff(ctx, currDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001975 fileName, isLlndk || isNdk, ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001976 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001977 // Check against the opt-in reference dumps.
1978 for i, optInDumpDir := range library.Properties.Header_abi_checker.Ref_dump_dirs {
1979 optInDumpDirPath := android.PathForModuleSrc(ctx, optInDumpDir)
1980 // Ref_dump_dirs are not versioned.
1981 // They do not contain subdir for binder bitness because 64-bit binder has been mandatory.
1982 optInDumpFile := getRefAbiDumpFile(ctx, optInDumpDirPath.String(), fileName)
1983 if !optInDumpFile.Valid() {
1984 continue
1985 }
1986 library.optInAbiDiff(ctx, optInDumpFile.Path(),
1987 fileName, "opt"+strconv.Itoa(i), isLlndk || isNdk,
1988 optInDumpDirPath.String())
1989 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001990 }
1991}
1992
Inseob Kimcc12d902021-05-14 20:15:55 +09001993func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001994 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1995 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1996
Colin Cross127bb8b2020-12-16 16:46:01 -08001997 for _, header := range srcFiles {
1998 headerDir := filepath.Dir(header.String())
1999 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
2000 if err != nil {
2001 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
2002 srcDir.String(), headerDir, err)
2003 continue
2004 }
2005
2006 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
2007 }
2008
Inseob Kimcc12d902021-05-14 20:15:55 +09002009 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08002010}
2011
Chris Parsons3c27ca32020-11-20 12:42:07 -05002012// link registers actions to link this library, and sets various fields
2013// on this library to reflect information that should be exported up the build
2014// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07002015func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002016 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002017
Colin Cross127bb8b2020-12-16 16:46:01 -08002018 if ctx.IsLlndk() {
2019 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
2020 // This is the vendor variant of an LLNDK library with preprocessed headers.
2021 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
2022
2023 var timestampFiles android.Paths
2024 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09002025 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
2026 timestampFiles = append(timestampFiles, timestampFile)
2027 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08002028 }
2029
2030 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2031 library.reexportSystemDirs(genHeaderOutDir)
2032 } else {
2033 library.reexportDirs(genHeaderOutDir)
2034 }
2035
2036 library.reexportDeps(timestampFiles...)
2037 }
2038
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002039 // override the module's export_include_dirs with llndk.override_export_include_dirs
2040 // if it is set.
2041 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
2042 library.flagExporter.Properties.Export_include_dirs = override
2043 }
2044
Colin Cross127bb8b2020-12-16 16:46:01 -08002045 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2046 library.flagExporter.Properties.Export_system_include_dirs = append(
2047 library.flagExporter.Properties.Export_system_include_dirs,
2048 library.flagExporter.Properties.Export_include_dirs...)
2049 library.flagExporter.Properties.Export_include_dirs = nil
2050 }
2051 }
2052
Colin Cross5271fea2021-04-27 13:06:04 -07002053 if ctx.IsVendorPublicLibrary() {
2054 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
2055 // if it is set.
2056 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
2057 library.flagExporter.Properties.Export_include_dirs = override
2058 }
2059 }
2060
Chris Parsons3c27ca32020-11-20 12:42:07 -05002061 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
2062 // of this library), together with `objs` (.o files created by compiling this
2063 // library).
Colin Crossad59e752017-11-16 14:29:11 -08002064 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002065 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08002066 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002067 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002068 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002069 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002070 }
2071
Chris Parsons3c27ca32020-11-20 12:42:07 -05002072 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09002073 library.exportIncludes(ctx)
2074 library.reexportDirs(deps.ReexportedDirs...)
2075 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
2076 library.reexportFlags(deps.ReexportedFlags...)
2077 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09002078 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002079
Chris Parsons3c27ca32020-11-20 12:42:07 -05002080 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002081 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002082 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09002083 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09002084 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09002085
Paul Duffin33056e82021-02-19 13:49:08 +00002086 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
2087 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07002088 }
2089 }
2090
Chris Parsons3c27ca32020-11-20 12:42:07 -05002091 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002092 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002093 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09002094 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07002095 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09002096 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07002097 }
Jiyong Park74955042019-10-22 20:19:51 +09002098 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09002099 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09002100
Paul Duffin33056e82021-02-19 13:49:08 +00002101 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
2102 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07002103 }
2104 }
2105
Inseob Kim07def122020-11-23 14:43:02 +09002106 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09002107 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09002108 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002109 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09002110 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
2111
Inseob Kim07def122020-11-23 14:43:02 +09002112 // If the owner is different from the user, expose public header. That is,
2113 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09002114 // 2) if the owner is platform and the client is vendor
2115 // We don't care Platform -> Vendor dependency as it's already forbidden.
2116 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09002117 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002118 }
2119 }
2120
Paul Duffin37e0de52021-02-19 17:05:39 +00002121 // Make sure to only export headers which are within the include directory.
2122 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
2123 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
2124 return isRel
2125 })
2126
Chris Parsons3c27ca32020-11-20 12:42:07 -05002127 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09002128 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00002129 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00002130 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09002131 }
2132
Chris Parsons3c27ca32020-11-20 12:42:07 -05002133 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09002134 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002135
Chris Parsons3c27ca32020-11-20 12:42:07 -05002136 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002137 library.flagExporter.setProvider(ctx)
2138
Colin Cross4d9c2d12016-07-29 12:48:20 -07002139 return out
2140}
2141
Jiyong Park892a98f2020-12-14 09:20:00 +09002142func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002143 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09002144 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09002145 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
2146 if err != nil {
2147 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
2148 }
2149 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09002150 }
2151}
2152
Chris Parsons3c27ca32020-11-20 12:42:07 -05002153// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07002154func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002155 return library.MutatedProperties.BuildStatic &&
2156 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002157}
2158
Chris Parsons3c27ca32020-11-20 12:42:07 -05002159// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07002160func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002161 return library.MutatedProperties.BuildShared &&
2162 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002163}
2164
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002165func (library *libraryDecorator) objs() Objects {
2166 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002167}
2168
Colin Cross0de8a1e2020-09-18 14:15:30 -07002169func (library *libraryDecorator) reuseObjs() Objects {
2170 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002171}
2172
Colin Cross26c34ed2016-09-30 17:10:16 -07002173func (library *libraryDecorator) toc() android.OptionalPath {
2174 return library.tocFile
2175}
2176
Jiyong Parkf1194352019-02-25 11:05:47 +09002177func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
2178 dir := library.baseInstaller.installDir(ctx)
2179 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
2180 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
2181 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002182 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09002183}
2184
Colin Crossb916a382016-07-29 17:28:03 -07002185func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07002186 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09002187 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09002188 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05002189 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002190 if ctx.isVndkSp() {
2191 library.baseInstaller.subDir = "vndk-sp"
2192 } else {
2193 library.baseInstaller.subDir = "vndk"
2194 }
2195 }
2196
Justin Yun31094b12020-12-24 16:11:23 +09002197 // In some cases we want to use core variant for VNDK-Core libs.
2198 // Skip product variant since VNDKs use only the vendor variant.
2199 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08002200 mayUseCoreVariant := true
2201
2202 if ctx.mustUseVendorVariant() {
2203 mayUseCoreVariant = false
2204 }
2205
Elvis Chien9c993542021-06-25 01:15:17 +08002206 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08002207 mayUseCoreVariant = false
2208 }
2209
2210 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08002211 library.checkSameCoreVariant = true
2212 if ctx.DeviceConfig().VndkUseCoreVariant() {
2213 library.useCoreVariant = true
2214 }
Vic Yangefd249e2018-11-12 20:19:56 -08002215 }
Justin Yun8fe12122017-12-07 17:18:15 +09002216 }
Logan Chienf3511742017-10-31 18:04:35 +08002217
Jooyung Han261e1582020-10-20 18:54:21 +09002218 // do not install vndk libs
2219 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05002220 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002221 return
Justin Yun8effde42017-06-23 19:24:43 +09002222 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002223 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09002224 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
2225 // The original path becomes a symlink to the corresponding file in the
2226 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07002227 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07002228 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002229 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01002230 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09002231 library.installSymlinkToRuntimeApex(ctx, file)
2232 }
Jiyong Park429660f2019-01-16 22:31:11 +09002233 library.baseInstaller.subDir = "bootstrap"
2234 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002235 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002236 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002237 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09002238 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002239
Colin Cross4d9c2d12016-07-29 12:48:20 -07002240 library.baseInstaller.install(ctx, file)
2241 }
Dan Albertf563d252017-10-13 00:29:00 -07002242
Dan Albert281f22b2017-12-13 15:03:47 -08002243 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002244 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09002245 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08002246 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07002247 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07002248 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07002249
2250 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
2251 Rule: android.Cp,
2252 Description: "install " + installPath.Base(),
2253 Output: installPath,
2254 Input: file,
2255 })
2256
Colin Cross0875c522017-11-28 17:34:01 -08002257 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07002258 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002259}
2260
Paul Duffin0cb37b92020-03-04 14:52:46 +00002261func (library *libraryDecorator) everInstallable() bool {
2262 // Only shared and static libraries are installed. Header libraries (which are
2263 // neither static or shared) are not installed.
2264 return library.shared() || library.static()
2265}
2266
Chris Parsons3c27ca32020-11-20 12:42:07 -05002267// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07002268func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002269 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07002270}
2271
Chris Parsons3c27ca32020-11-20 12:42:07 -05002272// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002273func (library *libraryDecorator) shared() bool {
2274 return library.MutatedProperties.VariantIsShared
2275}
2276
Chris Parsons3c27ca32020-11-20 12:42:07 -05002277// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002278func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002279 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002280 return !library.static() && !library.shared()
2281}
2282
Chris Parsons3c27ca32020-11-20 12:42:07 -05002283// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002284func (library *libraryDecorator) setStatic() {
2285 library.MutatedProperties.VariantIsStatic = true
2286 library.MutatedProperties.VariantIsShared = false
2287}
2288
Chris Parsons3c27ca32020-11-20 12:42:07 -05002289// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002290func (library *libraryDecorator) setShared() {
2291 library.MutatedProperties.VariantIsStatic = false
2292 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07002293}
2294
Chris Parsons3c27ca32020-11-20 12:42:07 -05002295// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08002296func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002297 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08002298}
2299
Chris Parsons3c27ca32020-11-20 12:42:07 -05002300// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08002301func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002302 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08002303}
2304
Chris Parsons3c27ca32020-11-20 12:42:07 -05002305// HeaderOnly disables building this library as a shared or static library;
2306// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08002307func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002308 library.MutatedProperties.BuildShared = false
2309 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08002310}
2311
Colin Cross127bb8b2020-12-16 16:46:01 -08002312// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
2313func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07002314 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002315}
2316
Colin Cross203b4212021-04-26 17:19:41 -07002317// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07002318func (library *libraryDecorator) hasLLNDKHeaders() bool {
2319 return Bool(library.Properties.Llndk.Llndk_headers)
2320}
2321
Colin Cross5271fea2021-04-27 13:06:04 -07002322// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
2323// vendor public library stubs.
2324func (library *libraryDecorator) hasVendorPublicLibrary() bool {
2325 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
2326}
2327
Colin Cross0477b422020-10-13 18:43:54 -07002328func (library *libraryDecorator) implementationModuleName(name string) string {
2329 return name
2330}
2331
Jiyong Park7ed9de32018-10-15 22:25:07 +09002332func (library *libraryDecorator) buildStubs() bool {
2333 return library.MutatedProperties.BuildStubs
2334}
2335
Jiyong Parka034b832019-08-27 14:02:19 +09002336func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
2337 if library.Properties.Header_abi_checker.Symbol_file != nil {
2338 return library.Properties.Header_abi_checker.Symbol_file
2339 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002340 if ctx.Module().(*Module).IsLlndk() {
2341 return library.Properties.Llndk.Symbol_file
2342 }
Colin Cross31076b32020-10-23 17:22:06 -07002343 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09002344 return library.Properties.Stubs.Symbol_file
2345 }
2346 return nil
2347}
2348
Colin Crossc88c2722020-09-28 17:32:47 -07002349func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002350 // Just having stubs.symbol_file is enough to create a stub variant. In that case
2351 // the stub for the future API level is created.
2352 return library.Properties.Stubs.Symbol_file != nil ||
2353 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07002354}
2355
Alan Stokes73feba32022-11-14 12:21:24 +00002356func (library *libraryDecorator) isStubsImplementationRequired() bool {
2357 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
2358}
2359
Colin Cross3572cf72020-10-01 15:58:11 -07002360func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002361 if !library.hasStubsVariants() {
2362 return nil
2363 }
2364
Colin Crossc1b36442021-05-06 13:42:48 -07002365 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
2366 // LLNDK libraries only need a single stubs variant.
2367 return []string{android.FutureApiLevel.String()}
2368 }
2369
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002370 // Future API level is implicitly added if there isn't
2371 vers := library.Properties.Stubs.Versions
2372 if inList(android.FutureApiLevel.String(), vers) {
2373 return vers
2374 }
2375 // In some cases, people use the raw value "10000" in the versions property.
2376 // We shouldn't add the future API level in that case, otherwise there will
2377 // be two identical versions.
2378 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2379 return vers
2380 }
2381 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002382}
2383
2384func (library *libraryDecorator) setStubsVersion(version string) {
2385 library.MutatedProperties.StubsVersion = version
2386}
2387
Jiyong Park7ed9de32018-10-15 22:25:07 +09002388func (library *libraryDecorator) stubsVersion() string {
2389 return library.MutatedProperties.StubsVersion
2390}
2391
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002392func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002393 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002394 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002395}
2396
2397func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2398 library.MutatedProperties.AllStubsVersions = versions
2399}
2400
2401func (library *libraryDecorator) allStubsVersions() []string {
2402 return library.MutatedProperties.AllStubsVersions
2403}
2404
Jooyung Hanad4c1872020-02-27 17:56:44 +09002405func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002406 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002407}
2408
Jiyong Parka90ca002019-10-07 15:47:24 +09002409func (library *libraryDecorator) availableFor(what string) bool {
2410 var list []string
2411 if library.static() {
2412 list = library.StaticProperties.Static.Apex_available
2413 } else if library.shared() {
2414 list = library.SharedProperties.Shared.Apex_available
2415 }
2416 if len(list) == 0 {
2417 return false
2418 }
2419 return android.CheckAvailableForApex(what, list)
2420}
2421
Colin Cross1bc94122021-10-28 13:25:54 -07002422func (library *libraryDecorator) installable() *bool {
2423 if library.static() {
2424 return library.StaticProperties.Static.Installable
2425 } else if library.shared() {
2426 return library.SharedProperties.Shared.Installable
2427 }
2428 return nil
2429}
2430
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002431func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002432 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002433 // If we're asked to make a static library uninstallable we don't do
2434 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2435 // for these entries. This is done to still get the make targets for NOTICE
2436 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002437 return
2438 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002439 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002440}
2441
Jihoon Kangf78a8902022-09-01 22:47:07 +00002442func (library *libraryDecorator) getPartition() string {
2443 return library.path.Partition()
2444}
2445
Colin Crossceaa5322021-09-28 16:37:50 -07002446func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2447 return library.apiListCoverageXmlPath
2448}
2449
Inseob Kima1888ce2022-10-04 14:42:02 +09002450func (library *libraryDecorator) overriddenModules() []string {
2451 return library.Properties.Overrides
2452}
2453
2454var _ overridable = (*libraryDecorator)(nil)
2455
Colin Cross571cccf2019-02-04 11:22:08 -08002456var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2457
Chris Parsons3c27ca32020-11-20 12:42:07 -05002458// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2459// and values are the module name responsible for registering the version macro name.
2460//
2461// Version macros are used when building against stubs, to provide version information about
2462// the stub. Only stub libraries should have an entry in this list.
2463//
2464// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2465// that headers from libFoo can be conditionally compiled (this may hide APIs
2466// that are not available for the version).
2467//
2468// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002469func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002470 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002471 m := make(map[string]string)
2472 return &m
2473 }).(*map[string]string)
2474}
2475
2476// alphanumeric and _ characters are preserved.
2477// other characters are all converted to _
2478var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2479
Chris Parsons3c27ca32020-11-20 12:42:07 -05002480// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002481func versioningMacroName(moduleName string) string {
2482 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002483 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002484 return "__" + macroName + "_API__"
2485}
2486
Chris Parsons3c27ca32020-11-20 12:42:07 -05002487// NewLibrary builds and returns a new Module corresponding to a C++ library.
2488// Individual module implementations which comprise a C++ library (or something like
2489// a C++ library) should call this function, set some fields on the result, and
2490// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002491func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002492 module := newModule(hod, android.MultilibBoth)
2493
Colin Crossb916a382016-07-29 17:28:03 -07002494 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002495 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002496 BuildShared: true,
2497 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002498 },
Colin Crossb916a382016-07-29 17:28:03 -07002499 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002500 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002501 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002502 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002503 }
2504
Colin Crossb916a382016-07-29 17:28:03 -07002505 module.compiler = library
2506 module.linker = library
2507 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002508 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002509
2510 return module, library
2511}
2512
Colin Cross10d22312017-05-03 11:01:58 -07002513// connects a shared library to a static library in order to reuse its .o files to avoid
2514// compiling source files twice.
2515func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2516 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2517 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002518
2519 // Check libraries in addition to cflags, since libraries may be exporting different
2520 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002521 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2522 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2523 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2524 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2525 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2526 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2527 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2528 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002529 // Compare System_shared_libs properties with nil because empty lists are
2530 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002531 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2532 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002533
2534 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2535 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2536 sharedCompiler.baseCompiler.Properties.Srcs
2537 sharedCompiler.baseCompiler.Properties.Srcs = nil
2538 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2539 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002540
2541 // This dep is just to reference static variant from shared variant
2542 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002543 }
2544}
2545
Chris Parsons3c27ca32020-11-20 12:42:07 -05002546// LinkageMutator adds "static" or "shared" variants for modules depending
2547// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002548func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002549 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002550 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002551 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002552 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002553 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002554 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002555
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002556 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002557 buildStatic := library.buildStatic()
2558 buildShared := library.buildShared()
2559 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002560 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2561 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2562 // all the variants of the cc_library also exist on the prebuilt.
2563 modules := mctx.CreateLocalVariations("static", "shared")
2564 static := modules[0].(*Module)
2565 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002566
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002567 static.linker.(prebuiltLibraryInterface).setStatic()
2568 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002569
Colin Cross127bb8b2020-12-16 16:46:01 -08002570 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002571 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002572 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002573 mctx.AliasVariation("static")
2574 }
2575
Colin Cross127bb8b2020-12-16 16:46:01 -08002576 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002577 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2578 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002579 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002580 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2581 }
2582 } else {
2583 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002584 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002585
Ivan Lozano52767be2019-10-18 14:49:46 -07002586 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002587
Ivan Lozano2b262972019-11-21 12:30:50 -08002588 // Non-cc.Modules may need an empty variant for their mutators.
2589 variations := []string{}
2590 if library.NonCcVariants() {
2591 variations = append(variations, "")
2592 }
2593
Colin Cross127bb8b2020-12-16 16:46:01 -08002594 isLLNDK := false
2595 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002596 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002597 }
2598 buildStatic := library.BuildStaticVariant() && !isLLNDK
2599 buildShared := library.BuildSharedVariant()
2600 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002601 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002602
2603 modules := mctx.CreateLocalVariations(variations...)
2604 static := modules[0].(LinkableInterface)
2605 shared := modules[1].(LinkableInterface)
2606
2607 static.SetStatic()
2608 shared.SetShared()
2609
2610 if _, ok := library.(*Module); ok {
2611 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2612 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002613 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002614 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002615 variations := append([]string{"static"}, variations...)
2616
2617 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002618 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002619 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002620 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002621 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002622
Ivan Lozano2b262972019-11-21 12:30:50 -08002623 modules := mctx.CreateLocalVariations(variations...)
2624 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002625 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002626 } else if len(variations) > 0 {
2627 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002628 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002629 }
Colin Crossb916a382016-07-29 17:28:03 -07002630 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002631}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002632
Chris Parsons3c27ca32020-11-20 12:42:07 -05002633// normalizeVersions modifies `versions` in place, so that each raw version
2634// string becomes its normalized canonical form.
2635// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002636func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002637 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002638 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002639 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002640 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002641 ctx.PropertyErrorf("versions", "%s", err.Error())
2642 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002643 }
Dan Albertc8060532020-07-22 22:32:17 -07002644 if i > 0 && ver.LessThanOrEqualTo(previous) {
2645 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2646 }
2647 versions[i] = ver.String()
2648 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002649 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002650}
2651
Jooyung Han61b66e92020-03-21 14:21:46 +00002652func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002653 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2654 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002655 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002656
Colin Cross127bb8b2020-12-16 16:46:01 -08002657 m := mctx.Module().(*Module)
2658 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002659 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002660 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002661
Colin Crossd1f898e2020-08-18 18:35:15 -07002662 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002663 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002664
Kiyoung Kimee58c932022-10-25 22:59:41 +09002665 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002666 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002667 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002668 c.sanitize = nil
2669 c.stl = nil
2670 c.Properties.PreventInstall = true
2671 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002672 isLatest := i == (len(versions) - 1)
2673 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002674
2675 if variants[i] != "" {
2676 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2677 // implementation module to the stubs module.
2678 c.Properties.HideFromMake = true
2679 lib.setStubsVersion(variants[i])
2680 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2681 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002682 }
2683 }
Colin Cross094faa52020-08-06 17:38:25 -07002684 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002685 latestVersion := ""
2686 if len(versions) > 0 {
2687 latestVersion = versions[len(versions)-1]
2688 }
2689 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002690}
2691
Colin Crossbbc941b2020-09-30 12:27:01 -07002692func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2693 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2694 if err != nil {
2695 mctx.PropertyErrorf("min_sdk_version", err.Error())
2696 return
2697 }
2698
2699 versionStrs := ndkLibraryVersions(mctx, from)
2700 modules := mctx.CreateLocalVariations(versionStrs...)
2701
2702 for i, module := range modules {
2703 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002704 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002705 }
2706}
2707
Liz Kammer23942242022-04-08 15:41:00 -04002708func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002709 Host() bool
2710 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002711 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002712}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002713 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002714}
2715
Liz Kammer23942242022-04-08 15:41:00 -04002716func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002717 Host() bool
2718 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002719 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002720 CcLibraryInterface() bool
2721 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002722}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002723 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002724 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002725}
2726
Colin Cross127bb8b2020-12-16 16:46:01 -08002727func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002728 if m, ok := module.(*Module); ok {
2729 return m.library
2730 }
2731 return nil
2732}
2733
Liz Kammer23942242022-04-08 15:41:00 -04002734// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2735func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2736 if !library.buildShared() || !canBeVersionVariant(module) {
2737 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002738 }
Liz Kammer23942242022-04-08 15:41:00 -04002739 versions := library.stubsVersions(mctx)
2740 if len(versions) <= 0 {
2741 return
2742 }
2743 normalizeVersions(mctx, versions)
2744 if mctx.Failed() {
2745 return
2746 }
2747 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2748 // depend on the implementation library and haven't been mutated yet.
2749 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002750}
Jooyung Han61b66e92020-03-21 14:21:46 +00002751
Colin Crossd1f898e2020-08-18 18:35:15 -07002752// versionMutator splits a module into the mandatory non-stubs variant
2753// (which is unnamed) and zero or more stubs variants.
2754func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002755 if mctx.Os() != android.Android {
2756 return
2757 }
2758
2759 m, ok := mctx.Module().(*Module)
2760 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2761 setStubsVersions(mctx, library, m)
2762
Colin Cross31076b32020-10-23 17:22:06 -07002763 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002764 return
2765 }
2766
Liz Kammer23942242022-04-08 15:41:00 -04002767 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002768 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002769 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2770 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002771 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002772}
Colin Crossd7227f92019-09-05 14:26:33 -07002773
2774// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2775// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2776// that the linked output file should be written to.
2777// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2778func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2779 inject *bool, fileName string) android.ModuleOutPath {
2780 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2781 injectBoringSSLHash := Bool(inject)
2782 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002783 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002784 if cc, ok := dep.(*Module); ok {
2785 if library, ok := cc.linker.(*libraryDecorator); ok {
2786 if Bool(library.Properties.Inject_bssl_hash) {
2787 injectBoringSSLHash = true
2788 }
2789 }
2790 }
2791 }
2792 })
2793 if injectBoringSSLHash {
2794 hashedOutputfile := outputFile
2795 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2796
Colin Crossf1a035e2020-11-16 17:32:30 -08002797 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002798 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002799 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002800 FlagWithInput("-in-object ", outputFile).
2801 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002802 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002803 }
2804
2805 return outputFile
2806}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002807
Yu Liu56ccb1a2022-11-12 10:47:07 -08002808func bp2buildParseAbiCheckerProps(ctx android.TopDownMutatorContext, module *Module) bazelCcHeaderAbiCheckerAttributes {
2809 lib, ok := module.linker.(*libraryDecorator)
2810 if !ok {
2811 return bazelCcHeaderAbiCheckerAttributes{}
2812 }
2813
2814 abiChecker := lib.Properties.Header_abi_checker
2815
2816 abiCheckerAttrs := bazelCcHeaderAbiCheckerAttributes{
2817 Abi_checker_enabled: abiChecker.Enabled,
2818 Abi_checker_exclude_symbol_versions: abiChecker.Exclude_symbol_versions,
2819 Abi_checker_exclude_symbol_tags: abiChecker.Exclude_symbol_tags,
2820 Abi_checker_check_all_apis: abiChecker.Check_all_apis,
2821 Abi_checker_diff_flags: abiChecker.Diff_flags,
2822 }
2823 if abiChecker.Symbol_file != nil {
2824 symbolFile := android.BazelLabelForModuleSrcSingle(ctx, *abiChecker.Symbol_file)
2825 abiCheckerAttrs.Abi_checker_symbol_file = &symbolFile
2826 }
2827
2828 return abiCheckerAttrs
2829}
2830
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002831func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002832 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2833 compilerAttrs := baseAttributes.compilerAttributes
2834 linkerAttrs := baseAttributes.linkerAttributes
2835
Liz Kammer54549442022-05-11 13:55:06 -04002836 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, &compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002837
2838 // Append shared/static{} stanza properties. These won't be specified on
2839 // cc_library_* itself, but may be specified in cc_defaults that this module
2840 // depends on.
2841 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2842
2843 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2844 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2845 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2846 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002847
2848 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2849 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002850 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002851 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002852 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2853
2854 asFlags := compilerAttrs.asFlags
2855 if compilerAttrs.asSrcs.IsEmpty() {
2856 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2857 asFlags = bazel.MakeStringListAttribute(nil)
2858 }
2859
Liz Kammer7a210ac2021-09-22 15:52:58 -04002860 commonAttrs := staticOrSharedAttributes{
2861 Srcs: compilerAttrs.srcs,
2862 Srcs_c: compilerAttrs.cSrcs,
2863 Srcs_as: compilerAttrs.asSrcs,
2864 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002865 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002866
Liz Kammer12615db2021-09-28 09:19:17 -04002867 Deps: linkerAttrs.deps,
2868 Implementation_deps: linkerAttrs.implementationDeps,
2869 Dynamic_deps: linkerAttrs.dynamicDeps,
2870 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2871 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2872 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2873 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Yu Liufc603162022-03-01 15:44:08 -08002874 sdkAttributes: bp2BuildParseSdkAttributes(module),
Cole Faust6b29f592022-08-09 09:50:56 -07002875 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liuf01a0f02022-12-07 15:45:30 -08002876 Native_coverage: baseAttributes.Native_coverage,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002877 }
2878
Sam Delmericoc9b8fbd2022-10-25 15:47:17 -04002879 module.convertTidyAttributes(ctx, &commonAttrs.tidyAttributes)
Sam Delmericofb3bb322022-10-21 10:42:24 -04002880
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002881 var attrs interface{}
2882 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002883 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002884 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002885 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002886
Liz Kammerbaced712022-09-16 09:01:29 -04002887 Use_libcrt: linkerAttrs.useLibcrt,
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002888
Liz Kammer1263d9b2021-12-10 14:28:20 -05002889 Rtti: compilerAttrs.rtti,
2890 Stl: compilerAttrs.stl,
2891 Cpp_std: compilerAttrs.cppStd,
2892 C_std: compilerAttrs.cStd,
2893
2894 Export_includes: exportedIncludes.Includes,
2895 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2896 Export_system_includes: exportedIncludes.SystemIncludes,
2897 Local_includes: compilerAttrs.localIncludes,
2898 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002899
2900 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002901 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002902 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002903
Cole Faust5fa4e962022-08-22 14:31:04 -07002904 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002905 }
2906 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002907 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2908
Wei Li81852ca2022-07-27 00:22:06 -07002909 sharedLibAttrs := &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002910 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002911
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002912 Cppflags: compilerAttrs.cppFlags,
2913 Conlyflags: compilerAttrs.conlyFlags,
2914 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002915
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002916 Linkopts: linkerAttrs.linkopts,
2917 Link_crt: linkerAttrs.linkCrt,
2918 Use_libcrt: linkerAttrs.useLibcrt,
2919 Use_version_lib: linkerAttrs.useVersionLib,
2920
2921 Rtti: compilerAttrs.rtti,
2922 Stl: compilerAttrs.stl,
2923 Cpp_std: compilerAttrs.cppStd,
2924 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002925
Liz Kammerd2871182021-10-04 13:54:37 -04002926 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002927 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002928 Export_system_includes: exportedIncludes.SystemIncludes,
2929 Local_includes: compilerAttrs.localIncludes,
2930 Absolute_includes: compilerAttrs.absoluteIncludes,
2931 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002932
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00002933 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
Liz Kammer0eae52e2021-10-06 10:32:26 -04002934
Cole Faust5fa4e962022-08-22 14:31:04 -07002935 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05002936
2937 Suffix: compilerAttrs.suffix,
Yu Liu56ccb1a2022-11-12 10:47:07 -08002938
2939 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, module),
Vinh Tran99270ea2022-11-28 11:15:23 -05002940
2941 Fdo_profile: compilerAttrs.fdoProfile,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002942 }
Wei Li81852ca2022-07-27 00:22:06 -07002943 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
Yu Liu56ccb1a2022-11-12 10:47:07 -08002944 sharedLibAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Wei Li81852ca2022-07-27 00:22:06 -07002945 }
2946 attrs = sharedLibAttrs
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002947 }
2948
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002949 var modType string
2950 if isStatic {
2951 modType = "cc_library_static"
2952 } else {
2953 modType = "cc_library_shared"
Trevor Radcliffef19d8a72022-09-20 23:04:39 +00002954 createStubsBazelTargetIfNeeded(ctx, module, compilerAttrs, exportedIncludes, baseAttributes)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002955 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002956 props := bazel.BazelTargetModuleProperties{
2957 Rule_class: modType,
Liz Kammer2b376bc2022-01-12 12:00:49 -05002958 Bzl_load_location: fmt.Sprintf("//build/bazel/rules/cc:%s.bzl", modType),
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002959 }
2960
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002961 tags := android.ApexAvailableTags(module)
Yu Liuf01a0f02022-12-07 15:45:30 -08002962
2963 // This lib needs some special handling in bazel, so add this tag to the build
2964 // file.
2965 if module.Name() == "libprofile-clang-extras" {
2966 tags.Append(bazel.MakeStringListAttribute([]string{"NO_EXPORTING"}))
2967 }
2968
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002969 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name(), Tags: tags}, attrs)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002970}
2971
2972// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002973type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002974 staticOrSharedAttributes
2975
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002976 Use_libcrt bazel.BoolAttribute
2977 Use_version_lib bazel.BoolAttribute
2978
2979 Rtti bazel.BoolAttribute
2980 Stl *string
2981 Cpp_std *string
2982 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002983
Liz Kammer1263d9b2021-12-10 14:28:20 -05002984 Export_includes bazel.StringListAttribute
2985 Export_absolute_includes bazel.StringListAttribute
2986 Export_system_includes bazel.StringListAttribute
2987 Local_includes bazel.StringListAttribute
2988 Absolute_includes bazel.StringListAttribute
2989 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002990
2991 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002992 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002993 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002994
2995 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002996}
2997
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002998// TODO(b/199902614): Can this be factored to share with the other Attributes?
2999type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04003000 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003001
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05003002 Linkopts bazel.StringListAttribute
3003 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
3004
3005 Use_libcrt bazel.BoolAttribute
3006 Use_version_lib bazel.BoolAttribute
3007
3008 Rtti bazel.BoolAttribute
3009 Stl *string
3010 Cpp_std *string
3011 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003012
Liz Kammer1263d9b2021-12-10 14:28:20 -05003013 Export_includes bazel.StringListAttribute
3014 Export_absolute_includes bazel.StringListAttribute
3015 Export_system_includes bazel.StringListAttribute
3016 Local_includes bazel.StringListAttribute
3017 Absolute_includes bazel.StringListAttribute
3018 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003019
Liz Kammerd2871182021-10-04 13:54:37 -04003020 Strip stripAttributes
3021 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04003022
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003023 Cppflags bazel.StringListAttribute
3024 Conlyflags bazel.StringListAttribute
3025 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04003026
3027 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00003028
Yu Liu56ccb1a2022-11-12 10:47:07 -08003029 Stubs_symbol_file *string
Wei Li81852ca2022-07-27 00:22:06 -07003030
3031 Inject_bssl_hash bazel.BoolAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05003032
3033 Suffix bazel.StringAttribute
Yu Liu56ccb1a2022-11-12 10:47:07 -08003034
3035 bazelCcHeaderAbiCheckerAttributes
Vinh Tran99270ea2022-11-28 11:15:23 -05003036
3037 Fdo_profile bazel.LabelAttribute
Wei Li81852ca2022-07-27 00:22:06 -07003038}
3039
3040type bazelCcStubSuiteAttributes struct {
3041 Symbol_file *string
3042 Versions bazel.StringListAttribute
3043 Export_includes bazel.StringListAttribute
3044 Source_library bazel.LabelAttribute
3045 Soname *string
3046 Deps bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003047}
Yu Liu56ccb1a2022-11-12 10:47:07 -08003048
3049type bazelCcHeaderAbiCheckerAttributes struct {
3050 Abi_checker_enabled *bool
3051 Abi_checker_symbol_file *bazel.Label
3052 Abi_checker_exclude_symbol_versions []string
3053 Abi_checker_exclude_symbol_tags []string
3054 Abi_checker_check_all_apis *bool
3055 Abi_checker_diff_flags []string
3056}