blob: d1d19452fce9e2174653172885d1b6a711e0728d [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
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800123 }
Vic Yang6cd1be82019-06-24 16:08:48 -0700124
Pete Bentley803e1612019-08-06 22:19:59 +0100125 // Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
126 Inject_bssl_hash *bool `android:"arch_variant"`
Colin Cross0477b422020-10-13 18:43:54 -0700127
Colin Cross127bb8b2020-12-16 16:46:01 -0800128 // If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
129 // the module pointed to by llndk_stubs if it is set.
130 Llndk llndkLibraryProperties
Colin Cross5271fea2021-04-27 13:06:04 -0700131
132 // If this is a vendor public library, properties to describe the vendor public library stubs.
133 Vendor_public_library vendorPublicLibraryProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800134}
Colin Cross0c461f12016-10-20 16:11:43 -0700135
Chris Parsons3c27ca32020-11-20 12:42:07 -0500136// StaticProperties is a properties stanza to affect only attributes of the "static" variants of a
137// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700138type StaticProperties struct {
139 Static StaticOrSharedProperties `android:"arch_variant"`
140}
141
Chris Parsons3c27ca32020-11-20 12:42:07 -0500142// SharedProperties is a properties stanza to affect only attributes of the "shared" variants of a
143// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700144type SharedProperties struct {
145 Shared StaticOrSharedProperties `android:"arch_variant"`
146}
147
Chris Parsons3c27ca32020-11-20 12:42:07 -0500148// StaticOrSharedProperties is an embedded struct representing properties to affect attributes of
149// either only the "static" variants or only the "shared" variants of a library module. These override
150// the base properties of the same name.
151// Use `StaticProperties` or `SharedProperties`, depending on which variant is needed.
152// `StaticOrSharedProperties` exists only to avoid duplication.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700153type StaticOrSharedProperties struct {
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700154 Srcs []string `android:"path,arch_variant"`
155
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700156 Tidy_disabled_srcs []string `android:"path,arch_variant"`
157
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800158 Tidy_timeout_srcs []string `android:"path,arch_variant"`
159
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700160 Sanitized Sanitized `android:"arch_variant"`
161
Colin Crosse1bb5d02019-09-24 14:55:04 -0700162 Cflags []string `android:"arch_variant"`
163
Colin Cross6b8f4252021-07-22 11:39:44 -0700164 Enabled *bool `android:"arch_variant"`
165 Whole_static_libs []string `android:"arch_variant"`
166 Static_libs []string `android:"arch_variant"`
167 Shared_libs []string `android:"arch_variant"`
168 System_shared_libs []string `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700169
170 Export_shared_lib_headers []string `android:"arch_variant"`
171 Export_static_lib_headers []string `android:"arch_variant"`
Jiyong Parka90ca002019-10-07 15:47:24 +0900172
173 Apex_available []string `android:"arch_variant"`
Colin Cross1bc94122021-10-28 13:25:54 -0700174
175 Installable *bool `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700176}
177
Colin Crossa48ab5b2017-02-14 15:28:44 -0800178type LibraryMutatedProperties struct {
Colin Crossb916a382016-07-29 17:28:03 -0700179 // Build a static variant
180 BuildStatic bool `blueprint:"mutated"`
181 // Build a shared variant
182 BuildShared bool `blueprint:"mutated"`
183 // This variant is shared
184 VariantIsShared bool `blueprint:"mutated"`
185 // This variant is static
186 VariantIsStatic bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900187
188 // This variant is a stubs lib
189 BuildStubs bool `blueprint:"mutated"`
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900190 // This variant is the latest version
191 IsLatestVersion bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900192 // Version of the stubs lib
193 StubsVersion string `blueprint:"mutated"`
Colin Crossd1f898e2020-08-18 18:35:15 -0700194 // List of all stubs versions associated with an implementation lib
195 AllStubsVersions []string `blueprint:"mutated"`
Colin Crossb916a382016-07-29 17:28:03 -0700196}
197
198type FlagExporterProperties struct {
199 // list of directories relative to the Blueprints file that will
Dan Willemsen273af7f2016-11-03 15:53:42 -0700200 // be added to the include path (using -I) for this module and any module that links
Colin Cross5d195602017-10-17 16:15:50 -0700201 // against this module. Directories listed in export_include_dirs do not need to be
202 // listed in local_include_dirs.
Colin Cross0ed579e2021-06-29 00:51:12 +0000203 Export_include_dirs []string `android:"arch_variant,variant_prepend"`
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700204
Jiyong Park73c54ee2019-10-22 20:31:18 +0900205 // list of directories that will be added to the system include path
206 // using -isystem for this module and any module that links against this module.
Colin Cross0ed579e2021-06-29 00:51:12 +0000207 Export_system_include_dirs []string `android:"arch_variant,variant_prepend"`
Jiyong Park73c54ee2019-10-22 20:31:18 +0900208
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700209 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900210 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700211 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900212 // export_include_dirs, that will be applied to
213 // vendor or product variant of this library.
214 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800215 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700216 }
217 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700218}
219
220func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000221 RegisterLibraryBuildComponents(android.InitRegistrationContext)
222}
223
224func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
225 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
226 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
227 ctx.RegisterModuleType("cc_library", LibraryFactory)
228 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
229 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700230}
231
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +0000232// TODO(b/199902614): Can this be factored to share with the other Attributes?
Jingwen Chen63930982021-03-24 10:04:33 -0400233// For bp2build conversion.
234type bazelCcLibraryAttributes struct {
Chris Parsons08648312021-05-06 16:23:19 -0400235 // Attributes pertaining to both static and shared variants.
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000236 Srcs bazel.LabelListAttribute
237 Srcs_c bazel.LabelListAttribute
238 Srcs_as bazel.LabelListAttribute
239
240 Copts bazel.StringListAttribute
241 Cppflags bazel.StringListAttribute
242 Conlyflags bazel.StringListAttribute
243 Asflags bazel.StringListAttribute
244
Liz Kammer7a210ac2021-09-22 15:52:58 -0400245 Hdrs bazel.LabelListAttribute
246
Liz Kammer12615db2021-09-28 09:19:17 -0400247 Deps bazel.LabelListAttribute
248 Implementation_deps bazel.LabelListAttribute
249 Dynamic_deps bazel.LabelListAttribute
250 Implementation_dynamic_deps bazel.LabelListAttribute
251 Whole_archive_deps bazel.LabelListAttribute
252 Implementation_whole_archive_deps bazel.LabelListAttribute
253 System_dynamic_deps bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -0400254
Liz Kammer5fad5012021-09-09 14:08:21 -0400255 Export_includes bazel.StringListAttribute
256 Export_system_includes bazel.StringListAttribute
Liz Kammer35687bc2021-09-10 10:07:07 -0400257 Local_includes bazel.StringListAttribute
258 Absolute_includes bazel.StringListAttribute
Liz Kammer5fad5012021-09-09 14:08:21 -0400259 Linkopts bazel.StringListAttribute
260 Use_libcrt bazel.BoolAttribute
261 Rtti bazel.BoolAttribute
Jingwen Chen5b11ab12021-10-11 17:44:33 +0000262
263 Stl *string
264 Cpp_std *string
Chris Parsons79bd2b72021-11-29 17:52:41 -0500265 C_std *string
Chris Parsons990c4f42021-05-25 12:10:58 -0400266
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000267 // This is shared only.
Liz Kammerd2871182021-10-04 13:54:37 -0400268 Link_crt bazel.BoolAttribute
269 Additional_linker_inputs bazel.LabelListAttribute
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000270
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000271 // Common properties shared between both shared and static variants.
272 Shared staticOrSharedAttributes
273 Static staticOrSharedAttributes
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000274
275 Strip stripAttributes
Liz Kammer0eae52e2021-10-06 10:32:26 -0400276
277 Features bazel.StringListAttribute
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000278}
279
Vinh Tran9f6796a2022-08-16 13:10:31 -0400280type aidlLibraryAttributes struct {
281 Srcs bazel.LabelListAttribute
282 Include_dir *string
283}
284
285type ccAidlLibraryAttributes struct {
Vinh Tran395a1e92022-09-16 18:27:29 -0400286 Deps bazel.LabelListAttribute
287 Implementation_dynamic_deps bazel.LabelListAttribute
Vinh Tran9f6796a2022-08-16 13:10:31 -0400288}
289
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000290type stripAttributes struct {
291 Keep_symbols bazel.BoolAttribute
292 Keep_symbols_and_debug_frame bazel.BoolAttribute
293 Keep_symbols_list bazel.StringListAttribute
294 All bazel.BoolAttribute
295 None bazel.BoolAttribute
Jingwen Chen63930982021-03-24 10:04:33 -0400296}
297
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +0000298func stripAttrsFromLinkerAttrs(la *linkerAttributes) stripAttributes {
299 return stripAttributes{
300 Keep_symbols: la.stripKeepSymbols,
301 Keep_symbols_and_debug_frame: la.stripKeepSymbolsAndDebugFrame,
302 Keep_symbols_list: la.stripKeepSymbolsList,
303 All: la.stripAll,
304 None: la.stripNone,
305 }
306}
307
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400308func libraryBp2Build(ctx android.TopDownMutatorContext, m *Module) {
Jingwen Chen179856a2021-05-03 09:15:48 +0000309 // For some cc_library modules, their static variants are ready to be
310 // converted, but not their shared variants. For these modules, delegate to
311 // the cc_library_static bp2build converter temporarily instead.
Chris Parsonsad876012022-08-20 14:48:32 -0400312 if android.GetBp2BuildAllowList().GenerateCcLibraryStaticOnly(ctx.Module().Name()) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400313 sharedOrStaticLibraryBp2Build(ctx, m, true)
Jingwen Chen179856a2021-05-03 09:15:48 +0000314 return
315 }
316
Jingwen Chen53681ef2021-04-29 08:15:13 +0000317 sharedAttrs := bp2BuildParseSharedProps(ctx, m)
318 staticAttrs := bp2BuildParseStaticProps(ctx, m)
Liz Kammere6583482021-10-19 13:56:10 -0400319 baseAttributes := bp2BuildParseBaseProps(ctx, m)
320 compilerAttrs := baseAttributes.compilerAttributes
321 linkerAttrs := baseAttributes.linkerAttributes
Liz Kammer54549442022-05-11 13:55:06 -0400322 exportedIncludes := bp2BuildParseExportedIncludes(ctx, m, &compilerAttrs.includes)
Jingwen Chen63930982021-03-24 10:04:33 -0400323
Liz Kammer9abd62d2021-05-21 08:37:59 -0400324 srcs := compilerAttrs.srcs
Jingwen Chen53681ef2021-04-29 08:15:13 +0000325
Liz Kammer12615db2021-09-28 09:19:17 -0400326 sharedAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
327 staticAttrs.Deps.Add(baseAttributes.protoDependency)
328
Chris Parsons69fa9f92021-07-13 11:47:44 -0400329 asFlags := compilerAttrs.asFlags
330 if compilerAttrs.asSrcs.IsEmpty() && sharedAttrs.Srcs_as.IsEmpty() && staticAttrs.Srcs_as.IsEmpty() {
331 // Skip asflags for BUILD file simplicity if there are no assembly sources.
332 asFlags = bazel.MakeStringListAttribute(nil)
333 }
334
Chris Parsons77acf2e2021-12-03 17:27:16 -0500335 staticCommonAttrs := staticOrSharedAttributes{
336 Srcs: *srcs.Clone().Append(staticAttrs.Srcs),
337 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(staticAttrs.Srcs_c),
338 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(staticAttrs.Srcs_as),
339 Copts: *compilerAttrs.copts.Clone().Append(staticAttrs.Copts),
340 Hdrs: *compilerAttrs.hdrs.Clone().Append(staticAttrs.Hdrs),
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000341
Chris Parsons77acf2e2021-12-03 17:27:16 -0500342 Deps: *linkerAttrs.deps.Clone().Append(staticAttrs.Deps),
343 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(staticAttrs.Implementation_deps),
344 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(staticAttrs.Dynamic_deps),
345 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(staticAttrs.Implementation_dynamic_deps),
346 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
347 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(staticAttrs.Whole_archive_deps),
348 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(staticAttrs.System_dynamic_deps),
Cole Faust6b29f592022-08-09 09:50:56 -0700349 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liufc603162022-03-01 15:44:08 -0800350 sdkAttributes: bp2BuildParseSdkAttributes(m),
Chris Parsons77acf2e2021-12-03 17:27:16 -0500351 }
352
353 sharedCommonAttrs := staticOrSharedAttributes{
354 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
355 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
356 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
357 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
358 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
359
Liz Kammer84b0ecb2022-09-14 10:49:13 -0400360 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
361 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
362 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
363 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
364 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
365 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
366 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
367 Runtime_deps: linkerAttrs.runtimeDeps,
368 sdkAttributes: bp2BuildParseSdkAttributes(m),
Chris Parsons77acf2e2021-12-03 17:27:16 -0500369 }
370
371 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
372 staticOrSharedAttributes: staticCommonAttrs,
373
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000374 Cppflags: compilerAttrs.cppFlags,
375 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400376 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000377
Liz Kammer1263d9b2021-12-10 14:28:20 -0500378 Export_includes: exportedIncludes.Includes,
379 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
380 Export_system_includes: exportedIncludes.SystemIncludes,
381 Local_includes: compilerAttrs.localIncludes,
382 Absolute_includes: compilerAttrs.absoluteIncludes,
383 Use_libcrt: linkerAttrs.useLibcrt,
384 Rtti: compilerAttrs.rtti,
385 Stl: compilerAttrs.stl,
386 Cpp_std: compilerAttrs.cppStd,
387 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500388
Cole Faust5fa4e962022-08-22 14:31:04 -0700389 Features: baseAttributes.features,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500390 }
391
392 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
393 staticOrSharedAttributes: sharedCommonAttrs,
394 Cppflags: compilerAttrs.cppFlags,
395 Conlyflags: compilerAttrs.conlyFlags,
396 Asflags: asFlags,
397
Liz Kammer1263d9b2021-12-10 14:28:20 -0500398 Export_includes: exportedIncludes.Includes,
399 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
400 Export_system_includes: exportedIncludes.SystemIncludes,
401 Local_includes: compilerAttrs.localIncludes,
402 Absolute_includes: compilerAttrs.absoluteIncludes,
403 Linkopts: linkerAttrs.linkopts,
404 Link_crt: linkerAttrs.linkCrt,
405 Use_libcrt: linkerAttrs.useLibcrt,
406 Rtti: compilerAttrs.rtti,
407 Stl: compilerAttrs.stl,
408 Cpp_std: compilerAttrs.cppStd,
409 C_std: compilerAttrs.cStd,
Yu Liua79c9462022-03-22 16:35:22 -0700410 Use_version_lib: linkerAttrs.useVersionLib,
Chris Parsons990c4f42021-05-25 12:10:58 -0400411
Liz Kammerd2871182021-10-04 13:54:37 -0400412 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000413
Yu Liu56ccb1a2022-11-12 10:47:07 -0800414 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
415 Features: baseAttributes.features,
416 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, m),
Wei Li81852ca2022-07-27 00:22:06 -0700417 }
Jingwen Chen0ee88a62022-01-07 14:55:29 +0000418
Wei Li81852ca2022-07-27 00:22:06 -0700419 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
420 hasStubs := true
421 sharedTargetAttrs.Has_stubs.SetValue(&hasStubs)
Yu Liu56ccb1a2022-11-12 10:47:07 -0800422 sharedTargetAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Jingwen Chen63930982021-03-24 10:04:33 -0400423 }
424
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -0500425 sharedTargetAttrs.Suffix = compilerAttrs.suffix
426
Yu Liu75be7b92022-02-01 09:54:09 -0800427 for axis, configToProps := range m.GetArchVariantProperties(ctx, &LibraryProperties{}) {
428 for config, props := range configToProps {
429 if props, ok := props.(*LibraryProperties); ok {
430 if props.Inject_bssl_hash != nil {
431 // This is an edge case applies only to libcrypto
Sam Delmericofae47f92022-08-08 13:35:08 -0400432 if m.Name() == "libcrypto" || m.Name() == "libcrypto_for_testing" {
Yu Liu75be7b92022-02-01 09:54:09 -0800433 sharedTargetAttrs.Inject_bssl_hash.SetSelectValue(axis, config, props.Inject_bssl_hash)
434 } else {
435 ctx.PropertyErrorf("inject_bssl_hash", "only applies to libcrypto")
436 }
437 }
438 }
439 }
440 }
441
Chris Parsons77acf2e2021-12-03 17:27:16 -0500442 staticProps := bazel.BazelTargetModuleProperties{
443 Rule_class: "cc_library_static",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500444 Bzl_load_location: "//build/bazel/rules/cc:cc_library_static.bzl",
Chris Parsons77acf2e2021-12-03 17:27:16 -0500445 }
446 sharedProps := bazel.BazelTargetModuleProperties{
447 Rule_class: "cc_library_shared",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500448 Bzl_load_location: "//build/bazel/rules/cc:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400449 }
450
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000451 tags := android.ApexAvailableTags(m)
Chris Parsons58852a02021-12-09 18:10:18 -0500452 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000453 android.CommonAttributes{
454 Name: m.Name() + "_bp2build_cc_library_static",
455 Tags: tags,
456 },
Chris Parsons58852a02021-12-09 18:10:18 -0500457 staticTargetAttrs, staticAttrs.Enabled)
458 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000459 android.CommonAttributes{
460 Name: m.Name(),
461 Tags: tags,
462 },
Chris Parsons58852a02021-12-09 18:10:18 -0500463 sharedTargetAttrs, sharedAttrs.Enabled)
Wei Li81852ca2022-07-27 00:22:06 -0700464
Trevor Radcliffe087af542022-09-16 15:36:10 +0000465 createStubsBazelTargetIfNeeded(ctx, m, compilerAttrs, exportedIncludes, baseAttributes)
466}
467
468func createStubsBazelTargetIfNeeded(ctx android.TopDownMutatorContext, m *Module, compilerAttrs compilerAttributes, exportedIncludes BazelIncludes, baseAttributes baseAttributes) {
Wei Li81852ca2022-07-27 00:22:06 -0700469 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
470 stubSuitesProps := bazel.BazelTargetModuleProperties{
471 Rule_class: "cc_stub_suite",
472 Bzl_load_location: "//build/bazel/rules/cc:cc_stub_library.bzl",
473 }
474 soname := m.Name() + ".so"
475 stubSuitesAttrs := &bazelCcStubSuiteAttributes{
476 Symbol_file: compilerAttrs.stubsSymbolFile,
477 Versions: compilerAttrs.stubsVersions,
478 Export_includes: exportedIncludes.Includes,
479 Soname: &soname,
480 Source_library: *bazel.MakeLabelAttribute(":" + m.Name()),
481 Deps: baseAttributes.deps,
482 }
483 ctx.CreateBazelTargetModule(stubSuitesProps,
484 android.CommonAttributes{Name: m.Name() + "_stub_libs"},
485 stubSuitesAttrs)
486 }
Jingwen Chen63930982021-03-24 10:04:33 -0400487}
488
Spandan Das4238c652022-09-09 01:38:47 +0000489func apiContributionBp2Build(ctx android.TopDownMutatorContext, module *Module) {
490 apiSurfaces := make([]string, 0)
491 apiHeaders := make([]string, 0)
492 // systemapi (non-null `stubs` property)
493 if module.HasStubsVariants() {
494 apiSurfaces = append(apiSurfaces, android.SystemApi.String())
495 apiIncludes := getSystemApiIncludes(ctx, module)
496 if !apiIncludes.isEmpty() {
497 createApiHeaderTarget(ctx, apiIncludes)
498 apiHeaders = append(apiHeaders, apiIncludes.name)
499 }
500 }
501 // vendorapi (non-null `llndk` property)
502 if module.HasLlndkStubs() {
503 apiSurfaces = append(apiSurfaces, android.VendorApi.String())
504 apiIncludes := getVendorApiIncludes(ctx, module)
505 if !apiIncludes.isEmpty() {
506 createApiHeaderTarget(ctx, apiIncludes)
507 apiHeaders = append(apiHeaders, apiIncludes.name)
508 }
509 }
510 // create a target only if this module contributes to an api surface
511 // TODO: Currently this does not distinguish systemapi-only headers and vendrorapi-only headers
512 // TODO: Update so that systemapi-only headers do not get exported to vendorapi (and vice-versa)
513 if len(apiSurfaces) > 0 {
514 props := bazel.BazelTargetModuleProperties{
515 Rule_class: "cc_api_contribution",
516 Bzl_load_location: "//build/bazel/rules/apis:cc_api_contribution.bzl",
517 }
518 attrs := &bazelCcApiContributionAttributes{
519 Library_name: module.Name(),
520 Api_surfaces: bazel.MakeStringListAttribute(apiSurfaces),
521 Api: apiLabelAttribute(ctx, module),
522 Hdrs: bazel.MakeLabelListAttribute(
523 bazel.MakeLabelListFromTargetNames(apiHeaders),
524 ),
525 }
526 ctx.CreateBazelTargetModule(
527 props,
528 android.CommonAttributes{
529 Name: android.ApiContributionTargetName(module.Name()),
530 SkipData: proptools.BoolPtr(true),
531 },
532 attrs,
533 )
534 }
535}
536
537// Native apis are versioned in a single .map.txt for all api surfaces
538// Pick any one of the .map.txt files
539func apiLabelAttribute(ctx android.TopDownMutatorContext, module *Module) bazel.LabelAttribute {
540 var apiFile *string
541 linker := module.linker.(*libraryDecorator)
542 if llndkApi := linker.Properties.Llndk.Symbol_file; llndkApi != nil {
543 apiFile = llndkApi
544 } else if systemApi := linker.Properties.Stubs.Symbol_file; systemApi != nil {
545 apiFile = systemApi
546 } else {
547 ctx.ModuleErrorf("API surface library does not have any API file")
548 }
549 apiLabel := android.BazelLabelForModuleSrcSingle(ctx, proptools.String(apiFile)).Label
550 return *bazel.MakeLabelAttribute(apiLabel)
551}
552
553// wrapper struct to flatten the arch and os specific export_include_dirs
554// flattening is necessary since we want to export apis of all arches even when we build for x86 (e.g.)
555type bazelCcApiLibraryHeadersAttributes struct {
556 bazelCcLibraryHeadersAttributes
557
558 Arch *string
559}
560
561func (a *bazelCcApiLibraryHeadersAttributes) isEmpty() bool {
562 return a.Export_includes.IsEmpty() &&
563 a.Export_system_includes.IsEmpty() &&
564 a.Deps.IsEmpty()
565}
566
567type apiIncludes struct {
568 name string // name of the Bazel target in the generated bp2build workspace
569 attrs bazelCcApiLibraryHeadersAttributes
570}
571
572func (includes *apiIncludes) isEmpty() bool {
573 return includes.attrs.isEmpty()
574}
575
576func (includes *apiIncludes) addDep(name string) {
577 l := bazel.Label{Label: ":" + name}
578 ll := bazel.MakeLabelList([]bazel.Label{l})
579 lla := bazel.MakeLabelListAttribute(ll)
580 includes.attrs.Deps.Append(lla)
581}
582
583func getSystemApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
584 flagProps := c.library.(*libraryDecorator).flagExporter.Properties
585 linkProps := c.library.(*libraryDecorator).baseLinker.Properties
586 includes := android.FirstUniqueStrings(flagProps.Export_include_dirs)
587 systemIncludes := android.FirstUniqueStrings(flagProps.Export_system_include_dirs)
588 headerLibs := android.FirstUniqueStrings(linkProps.Export_header_lib_headers)
589 attrs := bazelCcLibraryHeadersAttributes{
590 Export_includes: bazel.MakeStringListAttribute(includes),
591 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
592 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, headerLibs)),
593 }
594
595 return apiIncludes{
596 name: c.Name() + ".systemapi.headers",
597 attrs: bazelCcApiLibraryHeadersAttributes{
598 bazelCcLibraryHeadersAttributes: attrs,
599 },
600 }
601}
602
603func getVendorApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
604 baseProps := c.library.(*libraryDecorator).flagExporter.Properties
605 llndkProps := c.library.(*libraryDecorator).Properties.Llndk
606 includes := baseProps.Export_include_dirs
607 systemIncludes := baseProps.Export_system_include_dirs
608 // LLNDK can override the base includes
609 if llndkIncludes := llndkProps.Override_export_include_dirs; llndkIncludes != nil {
610 includes = llndkIncludes
611 }
612 if proptools.Bool(llndkProps.Export_headers_as_system) {
613 systemIncludes = append(systemIncludes, includes...)
614 includes = nil
615 }
616
617 attrs := bazelCcLibraryHeadersAttributes{
618 Export_includes: bazel.MakeStringListAttribute(includes),
619 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
620 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, llndkProps.Export_llndk_headers)),
621 }
622 return apiIncludes{
623 name: c.Name() + ".vendorapi.headers",
624 attrs: bazelCcApiLibraryHeadersAttributes{
625 bazelCcLibraryHeadersAttributes: attrs,
626 },
627 }
628}
629
Patrice Arruda83c89e02019-03-25 15:32:39 -0700630// cc_library creates both static and/or shared libraries for a device and/or
631// host. By default, a cc_library has a single variant that targets the device.
632// Specifying `host_supported: true` also creates a library that targets the
633// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700634func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800635 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000636 // Can be used as both a static and a shared library.
637 module.sdkMemberTypes = []android.SdkMemberType{
638 sharedLibrarySdkMemberType,
639 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000640 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000641 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400642 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400643 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700644 return module.Init()
645}
646
Patrice Arruda83c89e02019-03-25 15:32:39 -0700647// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700648func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800649 module, library := NewLibrary(android.HostAndDeviceSupported)
650 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000651 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400652 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400653 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700654 return module.Init()
655}
656
Patrice Arruda83c89e02019-03-25 15:32:39 -0700657// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700658func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800659 module, library := NewLibrary(android.HostAndDeviceSupported)
660 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000661 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400662 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000663 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700664 return module.Init()
665}
666
Patrice Arruda83c89e02019-03-25 15:32:39 -0700667// cc_library_host_static creates a static library that is linkable to a host
668// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700669func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800670 module, library := NewLibrary(android.HostSupported)
671 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000672 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000673 module.bazelable = true
674 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700675 return module.Init()
676}
677
Patrice Arruda83c89e02019-03-25 15:32:39 -0700678// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700679func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800680 module, library := NewLibrary(android.HostSupported)
681 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000682 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800683 module.bazelable = true
684 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700685 return module.Init()
686}
687
Chris Parsons3c27ca32020-11-20 12:42:07 -0500688// flagExporter is a separated portion of libraryDecorator pertaining to exported
689// include paths and flags. Keeping this dependency-related information separate
690// from the rest of library information is helpful in keeping data more structured
691// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700692type flagExporter struct {
693 Properties FlagExporterProperties
694
Chris Parsons3c27ca32020-11-20 12:42:07 -0500695 dirs android.Paths // Include directories to be included with -I
696 systemDirs android.Paths // System include directories to be included with -isystem
697 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900698 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900699 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700700}
701
Chris Parsons3c27ca32020-11-20 12:42:07 -0500702// exportedIncludes returns the effective include paths for this module and
703// any module that links against this module. This is obtained from
704// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700705func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900706 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800707 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700708 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900709 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
710 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
711 }
712 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700713}
714
Chris Parsons3c27ca32020-11-20 12:42:07 -0500715// exportIncludes registers the include directories and system include directories to be exported
716// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900717func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900718 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900719 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700720}
721
Chris Parsons3c27ca32020-11-20 12:42:07 -0500722// exportIncludesAsSystem registers the include directories and system include directories to be
723// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900724func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900725 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900726 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900727 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900728}
729
Chris Parsons3c27ca32020-11-20 12:42:07 -0500730// reexportDirs registers the given directories as include directories to be exported transitively
731// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900732func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900733 f.dirs = append(f.dirs, dirs...)
734}
735
Chris Parsons3c27ca32020-11-20 12:42:07 -0500736// reexportSystemDirs registers the given directories as system include directories
737// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900738func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900739 f.systemDirs = append(f.systemDirs, dirs...)
740}
741
Chris Parsons3c27ca32020-11-20 12:42:07 -0500742// reexportFlags registers the flags to be exported transitively to modules depending on this
743// module.
Inseob Kim69378442019-06-03 19:10:47 +0900744func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800745 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
746 panic(fmt.Errorf("Exporting invalid flag %q: "+
747 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900748 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700749 f.flags = append(f.flags, flags...)
750}
751
Inseob Kim69378442019-06-03 19:10:47 +0900752func (f *flagExporter) reexportDeps(deps ...android.Path) {
753 f.deps = append(f.deps, deps...)
754}
755
Inseob Kimd110f872019-12-06 13:15:38 +0900756// addExportedGeneratedHeaders does nothing but collects generated header files.
757// This can be differ to exportedDeps which may contain phony files to minimize ninja.
758func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
759 f.headers = append(f.headers, headers...)
760}
761
Colin Cross0de8a1e2020-09-18 14:15:30 -0700762func (f *flagExporter) setProvider(ctx android.ModuleContext) {
763 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400764 // Comes from Export_include_dirs property, and those of exported transitive deps
765 IncludeDirs: android.FirstUniquePaths(f.dirs),
766 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700767 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400768 // Used in very few places as a one-off way of adding extra defines.
769 Flags: f.flags,
770 // Used sparingly, for extra files that need to be explicitly exported to dependers,
771 // or for phony files to minimize ninja.
772 Deps: f.deps,
773 // For exported generated headers, such as exported aidl headers, proto headers, or
774 // sysprop headers.
775 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700776 })
Inseob Kim69378442019-06-03 19:10:47 +0900777}
778
Colin Crossb916a382016-07-29 17:28:03 -0700779// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
780// functionality: static vs. shared linkage, reusing object files for shared libraries
781type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800782 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700783 StaticProperties StaticProperties
784 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800785 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700786
787 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900788 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700789
Colin Cross26c34ed2016-09-30 17:10:16 -0700790 // table-of-contents file to optimize out relinking when possible
791 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700792
Colin Cross4d9c2d12016-07-29 12:48:20 -0700793 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400794 flagExporterInfo *FlagExporterInfo
795 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700796
Colin Cross4d9c2d12016-07-29 12:48:20 -0700797 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800798 objects Objects
799 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700800
801 // Uses the module's name if empty, but can be overridden. Does not include
802 // shlib suffix.
803 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700804
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800805 sabi *sabi
806
Dan Willemsen581341d2017-02-09 16:16:31 -0800807 // Output archive of gcno coverage information files
808 coverageOutputFile android.OptionalPath
809
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800810 // linked Source Abi Dump
811 sAbiOutputFile android.OptionalPath
812
813 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800814 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000815
Colin Cross0875c522017-11-28 17:34:01 -0800816 // Location of the static library in the sysroot. Empty if the library is
817 // not included in the NDK.
818 ndkSysrootPath android.Path
819
Colin Crossb60190a2018-09-04 16:28:17 -0700820 // Location of the linked, unstripped library for shared libraries
821 unstrippedOutputFile android.Path
822
Dan Willemsen569edc52018-11-19 09:33:29 -0800823 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000824 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800825
Colin Cross8e21aa52020-09-28 18:28:02 -0700826 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900827
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800828 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900829
Vic Yangefd249e2018-11-12 20:19:56 -0800830 // If useCoreVariant is true, the vendor variant of a VNDK library is
831 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800832 useCoreVariant bool
833 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800834
Colin Cross5ec407b2020-09-30 11:41:33 -0700835 skipAPIDefine bool
836
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100837 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700838 *baseCompiler
839 *baseLinker
840 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900841
842 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700843
844 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900845}
846
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400847type ccLibraryBazelHandler struct {
Chris Parsons808d84c2021-03-09 20:43:32 -0500848 module *Module
849}
850
Chris Parsons6ce2cf92022-05-20 10:54:17 -0400851var _ BazelHandler = (*ccLibraryBazelHandler)(nil)
852
Chris Parsons94a0bba2021-06-04 15:03:47 -0400853// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
854// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400855func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400856 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400857 if len(rootStaticArchives) != 1 {
858 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsonsf874e462022-05-10 13:50:12 -0400859 return
Chris Parsons944e7d02021-03-11 11:08:46 -0500860 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400861 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500862 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
863
Chris Parsons94a0bba2021-06-04 15:03:47 -0400864 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500865 objFiles := make(android.Paths, len(objPaths))
866 for i, objPath := range objPaths {
867 objFiles[i] = android.PathForBazelOut(ctx, objPath)
868 }
869 objects := Objects{
870 objFiles: objFiles,
871 }
872
873 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
874 StaticLibrary: outputFilePath,
875 ReuseObjects: objects,
876 Objects: objects,
877
Chris Parsons94a0bba2021-06-04 15:03:47 -0400878 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500879 // static libraries with deps.
880 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
881 Direct(outputFilePath).
882 Build(),
883 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400884
Chris Parsonsf874e462022-05-10 13:50:12 -0400885 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400886}
887
888// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
889// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400890func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400891 rootDynamicLibraries := ccInfo.RootDynamicLibraries
892
893 if len(rootDynamicLibraries) != 1 {
894 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
Chris Parsonsf874e462022-05-10 13:50:12 -0400895 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400896 }
897 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
898 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
899
Sasha Smundakedd16662022-10-07 14:44:50 -0700900 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = android.PathForBazelOut(ctx, ccInfo.UnstrippedOutput)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400901
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000902 var tocFile android.OptionalPath
903 if len(ccInfo.TocFile) > 0 {
904 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
905 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400906 handler.module.linker.(*libraryDecorator).tocFile = tocFile
907
Yu Liu24214aa2022-11-22 12:30:59 -0800908 if len(ccInfo.AbiDiffFiles) > 0 {
909 handler.module.linker.(*libraryDecorator).sAbiDiff = android.PathsForBazelOut(ctx, ccInfo.AbiDiffFiles)
910 }
911
Chris Parsons94a0bba2021-06-04 15:03:47 -0400912 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
913 TableOfContents: tocFile,
914 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000915 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400916 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000917 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400918 })
Chris Parsons94a0bba2021-06-04 15:03:47 -0400919}
920
Chris Parsonsf874e462022-05-10 13:50:12 -0400921func (handler *ccLibraryBazelHandler) QueueBazelCall(ctx android.BaseModuleContext, label string) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400922 bazelCtx := ctx.Config().BazelContext
Chris Parsonsf874e462022-05-10 13:50:12 -0400923 bazelCtx.QueueBazelRequest(label, cquery.GetCcInfo, android.GetConfigKey(ctx))
924}
925
926func (handler *ccLibraryBazelHandler) ProcessBazelQueryResponse(ctx android.ModuleContext, label string) {
927 bazelCtx := ctx.Config().BazelContext
928 ccInfo, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400929 if err != nil {
930 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
Chris Parsonsf874e462022-05-10 13:50:12 -0400931 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400932 }
933
934 if handler.module.static() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400935 handler.generateStaticBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400936 } else if handler.module.Shared() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400937 handler.generateSharedBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400938 } else {
Chris Parsonsf874e462022-05-10 13:50:12 -0400939 ctx.ModuleErrorf("Unhandled bazel case for %s (neither shared nor static!)", ctx.ModuleName())
Chris Parsons94a0bba2021-06-04 15:03:47 -0400940 }
941
942 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
943 handler.module.maybeUnhideFromMake()
944
Chris Parsonseefc9e62021-04-02 17:36:47 -0400945 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
946 // Dependencies on this library will expect collectedSnapshotHeaders to
947 // be set, otherwise validation will fail. For now, set this to an empty
948 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400949 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400950 // implementation.
951 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
952 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500953}
954
Chris Parsons94a0bba2021-06-04 15:03:47 -0400955func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
956 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
957 // flag exporters consolidates properties like includes, flags, dependencies that should be
958 // exported from this module to other modules
959 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
960 // Store flag info to be passed along to androidmk
961 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
962 library.flagExporterInfo = &flagExporterInfo
963}
964
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400965func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900966 ret := android.Paths{}
967
968 // Headers in the source tree should be globbed. On the contrast, generated headers
969 // can't be globbed, and they should be manually collected.
970 // So, we first filter out intermediate directories (which contains generated headers)
971 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400972 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900973 dir := path.String()
974 // Skip if dir is for generated headers
Spandan Das925cb2a2022-11-03 16:34:12 +0000975 if strings.HasPrefix(dir, ctx.Config().OutDir()) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900976 continue
977 }
Yu Liu1175c052022-08-15 10:21:31 -0700978
979 // Filter out the generated headers from bazel.
980 if strings.HasPrefix(dir, android.PathForBazelOut(ctx, "bazel-out").String()) {
981 continue
982 }
983
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900984 // libeigen wrongly exports the root directory "external/eigen". But only two
985 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
986 // some of them have no extension. So we need special treatment for libeigen in order
987 // to glob correctly.
988 if dir == "external/eigen" {
989 // Only these two directories contains exported headers.
990 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
Liz Kammer0ea79982022-02-07 08:51:47 -0500991 globDir := "external/eigen/" + subdir + "/**/*"
992 glob, err := ctx.GlobWithDeps(globDir, nil)
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900993 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500994 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400995 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900996 }
997 for _, header := range glob {
998 if strings.HasSuffix(header, "/") {
999 continue
1000 }
1001 ext := filepath.Ext(header)
1002 if ext != "" && ext != ".h" {
1003 continue
1004 }
1005 ret = append(ret, android.PathForSource(ctx, header))
1006 }
1007 }
1008 continue
1009 }
Liz Kammer0ea79982022-02-07 08:51:47 -05001010 globDir := dir + "/**/*"
1011 glob, err := ctx.GlobWithDeps(globDir, nil)
Colin Crossec118d02021-01-22 18:05:59 +00001012 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -05001013 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001014 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001015 }
Colin Crossec118d02021-01-22 18:05:59 +00001016 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -07001017 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +00001018 if isLibcxx {
1019 // Glob all files under this special directory, because of C++ headers with no
1020 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -07001021 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001022 continue
1023 }
Colin Crossec118d02021-01-22 18:05:59 +00001024 } else {
1025 // Filter out only the files with extensions that are headers.
1026 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001027 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +00001028 if strings.HasSuffix(header, ext) {
1029 found = true
1030 break
1031 }
1032 }
1033 if !found {
1034 continue
1035 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001036 }
Jose Galmes0d736912021-03-30 11:00:06 -07001037 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001038 }
1039 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001040 return ret
1041}
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001042
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001043func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
1044 ret := android.Paths{}
1045 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001046 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
1047 if strings.HasSuffix(header.Base(), "-phony") {
1048 continue
1049 }
1050 ret = append(ret, header)
1051 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001052 return ret
1053}
1054
1055// collectHeadersForSnapshot collects all exported headers from library.
1056// It globs header files in the source tree for exported include directories,
1057// and tracks generated header files separately.
1058//
1059// This is to be called from GenerateAndroidBuildActions, and then collected
1060// header files can be retrieved by snapshotHeaders().
1061func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
1062 ret := android.Paths{}
1063
1064 // Headers in the source tree should be globbed. On the contrast, generated headers
1065 // can't be globbed, and they should be manually collected.
1066 // So, we first filter out intermediate directories (which contains generated headers)
1067 // from exported directories, and then glob headers under remaining directories.
1068 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
1069
1070 // Collect generated headers
1071 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001072
1073 l.collectedSnapshotHeaders = ret
1074}
1075
1076// This returns all exported header files, both generated ones and headers from source tree.
1077// collectHeadersForSnapshot() must be called before calling this.
1078func (l *libraryDecorator) snapshotHeaders() android.Paths {
1079 if l.collectedSnapshotHeaders == nil {
1080 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
1081 }
1082 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -07001083}
1084
Chris Parsons3c27ca32020-11-20 12:42:07 -05001085// linkerProps returns the list of properties structs relevant for this library. (For example, if
1086// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -07001087func (library *libraryDecorator) linkerProps() []interface{} {
1088 var props []interface{}
1089 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001090 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001091 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -08001092 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001093 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -07001094 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001095
1096 if library.MutatedProperties.BuildShared {
1097 props = append(props, &library.SharedProperties)
1098 }
1099 if library.MutatedProperties.BuildStatic {
1100 props = append(props, &library.StaticProperties)
1101 }
1102
1103 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -07001104}
1105
Chris Parsons3c27ca32020-11-20 12:42:07 -05001106// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
1107// library, or that are implied by attributes of this library (such as whether this library is a
1108// shared library).
Colin Crossb916a382016-07-29 17:28:03 -07001109func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -07001110 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001111
Colin Crossb916a382016-07-29 17:28:03 -07001112 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
1113 // all code is position independent, and then those warnings get promoted to
1114 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -07001115 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001116 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -07001117 }
1118
1119 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001120 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001121 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001122 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -07001123 }
1124
Colin Crossa48ab5b2017-02-14 15:28:44 -08001125 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001126 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001127 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -07001128 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001129 f = append(f,
1130 "-nostdlib",
1131 "-Wl,--gc-sections",
1132 )
1133 }
1134
1135 if ctx.Darwin() {
1136 f = append(f,
1137 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -07001138 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
1139 )
Colin Cross7863cf52016-10-20 10:47:21 -07001140 if ctx.Arch().ArchType == android.X86 {
1141 f = append(f,
1142 "-read_only_relocs suppress",
1143 )
1144 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001145 } else {
Josh Gao75a50a22019-06-07 17:58:59 -07001146 f = append(f, "-shared")
1147 if !ctx.Windows() {
1148 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
1149 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001150 }
1151
Colin Cross4af21ed2019-11-04 09:37:55 -08001152 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001153 }
1154
1155 return flags
1156}
1157
Chris Parsons3c27ca32020-11-20 12:42:07 -05001158// compilerFlags takes a Flags and augments it to contain compile flags from global values,
1159// per-target values, module type values, per-module Blueprints properties, extra flags from
1160// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -08001161func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001162 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001163 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -07001164 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -08001165 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
1166 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001167 }
1168
Jiyong Park7ed9de32018-10-15 22:25:07 +09001169 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -08001170 if ctx.IsLlndk() {
1171 // LLNDK libraries ignore most of the properties on the cc_library and use the
1172 // LLNDK-specific properties instead.
1173 // Wipe all the module-local properties, leaving only the global properties.
1174 flags.Local = LocalOrGlobalFlags{}
1175 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001176 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +09001177 // Remove -include <file> when compiling stubs. Otherwise, the force included
1178 // headers might cause conflicting types error with the symbols in the
1179 // generated stubs source code. e.g.
1180 // double acos(double); // in header
1181 // void acos() {} // in the generated source code
1182 removeInclude := func(flags []string) []string {
1183 ret := flags[:0]
1184 for _, f := range flags {
1185 if strings.HasPrefix(f, "-include ") {
1186 continue
1187 }
1188 ret = append(ret, f)
1189 }
1190 return ret
1191 }
Colin Cross4af21ed2019-11-04 09:37:55 -08001192 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
1193 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +09001194
Jiyong Park7ed9de32018-10-15 22:25:07 +09001195 flags = addStubLibraryCompilerFlags(flags)
1196 }
1197 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -07001198}
1199
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001200func (library *libraryDecorator) headerAbiCheckerEnabled() bool {
1201 return Bool(library.Properties.Header_abi_checker.Enabled)
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001202}
1203
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001204func (library *libraryDecorator) headerAbiCheckerExplicitlyDisabled() bool {
1205 return !BoolDefault(library.Properties.Header_abi_checker.Enabled, true)
Logan Chien41eabe62019-04-10 13:33:58 +08001206}
1207
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001208func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -08001209 if ctx.IsLlndk() {
1210 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
1211 vndkVer := ctx.Module().(*Module).VndkVersion()
1212 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
1213 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
1214 vndkVer = "current"
1215 }
1216 if library.stubsVersion() != "" {
1217 vndkVer = library.stubsVersion()
1218 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001219 nativeAbiResult := parseNativeAbiDefinition(ctx,
1220 String(library.Properties.Llndk.Symbol_file),
1221 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
1222 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -08001223 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001224 library.versionScriptPath = android.OptionalPathForPath(
1225 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -08001226 }
1227 return objs
1228 }
Colin Cross5271fea2021-04-27 13:06:04 -07001229 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -07001230 nativeAbiResult := parseNativeAbiDefinition(ctx,
1231 String(library.Properties.Vendor_public_library.Symbol_file),
1232 android.FutureApiLevel, "")
1233 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001234 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001235 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001236 }
1237 return objs
1238 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001239 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001240 symbolFile := String(library.Properties.Stubs.Symbol_file)
1241 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1242 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1243 return Objects{}
1244 }
Jiyong Park85cc35a2022-07-17 11:30:47 +09001245 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
1246 // systemapi, respectively. The former is for symbols defined in platform libraries
1247 // and the latter is for symbols defined in APEXes.
1248 var flag string
1249 if ctx.Module().(android.ApexModule).NotInPlatform() {
1250 flag = "--apex"
1251 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +09001252 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +09001253 }
Jiyong Parkaa27c082022-09-26 21:16:09 +09001254 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
1255 // the stub so that it is mandated that all symbols are explicitly marked with
1256 // either apex or systemapi.
1257 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
1258 flag = flag + " --no-ndk"
1259 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001260 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +09001261 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -07001262 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1263 library.versionScriptPath = android.OptionalPathForPath(
1264 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001265
1266 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001267 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001268 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1269 }
1270
Jiyong Park7ed9de32018-10-15 22:25:07 +09001271 return objs
1272 }
1273
Colin Cross5950f382016-12-13 12:50:57 -08001274 if !library.buildShared() && !library.buildStatic() {
1275 if len(library.baseCompiler.Properties.Srcs) > 0 {
1276 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1277 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001278 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001279 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1280 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001281 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001282 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1283 }
1284 return Objects{}
1285 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001286 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001287 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001288 var SourceAbiFlags []string
1289 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001290 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001291 }
Inseob Kim69378442019-06-03 19:10:47 +09001292 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1293 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001294 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001295 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001296 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001297 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001298 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001299 flags.SAbiDump = true
1300 }
1301 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001302 objs := library.baseCompiler.compile(ctx, flags, deps)
1303 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001304 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001305
Colin Cross4d9c2d12016-07-29 12:48:20 -07001306 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001307 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001308 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1309 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001310 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001311 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001312 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001313 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001314 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1315 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001316 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001317 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001318 }
1319
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001320 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001321}
1322
1323type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001324 versionedInterface
1325
Colin Crossb916a382016-07-29 17:28:03 -07001326 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001327 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001328 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001329 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001330 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001331
1332 // Returns true if the build options for the module have selected a static or shared build
1333 buildStatic() bool
1334 buildShared() bool
1335
1336 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001337 setStatic()
1338 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001339
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001340 // Check whether header_abi_checker is enabled or explicitly disabled.
1341 headerAbiCheckerEnabled() bool
1342 headerAbiCheckerExplicitlyDisabled() bool
1343
Logan Chien41eabe62019-04-10 13:33:58 +08001344 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1345 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001346
1347 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001348
1349 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001350
1351 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001352}
1353
Colin Crossc88c2722020-09-28 17:32:47 -07001354type versionedInterface interface {
1355 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001356 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001357 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +00001358 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001359 setStubsVersion(string)
1360 stubsVersion() string
1361
Colin Cross3572cf72020-10-01 15:58:11 -07001362 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001363 setAllStubsVersions([]string)
1364 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001365
1366 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001367 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001368 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001369 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001370}
1371
1372var _ libraryInterface = (*libraryDecorator)(nil)
1373var _ versionedInterface = (*libraryDecorator)(nil)
1374
Justin Yun6977e8a2020-10-29 18:24:11 +09001375func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001376 name := library.libName
1377 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001378 name = String(library.Properties.Stem)
1379 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001380 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001381 }
Colin Crossb916a382016-07-29 17:28:03 -07001382 }
1383
Colin Cross0fd6a412019-08-16 14:22:10 -07001384 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001385 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001386 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001387 } else if inProduct {
1388 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001389 }
1390 if suffix == "" {
1391 suffix = String(library.Properties.Suffix)
1392 }
1393
Jooyung Han0302a842019-10-30 18:43:49 +09001394 return name + suffix
1395}
1396
Chris Parsons3c27ca32020-11-20 12:42:07 -05001397// getLibName returns the actual canonical name of the library (the name which
1398// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001399func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001400 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001401
Ivan Lozanof9e21722020-12-02 09:00:51 -05001402 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001403 // vndk-ext lib should have the same name with original lib
1404 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1405 originalName := module.(*Module).outputFile.Path()
1406 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1407 })
Logan Chienf3511742017-10-31 18:04:35 +08001408 }
1409
Colin Crossb916a382016-07-29 17:28:03 -07001410 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1411 if !strings.HasSuffix(name, "-host") {
1412 name = name + "-host"
1413 }
1414 }
1415
Inseob Kim0ce291e2019-07-04 14:38:27 +09001416 return name
Colin Crossb916a382016-07-29 17:28:03 -07001417}
1418
Jiyong Parkda732bd2018-11-02 18:23:15 +09001419var versioningMacroNamesListMutex sync.Mutex
1420
Colin Crossb916a382016-07-29 17:28:03 -07001421func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1422 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001423 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001424 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001425 }
1426 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001427 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001428 // Let baseLinker know whether this variant is for stubs or not, so that
1429 // it can omit things that are not required for linking stubs.
1430 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001431
1432 if library.buildStubs() {
1433 macroNames := versioningMacroNamesList(ctx.Config())
1434 myName := versioningMacroName(ctx.ModuleName())
1435 versioningMacroNamesListMutex.Lock()
1436 defer versioningMacroNamesListMutex.Unlock()
1437 if (*macroNames)[myName] == "" {
1438 (*macroNames)[myName] = ctx.ModuleName()
1439 } else if (*macroNames)[myName] != ctx.ModuleName() {
1440 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1441 }
1442 }
Colin Crossb916a382016-07-29 17:28:03 -07001443}
1444
dimitry0345ad82018-12-05 16:28:14 +01001445func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001446 if ctx.IsLlndk() {
1447 // LLNDK libraries ignore most of the properties on the cc_library and use the
1448 // LLNDK-specific properties instead.
1449 return deps
1450 }
1451
dimitry0345ad82018-12-05 16:28:14 +01001452 deps = library.baseCompiler.compilerDeps(ctx, deps)
1453
dimitry0345ad82018-12-05 16:28:14 +01001454 return deps
1455}
1456
Colin Cross37047f12016-12-13 17:06:13 -08001457func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001458 if ctx.IsLlndk() {
1459 // LLNDK libraries ignore most of the properties on the cc_library and use the
1460 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001461 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1462 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001463 return deps
1464 }
Colin Cross5271fea2021-04-27 13:06:04 -07001465 if ctx.IsVendorPublicLibrary() {
1466 headers := library.Properties.Vendor_public_library.Export_public_headers
1467 deps.HeaderLibs = append([]string(nil), headers...)
1468 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1469 return deps
1470 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001471
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001472 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001473 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001474 if library.StaticProperties.Static.System_shared_libs != nil {
1475 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001476 }
1477 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001478 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001479 if library.SharedProperties.Shared.System_shared_libs != nil {
1480 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001481 }
1482 }
1483
Colin Crossb916a382016-07-29 17:28:03 -07001484 deps = library.baseLinker.linkerDeps(ctx, deps)
1485
1486 if library.static() {
1487 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001488 library.StaticProperties.Static.Whole_static_libs...)
1489 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1490 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001491
Colin Crosse1bb5d02019-09-24 14:55:04 -07001492 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1493 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001494 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001495 if !Bool(library.baseLinker.Properties.Nocrt) {
1496 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1497 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001498 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001499 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1500 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1501 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001502
Colin Crosse1bb5d02019-09-24 14:55:04 -07001503 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1504 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001505 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001506 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001507 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1508 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1509 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001510 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1511 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001512 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001513 if ctx.inProduct() {
1514 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1515 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1516 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1517 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1518 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1519 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001520 if ctx.inRecovery() {
1521 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1522 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1523 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001524 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1525 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001526 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001527 if ctx.inRamdisk() {
1528 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1529 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1530 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1531 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1532 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1533 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001534 if ctx.inVendorRamdisk() {
1535 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1536 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1537 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1538 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1539 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1540 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001541
Colin Cross4d9c2d12016-07-29 12:48:20 -07001542 return deps
1543}
1544
Paul Duffin13f02712020-03-06 12:30:43 +00001545func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1546 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1547 var properties StaticOrSharedProperties
1548 if library.static() {
1549 properties = library.StaticProperties.Static
1550 } else if library.shared() {
1551 properties = library.SharedProperties.Shared
1552 }
1553
1554 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001555
1556 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1557 // either input list doesn't come out as nil.
1558 if specifiedDeps.systemSharedLibs == nil {
1559 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1560 } else {
1561 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1562 }
Paul Duffin13f02712020-03-06 12:30:43 +00001563
1564 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001565 if len(specifiedDeps.systemSharedLibs) > 0 {
1566 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1567 // retained.
1568 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1569 }
Paul Duffin13f02712020-03-06 12:30:43 +00001570 return specifiedDeps
1571}
1572
Colin Crossb916a382016-07-29 17:28:03 -07001573func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001574 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001575
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001576 library.objects = deps.WholeStaticLibObjs.Copy()
1577 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001578 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001579
Inseob Kim0ce291e2019-07-04 14:38:27 +09001580 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001581 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001582 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001583
Dan Willemsen569edc52018-11-19 09:33:29 -08001584 if Bool(library.baseLinker.Properties.Use_version_lib) {
1585 if ctx.Host() {
1586 versionedOutputFile := outputFile
1587 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1588 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1589 } else {
1590 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001591 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001592 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1593 }
Colin Cross86803cf2018-02-15 14:12:26 -08001594 }
1595
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001596 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001597
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001598 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001599
Colin Cross4d9c2d12016-07-29 12:48:20 -07001600 ctx.CheckbuildFile(outputFile)
1601
Colin Cross649d8172020-12-10 12:30:21 -08001602 if library.static() {
1603 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001604 StaticLibrary: outputFile,
1605 ReuseObjects: library.reuseObjects,
1606 Objects: library.objects,
1607 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001608
Colin Cross649d8172020-12-10 12:30:21 -08001609 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1610 Direct(outputFile).
1611 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1612 Build(),
1613 })
1614 }
1615
1616 if library.header() {
1617 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1618 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001619
Colin Cross4d9c2d12016-07-29 12:48:20 -07001620 return outputFile
1621}
1622
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001623func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1624 if ctx.Module().(*Module).IsSdkVariant() {
1625 // The NDK sysroot timestamp file depends on all the NDK
1626 // sysroot header and shared library files.
1627 return android.Paths{getNdkBaseTimestampFile(ctx)}
1628 }
1629 return nil
1630}
1631
Colin Crossb916a382016-07-29 17:28:03 -07001632func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001633 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001634
1635 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001636 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001637 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001638
Colin Cross2383f3b2018-02-06 14:40:13 -08001639 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1640 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1641 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001642 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001643 if unexportedSymbols.Valid() {
1644 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1645 }
1646 if forceNotWeakSymbols.Valid() {
1647 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1648 }
1649 if forceWeakSymbols.Valid() {
1650 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1651 }
1652 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001653 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001654 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001655 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1656 }
1657 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001658 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001659 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1660 }
1661 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001662 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001663 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1664 }
1665 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001666 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001667 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001668 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001669 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001670 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001671
1672 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1673 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001674 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001675
Josh Gao75a50a22019-06-07 17:58:59 -07001676 var implicitOutputs android.WritablePaths
1677 if ctx.Windows() {
1678 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1679
Colin Cross4af21ed2019-11-04 09:37:55 -08001680 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001681 implicitOutputs = append(implicitOutputs, importLibraryPath)
1682 }
1683
Colin Cross4d9c2d12016-07-29 12:48:20 -07001684 builderFlags := flagsToBuilderFlags(flags)
1685
Dan Willemsen47450072021-10-19 20:24:49 -07001686 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1687 fatOutputFile := outputFile
1688 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1689 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1690 }
1691
Colin Crossb496cfd2018-09-10 16:50:05 -07001692 // Optimize out relinking against shared libraries whose interface hasn't changed by
1693 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001694 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001695 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001696 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001697
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001698 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001699 needsStrip := library.stripper.NeedsStrip(ctx)
1700 if library.buildStubs() {
1701 // No need to strip stubs libraries
1702 needsStrip = false
1703 }
1704 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001705 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001706 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001707 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001708 strippedOutputFile := outputFile
1709 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001710 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001711 }
Colin Crossb60190a2018-09-04 16:28:17 -07001712 library.unstrippedOutputFile = outputFile
1713
Colin Crossd7227f92019-09-05 14:26:33 -07001714 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001715
Dan Willemsen569edc52018-11-19 09:33:29 -08001716 if Bool(library.baseLinker.Properties.Use_version_lib) {
1717 if ctx.Host() {
1718 versionedOutputFile := outputFile
1719 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1720 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1721 } else {
1722 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001723 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001724
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001725 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001726 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001727 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001728 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001729 }
1730
1731 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1732 }
Colin Cross86803cf2018-02-15 14:12:26 -08001733 }
1734
Jiyong Park64a44f22019-01-18 14:37:08 +09001735 sharedLibs := deps.EarlySharedLibs
1736 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001737 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1738
Jiyong Park64a44f22019-01-18 14:37:08 +09001739 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001740 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1741 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001742 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001743 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001744 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001745
Dan Willemsen581341d2017-02-09 16:16:31 -08001746 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1747 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001748 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1749 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1750
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001751 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001752 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001753
Liz Kammeref6dfea2021-06-08 15:37:09 -04001754 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001755 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1756 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001757 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001758 }
1759
1760 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001761 TableOfContents: android.OptionalPathForPath(tocFile),
1762 SharedLibrary: unstrippedOutputFile,
1763 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1764 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001765 })
1766
1767 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1768 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001769 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001770 for _, stub := range stubs {
1771 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1772 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001773 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001774 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001775 SharedLibraryInfo: stubInfo,
1776 FlagExporterInfo: flagInfo,
1777 })
1778 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001779 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1780 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001781
Colin Cross127bb8b2020-12-16 16:46:01 -08001782 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001783 })
1784 }
1785
1786 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001787}
1788
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001789func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1790 return library.unstrippedOutputFile
1791}
1792
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001793func (library *libraryDecorator) disableStripping() {
1794 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1795}
1796
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001797func (library *libraryDecorator) nativeCoverage() bool {
1798 if library.header() || library.buildStubs() {
1799 return false
1800 }
1801 return true
1802}
1803
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001804func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1805 return library.coverageOutputFile
1806}
1807
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001808func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1809 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001810
1811 currentArchType := ctx.Arch().ArchType
1812 primaryArchType := ctx.Config().DevicePrimaryArchType()
1813 archName := currentArchType.String()
1814 if currentArchType != primaryArchType {
1815 archName += "_" + primaryArchType.String()
1816 }
1817
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001818 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001819 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001820}
1821
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001822func getRefAbiDumpDir(isNdk, isVndk bool) string {
1823 var dirName string
1824 if isNdk {
1825 dirName = "ndk"
1826 } else if isVndk {
1827 dirName = "vndk"
1828 } else {
1829 dirName = "platform"
1830 }
1831 return filepath.Join("prebuilts", "abi-dumps", dirName)
1832}
Logan Chien7eefdc42018-07-11 18:10:41 +08001833
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001834func prevRefAbiDumpVersion(ctx ModuleContext, dumpDir string) int {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001835 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
1836 sdkVersionStr := ctx.Config().PlatformSdkVersion().String()
1837
1838 if ctx.Config().PlatformSdkFinal() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001839 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001840 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001841 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1842 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1843 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001844 versionedDumpDir := android.ExistentPathForSource(ctx, dumpDir, sdkVersionStr)
1845 if versionedDumpDir.Valid() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001846 return sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001847 } else {
Mu-Le Lee13043932022-08-27 08:55:25 +00001848 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001849 }
1850 }
1851}
1852
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001853func currRefAbiDumpVersion(ctx ModuleContext, isVndk bool) string {
1854 if isVndk {
1855 // Each version of VNDK is independent, so follow the VNDK version which is the codename or PLATFORM_SDK_VERSION.
1856 return ctx.Module().(*Module).VndkVersion()
1857 } else if ctx.Config().PlatformSdkFinal() {
1858 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1859 // so choose PLATFORM_SDK_VERSION as the current version.
1860 return ctx.Config().PlatformSdkVersion().String()
1861 } else {
1862 return "current"
1863 }
1864}
1865
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001866// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
1867func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1868 baseName, nameExt string, isLlndkOrNdk, allowExtensions bool,
1869 sourceVersion, errorMessage string) {
1870
1871 sourceDump := library.sAbiOutputFile.Path()
1872
1873 extraFlags := []string{"-target-version", sourceVersion}
1874 if Bool(library.Properties.Header_abi_checker.Check_all_apis) {
1875 extraFlags = append(extraFlags, "-check-all-apis")
1876 } else {
1877 extraFlags = append(extraFlags,
1878 "-allow-unreferenced-changes",
1879 "-allow-unreferenced-elf-symbol-changes")
1880 }
1881 if isLlndkOrNdk {
1882 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1883 }
1884 if allowExtensions {
1885 extraFlags = append(extraFlags, "-allow-extensions")
1886 }
1887 extraFlags = append(extraFlags, library.Properties.Header_abi_checker.Diff_flags...)
1888
1889 library.sAbiDiff = append(
1890 library.sAbiDiff,
1891 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1892 baseName, nameExt, extraFlags, errorMessage))
1893}
1894
1895func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1896 baseName string, isLlndkOrNdk bool, sourceVersion, prevVersion string) {
1897
1898 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 + "."
1899
1900 library.sourceAbiDiff(ctx, referenceDump, baseName, prevVersion,
1901 isLlndkOrNdk, /* allowExtensions */ true, sourceVersion, errorMessage)
1902}
1903
1904func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1905 baseName string, isLlndkOrNdk, allowExtensions bool) {
1906
1907 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1908 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName
1909
1910 library.sourceAbiDiff(ctx, referenceDump, baseName, /* nameExt */ "",
1911 isLlndkOrNdk, allowExtensions, "current", errorMessage)
1912}
1913
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001914func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001915 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001916 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001917 var SourceAbiFlags []string
1918 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001919 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1920 }
Inseob Kim69378442019-06-03 19:10:47 +09001921 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1922 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001923 }
1924 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001925 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001926 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001927 library.Properties.Header_abi_checker.Exclude_symbol_versions,
1928 library.Properties.Header_abi_checker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001929
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001930 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001931
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001932 // The logic must be consistent with classifySourceAbiDump.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001933 isVndk := ctx.useVndk() && ctx.isVndk()
Hsin-Yi Chen7584bda2022-11-08 22:51:02 +08001934 isNdk := ctx.isNdk(ctx.Config())
1935 isLlndk := ctx.isImplementationForLLNDKPublic()
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001936 dumpDir := getRefAbiDumpDir(isNdk, isVndk)
1937 binderBitness := ctx.DeviceConfig().BinderBitness()
Mu-Le Lee13043932022-08-27 08:55:25 +00001938 // If NDK or PLATFORM library, check against previous version ABI.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001939 if !isVndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001940 prevVersionInt := prevRefAbiDumpVersion(ctx, dumpDir)
1941 prevVersion := strconv.Itoa(prevVersionInt)
1942 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1943 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001944 if prevDumpFile.Valid() {
1945 library.crossVersionAbiDiff(ctx, prevDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001946 fileName, isLlndk || isNdk,
1947 strconv.Itoa(prevVersionInt+1), prevVersion)
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001948 }
1949 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001950 // Check against the current version.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001951 currVersion := currRefAbiDumpVersion(ctx, isVndk)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001952 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1953 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001954 if currDumpFile.Valid() {
1955 library.sameVersionAbiDiff(ctx, currDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001956 fileName, isLlndk || isNdk, ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001957 }
1958 }
1959}
1960
Inseob Kimcc12d902021-05-14 20:15:55 +09001961func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001962 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1963 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1964
Colin Cross127bb8b2020-12-16 16:46:01 -08001965 for _, header := range srcFiles {
1966 headerDir := filepath.Dir(header.String())
1967 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1968 if err != nil {
1969 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1970 srcDir.String(), headerDir, err)
1971 continue
1972 }
1973
1974 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1975 }
1976
Inseob Kimcc12d902021-05-14 20:15:55 +09001977 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001978}
1979
Chris Parsons3c27ca32020-11-20 12:42:07 -05001980// link registers actions to link this library, and sets various fields
1981// on this library to reflect information that should be exported up the build
1982// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07001983func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001984 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001985
Colin Cross127bb8b2020-12-16 16:46:01 -08001986 if ctx.IsLlndk() {
1987 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
1988 // This is the vendor variant of an LLNDK library with preprocessed headers.
1989 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
1990
1991 var timestampFiles android.Paths
1992 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09001993 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
1994 timestampFiles = append(timestampFiles, timestampFile)
1995 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001996 }
1997
1998 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1999 library.reexportSystemDirs(genHeaderOutDir)
2000 } else {
2001 library.reexportDirs(genHeaderOutDir)
2002 }
2003
2004 library.reexportDeps(timestampFiles...)
2005 }
2006
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002007 // override the module's export_include_dirs with llndk.override_export_include_dirs
2008 // if it is set.
2009 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
2010 library.flagExporter.Properties.Export_include_dirs = override
2011 }
2012
Colin Cross127bb8b2020-12-16 16:46:01 -08002013 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2014 library.flagExporter.Properties.Export_system_include_dirs = append(
2015 library.flagExporter.Properties.Export_system_include_dirs,
2016 library.flagExporter.Properties.Export_include_dirs...)
2017 library.flagExporter.Properties.Export_include_dirs = nil
2018 }
2019 }
2020
Colin Cross5271fea2021-04-27 13:06:04 -07002021 if ctx.IsVendorPublicLibrary() {
2022 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
2023 // if it is set.
2024 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
2025 library.flagExporter.Properties.Export_include_dirs = override
2026 }
2027 }
2028
Chris Parsons3c27ca32020-11-20 12:42:07 -05002029 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
2030 // of this library), together with `objs` (.o files created by compiling this
2031 // library).
Colin Crossad59e752017-11-16 14:29:11 -08002032 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002033 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08002034 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002035 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002036 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002037 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002038 }
2039
Chris Parsons3c27ca32020-11-20 12:42:07 -05002040 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09002041 library.exportIncludes(ctx)
2042 library.reexportDirs(deps.ReexportedDirs...)
2043 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
2044 library.reexportFlags(deps.ReexportedFlags...)
2045 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09002046 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002047
Chris Parsons3c27ca32020-11-20 12:42:07 -05002048 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002049 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002050 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09002051 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09002052 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09002053
Paul Duffin33056e82021-02-19 13:49:08 +00002054 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
2055 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07002056 }
2057 }
2058
Chris Parsons3c27ca32020-11-20 12:42:07 -05002059 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002060 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002061 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09002062 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07002063 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09002064 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07002065 }
Jiyong Park74955042019-10-22 20:19:51 +09002066 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09002067 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09002068
Paul Duffin33056e82021-02-19 13:49:08 +00002069 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
2070 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07002071 }
2072 }
2073
Inseob Kim07def122020-11-23 14:43:02 +09002074 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09002075 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09002076 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002077 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09002078 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
2079
Inseob Kim07def122020-11-23 14:43:02 +09002080 // If the owner is different from the user, expose public header. That is,
2081 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09002082 // 2) if the owner is platform and the client is vendor
2083 // We don't care Platform -> Vendor dependency as it's already forbidden.
2084 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09002085 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002086 }
2087 }
2088
Paul Duffin37e0de52021-02-19 17:05:39 +00002089 // Make sure to only export headers which are within the include directory.
2090 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
2091 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
2092 return isRel
2093 })
2094
Chris Parsons3c27ca32020-11-20 12:42:07 -05002095 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09002096 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00002097 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00002098 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09002099 }
2100
Chris Parsons3c27ca32020-11-20 12:42:07 -05002101 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09002102 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002103
Chris Parsons3c27ca32020-11-20 12:42:07 -05002104 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002105 library.flagExporter.setProvider(ctx)
2106
Colin Cross4d9c2d12016-07-29 12:48:20 -07002107 return out
2108}
2109
Jiyong Park892a98f2020-12-14 09:20:00 +09002110func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002111 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09002112 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09002113 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
2114 if err != nil {
2115 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
2116 }
2117 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09002118 }
2119}
2120
Chris Parsons3c27ca32020-11-20 12:42:07 -05002121// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07002122func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002123 return library.MutatedProperties.BuildStatic &&
2124 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002125}
2126
Chris Parsons3c27ca32020-11-20 12:42:07 -05002127// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07002128func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002129 return library.MutatedProperties.BuildShared &&
2130 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002131}
2132
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002133func (library *libraryDecorator) objs() Objects {
2134 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002135}
2136
Colin Cross0de8a1e2020-09-18 14:15:30 -07002137func (library *libraryDecorator) reuseObjs() Objects {
2138 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002139}
2140
Colin Cross26c34ed2016-09-30 17:10:16 -07002141func (library *libraryDecorator) toc() android.OptionalPath {
2142 return library.tocFile
2143}
2144
Jiyong Parkf1194352019-02-25 11:05:47 +09002145func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
2146 dir := library.baseInstaller.installDir(ctx)
2147 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
2148 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
2149 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002150 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09002151}
2152
Colin Crossb916a382016-07-29 17:28:03 -07002153func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07002154 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09002155 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09002156 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05002157 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002158 if ctx.isVndkSp() {
2159 library.baseInstaller.subDir = "vndk-sp"
2160 } else {
2161 library.baseInstaller.subDir = "vndk"
2162 }
2163 }
2164
Justin Yun31094b12020-12-24 16:11:23 +09002165 // In some cases we want to use core variant for VNDK-Core libs.
2166 // Skip product variant since VNDKs use only the vendor variant.
2167 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08002168 mayUseCoreVariant := true
2169
2170 if ctx.mustUseVendorVariant() {
2171 mayUseCoreVariant = false
2172 }
2173
Elvis Chien9c993542021-06-25 01:15:17 +08002174 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08002175 mayUseCoreVariant = false
2176 }
2177
2178 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08002179 library.checkSameCoreVariant = true
2180 if ctx.DeviceConfig().VndkUseCoreVariant() {
2181 library.useCoreVariant = true
2182 }
Vic Yangefd249e2018-11-12 20:19:56 -08002183 }
Justin Yun8fe12122017-12-07 17:18:15 +09002184 }
Logan Chienf3511742017-10-31 18:04:35 +08002185
Jooyung Han261e1582020-10-20 18:54:21 +09002186 // do not install vndk libs
2187 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05002188 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002189 return
Justin Yun8effde42017-06-23 19:24:43 +09002190 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002191 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09002192 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
2193 // The original path becomes a symlink to the corresponding file in the
2194 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07002195 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07002196 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002197 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01002198 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09002199 library.installSymlinkToRuntimeApex(ctx, file)
2200 }
Jiyong Park429660f2019-01-16 22:31:11 +09002201 library.baseInstaller.subDir = "bootstrap"
2202 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002203 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002204 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002205 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09002206 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002207
Colin Cross4d9c2d12016-07-29 12:48:20 -07002208 library.baseInstaller.install(ctx, file)
2209 }
Dan Albertf563d252017-10-13 00:29:00 -07002210
Dan Albert281f22b2017-12-13 15:03:47 -08002211 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002212 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09002213 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08002214 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07002215 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07002216 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07002217
2218 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
2219 Rule: android.Cp,
2220 Description: "install " + installPath.Base(),
2221 Output: installPath,
2222 Input: file,
2223 })
2224
Colin Cross0875c522017-11-28 17:34:01 -08002225 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07002226 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002227}
2228
Paul Duffin0cb37b92020-03-04 14:52:46 +00002229func (library *libraryDecorator) everInstallable() bool {
2230 // Only shared and static libraries are installed. Header libraries (which are
2231 // neither static or shared) are not installed.
2232 return library.shared() || library.static()
2233}
2234
Chris Parsons3c27ca32020-11-20 12:42:07 -05002235// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07002236func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002237 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07002238}
2239
Chris Parsons3c27ca32020-11-20 12:42:07 -05002240// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002241func (library *libraryDecorator) shared() bool {
2242 return library.MutatedProperties.VariantIsShared
2243}
2244
Chris Parsons3c27ca32020-11-20 12:42:07 -05002245// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002246func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002247 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002248 return !library.static() && !library.shared()
2249}
2250
Chris Parsons3c27ca32020-11-20 12:42:07 -05002251// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002252func (library *libraryDecorator) setStatic() {
2253 library.MutatedProperties.VariantIsStatic = true
2254 library.MutatedProperties.VariantIsShared = false
2255}
2256
Chris Parsons3c27ca32020-11-20 12:42:07 -05002257// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002258func (library *libraryDecorator) setShared() {
2259 library.MutatedProperties.VariantIsStatic = false
2260 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07002261}
2262
Chris Parsons3c27ca32020-11-20 12:42:07 -05002263// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08002264func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002265 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08002266}
2267
Chris Parsons3c27ca32020-11-20 12:42:07 -05002268// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08002269func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002270 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08002271}
2272
Chris Parsons3c27ca32020-11-20 12:42:07 -05002273// HeaderOnly disables building this library as a shared or static library;
2274// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08002275func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002276 library.MutatedProperties.BuildShared = false
2277 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08002278}
2279
Colin Cross127bb8b2020-12-16 16:46:01 -08002280// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
2281func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07002282 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002283}
2284
Colin Cross203b4212021-04-26 17:19:41 -07002285// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07002286func (library *libraryDecorator) hasLLNDKHeaders() bool {
2287 return Bool(library.Properties.Llndk.Llndk_headers)
2288}
2289
Colin Cross5271fea2021-04-27 13:06:04 -07002290// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
2291// vendor public library stubs.
2292func (library *libraryDecorator) hasVendorPublicLibrary() bool {
2293 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
2294}
2295
Colin Cross0477b422020-10-13 18:43:54 -07002296func (library *libraryDecorator) implementationModuleName(name string) string {
2297 return name
2298}
2299
Jiyong Park7ed9de32018-10-15 22:25:07 +09002300func (library *libraryDecorator) buildStubs() bool {
2301 return library.MutatedProperties.BuildStubs
2302}
2303
Jiyong Parka034b832019-08-27 14:02:19 +09002304func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
2305 if library.Properties.Header_abi_checker.Symbol_file != nil {
2306 return library.Properties.Header_abi_checker.Symbol_file
2307 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002308 if ctx.Module().(*Module).IsLlndk() {
2309 return library.Properties.Llndk.Symbol_file
2310 }
Colin Cross31076b32020-10-23 17:22:06 -07002311 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09002312 return library.Properties.Stubs.Symbol_file
2313 }
2314 return nil
2315}
2316
Colin Crossc88c2722020-09-28 17:32:47 -07002317func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002318 // Just having stubs.symbol_file is enough to create a stub variant. In that case
2319 // the stub for the future API level is created.
2320 return library.Properties.Stubs.Symbol_file != nil ||
2321 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07002322}
2323
Alan Stokes73feba32022-11-14 12:21:24 +00002324func (library *libraryDecorator) isStubsImplementationRequired() bool {
2325 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
2326}
2327
Colin Cross3572cf72020-10-01 15:58:11 -07002328func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002329 if !library.hasStubsVariants() {
2330 return nil
2331 }
2332
Colin Crossc1b36442021-05-06 13:42:48 -07002333 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
2334 // LLNDK libraries only need a single stubs variant.
2335 return []string{android.FutureApiLevel.String()}
2336 }
2337
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002338 // Future API level is implicitly added if there isn't
2339 vers := library.Properties.Stubs.Versions
2340 if inList(android.FutureApiLevel.String(), vers) {
2341 return vers
2342 }
2343 // In some cases, people use the raw value "10000" in the versions property.
2344 // We shouldn't add the future API level in that case, otherwise there will
2345 // be two identical versions.
2346 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2347 return vers
2348 }
2349 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002350}
2351
2352func (library *libraryDecorator) setStubsVersion(version string) {
2353 library.MutatedProperties.StubsVersion = version
2354}
2355
Jiyong Park7ed9de32018-10-15 22:25:07 +09002356func (library *libraryDecorator) stubsVersion() string {
2357 return library.MutatedProperties.StubsVersion
2358}
2359
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002360func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002361 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002362 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002363}
2364
2365func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2366 library.MutatedProperties.AllStubsVersions = versions
2367}
2368
2369func (library *libraryDecorator) allStubsVersions() []string {
2370 return library.MutatedProperties.AllStubsVersions
2371}
2372
Jooyung Hanad4c1872020-02-27 17:56:44 +09002373func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002374 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002375}
2376
Jiyong Parka90ca002019-10-07 15:47:24 +09002377func (library *libraryDecorator) availableFor(what string) bool {
2378 var list []string
2379 if library.static() {
2380 list = library.StaticProperties.Static.Apex_available
2381 } else if library.shared() {
2382 list = library.SharedProperties.Shared.Apex_available
2383 }
2384 if len(list) == 0 {
2385 return false
2386 }
2387 return android.CheckAvailableForApex(what, list)
2388}
2389
Colin Cross1bc94122021-10-28 13:25:54 -07002390func (library *libraryDecorator) installable() *bool {
2391 if library.static() {
2392 return library.StaticProperties.Static.Installable
2393 } else if library.shared() {
2394 return library.SharedProperties.Shared.Installable
2395 }
2396 return nil
2397}
2398
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002399func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002400 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002401 // If we're asked to make a static library uninstallable we don't do
2402 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2403 // for these entries. This is done to still get the make targets for NOTICE
2404 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002405 return
2406 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002407 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002408}
2409
Jihoon Kangf78a8902022-09-01 22:47:07 +00002410func (library *libraryDecorator) getPartition() string {
2411 return library.path.Partition()
2412}
2413
Colin Crossceaa5322021-09-28 16:37:50 -07002414func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2415 return library.apiListCoverageXmlPath
2416}
2417
Inseob Kima1888ce2022-10-04 14:42:02 +09002418func (library *libraryDecorator) overriddenModules() []string {
2419 return library.Properties.Overrides
2420}
2421
2422var _ overridable = (*libraryDecorator)(nil)
2423
Colin Cross571cccf2019-02-04 11:22:08 -08002424var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2425
Chris Parsons3c27ca32020-11-20 12:42:07 -05002426// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2427// and values are the module name responsible for registering the version macro name.
2428//
2429// Version macros are used when building against stubs, to provide version information about
2430// the stub. Only stub libraries should have an entry in this list.
2431//
2432// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2433// that headers from libFoo can be conditionally compiled (this may hide APIs
2434// that are not available for the version).
2435//
2436// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002437func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002438 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002439 m := make(map[string]string)
2440 return &m
2441 }).(*map[string]string)
2442}
2443
2444// alphanumeric and _ characters are preserved.
2445// other characters are all converted to _
2446var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2447
Chris Parsons3c27ca32020-11-20 12:42:07 -05002448// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002449func versioningMacroName(moduleName string) string {
2450 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002451 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002452 return "__" + macroName + "_API__"
2453}
2454
Chris Parsons3c27ca32020-11-20 12:42:07 -05002455// NewLibrary builds and returns a new Module corresponding to a C++ library.
2456// Individual module implementations which comprise a C++ library (or something like
2457// a C++ library) should call this function, set some fields on the result, and
2458// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002459func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002460 module := newModule(hod, android.MultilibBoth)
2461
Colin Crossb916a382016-07-29 17:28:03 -07002462 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002463 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002464 BuildShared: true,
2465 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002466 },
Colin Crossb916a382016-07-29 17:28:03 -07002467 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002468 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002469 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002470 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002471 }
2472
Colin Crossb916a382016-07-29 17:28:03 -07002473 module.compiler = library
2474 module.linker = library
2475 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002476 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002477
2478 return module, library
2479}
2480
Colin Cross10d22312017-05-03 11:01:58 -07002481// connects a shared library to a static library in order to reuse its .o files to avoid
2482// compiling source files twice.
2483func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2484 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2485 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002486
2487 // Check libraries in addition to cflags, since libraries may be exporting different
2488 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002489 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2490 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2491 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2492 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2493 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2494 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2495 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2496 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002497 // Compare System_shared_libs properties with nil because empty lists are
2498 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002499 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2500 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002501
2502 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2503 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2504 sharedCompiler.baseCompiler.Properties.Srcs
2505 sharedCompiler.baseCompiler.Properties.Srcs = nil
2506 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2507 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002508
2509 // This dep is just to reference static variant from shared variant
2510 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002511 }
2512}
2513
Chris Parsons3c27ca32020-11-20 12:42:07 -05002514// LinkageMutator adds "static" or "shared" variants for modules depending
2515// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002516func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002517 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002518 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002519 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002520 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002521 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002522 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002523
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002524 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002525 buildStatic := library.buildStatic()
2526 buildShared := library.buildShared()
2527 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002528 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2529 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2530 // all the variants of the cc_library also exist on the prebuilt.
2531 modules := mctx.CreateLocalVariations("static", "shared")
2532 static := modules[0].(*Module)
2533 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002534
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002535 static.linker.(prebuiltLibraryInterface).setStatic()
2536 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002537
Colin Cross127bb8b2020-12-16 16:46:01 -08002538 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002539 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002540 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002541 mctx.AliasVariation("static")
2542 }
2543
Colin Cross127bb8b2020-12-16 16:46:01 -08002544 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002545 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2546 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002547 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002548 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2549 }
2550 } else {
2551 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002552 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002553
Ivan Lozano52767be2019-10-18 14:49:46 -07002554 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002555
Ivan Lozano2b262972019-11-21 12:30:50 -08002556 // Non-cc.Modules may need an empty variant for their mutators.
2557 variations := []string{}
2558 if library.NonCcVariants() {
2559 variations = append(variations, "")
2560 }
2561
Colin Cross127bb8b2020-12-16 16:46:01 -08002562 isLLNDK := false
2563 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002564 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002565 }
2566 buildStatic := library.BuildStaticVariant() && !isLLNDK
2567 buildShared := library.BuildSharedVariant()
2568 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002569 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002570
2571 modules := mctx.CreateLocalVariations(variations...)
2572 static := modules[0].(LinkableInterface)
2573 shared := modules[1].(LinkableInterface)
2574
2575 static.SetStatic()
2576 shared.SetShared()
2577
2578 if _, ok := library.(*Module); ok {
2579 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2580 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002581 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002582 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002583 variations := append([]string{"static"}, variations...)
2584
2585 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002586 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002587 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002588 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002589 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002590
Ivan Lozano2b262972019-11-21 12:30:50 -08002591 modules := mctx.CreateLocalVariations(variations...)
2592 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002593 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002594 } else if len(variations) > 0 {
2595 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002596 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002597 }
Colin Crossb916a382016-07-29 17:28:03 -07002598 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002599}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002600
Chris Parsons3c27ca32020-11-20 12:42:07 -05002601// normalizeVersions modifies `versions` in place, so that each raw version
2602// string becomes its normalized canonical form.
2603// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002604func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002605 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002606 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002607 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002608 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002609 ctx.PropertyErrorf("versions", "%s", err.Error())
2610 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002611 }
Dan Albertc8060532020-07-22 22:32:17 -07002612 if i > 0 && ver.LessThanOrEqualTo(previous) {
2613 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2614 }
2615 versions[i] = ver.String()
2616 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002617 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002618}
2619
Jooyung Han61b66e92020-03-21 14:21:46 +00002620func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002621 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2622 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002623 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002624
Colin Cross127bb8b2020-12-16 16:46:01 -08002625 m := mctx.Module().(*Module)
2626 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002627 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002628 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002629
Colin Crossd1f898e2020-08-18 18:35:15 -07002630 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002631 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002632
Kiyoung Kimee58c932022-10-25 22:59:41 +09002633 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002634 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002635 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002636 c.sanitize = nil
2637 c.stl = nil
2638 c.Properties.PreventInstall = true
2639 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002640 isLatest := i == (len(versions) - 1)
2641 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002642
2643 if variants[i] != "" {
2644 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2645 // implementation module to the stubs module.
2646 c.Properties.HideFromMake = true
2647 lib.setStubsVersion(variants[i])
2648 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2649 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002650 }
2651 }
Colin Cross094faa52020-08-06 17:38:25 -07002652 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002653 latestVersion := ""
2654 if len(versions) > 0 {
2655 latestVersion = versions[len(versions)-1]
2656 }
2657 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002658}
2659
Colin Crossbbc941b2020-09-30 12:27:01 -07002660func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2661 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2662 if err != nil {
2663 mctx.PropertyErrorf("min_sdk_version", err.Error())
2664 return
2665 }
2666
2667 versionStrs := ndkLibraryVersions(mctx, from)
2668 modules := mctx.CreateLocalVariations(versionStrs...)
2669
2670 for i, module := range modules {
2671 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002672 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002673 }
2674}
2675
Liz Kammer23942242022-04-08 15:41:00 -04002676func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002677 Host() bool
2678 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002679 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002680}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002681 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002682}
2683
Liz Kammer23942242022-04-08 15:41:00 -04002684func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002685 Host() bool
2686 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002687 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002688 CcLibraryInterface() bool
2689 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002690}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002691 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002692 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002693}
2694
Colin Cross127bb8b2020-12-16 16:46:01 -08002695func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002696 if m, ok := module.(*Module); ok {
2697 return m.library
2698 }
2699 return nil
2700}
2701
Liz Kammer23942242022-04-08 15:41:00 -04002702// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2703func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2704 if !library.buildShared() || !canBeVersionVariant(module) {
2705 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002706 }
Liz Kammer23942242022-04-08 15:41:00 -04002707 versions := library.stubsVersions(mctx)
2708 if len(versions) <= 0 {
2709 return
2710 }
2711 normalizeVersions(mctx, versions)
2712 if mctx.Failed() {
2713 return
2714 }
2715 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2716 // depend on the implementation library and haven't been mutated yet.
2717 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002718}
Jooyung Han61b66e92020-03-21 14:21:46 +00002719
Colin Crossd1f898e2020-08-18 18:35:15 -07002720// versionMutator splits a module into the mandatory non-stubs variant
2721// (which is unnamed) and zero or more stubs variants.
2722func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002723 if mctx.Os() != android.Android {
2724 return
2725 }
2726
2727 m, ok := mctx.Module().(*Module)
2728 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2729 setStubsVersions(mctx, library, m)
2730
Colin Cross31076b32020-10-23 17:22:06 -07002731 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002732 return
2733 }
2734
Liz Kammer23942242022-04-08 15:41:00 -04002735 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002736 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002737 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2738 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002739 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002740}
Colin Crossd7227f92019-09-05 14:26:33 -07002741
2742// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2743// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2744// that the linked output file should be written to.
2745// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2746func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2747 inject *bool, fileName string) android.ModuleOutPath {
2748 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2749 injectBoringSSLHash := Bool(inject)
2750 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002751 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002752 if cc, ok := dep.(*Module); ok {
2753 if library, ok := cc.linker.(*libraryDecorator); ok {
2754 if Bool(library.Properties.Inject_bssl_hash) {
2755 injectBoringSSLHash = true
2756 }
2757 }
2758 }
2759 }
2760 })
2761 if injectBoringSSLHash {
2762 hashedOutputfile := outputFile
2763 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2764
Colin Crossf1a035e2020-11-16 17:32:30 -08002765 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002766 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002767 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002768 FlagWithInput("-in-object ", outputFile).
2769 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002770 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002771 }
2772
2773 return outputFile
2774}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002775
Yu Liu56ccb1a2022-11-12 10:47:07 -08002776func bp2buildParseAbiCheckerProps(ctx android.TopDownMutatorContext, module *Module) bazelCcHeaderAbiCheckerAttributes {
2777 lib, ok := module.linker.(*libraryDecorator)
2778 if !ok {
2779 return bazelCcHeaderAbiCheckerAttributes{}
2780 }
2781
2782 abiChecker := lib.Properties.Header_abi_checker
2783
2784 abiCheckerAttrs := bazelCcHeaderAbiCheckerAttributes{
2785 Abi_checker_enabled: abiChecker.Enabled,
2786 Abi_checker_exclude_symbol_versions: abiChecker.Exclude_symbol_versions,
2787 Abi_checker_exclude_symbol_tags: abiChecker.Exclude_symbol_tags,
2788 Abi_checker_check_all_apis: abiChecker.Check_all_apis,
2789 Abi_checker_diff_flags: abiChecker.Diff_flags,
2790 }
2791 if abiChecker.Symbol_file != nil {
2792 symbolFile := android.BazelLabelForModuleSrcSingle(ctx, *abiChecker.Symbol_file)
2793 abiCheckerAttrs.Abi_checker_symbol_file = &symbolFile
2794 }
2795
2796 return abiCheckerAttrs
2797}
2798
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002799func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002800 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2801 compilerAttrs := baseAttributes.compilerAttributes
2802 linkerAttrs := baseAttributes.linkerAttributes
2803
Liz Kammer54549442022-05-11 13:55:06 -04002804 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, &compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002805
2806 // Append shared/static{} stanza properties. These won't be specified on
2807 // cc_library_* itself, but may be specified in cc_defaults that this module
2808 // depends on.
2809 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2810
2811 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2812 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2813 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2814 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002815
2816 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2817 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002818 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002819 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002820 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2821
2822 asFlags := compilerAttrs.asFlags
2823 if compilerAttrs.asSrcs.IsEmpty() {
2824 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2825 asFlags = bazel.MakeStringListAttribute(nil)
2826 }
2827
Liz Kammer7a210ac2021-09-22 15:52:58 -04002828 commonAttrs := staticOrSharedAttributes{
2829 Srcs: compilerAttrs.srcs,
2830 Srcs_c: compilerAttrs.cSrcs,
2831 Srcs_as: compilerAttrs.asSrcs,
2832 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002833 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002834
Liz Kammer12615db2021-09-28 09:19:17 -04002835 Deps: linkerAttrs.deps,
2836 Implementation_deps: linkerAttrs.implementationDeps,
2837 Dynamic_deps: linkerAttrs.dynamicDeps,
2838 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2839 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2840 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2841 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Yu Liufc603162022-03-01 15:44:08 -08002842 sdkAttributes: bp2BuildParseSdkAttributes(module),
Cole Faust6b29f592022-08-09 09:50:56 -07002843 Runtime_deps: linkerAttrs.runtimeDeps,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002844 }
2845
Sam Delmericoc9b8fbd2022-10-25 15:47:17 -04002846 module.convertTidyAttributes(ctx, &commonAttrs.tidyAttributes)
Sam Delmericofb3bb322022-10-21 10:42:24 -04002847
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002848 var attrs interface{}
2849 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002850 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002851 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002852 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002853
Liz Kammerbaced712022-09-16 09:01:29 -04002854 Use_libcrt: linkerAttrs.useLibcrt,
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002855
Liz Kammer1263d9b2021-12-10 14:28:20 -05002856 Rtti: compilerAttrs.rtti,
2857 Stl: compilerAttrs.stl,
2858 Cpp_std: compilerAttrs.cppStd,
2859 C_std: compilerAttrs.cStd,
2860
2861 Export_includes: exportedIncludes.Includes,
2862 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2863 Export_system_includes: exportedIncludes.SystemIncludes,
2864 Local_includes: compilerAttrs.localIncludes,
2865 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002866
2867 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002868 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002869 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002870
Cole Faust5fa4e962022-08-22 14:31:04 -07002871 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002872 }
2873 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002874 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2875
Wei Li81852ca2022-07-27 00:22:06 -07002876 sharedLibAttrs := &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002877 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002878
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002879 Cppflags: compilerAttrs.cppFlags,
2880 Conlyflags: compilerAttrs.conlyFlags,
2881 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002882
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002883 Linkopts: linkerAttrs.linkopts,
2884 Link_crt: linkerAttrs.linkCrt,
2885 Use_libcrt: linkerAttrs.useLibcrt,
2886 Use_version_lib: linkerAttrs.useVersionLib,
2887
2888 Rtti: compilerAttrs.rtti,
2889 Stl: compilerAttrs.stl,
2890 Cpp_std: compilerAttrs.cppStd,
2891 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002892
Liz Kammerd2871182021-10-04 13:54:37 -04002893 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002894 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002895 Export_system_includes: exportedIncludes.SystemIncludes,
2896 Local_includes: compilerAttrs.localIncludes,
2897 Absolute_includes: compilerAttrs.absoluteIncludes,
2898 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002899
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00002900 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
Liz Kammer0eae52e2021-10-06 10:32:26 -04002901
Cole Faust5fa4e962022-08-22 14:31:04 -07002902 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05002903
2904 Suffix: compilerAttrs.suffix,
Yu Liu56ccb1a2022-11-12 10:47:07 -08002905
2906 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, module),
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002907 }
Wei Li81852ca2022-07-27 00:22:06 -07002908 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
2909 hasStubs := true
2910 sharedLibAttrs.Has_stubs.SetValue(&hasStubs)
Yu Liu56ccb1a2022-11-12 10:47:07 -08002911 sharedLibAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Wei Li81852ca2022-07-27 00:22:06 -07002912 }
2913 attrs = sharedLibAttrs
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002914 }
2915
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002916 var modType string
2917 if isStatic {
2918 modType = "cc_library_static"
2919 } else {
2920 modType = "cc_library_shared"
Trevor Radcliffef19d8a72022-09-20 23:04:39 +00002921 createStubsBazelTargetIfNeeded(ctx, module, compilerAttrs, exportedIncludes, baseAttributes)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002922 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002923 props := bazel.BazelTargetModuleProperties{
2924 Rule_class: modType,
Liz Kammer2b376bc2022-01-12 12:00:49 -05002925 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 +00002926 }
2927
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002928 tags := android.ApexAvailableTags(module)
2929 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 +00002930}
2931
2932// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002933type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002934 staticOrSharedAttributes
2935
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002936 Use_libcrt bazel.BoolAttribute
2937 Use_version_lib bazel.BoolAttribute
2938
2939 Rtti bazel.BoolAttribute
2940 Stl *string
2941 Cpp_std *string
2942 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002943
Liz Kammer1263d9b2021-12-10 14:28:20 -05002944 Export_includes bazel.StringListAttribute
2945 Export_absolute_includes bazel.StringListAttribute
2946 Export_system_includes bazel.StringListAttribute
2947 Local_includes bazel.StringListAttribute
2948 Absolute_includes bazel.StringListAttribute
2949 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002950
2951 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002952 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002953 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002954
2955 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002956}
2957
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002958// TODO(b/199902614): Can this be factored to share with the other Attributes?
2959type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002960 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002961
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002962 Linkopts bazel.StringListAttribute
2963 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
2964
2965 Use_libcrt bazel.BoolAttribute
2966 Use_version_lib bazel.BoolAttribute
2967
2968 Rtti bazel.BoolAttribute
2969 Stl *string
2970 Cpp_std *string
2971 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002972
Liz Kammer1263d9b2021-12-10 14:28:20 -05002973 Export_includes bazel.StringListAttribute
2974 Export_absolute_includes bazel.StringListAttribute
2975 Export_system_includes bazel.StringListAttribute
2976 Local_includes bazel.StringListAttribute
2977 Absolute_includes bazel.StringListAttribute
2978 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002979
Liz Kammerd2871182021-10-04 13:54:37 -04002980 Strip stripAttributes
2981 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04002982
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002983 Cppflags bazel.StringListAttribute
2984 Conlyflags bazel.StringListAttribute
2985 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002986
2987 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00002988
Yu Liu56ccb1a2022-11-12 10:47:07 -08002989 Has_stubs bazel.BoolAttribute
2990 Stubs_symbol_file *string
Wei Li81852ca2022-07-27 00:22:06 -07002991
2992 Inject_bssl_hash bazel.BoolAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05002993
2994 Suffix bazel.StringAttribute
Yu Liu56ccb1a2022-11-12 10:47:07 -08002995
2996 bazelCcHeaderAbiCheckerAttributes
Wei Li81852ca2022-07-27 00:22:06 -07002997}
2998
2999type bazelCcStubSuiteAttributes struct {
3000 Symbol_file *string
3001 Versions bazel.StringListAttribute
3002 Export_includes bazel.StringListAttribute
3003 Source_library bazel.LabelAttribute
3004 Soname *string
3005 Deps bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003006}
Yu Liu56ccb1a2022-11-12 10:47:07 -08003007
3008type bazelCcHeaderAbiCheckerAttributes struct {
3009 Abi_checker_enabled *bool
3010 Abi_checker_symbol_file *bazel.Label
3011 Abi_checker_exclude_symbol_versions []string
3012 Abi_checker_exclude_symbol_tags []string
3013 Abi_checker_check_all_apis *bool
3014 Abi_checker_diff_flags []string
3015}