blob: e8e9acfefd1ee9ad1c0ab446ef80c444acb7e59b [file] [log] [blame]
Colin Cross4d9c2d12016-07-29 12:48:20 -07001// Copyright 2016 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17import (
Inseob Kim69378442019-06-03 19:10:47 +090018 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080019 "io"
Jiyong Parkf1194352019-02-25 11:05:47 +090020 "path/filepath"
Jiyong Parkda732bd2018-11-02 18:23:15 +090021 "regexp"
Jooyung Han11b0fbd2021-02-05 02:28:22 +090022 "strconv"
Colin Cross4d9c2d12016-07-29 12:48:20 -070023 "strings"
Jiyong Parkda732bd2018-11-02 18:23:15 +090024 "sync"
Colin Cross4d9c2d12016-07-29 12:48:20 -070025
Colin Cross4d9c2d12016-07-29 12:48:20 -070026 "android/soong/android"
Rupert Shuttleworth095081c2021-03-25 09:06:03 +000027 "android/soong/bazel"
Chris Parsons94a0bba2021-06-04 15:03:47 -040028 "android/soong/bazel/cquery"
Dan Albertea4b7b92018-04-25 16:05:30 -070029 "android/soong/cc/config"
Liz Kammer2ada09a2021-08-11 00:17:36 -040030
Chris Parsons51f8c392021-08-03 21:01:05 -040031 "github.com/google/blueprint"
32 "github.com/google/blueprint/pathtools"
Spandan Das4238c652022-09-09 01:38:47 +000033 "github.com/google/blueprint/proptools"
Colin Cross4d9c2d12016-07-29 12:48:20 -070034)
35
Liz Kammer2b376bc2022-01-12 12:00:49 -050036// LibraryProperties is a collection of properties shared by cc library rules/cc.
Colin Crossb916a382016-07-29 17:28:03 -070037type LibraryProperties struct {
Colin Cross4d9c2d12016-07-29 12:48:20 -070038 // local file name to pass to the linker as -unexported_symbols_list
Colin Cross27b922f2019-03-04 22:35:41 -080039 Unexported_symbols_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070040 // local file name to pass to the linker as -force_symbols_not_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080041 Force_symbols_not_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070042 // local file name to pass to the linker as -force_symbols_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080043 Force_symbols_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070044
45 // rename host libraries to prevent overlap with system installed libraries
46 Unique_host_soname *bool
47
Dan Willemsene1240db2016-11-03 14:28:51 -070048 Aidl struct {
49 // export headers generated from .aidl sources
Nan Zhang0007d812017-11-07 10:57:05 -080050 Export_aidl_headers *bool
Dan Willemsene1240db2016-11-03 14:28:51 -070051 }
52
Colin Cross0c461f12016-10-20 16:11:43 -070053 Proto struct {
54 // export headers generated from .proto sources
Nan Zhang0007d812017-11-07 10:57:05 -080055 Export_proto_headers *bool
Colin Cross0c461f12016-10-20 16:11:43 -070056 }
Dan Albertf563d252017-10-13 00:29:00 -070057
Inseob Kimc0907f12019-02-08 21:00:45 +090058 Sysprop struct {
59 // Whether platform owns this sysprop library.
60 Platform *bool
Inseob Kimb3f22ca2019-03-05 12:40:24 +090061 } `blueprint:"mutated"`
Inseob Kimc0907f12019-02-08 21:00:45 +090062
Nan Zhang0007d812017-11-07 10:57:05 -080063 Static_ndk_lib *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090064
Florian Mayer6dab96c2020-12-31 11:39:48 +000065 // Generate stubs to make this library accessible to APEXes.
Jiyong Park7ed9de32018-10-15 22:25:07 +090066 Stubs struct {
67 // Relative path to the symbol map. The symbol map provides the list of
68 // symbols that are exported for stubs variant of this library.
Colin Cross27b922f2019-03-04 22:35:41 -080069 Symbol_file *string `android:"path"`
Jiyong Park7ed9de32018-10-15 22:25:07 +090070
Jiyong Parkd4a3a132021-03-17 20:21:35 +090071 // List versions to generate stubs libs for. The version name "current" is always
72 // implicitly added.
Jiyong Park7ed9de32018-10-15 22:25:07 +090073 Versions []string
Alan Stokes73feba32022-11-14 12:21:24 +000074
75 // Whether to not require the implementation of the library to be installed if a
76 // client of the stubs is installed. Defaults to true; set to false if the
77 // implementation is made available by some other means, e.g. in a Microdroid
78 // virtual machine.
79 Implementation_installable *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090080 }
dimitryd95964a2018-11-07 13:43:34 +010081
82 // set the name of the output
83 Stem *string `android:"arch_variant"`
84
Colin Cross0fd6a412019-08-16 14:22:10 -070085 // set suffix of the name of the output
86 Suffix *string `android:"arch_variant"`
87
88 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +090089 Vendor, Product struct {
Colin Cross0fd6a412019-08-16 14:22:10 -070090 // set suffix of the name of the output
91 Suffix *string `android:"arch_variant"`
92 }
93 }
94
dimitryd95964a2018-11-07 13:43:34 +010095 // Names of modules to be overridden. Listed modules can only be other shared libraries
96 // (in Make or Soong).
97 // This does not completely prevent installation of the overridden libraries, but if both
98 // binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
99 // from PRODUCT_PACKAGES.
100 Overrides []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800101
102 // Properties for ABI compatibility checker
103 Header_abi_checker struct {
Logan Chien41eabe62019-04-10 13:33:58 +0800104 // Enable ABI checks (even if this is not an LLNDK/VNDK lib)
105 Enabled *bool
106
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800107 // Path to a symbol file that specifies the symbols to be included in the generated
108 // ABI dump file
Colin Cross27b922f2019-03-04 22:35:41 -0800109 Symbol_file *string `android:"path"`
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800110
111 // Symbol versions that should be ignored from the symbol file
112 Exclude_symbol_versions []string
113
114 // Symbol tags that should be ignored from the symbol file
115 Exclude_symbol_tags []string
Logan Chien2a65dda2019-10-01 15:58:07 -0700116
117 // Run checks on all APIs (in addition to the ones referred by
118 // one of exported ELF symbols.)
119 Check_all_apis *bool
Hsin-Yi Chen6ad1e4b2022-05-19 15:17:54 +0800120
121 // Extra flags passed to header-abi-diff
122 Diff_flags []string
Hsin-Yi Chenf3630122022-11-17 14:29:43 +0800123
124 // Opt-in reference dump directories
125 Ref_dump_dirs []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800126 }
Vic Yang6cd1be82019-06-24 16:08:48 -0700127
Pete Bentley803e1612019-08-06 22:19:59 +0100128 // Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
129 Inject_bssl_hash *bool `android:"arch_variant"`
Colin Cross0477b422020-10-13 18:43:54 -0700130
Colin Cross127bb8b2020-12-16 16:46:01 -0800131 // If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
132 // the module pointed to by llndk_stubs if it is set.
133 Llndk llndkLibraryProperties
Colin Cross5271fea2021-04-27 13:06:04 -0700134
135 // If this is a vendor public library, properties to describe the vendor public library stubs.
136 Vendor_public_library vendorPublicLibraryProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800137}
Colin Cross0c461f12016-10-20 16:11:43 -0700138
Chris Parsons3c27ca32020-11-20 12:42:07 -0500139// StaticProperties is a properties stanza to affect only attributes of the "static" variants of a
140// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700141type StaticProperties struct {
142 Static StaticOrSharedProperties `android:"arch_variant"`
143}
144
Chris Parsons3c27ca32020-11-20 12:42:07 -0500145// SharedProperties is a properties stanza to affect only attributes of the "shared" variants of a
146// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700147type SharedProperties struct {
148 Shared StaticOrSharedProperties `android:"arch_variant"`
149}
150
Chris Parsons3c27ca32020-11-20 12:42:07 -0500151// StaticOrSharedProperties is an embedded struct representing properties to affect attributes of
152// either only the "static" variants or only the "shared" variants of a library module. These override
153// the base properties of the same name.
154// Use `StaticProperties` or `SharedProperties`, depending on which variant is needed.
155// `StaticOrSharedProperties` exists only to avoid duplication.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700156type StaticOrSharedProperties struct {
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700157 Srcs []string `android:"path,arch_variant"`
158
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700159 Tidy_disabled_srcs []string `android:"path,arch_variant"`
160
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800161 Tidy_timeout_srcs []string `android:"path,arch_variant"`
162
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700163 Sanitized Sanitized `android:"arch_variant"`
164
Colin Crosse1bb5d02019-09-24 14:55:04 -0700165 Cflags []string `android:"arch_variant"`
166
Colin Cross6b8f4252021-07-22 11:39:44 -0700167 Enabled *bool `android:"arch_variant"`
168 Whole_static_libs []string `android:"arch_variant"`
169 Static_libs []string `android:"arch_variant"`
170 Shared_libs []string `android:"arch_variant"`
171 System_shared_libs []string `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700172
173 Export_shared_lib_headers []string `android:"arch_variant"`
174 Export_static_lib_headers []string `android:"arch_variant"`
Jiyong Parka90ca002019-10-07 15:47:24 +0900175
176 Apex_available []string `android:"arch_variant"`
Colin Cross1bc94122021-10-28 13:25:54 -0700177
178 Installable *bool `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700179}
180
Colin Crossa48ab5b2017-02-14 15:28:44 -0800181type LibraryMutatedProperties struct {
Colin Crossb916a382016-07-29 17:28:03 -0700182 // Build a static variant
183 BuildStatic bool `blueprint:"mutated"`
184 // Build a shared variant
185 BuildShared bool `blueprint:"mutated"`
186 // This variant is shared
187 VariantIsShared bool `blueprint:"mutated"`
188 // This variant is static
189 VariantIsStatic bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900190
191 // This variant is a stubs lib
192 BuildStubs bool `blueprint:"mutated"`
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900193 // This variant is the latest version
194 IsLatestVersion bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900195 // Version of the stubs lib
196 StubsVersion string `blueprint:"mutated"`
Colin Crossd1f898e2020-08-18 18:35:15 -0700197 // List of all stubs versions associated with an implementation lib
198 AllStubsVersions []string `blueprint:"mutated"`
Colin Crossb916a382016-07-29 17:28:03 -0700199}
200
201type FlagExporterProperties struct {
202 // list of directories relative to the Blueprints file that will
Dan Willemsen273af7f2016-11-03 15:53:42 -0700203 // be added to the include path (using -I) for this module and any module that links
Colin Cross5d195602017-10-17 16:15:50 -0700204 // against this module. Directories listed in export_include_dirs do not need to be
205 // listed in local_include_dirs.
Colin Cross0ed579e2021-06-29 00:51:12 +0000206 Export_include_dirs []string `android:"arch_variant,variant_prepend"`
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700207
Jiyong Park73c54ee2019-10-22 20:31:18 +0900208 // list of directories that will be added to the system include path
209 // using -isystem for this module and any module that links against this module.
Colin Cross0ed579e2021-06-29 00:51:12 +0000210 Export_system_include_dirs []string `android:"arch_variant,variant_prepend"`
Jiyong Park73c54ee2019-10-22 20:31:18 +0900211
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700212 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900213 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700214 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900215 // export_include_dirs, that will be applied to
216 // vendor or product variant of this library.
217 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800218 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700219 }
220 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700221}
222
223func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000224 RegisterLibraryBuildComponents(android.InitRegistrationContext)
225}
226
227func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
228 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
229 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
230 ctx.RegisterModuleType("cc_library", LibraryFactory)
231 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
232 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700233}
234
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +0000235// TODO(b/199902614): Can this be factored to share with the other Attributes?
Jingwen Chen63930982021-03-24 10:04:33 -0400236// For bp2build conversion.
237type bazelCcLibraryAttributes struct {
Chris Parsons08648312021-05-06 16:23:19 -0400238 // Attributes pertaining to both static and shared variants.
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000239 Srcs bazel.LabelListAttribute
240 Srcs_c bazel.LabelListAttribute
241 Srcs_as bazel.LabelListAttribute
242
243 Copts bazel.StringListAttribute
244 Cppflags bazel.StringListAttribute
245 Conlyflags bazel.StringListAttribute
246 Asflags bazel.StringListAttribute
247
Liz Kammer7a210ac2021-09-22 15:52:58 -0400248 Hdrs bazel.LabelListAttribute
249
Liz Kammer12615db2021-09-28 09:19:17 -0400250 Deps bazel.LabelListAttribute
251 Implementation_deps bazel.LabelListAttribute
252 Dynamic_deps bazel.LabelListAttribute
253 Implementation_dynamic_deps bazel.LabelListAttribute
254 Whole_archive_deps bazel.LabelListAttribute
255 Implementation_whole_archive_deps bazel.LabelListAttribute
256 System_dynamic_deps bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -0400257
Liz Kammer5fad5012021-09-09 14:08:21 -0400258 Export_includes bazel.StringListAttribute
259 Export_system_includes bazel.StringListAttribute
Liz Kammer35687bc2021-09-10 10:07:07 -0400260 Local_includes bazel.StringListAttribute
261 Absolute_includes bazel.StringListAttribute
Liz Kammer5fad5012021-09-09 14:08:21 -0400262 Linkopts bazel.StringListAttribute
263 Use_libcrt bazel.BoolAttribute
264 Rtti bazel.BoolAttribute
Jingwen Chen5b11ab12021-10-11 17:44:33 +0000265
266 Stl *string
267 Cpp_std *string
Chris Parsons79bd2b72021-11-29 17:52:41 -0500268 C_std *string
Chris Parsons990c4f42021-05-25 12:10:58 -0400269
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000270 // This is shared only.
Liz Kammerd2871182021-10-04 13:54:37 -0400271 Link_crt bazel.BoolAttribute
272 Additional_linker_inputs bazel.LabelListAttribute
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000273
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000274 // Common properties shared between both shared and static variants.
275 Shared staticOrSharedAttributes
276 Static staticOrSharedAttributes
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000277
278 Strip stripAttributes
Liz Kammer0eae52e2021-10-06 10:32:26 -0400279
280 Features bazel.StringListAttribute
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000281}
282
Vinh Tran9f6796a2022-08-16 13:10:31 -0400283type aidlLibraryAttributes struct {
284 Srcs bazel.LabelListAttribute
285 Include_dir *string
286}
287
288type ccAidlLibraryAttributes struct {
Vinh Tran395a1e92022-09-16 18:27:29 -0400289 Deps bazel.LabelListAttribute
290 Implementation_dynamic_deps bazel.LabelListAttribute
Vinh Tran9f6796a2022-08-16 13:10:31 -0400291}
292
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000293type stripAttributes struct {
294 Keep_symbols bazel.BoolAttribute
295 Keep_symbols_and_debug_frame bazel.BoolAttribute
296 Keep_symbols_list bazel.StringListAttribute
297 All bazel.BoolAttribute
298 None bazel.BoolAttribute
Jingwen Chen63930982021-03-24 10:04:33 -0400299}
300
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +0000301func stripAttrsFromLinkerAttrs(la *linkerAttributes) stripAttributes {
302 return stripAttributes{
303 Keep_symbols: la.stripKeepSymbols,
304 Keep_symbols_and_debug_frame: la.stripKeepSymbolsAndDebugFrame,
305 Keep_symbols_list: la.stripKeepSymbolsList,
306 All: la.stripAll,
307 None: la.stripNone,
308 }
309}
310
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400311func libraryBp2Build(ctx android.TopDownMutatorContext, m *Module) {
Jingwen Chen179856a2021-05-03 09:15:48 +0000312 // For some cc_library modules, their static variants are ready to be
313 // converted, but not their shared variants. For these modules, delegate to
314 // the cc_library_static bp2build converter temporarily instead.
Chris Parsonsad876012022-08-20 14:48:32 -0400315 if android.GetBp2BuildAllowList().GenerateCcLibraryStaticOnly(ctx.Module().Name()) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400316 sharedOrStaticLibraryBp2Build(ctx, m, true)
Jingwen Chen179856a2021-05-03 09:15:48 +0000317 return
318 }
319
Jingwen Chen53681ef2021-04-29 08:15:13 +0000320 sharedAttrs := bp2BuildParseSharedProps(ctx, m)
321 staticAttrs := bp2BuildParseStaticProps(ctx, m)
Liz Kammere6583482021-10-19 13:56:10 -0400322 baseAttributes := bp2BuildParseBaseProps(ctx, m)
323 compilerAttrs := baseAttributes.compilerAttributes
324 linkerAttrs := baseAttributes.linkerAttributes
Liz Kammer54549442022-05-11 13:55:06 -0400325 exportedIncludes := bp2BuildParseExportedIncludes(ctx, m, &compilerAttrs.includes)
Jingwen Chen63930982021-03-24 10:04:33 -0400326
Liz Kammer9abd62d2021-05-21 08:37:59 -0400327 srcs := compilerAttrs.srcs
Jingwen Chen53681ef2021-04-29 08:15:13 +0000328
Liz Kammer12615db2021-09-28 09:19:17 -0400329 sharedAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
330 staticAttrs.Deps.Add(baseAttributes.protoDependency)
331
Chris Parsons69fa9f92021-07-13 11:47:44 -0400332 asFlags := compilerAttrs.asFlags
333 if compilerAttrs.asSrcs.IsEmpty() && sharedAttrs.Srcs_as.IsEmpty() && staticAttrs.Srcs_as.IsEmpty() {
334 // Skip asflags for BUILD file simplicity if there are no assembly sources.
335 asFlags = bazel.MakeStringListAttribute(nil)
336 }
337
Chris Parsons77acf2e2021-12-03 17:27:16 -0500338 staticCommonAttrs := staticOrSharedAttributes{
339 Srcs: *srcs.Clone().Append(staticAttrs.Srcs),
340 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(staticAttrs.Srcs_c),
341 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(staticAttrs.Srcs_as),
342 Copts: *compilerAttrs.copts.Clone().Append(staticAttrs.Copts),
343 Hdrs: *compilerAttrs.hdrs.Clone().Append(staticAttrs.Hdrs),
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000344
Chris Parsons77acf2e2021-12-03 17:27:16 -0500345 Deps: *linkerAttrs.deps.Clone().Append(staticAttrs.Deps),
346 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(staticAttrs.Implementation_deps),
347 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(staticAttrs.Dynamic_deps),
348 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(staticAttrs.Implementation_dynamic_deps),
349 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
350 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(staticAttrs.Whole_archive_deps),
351 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(staticAttrs.System_dynamic_deps),
Cole Faust6b29f592022-08-09 09:50:56 -0700352 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liufc603162022-03-01 15:44:08 -0800353 sdkAttributes: bp2BuildParseSdkAttributes(m),
Yu Liuf01a0f02022-12-07 15:45:30 -0800354 Native_coverage: baseAttributes.Native_coverage,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500355 }
356
357 sharedCommonAttrs := staticOrSharedAttributes{
358 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
359 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
360 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
361 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
362 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
363
Liz Kammer84b0ecb2022-09-14 10:49:13 -0400364 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
365 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
366 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
367 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
368 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
369 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
370 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
371 Runtime_deps: linkerAttrs.runtimeDeps,
372 sdkAttributes: bp2BuildParseSdkAttributes(m),
Yu Liuf01a0f02022-12-07 15:45:30 -0800373 Native_coverage: baseAttributes.Native_coverage,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500374 }
375
376 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
377 staticOrSharedAttributes: staticCommonAttrs,
378
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000379 Cppflags: compilerAttrs.cppFlags,
380 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400381 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000382
Liz Kammer1263d9b2021-12-10 14:28:20 -0500383 Export_includes: exportedIncludes.Includes,
384 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
385 Export_system_includes: exportedIncludes.SystemIncludes,
386 Local_includes: compilerAttrs.localIncludes,
387 Absolute_includes: compilerAttrs.absoluteIncludes,
388 Use_libcrt: linkerAttrs.useLibcrt,
389 Rtti: compilerAttrs.rtti,
390 Stl: compilerAttrs.stl,
391 Cpp_std: compilerAttrs.cppStd,
392 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500393
Cole Faust5fa4e962022-08-22 14:31:04 -0700394 Features: baseAttributes.features,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500395 }
396
397 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
398 staticOrSharedAttributes: sharedCommonAttrs,
399 Cppflags: compilerAttrs.cppFlags,
400 Conlyflags: compilerAttrs.conlyFlags,
401 Asflags: asFlags,
402
Liz Kammer1263d9b2021-12-10 14:28:20 -0500403 Export_includes: exportedIncludes.Includes,
404 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
405 Export_system_includes: exportedIncludes.SystemIncludes,
406 Local_includes: compilerAttrs.localIncludes,
407 Absolute_includes: compilerAttrs.absoluteIncludes,
408 Linkopts: linkerAttrs.linkopts,
409 Link_crt: linkerAttrs.linkCrt,
410 Use_libcrt: linkerAttrs.useLibcrt,
411 Rtti: compilerAttrs.rtti,
412 Stl: compilerAttrs.stl,
413 Cpp_std: compilerAttrs.cppStd,
414 C_std: compilerAttrs.cStd,
Yu Liua79c9462022-03-22 16:35:22 -0700415 Use_version_lib: linkerAttrs.useVersionLib,
Chris Parsons990c4f42021-05-25 12:10:58 -0400416
Liz Kammerd2871182021-10-04 13:54:37 -0400417 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000418
Yu Liu56ccb1a2022-11-12 10:47:07 -0800419 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
420 Features: baseAttributes.features,
421 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, m),
Vinh Tran99270ea2022-11-28 11:15:23 -0500422
423 Fdo_profile: compilerAttrs.fdoProfile,
Wei Li81852ca2022-07-27 00:22:06 -0700424 }
Jingwen Chen0ee88a62022-01-07 14:55:29 +0000425
Wei Li81852ca2022-07-27 00:22:06 -0700426 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
Yu Liu56ccb1a2022-11-12 10:47:07 -0800427 sharedTargetAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Jingwen Chen63930982021-03-24 10:04:33 -0400428 }
429
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -0500430 sharedTargetAttrs.Suffix = compilerAttrs.suffix
431
Yu Liu75be7b92022-02-01 09:54:09 -0800432 for axis, configToProps := range m.GetArchVariantProperties(ctx, &LibraryProperties{}) {
433 for config, props := range configToProps {
434 if props, ok := props.(*LibraryProperties); ok {
435 if props.Inject_bssl_hash != nil {
436 // This is an edge case applies only to libcrypto
Sam Delmericofae47f92022-08-08 13:35:08 -0400437 if m.Name() == "libcrypto" || m.Name() == "libcrypto_for_testing" {
Yu Liu75be7b92022-02-01 09:54:09 -0800438 sharedTargetAttrs.Inject_bssl_hash.SetSelectValue(axis, config, props.Inject_bssl_hash)
439 } else {
440 ctx.PropertyErrorf("inject_bssl_hash", "only applies to libcrypto")
441 }
442 }
443 }
444 }
445 }
446
Chris Parsons77acf2e2021-12-03 17:27:16 -0500447 staticProps := bazel.BazelTargetModuleProperties{
448 Rule_class: "cc_library_static",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500449 Bzl_load_location: "//build/bazel/rules/cc:cc_library_static.bzl",
Chris Parsons77acf2e2021-12-03 17:27:16 -0500450 }
451 sharedProps := bazel.BazelTargetModuleProperties{
452 Rule_class: "cc_library_shared",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500453 Bzl_load_location: "//build/bazel/rules/cc:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400454 }
455
Vinh Tran55225e32022-12-20 10:38:48 -0500456 var tagsForStaticVariant bazel.StringListAttribute
457 if compilerAttrs.stubsSymbolFile == nil && len(compilerAttrs.stubsVersions.Value) == 0 {
458 tagsForStaticVariant = android.ApexAvailableTags(m)
459 }
460
461 tagsForSharedVariant := android.ApexAvailableTags(m)
462
Chris Parsons58852a02021-12-09 18:10:18 -0500463 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000464 android.CommonAttributes{
465 Name: m.Name() + "_bp2build_cc_library_static",
Vinh Tran55225e32022-12-20 10:38:48 -0500466 Tags: tagsForStaticVariant,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000467 },
Chris Parsons58852a02021-12-09 18:10:18 -0500468 staticTargetAttrs, staticAttrs.Enabled)
469 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000470 android.CommonAttributes{
471 Name: m.Name(),
Vinh Tran55225e32022-12-20 10:38:48 -0500472 Tags: tagsForSharedVariant,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000473 },
Chris Parsons58852a02021-12-09 18:10:18 -0500474 sharedTargetAttrs, sharedAttrs.Enabled)
Wei Li81852ca2022-07-27 00:22:06 -0700475
Trevor Radcliffe087af542022-09-16 15:36:10 +0000476 createStubsBazelTargetIfNeeded(ctx, m, compilerAttrs, exportedIncludes, baseAttributes)
477}
478
479func createStubsBazelTargetIfNeeded(ctx android.TopDownMutatorContext, m *Module, compilerAttrs compilerAttributes, exportedIncludes BazelIncludes, baseAttributes baseAttributes) {
Wei Li81852ca2022-07-27 00:22:06 -0700480 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
481 stubSuitesProps := bazel.BazelTargetModuleProperties{
482 Rule_class: "cc_stub_suite",
483 Bzl_load_location: "//build/bazel/rules/cc:cc_stub_library.bzl",
484 }
485 soname := m.Name() + ".so"
486 stubSuitesAttrs := &bazelCcStubSuiteAttributes{
487 Symbol_file: compilerAttrs.stubsSymbolFile,
488 Versions: compilerAttrs.stubsVersions,
489 Export_includes: exportedIncludes.Includes,
490 Soname: &soname,
491 Source_library: *bazel.MakeLabelAttribute(":" + m.Name()),
492 Deps: baseAttributes.deps,
493 }
494 ctx.CreateBazelTargetModule(stubSuitesProps,
495 android.CommonAttributes{Name: m.Name() + "_stub_libs"},
496 stubSuitesAttrs)
497 }
Jingwen Chen63930982021-03-24 10:04:33 -0400498}
499
Spandan Das4238c652022-09-09 01:38:47 +0000500func apiContributionBp2Build(ctx android.TopDownMutatorContext, module *Module) {
501 apiSurfaces := make([]string, 0)
502 apiHeaders := make([]string, 0)
503 // systemapi (non-null `stubs` property)
504 if module.HasStubsVariants() {
505 apiSurfaces = append(apiSurfaces, android.SystemApi.String())
506 apiIncludes := getSystemApiIncludes(ctx, module)
507 if !apiIncludes.isEmpty() {
508 createApiHeaderTarget(ctx, apiIncludes)
509 apiHeaders = append(apiHeaders, apiIncludes.name)
510 }
511 }
512 // vendorapi (non-null `llndk` property)
513 if module.HasLlndkStubs() {
514 apiSurfaces = append(apiSurfaces, android.VendorApi.String())
515 apiIncludes := getVendorApiIncludes(ctx, module)
516 if !apiIncludes.isEmpty() {
517 createApiHeaderTarget(ctx, apiIncludes)
518 apiHeaders = append(apiHeaders, apiIncludes.name)
519 }
520 }
521 // create a target only if this module contributes to an api surface
522 // TODO: Currently this does not distinguish systemapi-only headers and vendrorapi-only headers
523 // TODO: Update so that systemapi-only headers do not get exported to vendorapi (and vice-versa)
524 if len(apiSurfaces) > 0 {
525 props := bazel.BazelTargetModuleProperties{
526 Rule_class: "cc_api_contribution",
527 Bzl_load_location: "//build/bazel/rules/apis:cc_api_contribution.bzl",
528 }
529 attrs := &bazelCcApiContributionAttributes{
530 Library_name: module.Name(),
531 Api_surfaces: bazel.MakeStringListAttribute(apiSurfaces),
532 Api: apiLabelAttribute(ctx, module),
533 Hdrs: bazel.MakeLabelListAttribute(
534 bazel.MakeLabelListFromTargetNames(apiHeaders),
535 ),
536 }
537 ctx.CreateBazelTargetModule(
538 props,
539 android.CommonAttributes{
540 Name: android.ApiContributionTargetName(module.Name()),
541 SkipData: proptools.BoolPtr(true),
542 },
543 attrs,
544 )
545 }
546}
547
548// Native apis are versioned in a single .map.txt for all api surfaces
549// Pick any one of the .map.txt files
550func apiLabelAttribute(ctx android.TopDownMutatorContext, module *Module) bazel.LabelAttribute {
551 var apiFile *string
552 linker := module.linker.(*libraryDecorator)
553 if llndkApi := linker.Properties.Llndk.Symbol_file; llndkApi != nil {
554 apiFile = llndkApi
555 } else if systemApi := linker.Properties.Stubs.Symbol_file; systemApi != nil {
556 apiFile = systemApi
557 } else {
558 ctx.ModuleErrorf("API surface library does not have any API file")
559 }
560 apiLabel := android.BazelLabelForModuleSrcSingle(ctx, proptools.String(apiFile)).Label
561 return *bazel.MakeLabelAttribute(apiLabel)
562}
563
564// wrapper struct to flatten the arch and os specific export_include_dirs
565// flattening is necessary since we want to export apis of all arches even when we build for x86 (e.g.)
566type bazelCcApiLibraryHeadersAttributes struct {
567 bazelCcLibraryHeadersAttributes
568
569 Arch *string
570}
571
572func (a *bazelCcApiLibraryHeadersAttributes) isEmpty() bool {
573 return a.Export_includes.IsEmpty() &&
574 a.Export_system_includes.IsEmpty() &&
575 a.Deps.IsEmpty()
576}
577
578type apiIncludes struct {
579 name string // name of the Bazel target in the generated bp2build workspace
580 attrs bazelCcApiLibraryHeadersAttributes
581}
582
583func (includes *apiIncludes) isEmpty() bool {
584 return includes.attrs.isEmpty()
585}
586
587func (includes *apiIncludes) addDep(name string) {
588 l := bazel.Label{Label: ":" + name}
589 ll := bazel.MakeLabelList([]bazel.Label{l})
590 lla := bazel.MakeLabelListAttribute(ll)
591 includes.attrs.Deps.Append(lla)
592}
593
594func getSystemApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
595 flagProps := c.library.(*libraryDecorator).flagExporter.Properties
596 linkProps := c.library.(*libraryDecorator).baseLinker.Properties
597 includes := android.FirstUniqueStrings(flagProps.Export_include_dirs)
598 systemIncludes := android.FirstUniqueStrings(flagProps.Export_system_include_dirs)
599 headerLibs := android.FirstUniqueStrings(linkProps.Export_header_lib_headers)
600 attrs := bazelCcLibraryHeadersAttributes{
601 Export_includes: bazel.MakeStringListAttribute(includes),
602 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
603 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, headerLibs)),
604 }
605
606 return apiIncludes{
607 name: c.Name() + ".systemapi.headers",
608 attrs: bazelCcApiLibraryHeadersAttributes{
609 bazelCcLibraryHeadersAttributes: attrs,
610 },
611 }
612}
613
614func getVendorApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
615 baseProps := c.library.(*libraryDecorator).flagExporter.Properties
616 llndkProps := c.library.(*libraryDecorator).Properties.Llndk
617 includes := baseProps.Export_include_dirs
618 systemIncludes := baseProps.Export_system_include_dirs
619 // LLNDK can override the base includes
620 if llndkIncludes := llndkProps.Override_export_include_dirs; llndkIncludes != nil {
621 includes = llndkIncludes
622 }
623 if proptools.Bool(llndkProps.Export_headers_as_system) {
624 systemIncludes = append(systemIncludes, includes...)
625 includes = nil
626 }
627
628 attrs := bazelCcLibraryHeadersAttributes{
629 Export_includes: bazel.MakeStringListAttribute(includes),
630 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
631 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, llndkProps.Export_llndk_headers)),
632 }
633 return apiIncludes{
634 name: c.Name() + ".vendorapi.headers",
635 attrs: bazelCcApiLibraryHeadersAttributes{
636 bazelCcLibraryHeadersAttributes: attrs,
637 },
638 }
639}
640
Patrice Arruda83c89e02019-03-25 15:32:39 -0700641// cc_library creates both static and/or shared libraries for a device and/or
642// host. By default, a cc_library has a single variant that targets the device.
643// Specifying `host_supported: true` also creates a library that targets the
644// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700645func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800646 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000647 // Can be used as both a static and a shared library.
648 module.sdkMemberTypes = []android.SdkMemberType{
649 sharedLibrarySdkMemberType,
650 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000651 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000652 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400653 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400654 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700655 return module.Init()
656}
657
Patrice Arruda83c89e02019-03-25 15:32:39 -0700658// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700659func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800660 module, library := NewLibrary(android.HostAndDeviceSupported)
661 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000662 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400663 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400664 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700665 return module.Init()
666}
667
Patrice Arruda83c89e02019-03-25 15:32:39 -0700668// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700669func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800670 module, library := NewLibrary(android.HostAndDeviceSupported)
671 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000672 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400673 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000674 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_static creates a static library that is linkable to a host
679// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700680func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800681 module, library := NewLibrary(android.HostSupported)
682 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000683 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000684 module.bazelable = true
685 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700686 return module.Init()
687}
688
Patrice Arruda83c89e02019-03-25 15:32:39 -0700689// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700690func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800691 module, library := NewLibrary(android.HostSupported)
692 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000693 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800694 module.bazelable = true
695 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700696 return module.Init()
697}
698
Chris Parsons3c27ca32020-11-20 12:42:07 -0500699// flagExporter is a separated portion of libraryDecorator pertaining to exported
700// include paths and flags. Keeping this dependency-related information separate
701// from the rest of library information is helpful in keeping data more structured
702// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700703type flagExporter struct {
704 Properties FlagExporterProperties
705
Chris Parsons3c27ca32020-11-20 12:42:07 -0500706 dirs android.Paths // Include directories to be included with -I
707 systemDirs android.Paths // System include directories to be included with -isystem
708 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900709 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900710 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700711}
712
Chris Parsons3c27ca32020-11-20 12:42:07 -0500713// exportedIncludes returns the effective include paths for this module and
714// any module that links against this module. This is obtained from
715// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700716func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900717 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800718 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700719 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900720 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
721 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
722 }
723 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700724}
725
Chris Parsons3c27ca32020-11-20 12:42:07 -0500726// exportIncludes registers the include directories and system include directories to be exported
727// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900728func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900729 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900730 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700731}
732
Chris Parsons3c27ca32020-11-20 12:42:07 -0500733// exportIncludesAsSystem registers the include directories and system include directories to be
734// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900735func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900736 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900737 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900738 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900739}
740
Chris Parsons3c27ca32020-11-20 12:42:07 -0500741// reexportDirs registers the given directories as include directories to be exported transitively
742// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900743func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900744 f.dirs = append(f.dirs, dirs...)
745}
746
Chris Parsons3c27ca32020-11-20 12:42:07 -0500747// reexportSystemDirs registers the given directories as system include directories
748// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900749func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900750 f.systemDirs = append(f.systemDirs, dirs...)
751}
752
Chris Parsons3c27ca32020-11-20 12:42:07 -0500753// reexportFlags registers the flags to be exported transitively to modules depending on this
754// module.
Inseob Kim69378442019-06-03 19:10:47 +0900755func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800756 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
757 panic(fmt.Errorf("Exporting invalid flag %q: "+
758 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900759 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700760 f.flags = append(f.flags, flags...)
761}
762
Inseob Kim69378442019-06-03 19:10:47 +0900763func (f *flagExporter) reexportDeps(deps ...android.Path) {
764 f.deps = append(f.deps, deps...)
765}
766
Inseob Kimd110f872019-12-06 13:15:38 +0900767// addExportedGeneratedHeaders does nothing but collects generated header files.
768// This can be differ to exportedDeps which may contain phony files to minimize ninja.
769func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
770 f.headers = append(f.headers, headers...)
771}
772
Colin Cross0de8a1e2020-09-18 14:15:30 -0700773func (f *flagExporter) setProvider(ctx android.ModuleContext) {
774 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400775 // Comes from Export_include_dirs property, and those of exported transitive deps
776 IncludeDirs: android.FirstUniquePaths(f.dirs),
777 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700778 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400779 // Used in very few places as a one-off way of adding extra defines.
780 Flags: f.flags,
781 // Used sparingly, for extra files that need to be explicitly exported to dependers,
782 // or for phony files to minimize ninja.
783 Deps: f.deps,
784 // For exported generated headers, such as exported aidl headers, proto headers, or
785 // sysprop headers.
786 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700787 })
Inseob Kim69378442019-06-03 19:10:47 +0900788}
789
Colin Crossb916a382016-07-29 17:28:03 -0700790// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
791// functionality: static vs. shared linkage, reusing object files for shared libraries
792type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800793 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700794 StaticProperties StaticProperties
795 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800796 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700797
798 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900799 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700800
Colin Cross26c34ed2016-09-30 17:10:16 -0700801 // table-of-contents file to optimize out relinking when possible
802 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700803
Colin Cross4d9c2d12016-07-29 12:48:20 -0700804 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400805 flagExporterInfo *FlagExporterInfo
806 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700807
Colin Cross4d9c2d12016-07-29 12:48:20 -0700808 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800809 objects Objects
810 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700811
812 // Uses the module's name if empty, but can be overridden. Does not include
813 // shlib suffix.
814 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700815
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800816 sabi *sabi
817
Dan Willemsen581341d2017-02-09 16:16:31 -0800818 // Output archive of gcno coverage information files
819 coverageOutputFile android.OptionalPath
820
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800821 // linked Source Abi Dump
822 sAbiOutputFile android.OptionalPath
823
824 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800825 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000826
Colin Cross0875c522017-11-28 17:34:01 -0800827 // Location of the static library in the sysroot. Empty if the library is
828 // not included in the NDK.
829 ndkSysrootPath android.Path
830
Colin Crossb60190a2018-09-04 16:28:17 -0700831 // Location of the linked, unstripped library for shared libraries
832 unstrippedOutputFile android.Path
833
Dan Willemsen569edc52018-11-19 09:33:29 -0800834 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000835 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800836
Colin Cross8e21aa52020-09-28 18:28:02 -0700837 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900838
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800839 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900840
Vic Yangefd249e2018-11-12 20:19:56 -0800841 // If useCoreVariant is true, the vendor variant of a VNDK library is
842 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800843 useCoreVariant bool
844 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800845
Colin Cross5ec407b2020-09-30 11:41:33 -0700846 skipAPIDefine bool
847
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100848 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700849 *baseCompiler
850 *baseLinker
851 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900852
853 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700854
855 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900856}
857
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400858type ccLibraryBazelHandler struct {
Chris Parsons808d84c2021-03-09 20:43:32 -0500859 module *Module
860}
861
Chris Parsons6ce2cf92022-05-20 10:54:17 -0400862var _ BazelHandler = (*ccLibraryBazelHandler)(nil)
863
Chris Parsons94a0bba2021-06-04 15:03:47 -0400864// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
865// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400866func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400867 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400868 if len(rootStaticArchives) != 1 {
869 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsonsf874e462022-05-10 13:50:12 -0400870 return
Chris Parsons944e7d02021-03-11 11:08:46 -0500871 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400872 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500873 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
874
Chris Parsons94a0bba2021-06-04 15:03:47 -0400875 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500876 objFiles := make(android.Paths, len(objPaths))
877 for i, objPath := range objPaths {
878 objFiles[i] = android.PathForBazelOut(ctx, objPath)
879 }
880 objects := Objects{
881 objFiles: objFiles,
882 }
883
884 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
885 StaticLibrary: outputFilePath,
886 ReuseObjects: objects,
887 Objects: objects,
888
Chris Parsons94a0bba2021-06-04 15:03:47 -0400889 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500890 // static libraries with deps.
891 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
892 Direct(outputFilePath).
893 Build(),
894 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400895
Chris Parsonsf874e462022-05-10 13:50:12 -0400896 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400897}
898
899// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
900// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400901func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400902 rootDynamicLibraries := ccInfo.RootDynamicLibraries
903
904 if len(rootDynamicLibraries) != 1 {
905 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
Chris Parsonsf874e462022-05-10 13:50:12 -0400906 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400907 }
908 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
909 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
910
Sasha Smundakedd16662022-10-07 14:44:50 -0700911 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = android.PathForBazelOut(ctx, ccInfo.UnstrippedOutput)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400912
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000913 var tocFile android.OptionalPath
914 if len(ccInfo.TocFile) > 0 {
915 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
916 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400917 handler.module.linker.(*libraryDecorator).tocFile = tocFile
918
Yu Liu24214aa2022-11-22 12:30:59 -0800919 if len(ccInfo.AbiDiffFiles) > 0 {
920 handler.module.linker.(*libraryDecorator).sAbiDiff = android.PathsForBazelOut(ctx, ccInfo.AbiDiffFiles)
921 }
922
Chris Parsons94a0bba2021-06-04 15:03:47 -0400923 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
924 TableOfContents: tocFile,
925 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000926 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400927 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000928 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400929 })
Chris Parsons94a0bba2021-06-04 15:03:47 -0400930}
931
Chris Parsonsf874e462022-05-10 13:50:12 -0400932func (handler *ccLibraryBazelHandler) QueueBazelCall(ctx android.BaseModuleContext, label string) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400933 bazelCtx := ctx.Config().BazelContext
Chris Parsonsf874e462022-05-10 13:50:12 -0400934 bazelCtx.QueueBazelRequest(label, cquery.GetCcInfo, android.GetConfigKey(ctx))
935}
936
937func (handler *ccLibraryBazelHandler) ProcessBazelQueryResponse(ctx android.ModuleContext, label string) {
938 bazelCtx := ctx.Config().BazelContext
939 ccInfo, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400940 if err != nil {
941 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
Chris Parsonsf874e462022-05-10 13:50:12 -0400942 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400943 }
944
945 if handler.module.static() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400946 handler.generateStaticBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400947 } else if handler.module.Shared() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400948 handler.generateSharedBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400949 } else {
Chris Parsonsf874e462022-05-10 13:50:12 -0400950 ctx.ModuleErrorf("Unhandled bazel case for %s (neither shared nor static!)", ctx.ModuleName())
Chris Parsons94a0bba2021-06-04 15:03:47 -0400951 }
952
953 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
954 handler.module.maybeUnhideFromMake()
955
Chris Parsonseefc9e62021-04-02 17:36:47 -0400956 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
957 // Dependencies on this library will expect collectedSnapshotHeaders to
958 // be set, otherwise validation will fail. For now, set this to an empty
959 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400960 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400961 // implementation.
962 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
963 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500964}
965
Chris Parsons94a0bba2021-06-04 15:03:47 -0400966func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
967 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
968 // flag exporters consolidates properties like includes, flags, dependencies that should be
969 // exported from this module to other modules
970 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
971 // Store flag info to be passed along to androidmk
972 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
973 library.flagExporterInfo = &flagExporterInfo
974}
975
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400976func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900977 ret := android.Paths{}
978
979 // Headers in the source tree should be globbed. On the contrast, generated headers
980 // can't be globbed, and they should be manually collected.
981 // So, we first filter out intermediate directories (which contains generated headers)
982 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400983 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900984 dir := path.String()
985 // Skip if dir is for generated headers
Spandan Das925cb2a2022-11-03 16:34:12 +0000986 if strings.HasPrefix(dir, ctx.Config().OutDir()) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900987 continue
988 }
Yu Liu1175c052022-08-15 10:21:31 -0700989
990 // Filter out the generated headers from bazel.
991 if strings.HasPrefix(dir, android.PathForBazelOut(ctx, "bazel-out").String()) {
992 continue
993 }
994
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900995 // libeigen wrongly exports the root directory "external/eigen". But only two
996 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
997 // some of them have no extension. So we need special treatment for libeigen in order
998 // to glob correctly.
999 if dir == "external/eigen" {
1000 // Only these two directories contains exported headers.
1001 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
Liz Kammer0ea79982022-02-07 08:51:47 -05001002 globDir := "external/eigen/" + subdir + "/**/*"
1003 glob, err := ctx.GlobWithDeps(globDir, nil)
Inseob Kim04f2d6a2020-05-29 22:30:58 +09001004 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -05001005 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001006 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +09001007 }
1008 for _, header := range glob {
1009 if strings.HasSuffix(header, "/") {
1010 continue
1011 }
1012 ext := filepath.Ext(header)
1013 if ext != "" && ext != ".h" {
1014 continue
1015 }
1016 ret = append(ret, android.PathForSource(ctx, header))
1017 }
1018 }
1019 continue
1020 }
Liz Kammer0ea79982022-02-07 08:51:47 -05001021 globDir := dir + "/**/*"
1022 glob, err := ctx.GlobWithDeps(globDir, nil)
Colin Crossec118d02021-01-22 18:05:59 +00001023 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -05001024 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001025 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001026 }
Colin Crossec118d02021-01-22 18:05:59 +00001027 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -07001028 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +00001029 if isLibcxx {
1030 // Glob all files under this special directory, because of C++ headers with no
1031 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -07001032 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001033 continue
1034 }
Colin Crossec118d02021-01-22 18:05:59 +00001035 } else {
1036 // Filter out only the files with extensions that are headers.
1037 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001038 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +00001039 if strings.HasSuffix(header, ext) {
1040 found = true
1041 break
1042 }
1043 }
1044 if !found {
1045 continue
1046 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001047 }
Jose Galmes0d736912021-03-30 11:00:06 -07001048 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001049 }
1050 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001051 return ret
1052}
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001053
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001054func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
1055 ret := android.Paths{}
1056 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001057 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
1058 if strings.HasSuffix(header.Base(), "-phony") {
1059 continue
1060 }
1061 ret = append(ret, header)
1062 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001063 return ret
1064}
1065
1066// collectHeadersForSnapshot collects all exported headers from library.
1067// It globs header files in the source tree for exported include directories,
1068// and tracks generated header files separately.
1069//
1070// This is to be called from GenerateAndroidBuildActions, and then collected
1071// header files can be retrieved by snapshotHeaders().
1072func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
1073 ret := android.Paths{}
1074
1075 // Headers in the source tree should be globbed. On the contrast, generated headers
1076 // can't be globbed, and they should be manually collected.
1077 // So, we first filter out intermediate directories (which contains generated headers)
1078 // from exported directories, and then glob headers under remaining directories.
1079 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
1080
1081 // Collect generated headers
1082 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001083
1084 l.collectedSnapshotHeaders = ret
1085}
1086
1087// This returns all exported header files, both generated ones and headers from source tree.
1088// collectHeadersForSnapshot() must be called before calling this.
1089func (l *libraryDecorator) snapshotHeaders() android.Paths {
1090 if l.collectedSnapshotHeaders == nil {
1091 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
1092 }
1093 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -07001094}
1095
Chris Parsons3c27ca32020-11-20 12:42:07 -05001096// linkerProps returns the list of properties structs relevant for this library. (For example, if
1097// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -07001098func (library *libraryDecorator) linkerProps() []interface{} {
1099 var props []interface{}
1100 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001101 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001102 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -08001103 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001104 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -07001105 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001106
1107 if library.MutatedProperties.BuildShared {
1108 props = append(props, &library.SharedProperties)
1109 }
1110 if library.MutatedProperties.BuildStatic {
1111 props = append(props, &library.StaticProperties)
1112 }
1113
1114 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -07001115}
1116
Chris Parsons3c27ca32020-11-20 12:42:07 -05001117// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
1118// library, or that are implied by attributes of this library (such as whether this library is a
1119// shared library).
Colin Crossb916a382016-07-29 17:28:03 -07001120func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -07001121 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001122
Colin Crossb916a382016-07-29 17:28:03 -07001123 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
1124 // all code is position independent, and then those warnings get promoted to
1125 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -07001126 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001127 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -07001128 }
1129
1130 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001131 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001132 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001133 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -07001134 }
1135
Colin Crossa48ab5b2017-02-14 15:28:44 -08001136 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001137 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001138 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -07001139 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001140 f = append(f,
1141 "-nostdlib",
1142 "-Wl,--gc-sections",
1143 )
1144 }
1145
1146 if ctx.Darwin() {
1147 f = append(f,
1148 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -07001149 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
1150 )
Colin Cross7863cf52016-10-20 10:47:21 -07001151 if ctx.Arch().ArchType == android.X86 {
1152 f = append(f,
1153 "-read_only_relocs suppress",
1154 )
1155 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001156 } else {
Josh Gao75a50a22019-06-07 17:58:59 -07001157 f = append(f, "-shared")
1158 if !ctx.Windows() {
1159 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
1160 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001161 }
1162
Colin Cross4af21ed2019-11-04 09:37:55 -08001163 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001164 }
1165
1166 return flags
1167}
1168
Chris Parsons3c27ca32020-11-20 12:42:07 -05001169// compilerFlags takes a Flags and augments it to contain compile flags from global values,
1170// per-target values, module type values, per-module Blueprints properties, extra flags from
1171// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -08001172func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001173 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001174 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -07001175 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -08001176 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
1177 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001178 }
1179
Jiyong Park7ed9de32018-10-15 22:25:07 +09001180 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -08001181 if ctx.IsLlndk() {
1182 // LLNDK libraries ignore most of the properties on the cc_library and use the
1183 // LLNDK-specific properties instead.
1184 // Wipe all the module-local properties, leaving only the global properties.
1185 flags.Local = LocalOrGlobalFlags{}
1186 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001187 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +09001188 // Remove -include <file> when compiling stubs. Otherwise, the force included
1189 // headers might cause conflicting types error with the symbols in the
1190 // generated stubs source code. e.g.
1191 // double acos(double); // in header
1192 // void acos() {} // in the generated source code
1193 removeInclude := func(flags []string) []string {
1194 ret := flags[:0]
1195 for _, f := range flags {
1196 if strings.HasPrefix(f, "-include ") {
1197 continue
1198 }
1199 ret = append(ret, f)
1200 }
1201 return ret
1202 }
Colin Cross4af21ed2019-11-04 09:37:55 -08001203 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
1204 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +09001205
Jiyong Park7ed9de32018-10-15 22:25:07 +09001206 flags = addStubLibraryCompilerFlags(flags)
1207 }
1208 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -07001209}
1210
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001211func (library *libraryDecorator) headerAbiCheckerEnabled() bool {
1212 return Bool(library.Properties.Header_abi_checker.Enabled)
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001213}
1214
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001215func (library *libraryDecorator) headerAbiCheckerExplicitlyDisabled() bool {
1216 return !BoolDefault(library.Properties.Header_abi_checker.Enabled, true)
Logan Chien41eabe62019-04-10 13:33:58 +08001217}
1218
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001219func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -08001220 if ctx.IsLlndk() {
1221 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
1222 vndkVer := ctx.Module().(*Module).VndkVersion()
1223 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
1224 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
1225 vndkVer = "current"
1226 }
1227 if library.stubsVersion() != "" {
1228 vndkVer = library.stubsVersion()
1229 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001230 nativeAbiResult := parseNativeAbiDefinition(ctx,
1231 String(library.Properties.Llndk.Symbol_file),
1232 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
1233 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -08001234 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001235 library.versionScriptPath = android.OptionalPathForPath(
1236 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -08001237 }
1238 return objs
1239 }
Colin Cross5271fea2021-04-27 13:06:04 -07001240 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -07001241 nativeAbiResult := parseNativeAbiDefinition(ctx,
1242 String(library.Properties.Vendor_public_library.Symbol_file),
1243 android.FutureApiLevel, "")
1244 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001245 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001246 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001247 }
1248 return objs
1249 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001250 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001251 symbolFile := String(library.Properties.Stubs.Symbol_file)
1252 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1253 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1254 return Objects{}
1255 }
Jiyong Park85cc35a2022-07-17 11:30:47 +09001256 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
1257 // systemapi, respectively. The former is for symbols defined in platform libraries
1258 // and the latter is for symbols defined in APEXes.
1259 var flag string
1260 if ctx.Module().(android.ApexModule).NotInPlatform() {
1261 flag = "--apex"
1262 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +09001263 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +09001264 }
Jiyong Parkaa27c082022-09-26 21:16:09 +09001265 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
1266 // the stub so that it is mandated that all symbols are explicitly marked with
1267 // either apex or systemapi.
1268 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
1269 flag = flag + " --no-ndk"
1270 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001271 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +09001272 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -07001273 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1274 library.versionScriptPath = android.OptionalPathForPath(
1275 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001276
1277 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001278 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001279 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1280 }
1281
Jiyong Park7ed9de32018-10-15 22:25:07 +09001282 return objs
1283 }
1284
Colin Cross5950f382016-12-13 12:50:57 -08001285 if !library.buildShared() && !library.buildStatic() {
1286 if len(library.baseCompiler.Properties.Srcs) > 0 {
1287 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1288 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001289 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001290 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1291 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001292 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001293 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1294 }
1295 return Objects{}
1296 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001297 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001298 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001299 var SourceAbiFlags []string
1300 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001301 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001302 }
Inseob Kim69378442019-06-03 19:10:47 +09001303 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1304 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001305 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001306 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001307 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001308 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001309 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001310 flags.SAbiDump = true
1311 }
1312 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001313 objs := library.baseCompiler.compile(ctx, flags, deps)
1314 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001315 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001316
Colin Cross4d9c2d12016-07-29 12:48:20 -07001317 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001318 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001319 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1320 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001321 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001322 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001323 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001324 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001325 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1326 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001327 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001328 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001329 }
1330
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001331 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001332}
1333
1334type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001335 versionedInterface
1336
Colin Crossb916a382016-07-29 17:28:03 -07001337 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001338 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001339 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001340 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001341 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001342
1343 // Returns true if the build options for the module have selected a static or shared build
1344 buildStatic() bool
1345 buildShared() bool
1346
1347 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001348 setStatic()
1349 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001350
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001351 // Check whether header_abi_checker is enabled or explicitly disabled.
1352 headerAbiCheckerEnabled() bool
1353 headerAbiCheckerExplicitlyDisabled() bool
1354
Logan Chien41eabe62019-04-10 13:33:58 +08001355 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1356 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001357
1358 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001359
1360 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001361
1362 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001363}
1364
Colin Crossc88c2722020-09-28 17:32:47 -07001365type versionedInterface interface {
1366 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001367 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001368 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +00001369 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001370 setStubsVersion(string)
1371 stubsVersion() string
1372
Colin Cross3572cf72020-10-01 15:58:11 -07001373 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001374 setAllStubsVersions([]string)
1375 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001376
1377 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001378 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001379 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001380 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001381}
1382
1383var _ libraryInterface = (*libraryDecorator)(nil)
1384var _ versionedInterface = (*libraryDecorator)(nil)
1385
Justin Yun6977e8a2020-10-29 18:24:11 +09001386func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001387 name := library.libName
1388 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001389 name = String(library.Properties.Stem)
1390 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001391 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001392 }
Colin Crossb916a382016-07-29 17:28:03 -07001393 }
1394
Colin Cross0fd6a412019-08-16 14:22:10 -07001395 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001396 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001397 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001398 } else if inProduct {
1399 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001400 }
1401 if suffix == "" {
1402 suffix = String(library.Properties.Suffix)
1403 }
1404
Jooyung Han0302a842019-10-30 18:43:49 +09001405 return name + suffix
1406}
1407
Chris Parsons3c27ca32020-11-20 12:42:07 -05001408// getLibName returns the actual canonical name of the library (the name which
1409// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001410func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001411 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001412
Ivan Lozanof9e21722020-12-02 09:00:51 -05001413 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001414 // vndk-ext lib should have the same name with original lib
1415 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1416 originalName := module.(*Module).outputFile.Path()
1417 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1418 })
Logan Chienf3511742017-10-31 18:04:35 +08001419 }
1420
Colin Crossb916a382016-07-29 17:28:03 -07001421 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1422 if !strings.HasSuffix(name, "-host") {
1423 name = name + "-host"
1424 }
1425 }
1426
Inseob Kim0ce291e2019-07-04 14:38:27 +09001427 return name
Colin Crossb916a382016-07-29 17:28:03 -07001428}
1429
Jiyong Parkda732bd2018-11-02 18:23:15 +09001430var versioningMacroNamesListMutex sync.Mutex
1431
Colin Crossb916a382016-07-29 17:28:03 -07001432func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1433 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001434 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001435 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001436 }
1437 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001438 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001439 // Let baseLinker know whether this variant is for stubs or not, so that
1440 // it can omit things that are not required for linking stubs.
1441 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001442
1443 if library.buildStubs() {
1444 macroNames := versioningMacroNamesList(ctx.Config())
1445 myName := versioningMacroName(ctx.ModuleName())
1446 versioningMacroNamesListMutex.Lock()
1447 defer versioningMacroNamesListMutex.Unlock()
1448 if (*macroNames)[myName] == "" {
1449 (*macroNames)[myName] = ctx.ModuleName()
1450 } else if (*macroNames)[myName] != ctx.ModuleName() {
1451 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1452 }
1453 }
Colin Crossb916a382016-07-29 17:28:03 -07001454}
1455
dimitry0345ad82018-12-05 16:28:14 +01001456func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001457 if ctx.IsLlndk() {
1458 // LLNDK libraries ignore most of the properties on the cc_library and use the
1459 // LLNDK-specific properties instead.
1460 return deps
1461 }
1462
dimitry0345ad82018-12-05 16:28:14 +01001463 deps = library.baseCompiler.compilerDeps(ctx, deps)
1464
dimitry0345ad82018-12-05 16:28:14 +01001465 return deps
1466}
1467
Colin Cross37047f12016-12-13 17:06:13 -08001468func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001469 if ctx.IsLlndk() {
1470 // LLNDK libraries ignore most of the properties on the cc_library and use the
1471 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001472 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1473 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001474 return deps
1475 }
Colin Cross5271fea2021-04-27 13:06:04 -07001476 if ctx.IsVendorPublicLibrary() {
1477 headers := library.Properties.Vendor_public_library.Export_public_headers
1478 deps.HeaderLibs = append([]string(nil), headers...)
1479 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1480 return deps
1481 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001482
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001483 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001484 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001485 if library.StaticProperties.Static.System_shared_libs != nil {
1486 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001487 }
1488 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001489 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001490 if library.SharedProperties.Shared.System_shared_libs != nil {
1491 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001492 }
1493 }
1494
Colin Crossb916a382016-07-29 17:28:03 -07001495 deps = library.baseLinker.linkerDeps(ctx, deps)
1496
1497 if library.static() {
1498 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001499 library.StaticProperties.Static.Whole_static_libs...)
1500 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1501 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001502
Colin Crosse1bb5d02019-09-24 14:55:04 -07001503 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1504 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001505 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001506 if !Bool(library.baseLinker.Properties.Nocrt) {
1507 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1508 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001509 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001510 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1511 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1512 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001513
Colin Crosse1bb5d02019-09-24 14:55:04 -07001514 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1515 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001516 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001517 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001518 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1519 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1520 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001521 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1522 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001523 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001524 if ctx.inProduct() {
1525 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1526 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1527 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1528 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1529 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1530 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001531 if ctx.inRecovery() {
1532 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1533 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1534 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001535 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1536 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001537 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001538 if ctx.inRamdisk() {
1539 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1540 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1541 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1542 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1543 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1544 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001545 if ctx.inVendorRamdisk() {
1546 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1547 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1548 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1549 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1550 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1551 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001552
Colin Cross4d9c2d12016-07-29 12:48:20 -07001553 return deps
1554}
1555
Paul Duffin13f02712020-03-06 12:30:43 +00001556func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1557 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1558 var properties StaticOrSharedProperties
1559 if library.static() {
1560 properties = library.StaticProperties.Static
1561 } else if library.shared() {
1562 properties = library.SharedProperties.Shared
1563 }
1564
1565 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001566
1567 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1568 // either input list doesn't come out as nil.
1569 if specifiedDeps.systemSharedLibs == nil {
1570 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1571 } else {
1572 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1573 }
Paul Duffin13f02712020-03-06 12:30:43 +00001574
1575 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001576 if len(specifiedDeps.systemSharedLibs) > 0 {
1577 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1578 // retained.
1579 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1580 }
Paul Duffin13f02712020-03-06 12:30:43 +00001581 return specifiedDeps
1582}
1583
Colin Crossb916a382016-07-29 17:28:03 -07001584func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001585 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001586
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001587 library.objects = deps.WholeStaticLibObjs.Copy()
1588 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001589 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001590
Inseob Kim0ce291e2019-07-04 14:38:27 +09001591 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001592 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001593 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001594
Dan Willemsen569edc52018-11-19 09:33:29 -08001595 if Bool(library.baseLinker.Properties.Use_version_lib) {
1596 if ctx.Host() {
1597 versionedOutputFile := outputFile
1598 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1599 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1600 } else {
1601 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001602 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001603 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1604 }
Colin Cross86803cf2018-02-15 14:12:26 -08001605 }
1606
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001607 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001608
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001609 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001610
Colin Cross4d9c2d12016-07-29 12:48:20 -07001611 ctx.CheckbuildFile(outputFile)
1612
Colin Cross649d8172020-12-10 12:30:21 -08001613 if library.static() {
1614 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001615 StaticLibrary: outputFile,
1616 ReuseObjects: library.reuseObjects,
1617 Objects: library.objects,
1618 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001619
Colin Cross649d8172020-12-10 12:30:21 -08001620 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1621 Direct(outputFile).
1622 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1623 Build(),
1624 })
1625 }
1626
1627 if library.header() {
1628 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1629 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001630
Colin Cross4d9c2d12016-07-29 12:48:20 -07001631 return outputFile
1632}
1633
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001634func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1635 if ctx.Module().(*Module).IsSdkVariant() {
1636 // The NDK sysroot timestamp file depends on all the NDK
1637 // sysroot header and shared library files.
1638 return android.Paths{getNdkBaseTimestampFile(ctx)}
1639 }
1640 return nil
1641}
1642
Colin Crossb916a382016-07-29 17:28:03 -07001643func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001644 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001645
1646 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001647 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001648 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001649
Colin Cross2383f3b2018-02-06 14:40:13 -08001650 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1651 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1652 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001653 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001654 if unexportedSymbols.Valid() {
1655 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1656 }
1657 if forceNotWeakSymbols.Valid() {
1658 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1659 }
1660 if forceWeakSymbols.Valid() {
1661 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1662 }
1663 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001664 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001665 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001666 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1667 }
1668 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001669 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001670 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1671 }
1672 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001673 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001674 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1675 }
1676 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001677 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001678 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001679 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001680 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001681 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001682
1683 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1684 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001685 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001686
Josh Gao75a50a22019-06-07 17:58:59 -07001687 var implicitOutputs android.WritablePaths
1688 if ctx.Windows() {
1689 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1690
Colin Cross4af21ed2019-11-04 09:37:55 -08001691 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001692 implicitOutputs = append(implicitOutputs, importLibraryPath)
1693 }
1694
Colin Cross4d9c2d12016-07-29 12:48:20 -07001695 builderFlags := flagsToBuilderFlags(flags)
1696
Dan Willemsen47450072021-10-19 20:24:49 -07001697 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1698 fatOutputFile := outputFile
1699 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1700 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1701 }
1702
Colin Crossb496cfd2018-09-10 16:50:05 -07001703 // Optimize out relinking against shared libraries whose interface hasn't changed by
1704 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001705 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001706 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001707 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001708
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001709 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001710 needsStrip := library.stripper.NeedsStrip(ctx)
1711 if library.buildStubs() {
1712 // No need to strip stubs libraries
1713 needsStrip = false
1714 }
1715 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001716 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001717 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001718 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001719 strippedOutputFile := outputFile
1720 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001721 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001722 }
Colin Crossb60190a2018-09-04 16:28:17 -07001723 library.unstrippedOutputFile = outputFile
1724
Colin Crossd7227f92019-09-05 14:26:33 -07001725 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001726
Dan Willemsen569edc52018-11-19 09:33:29 -08001727 if Bool(library.baseLinker.Properties.Use_version_lib) {
1728 if ctx.Host() {
1729 versionedOutputFile := outputFile
1730 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1731 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1732 } else {
1733 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001734 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001735
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001736 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001737 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001738 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001739 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001740 }
1741
1742 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1743 }
Colin Cross86803cf2018-02-15 14:12:26 -08001744 }
1745
Jiyong Park64a44f22019-01-18 14:37:08 +09001746 sharedLibs := deps.EarlySharedLibs
1747 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001748 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1749
Jiyong Park64a44f22019-01-18 14:37:08 +09001750 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001751 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1752 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001753 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001754 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001755 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001756
Dan Willemsen581341d2017-02-09 16:16:31 -08001757 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1758 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001759 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1760 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1761
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001762 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001763 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001764
Liz Kammeref6dfea2021-06-08 15:37:09 -04001765 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001766 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1767 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001768 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001769 }
1770
1771 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001772 TableOfContents: android.OptionalPathForPath(tocFile),
1773 SharedLibrary: unstrippedOutputFile,
1774 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1775 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001776 })
1777
1778 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1779 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001780 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001781 for _, stub := range stubs {
1782 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1783 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001784 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001785 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001786 SharedLibraryInfo: stubInfo,
1787 FlagExporterInfo: flagInfo,
1788 })
1789 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001790 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1791 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001792
Colin Cross127bb8b2020-12-16 16:46:01 -08001793 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001794 })
1795 }
1796
1797 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001798}
1799
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001800func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1801 return library.unstrippedOutputFile
1802}
1803
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001804func (library *libraryDecorator) disableStripping() {
1805 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1806}
1807
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001808func (library *libraryDecorator) nativeCoverage() bool {
1809 if library.header() || library.buildStubs() {
1810 return false
1811 }
1812 return true
1813}
1814
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001815func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1816 return library.coverageOutputFile
1817}
1818
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001819func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1820 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001821
1822 currentArchType := ctx.Arch().ArchType
1823 primaryArchType := ctx.Config().DevicePrimaryArchType()
1824 archName := currentArchType.String()
1825 if currentArchType != primaryArchType {
1826 archName += "_" + primaryArchType.String()
1827 }
1828
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001829 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001830 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001831}
1832
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001833func getRefAbiDumpDir(isNdk, isVndk bool) string {
1834 var dirName string
1835 if isNdk {
1836 dirName = "ndk"
1837 } else if isVndk {
1838 dirName = "vndk"
1839 } else {
1840 dirName = "platform"
1841 }
1842 return filepath.Join("prebuilts", "abi-dumps", dirName)
1843}
Logan Chien7eefdc42018-07-11 18:10:41 +08001844
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001845func prevRefAbiDumpVersion(ctx ModuleContext, dumpDir string) int {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001846 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
1847 sdkVersionStr := ctx.Config().PlatformSdkVersion().String()
1848
1849 if ctx.Config().PlatformSdkFinal() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001850 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001851 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001852 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1853 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1854 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001855 versionedDumpDir := android.ExistentPathForSource(ctx, dumpDir, sdkVersionStr)
1856 if versionedDumpDir.Valid() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001857 return sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001858 } else {
Mu-Le Lee13043932022-08-27 08:55:25 +00001859 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001860 }
1861 }
1862}
1863
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001864func currRefAbiDumpVersion(ctx ModuleContext, isVndk bool) string {
1865 if isVndk {
1866 // Each version of VNDK is independent, so follow the VNDK version which is the codename or PLATFORM_SDK_VERSION.
1867 return ctx.Module().(*Module).VndkVersion()
1868 } else if ctx.Config().PlatformSdkFinal() {
1869 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1870 // so choose PLATFORM_SDK_VERSION as the current version.
1871 return ctx.Config().PlatformSdkVersion().String()
1872 } else {
1873 return "current"
1874 }
1875}
1876
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001877// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
1878func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1879 baseName, nameExt string, isLlndkOrNdk, allowExtensions bool,
1880 sourceVersion, errorMessage string) {
1881
1882 sourceDump := library.sAbiOutputFile.Path()
1883
1884 extraFlags := []string{"-target-version", sourceVersion}
1885 if Bool(library.Properties.Header_abi_checker.Check_all_apis) {
1886 extraFlags = append(extraFlags, "-check-all-apis")
1887 } else {
1888 extraFlags = append(extraFlags,
1889 "-allow-unreferenced-changes",
1890 "-allow-unreferenced-elf-symbol-changes")
1891 }
1892 if isLlndkOrNdk {
1893 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1894 }
1895 if allowExtensions {
1896 extraFlags = append(extraFlags, "-allow-extensions")
1897 }
1898 extraFlags = append(extraFlags, library.Properties.Header_abi_checker.Diff_flags...)
1899
1900 library.sAbiDiff = append(
1901 library.sAbiDiff,
1902 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1903 baseName, nameExt, extraFlags, errorMessage))
1904}
1905
1906func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1907 baseName string, isLlndkOrNdk bool, sourceVersion, prevVersion string) {
1908
1909 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 + "."
1910
1911 library.sourceAbiDiff(ctx, referenceDump, baseName, prevVersion,
1912 isLlndkOrNdk, /* allowExtensions */ true, sourceVersion, errorMessage)
1913}
1914
1915func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1916 baseName string, isLlndkOrNdk, allowExtensions bool) {
1917
1918 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1919 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName
1920
1921 library.sourceAbiDiff(ctx, referenceDump, baseName, /* nameExt */ "",
1922 isLlndkOrNdk, allowExtensions, "current", errorMessage)
1923}
1924
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001925func (library *libraryDecorator) optInAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1926 baseName, nameExt string, isLlndkOrNdk bool, refDumpDir string) {
1927
1928 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1929 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName + " -ref-dump-dir $$ANDROID_BUILD_TOP/" + refDumpDir
1930
1931 library.sourceAbiDiff(ctx, referenceDump, baseName, nameExt,
1932 isLlndkOrNdk, /* allowExtensions */ false, "current", errorMessage)
1933}
1934
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001935func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001936 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001937 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001938 var SourceAbiFlags []string
1939 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001940 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1941 }
Inseob Kim69378442019-06-03 19:10:47 +09001942 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1943 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001944 }
1945 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001946 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001947 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001948 library.Properties.Header_abi_checker.Exclude_symbol_versions,
1949 library.Properties.Header_abi_checker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001950
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001951 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001952
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001953 // The logic must be consistent with classifySourceAbiDump.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001954 isVndk := ctx.useVndk() && ctx.isVndk()
Hsin-Yi Chen7584bda2022-11-08 22:51:02 +08001955 isNdk := ctx.isNdk(ctx.Config())
1956 isLlndk := ctx.isImplementationForLLNDKPublic()
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001957 dumpDir := getRefAbiDumpDir(isNdk, isVndk)
1958 binderBitness := ctx.DeviceConfig().BinderBitness()
Mu-Le Lee13043932022-08-27 08:55:25 +00001959 // If NDK or PLATFORM library, check against previous version ABI.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001960 if !isVndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001961 prevVersionInt := prevRefAbiDumpVersion(ctx, dumpDir)
1962 prevVersion := strconv.Itoa(prevVersionInt)
1963 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1964 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001965 if prevDumpFile.Valid() {
1966 library.crossVersionAbiDiff(ctx, prevDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001967 fileName, isLlndk || isNdk,
1968 strconv.Itoa(prevVersionInt+1), prevVersion)
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001969 }
1970 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001971 // Check against the current version.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001972 currVersion := currRefAbiDumpVersion(ctx, isVndk)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001973 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1974 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001975 if currDumpFile.Valid() {
1976 library.sameVersionAbiDiff(ctx, currDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001977 fileName, isLlndk || isNdk, ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001978 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001979 // Check against the opt-in reference dumps.
1980 for i, optInDumpDir := range library.Properties.Header_abi_checker.Ref_dump_dirs {
1981 optInDumpDirPath := android.PathForModuleSrc(ctx, optInDumpDir)
1982 // Ref_dump_dirs are not versioned.
1983 // They do not contain subdir for binder bitness because 64-bit binder has been mandatory.
1984 optInDumpFile := getRefAbiDumpFile(ctx, optInDumpDirPath.String(), fileName)
1985 if !optInDumpFile.Valid() {
1986 continue
1987 }
1988 library.optInAbiDiff(ctx, optInDumpFile.Path(),
1989 fileName, "opt"+strconv.Itoa(i), isLlndk || isNdk,
1990 optInDumpDirPath.String())
1991 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001992 }
1993}
1994
Inseob Kimcc12d902021-05-14 20:15:55 +09001995func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001996 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1997 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1998
Colin Cross127bb8b2020-12-16 16:46:01 -08001999 for _, header := range srcFiles {
2000 headerDir := filepath.Dir(header.String())
2001 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
2002 if err != nil {
2003 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
2004 srcDir.String(), headerDir, err)
2005 continue
2006 }
2007
2008 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
2009 }
2010
Inseob Kimcc12d902021-05-14 20:15:55 +09002011 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08002012}
2013
Chris Parsons3c27ca32020-11-20 12:42:07 -05002014// link registers actions to link this library, and sets various fields
2015// on this library to reflect information that should be exported up the build
2016// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07002017func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002018 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002019
Colin Cross127bb8b2020-12-16 16:46:01 -08002020 if ctx.IsLlndk() {
2021 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
2022 // This is the vendor variant of an LLNDK library with preprocessed headers.
2023 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
2024
2025 var timestampFiles android.Paths
2026 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09002027 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
2028 timestampFiles = append(timestampFiles, timestampFile)
2029 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08002030 }
2031
2032 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2033 library.reexportSystemDirs(genHeaderOutDir)
2034 } else {
2035 library.reexportDirs(genHeaderOutDir)
2036 }
2037
2038 library.reexportDeps(timestampFiles...)
2039 }
2040
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002041 // override the module's export_include_dirs with llndk.override_export_include_dirs
2042 // if it is set.
2043 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
2044 library.flagExporter.Properties.Export_include_dirs = override
2045 }
2046
Colin Cross127bb8b2020-12-16 16:46:01 -08002047 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2048 library.flagExporter.Properties.Export_system_include_dirs = append(
2049 library.flagExporter.Properties.Export_system_include_dirs,
2050 library.flagExporter.Properties.Export_include_dirs...)
2051 library.flagExporter.Properties.Export_include_dirs = nil
2052 }
2053 }
2054
Colin Cross5271fea2021-04-27 13:06:04 -07002055 if ctx.IsVendorPublicLibrary() {
2056 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
2057 // if it is set.
2058 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
2059 library.flagExporter.Properties.Export_include_dirs = override
2060 }
2061 }
2062
Chris Parsons3c27ca32020-11-20 12:42:07 -05002063 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
2064 // of this library), together with `objs` (.o files created by compiling this
2065 // library).
Colin Crossad59e752017-11-16 14:29:11 -08002066 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002067 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08002068 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002069 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002070 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002071 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002072 }
2073
Chris Parsons3c27ca32020-11-20 12:42:07 -05002074 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09002075 library.exportIncludes(ctx)
2076 library.reexportDirs(deps.ReexportedDirs...)
2077 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
2078 library.reexportFlags(deps.ReexportedFlags...)
2079 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09002080 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002081
Chris Parsons3c27ca32020-11-20 12:42:07 -05002082 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002083 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002084 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09002085 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09002086 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09002087
Paul Duffin33056e82021-02-19 13:49:08 +00002088 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
2089 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07002090 }
2091 }
2092
Chris Parsons3c27ca32020-11-20 12:42:07 -05002093 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002094 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002095 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09002096 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07002097 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09002098 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07002099 }
Jiyong Park74955042019-10-22 20:19:51 +09002100 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09002101 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09002102
Paul Duffin33056e82021-02-19 13:49:08 +00002103 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
2104 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07002105 }
2106 }
2107
Inseob Kim07def122020-11-23 14:43:02 +09002108 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09002109 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09002110 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002111 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09002112 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
2113
Inseob Kim07def122020-11-23 14:43:02 +09002114 // If the owner is different from the user, expose public header. That is,
2115 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09002116 // 2) if the owner is platform and the client is vendor
2117 // We don't care Platform -> Vendor dependency as it's already forbidden.
2118 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09002119 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002120 }
2121 }
2122
Paul Duffin37e0de52021-02-19 17:05:39 +00002123 // Make sure to only export headers which are within the include directory.
2124 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
2125 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
2126 return isRel
2127 })
2128
Chris Parsons3c27ca32020-11-20 12:42:07 -05002129 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09002130 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00002131 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00002132 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09002133 }
2134
Chris Parsons3c27ca32020-11-20 12:42:07 -05002135 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09002136 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002137
Chris Parsons3c27ca32020-11-20 12:42:07 -05002138 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002139 library.flagExporter.setProvider(ctx)
2140
Colin Cross4d9c2d12016-07-29 12:48:20 -07002141 return out
2142}
2143
Jiyong Park892a98f2020-12-14 09:20:00 +09002144func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002145 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09002146 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09002147 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
2148 if err != nil {
2149 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
2150 }
2151 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09002152 }
2153}
2154
Chris Parsons3c27ca32020-11-20 12:42:07 -05002155// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07002156func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002157 return library.MutatedProperties.BuildStatic &&
2158 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002159}
2160
Chris Parsons3c27ca32020-11-20 12:42:07 -05002161// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07002162func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002163 return library.MutatedProperties.BuildShared &&
2164 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002165}
2166
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002167func (library *libraryDecorator) objs() Objects {
2168 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002169}
2170
Colin Cross0de8a1e2020-09-18 14:15:30 -07002171func (library *libraryDecorator) reuseObjs() Objects {
2172 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002173}
2174
Colin Cross26c34ed2016-09-30 17:10:16 -07002175func (library *libraryDecorator) toc() android.OptionalPath {
2176 return library.tocFile
2177}
2178
Jiyong Parkf1194352019-02-25 11:05:47 +09002179func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
2180 dir := library.baseInstaller.installDir(ctx)
2181 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
2182 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
2183 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002184 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09002185}
2186
Colin Crossb916a382016-07-29 17:28:03 -07002187func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07002188 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09002189 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09002190 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05002191 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002192 if ctx.isVndkSp() {
2193 library.baseInstaller.subDir = "vndk-sp"
2194 } else {
2195 library.baseInstaller.subDir = "vndk"
2196 }
2197 }
2198
Justin Yun31094b12020-12-24 16:11:23 +09002199 // In some cases we want to use core variant for VNDK-Core libs.
2200 // Skip product variant since VNDKs use only the vendor variant.
2201 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08002202 mayUseCoreVariant := true
2203
2204 if ctx.mustUseVendorVariant() {
2205 mayUseCoreVariant = false
2206 }
2207
Elvis Chien9c993542021-06-25 01:15:17 +08002208 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08002209 mayUseCoreVariant = false
2210 }
2211
2212 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08002213 library.checkSameCoreVariant = true
2214 if ctx.DeviceConfig().VndkUseCoreVariant() {
2215 library.useCoreVariant = true
2216 }
Vic Yangefd249e2018-11-12 20:19:56 -08002217 }
Justin Yun8fe12122017-12-07 17:18:15 +09002218 }
Logan Chienf3511742017-10-31 18:04:35 +08002219
Jooyung Han261e1582020-10-20 18:54:21 +09002220 // do not install vndk libs
2221 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05002222 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002223 return
Justin Yun8effde42017-06-23 19:24:43 +09002224 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002225 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09002226 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
2227 // The original path becomes a symlink to the corresponding file in the
2228 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07002229 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07002230 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002231 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01002232 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09002233 library.installSymlinkToRuntimeApex(ctx, file)
2234 }
Jiyong Park429660f2019-01-16 22:31:11 +09002235 library.baseInstaller.subDir = "bootstrap"
2236 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002237 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002238 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002239 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09002240 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002241
Colin Cross4d9c2d12016-07-29 12:48:20 -07002242 library.baseInstaller.install(ctx, file)
2243 }
Dan Albertf563d252017-10-13 00:29:00 -07002244
Dan Albert281f22b2017-12-13 15:03:47 -08002245 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002246 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09002247 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08002248 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07002249 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07002250 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07002251
2252 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
2253 Rule: android.Cp,
2254 Description: "install " + installPath.Base(),
2255 Output: installPath,
2256 Input: file,
2257 })
2258
Colin Cross0875c522017-11-28 17:34:01 -08002259 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07002260 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002261}
2262
Paul Duffin0cb37b92020-03-04 14:52:46 +00002263func (library *libraryDecorator) everInstallable() bool {
2264 // Only shared and static libraries are installed. Header libraries (which are
2265 // neither static or shared) are not installed.
2266 return library.shared() || library.static()
2267}
2268
Chris Parsons3c27ca32020-11-20 12:42:07 -05002269// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07002270func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002271 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07002272}
2273
Chris Parsons3c27ca32020-11-20 12:42:07 -05002274// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002275func (library *libraryDecorator) shared() bool {
2276 return library.MutatedProperties.VariantIsShared
2277}
2278
Chris Parsons3c27ca32020-11-20 12:42:07 -05002279// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002280func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002281 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002282 return !library.static() && !library.shared()
2283}
2284
Chris Parsons3c27ca32020-11-20 12:42:07 -05002285// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002286func (library *libraryDecorator) setStatic() {
2287 library.MutatedProperties.VariantIsStatic = true
2288 library.MutatedProperties.VariantIsShared = false
2289}
2290
Chris Parsons3c27ca32020-11-20 12:42:07 -05002291// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002292func (library *libraryDecorator) setShared() {
2293 library.MutatedProperties.VariantIsStatic = false
2294 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07002295}
2296
Chris Parsons3c27ca32020-11-20 12:42:07 -05002297// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08002298func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002299 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08002300}
2301
Chris Parsons3c27ca32020-11-20 12:42:07 -05002302// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08002303func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002304 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08002305}
2306
Chris Parsons3c27ca32020-11-20 12:42:07 -05002307// HeaderOnly disables building this library as a shared or static library;
2308// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08002309func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002310 library.MutatedProperties.BuildShared = false
2311 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08002312}
2313
Colin Cross127bb8b2020-12-16 16:46:01 -08002314// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
2315func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07002316 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002317}
2318
Colin Cross203b4212021-04-26 17:19:41 -07002319// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07002320func (library *libraryDecorator) hasLLNDKHeaders() bool {
2321 return Bool(library.Properties.Llndk.Llndk_headers)
2322}
2323
Colin Cross5271fea2021-04-27 13:06:04 -07002324// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
2325// vendor public library stubs.
2326func (library *libraryDecorator) hasVendorPublicLibrary() bool {
2327 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
2328}
2329
Colin Cross0477b422020-10-13 18:43:54 -07002330func (library *libraryDecorator) implementationModuleName(name string) string {
2331 return name
2332}
2333
Jiyong Park7ed9de32018-10-15 22:25:07 +09002334func (library *libraryDecorator) buildStubs() bool {
2335 return library.MutatedProperties.BuildStubs
2336}
2337
Jiyong Parka034b832019-08-27 14:02:19 +09002338func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
2339 if library.Properties.Header_abi_checker.Symbol_file != nil {
2340 return library.Properties.Header_abi_checker.Symbol_file
2341 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002342 if ctx.Module().(*Module).IsLlndk() {
2343 return library.Properties.Llndk.Symbol_file
2344 }
Colin Cross31076b32020-10-23 17:22:06 -07002345 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09002346 return library.Properties.Stubs.Symbol_file
2347 }
2348 return nil
2349}
2350
Colin Crossc88c2722020-09-28 17:32:47 -07002351func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002352 // Just having stubs.symbol_file is enough to create a stub variant. In that case
2353 // the stub for the future API level is created.
2354 return library.Properties.Stubs.Symbol_file != nil ||
2355 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07002356}
2357
Alan Stokes73feba32022-11-14 12:21:24 +00002358func (library *libraryDecorator) isStubsImplementationRequired() bool {
2359 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
2360}
2361
Colin Cross3572cf72020-10-01 15:58:11 -07002362func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002363 if !library.hasStubsVariants() {
2364 return nil
2365 }
2366
Colin Crossc1b36442021-05-06 13:42:48 -07002367 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
2368 // LLNDK libraries only need a single stubs variant.
2369 return []string{android.FutureApiLevel.String()}
2370 }
2371
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002372 // Future API level is implicitly added if there isn't
2373 vers := library.Properties.Stubs.Versions
2374 if inList(android.FutureApiLevel.String(), vers) {
2375 return vers
2376 }
2377 // In some cases, people use the raw value "10000" in the versions property.
2378 // We shouldn't add the future API level in that case, otherwise there will
2379 // be two identical versions.
2380 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2381 return vers
2382 }
2383 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002384}
2385
2386func (library *libraryDecorator) setStubsVersion(version string) {
2387 library.MutatedProperties.StubsVersion = version
2388}
2389
Jiyong Park7ed9de32018-10-15 22:25:07 +09002390func (library *libraryDecorator) stubsVersion() string {
2391 return library.MutatedProperties.StubsVersion
2392}
2393
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002394func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002395 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002396 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002397}
2398
2399func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2400 library.MutatedProperties.AllStubsVersions = versions
2401}
2402
2403func (library *libraryDecorator) allStubsVersions() []string {
2404 return library.MutatedProperties.AllStubsVersions
2405}
2406
Jooyung Hanad4c1872020-02-27 17:56:44 +09002407func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002408 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002409}
2410
Jiyong Parka90ca002019-10-07 15:47:24 +09002411func (library *libraryDecorator) availableFor(what string) bool {
2412 var list []string
2413 if library.static() {
2414 list = library.StaticProperties.Static.Apex_available
2415 } else if library.shared() {
2416 list = library.SharedProperties.Shared.Apex_available
2417 }
2418 if len(list) == 0 {
2419 return false
2420 }
2421 return android.CheckAvailableForApex(what, list)
2422}
2423
Colin Cross1bc94122021-10-28 13:25:54 -07002424func (library *libraryDecorator) installable() *bool {
2425 if library.static() {
2426 return library.StaticProperties.Static.Installable
2427 } else if library.shared() {
2428 return library.SharedProperties.Shared.Installable
2429 }
2430 return nil
2431}
2432
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002433func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002434 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002435 // If we're asked to make a static library uninstallable we don't do
2436 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2437 // for these entries. This is done to still get the make targets for NOTICE
2438 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002439 return
2440 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002441 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002442}
2443
Jihoon Kangf78a8902022-09-01 22:47:07 +00002444func (library *libraryDecorator) getPartition() string {
2445 return library.path.Partition()
2446}
2447
Colin Crossceaa5322021-09-28 16:37:50 -07002448func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2449 return library.apiListCoverageXmlPath
2450}
2451
Inseob Kima1888ce2022-10-04 14:42:02 +09002452func (library *libraryDecorator) overriddenModules() []string {
2453 return library.Properties.Overrides
2454}
2455
2456var _ overridable = (*libraryDecorator)(nil)
2457
Colin Cross571cccf2019-02-04 11:22:08 -08002458var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2459
Chris Parsons3c27ca32020-11-20 12:42:07 -05002460// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2461// and values are the module name responsible for registering the version macro name.
2462//
2463// Version macros are used when building against stubs, to provide version information about
2464// the stub. Only stub libraries should have an entry in this list.
2465//
2466// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2467// that headers from libFoo can be conditionally compiled (this may hide APIs
2468// that are not available for the version).
2469//
2470// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002471func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002472 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002473 m := make(map[string]string)
2474 return &m
2475 }).(*map[string]string)
2476}
2477
2478// alphanumeric and _ characters are preserved.
2479// other characters are all converted to _
2480var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2481
Chris Parsons3c27ca32020-11-20 12:42:07 -05002482// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002483func versioningMacroName(moduleName string) string {
2484 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002485 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002486 return "__" + macroName + "_API__"
2487}
2488
Chris Parsons3c27ca32020-11-20 12:42:07 -05002489// NewLibrary builds and returns a new Module corresponding to a C++ library.
2490// Individual module implementations which comprise a C++ library (or something like
2491// a C++ library) should call this function, set some fields on the result, and
2492// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002493func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002494 module := newModule(hod, android.MultilibBoth)
2495
Colin Crossb916a382016-07-29 17:28:03 -07002496 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002497 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002498 BuildShared: true,
2499 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002500 },
Colin Crossb916a382016-07-29 17:28:03 -07002501 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002502 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002503 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002504 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002505 }
2506
Colin Crossb916a382016-07-29 17:28:03 -07002507 module.compiler = library
2508 module.linker = library
2509 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002510 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002511
2512 return module, library
2513}
2514
Colin Cross10d22312017-05-03 11:01:58 -07002515// connects a shared library to a static library in order to reuse its .o files to avoid
2516// compiling source files twice.
2517func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2518 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2519 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002520
2521 // Check libraries in addition to cflags, since libraries may be exporting different
2522 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002523 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2524 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2525 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2526 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2527 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2528 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2529 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2530 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002531 // Compare System_shared_libs properties with nil because empty lists are
2532 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002533 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2534 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002535
2536 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2537 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2538 sharedCompiler.baseCompiler.Properties.Srcs
2539 sharedCompiler.baseCompiler.Properties.Srcs = nil
2540 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2541 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002542
2543 // This dep is just to reference static variant from shared variant
2544 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002545 }
2546}
2547
Chris Parsons3c27ca32020-11-20 12:42:07 -05002548// LinkageMutator adds "static" or "shared" variants for modules depending
2549// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002550func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002551 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002552 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002553 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002554 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002555 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002556 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002557
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002558 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002559 buildStatic := library.buildStatic()
2560 buildShared := library.buildShared()
2561 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002562 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2563 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2564 // all the variants of the cc_library also exist on the prebuilt.
2565 modules := mctx.CreateLocalVariations("static", "shared")
2566 static := modules[0].(*Module)
2567 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002568
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002569 static.linker.(prebuiltLibraryInterface).setStatic()
2570 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002571
Colin Cross127bb8b2020-12-16 16:46:01 -08002572 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002573 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002574 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002575 mctx.AliasVariation("static")
2576 }
2577
Colin Cross127bb8b2020-12-16 16:46:01 -08002578 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002579 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2580 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002581 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002582 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2583 }
2584 } else {
2585 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002586 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002587
Ivan Lozano52767be2019-10-18 14:49:46 -07002588 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002589
Ivan Lozano2b262972019-11-21 12:30:50 -08002590 // Non-cc.Modules may need an empty variant for their mutators.
2591 variations := []string{}
2592 if library.NonCcVariants() {
2593 variations = append(variations, "")
2594 }
2595
Colin Cross127bb8b2020-12-16 16:46:01 -08002596 isLLNDK := false
2597 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002598 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002599 }
2600 buildStatic := library.BuildStaticVariant() && !isLLNDK
2601 buildShared := library.BuildSharedVariant()
2602 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002603 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002604
2605 modules := mctx.CreateLocalVariations(variations...)
2606 static := modules[0].(LinkableInterface)
2607 shared := modules[1].(LinkableInterface)
2608
2609 static.SetStatic()
2610 shared.SetShared()
2611
2612 if _, ok := library.(*Module); ok {
2613 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2614 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002615 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002616 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002617 variations := append([]string{"static"}, variations...)
2618
2619 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002620 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002621 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002622 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002623 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002624
Ivan Lozano2b262972019-11-21 12:30:50 -08002625 modules := mctx.CreateLocalVariations(variations...)
2626 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002627 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002628 } else if len(variations) > 0 {
2629 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002630 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002631 }
Colin Crossb916a382016-07-29 17:28:03 -07002632 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002633}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002634
Chris Parsons3c27ca32020-11-20 12:42:07 -05002635// normalizeVersions modifies `versions` in place, so that each raw version
2636// string becomes its normalized canonical form.
2637// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002638func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002639 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002640 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002641 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002642 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002643 ctx.PropertyErrorf("versions", "%s", err.Error())
2644 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002645 }
Dan Albertc8060532020-07-22 22:32:17 -07002646 if i > 0 && ver.LessThanOrEqualTo(previous) {
2647 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2648 }
2649 versions[i] = ver.String()
2650 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002651 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002652}
2653
Jooyung Han61b66e92020-03-21 14:21:46 +00002654func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002655 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2656 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002657 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002658
Colin Cross127bb8b2020-12-16 16:46:01 -08002659 m := mctx.Module().(*Module)
2660 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002661 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002662 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002663
Colin Crossd1f898e2020-08-18 18:35:15 -07002664 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002665 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002666
Kiyoung Kimee58c932022-10-25 22:59:41 +09002667 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002668 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002669 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002670 c.sanitize = nil
2671 c.stl = nil
2672 c.Properties.PreventInstall = true
2673 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002674 isLatest := i == (len(versions) - 1)
2675 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002676
2677 if variants[i] != "" {
2678 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2679 // implementation module to the stubs module.
2680 c.Properties.HideFromMake = true
2681 lib.setStubsVersion(variants[i])
2682 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2683 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002684 }
2685 }
Colin Cross094faa52020-08-06 17:38:25 -07002686 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002687 latestVersion := ""
2688 if len(versions) > 0 {
2689 latestVersion = versions[len(versions)-1]
2690 }
2691 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002692}
2693
Colin Crossbbc941b2020-09-30 12:27:01 -07002694func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2695 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2696 if err != nil {
2697 mctx.PropertyErrorf("min_sdk_version", err.Error())
2698 return
2699 }
2700
2701 versionStrs := ndkLibraryVersions(mctx, from)
2702 modules := mctx.CreateLocalVariations(versionStrs...)
2703
2704 for i, module := range modules {
2705 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002706 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002707 }
2708}
2709
Liz Kammer23942242022-04-08 15:41:00 -04002710func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002711 Host() bool
2712 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002713 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002714}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002715 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002716}
2717
Liz Kammer23942242022-04-08 15:41:00 -04002718func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002719 Host() bool
2720 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002721 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002722 CcLibraryInterface() bool
2723 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002724}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002725 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002726 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002727}
2728
Colin Cross127bb8b2020-12-16 16:46:01 -08002729func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002730 if m, ok := module.(*Module); ok {
2731 return m.library
2732 }
2733 return nil
2734}
2735
Liz Kammer23942242022-04-08 15:41:00 -04002736// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2737func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2738 if !library.buildShared() || !canBeVersionVariant(module) {
2739 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002740 }
Liz Kammer23942242022-04-08 15:41:00 -04002741 versions := library.stubsVersions(mctx)
2742 if len(versions) <= 0 {
2743 return
2744 }
2745 normalizeVersions(mctx, versions)
2746 if mctx.Failed() {
2747 return
2748 }
2749 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2750 // depend on the implementation library and haven't been mutated yet.
2751 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002752}
Jooyung Han61b66e92020-03-21 14:21:46 +00002753
Colin Crossd1f898e2020-08-18 18:35:15 -07002754// versionMutator splits a module into the mandatory non-stubs variant
2755// (which is unnamed) and zero or more stubs variants.
2756func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002757 if mctx.Os() != android.Android {
2758 return
2759 }
2760
2761 m, ok := mctx.Module().(*Module)
2762 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2763 setStubsVersions(mctx, library, m)
2764
Colin Cross31076b32020-10-23 17:22:06 -07002765 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002766 return
2767 }
2768
Liz Kammer23942242022-04-08 15:41:00 -04002769 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002770 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002771 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2772 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002773 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002774}
Colin Crossd7227f92019-09-05 14:26:33 -07002775
2776// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2777// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2778// that the linked output file should be written to.
2779// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2780func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2781 inject *bool, fileName string) android.ModuleOutPath {
2782 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2783 injectBoringSSLHash := Bool(inject)
2784 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002785 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002786 if cc, ok := dep.(*Module); ok {
2787 if library, ok := cc.linker.(*libraryDecorator); ok {
2788 if Bool(library.Properties.Inject_bssl_hash) {
2789 injectBoringSSLHash = true
2790 }
2791 }
2792 }
2793 }
2794 })
2795 if injectBoringSSLHash {
2796 hashedOutputfile := outputFile
2797 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2798
Colin Crossf1a035e2020-11-16 17:32:30 -08002799 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002800 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002801 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002802 FlagWithInput("-in-object ", outputFile).
2803 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002804 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002805 }
2806
2807 return outputFile
2808}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002809
Yu Liu56ccb1a2022-11-12 10:47:07 -08002810func bp2buildParseAbiCheckerProps(ctx android.TopDownMutatorContext, module *Module) bazelCcHeaderAbiCheckerAttributes {
2811 lib, ok := module.linker.(*libraryDecorator)
2812 if !ok {
2813 return bazelCcHeaderAbiCheckerAttributes{}
2814 }
2815
2816 abiChecker := lib.Properties.Header_abi_checker
2817
2818 abiCheckerAttrs := bazelCcHeaderAbiCheckerAttributes{
2819 Abi_checker_enabled: abiChecker.Enabled,
2820 Abi_checker_exclude_symbol_versions: abiChecker.Exclude_symbol_versions,
2821 Abi_checker_exclude_symbol_tags: abiChecker.Exclude_symbol_tags,
2822 Abi_checker_check_all_apis: abiChecker.Check_all_apis,
2823 Abi_checker_diff_flags: abiChecker.Diff_flags,
2824 }
2825 if abiChecker.Symbol_file != nil {
2826 symbolFile := android.BazelLabelForModuleSrcSingle(ctx, *abiChecker.Symbol_file)
2827 abiCheckerAttrs.Abi_checker_symbol_file = &symbolFile
2828 }
2829
2830 return abiCheckerAttrs
2831}
2832
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002833func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002834 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2835 compilerAttrs := baseAttributes.compilerAttributes
2836 linkerAttrs := baseAttributes.linkerAttributes
2837
Liz Kammer54549442022-05-11 13:55:06 -04002838 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, &compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002839
2840 // Append shared/static{} stanza properties. These won't be specified on
2841 // cc_library_* itself, but may be specified in cc_defaults that this module
2842 // depends on.
2843 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2844
2845 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2846 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2847 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2848 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002849
2850 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2851 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002852 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002853 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002854 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2855
2856 asFlags := compilerAttrs.asFlags
2857 if compilerAttrs.asSrcs.IsEmpty() {
2858 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2859 asFlags = bazel.MakeStringListAttribute(nil)
2860 }
2861
Liz Kammer7a210ac2021-09-22 15:52:58 -04002862 commonAttrs := staticOrSharedAttributes{
2863 Srcs: compilerAttrs.srcs,
2864 Srcs_c: compilerAttrs.cSrcs,
2865 Srcs_as: compilerAttrs.asSrcs,
2866 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002867 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002868
Liz Kammer12615db2021-09-28 09:19:17 -04002869 Deps: linkerAttrs.deps,
2870 Implementation_deps: linkerAttrs.implementationDeps,
2871 Dynamic_deps: linkerAttrs.dynamicDeps,
2872 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2873 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2874 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2875 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Yu Liufc603162022-03-01 15:44:08 -08002876 sdkAttributes: bp2BuildParseSdkAttributes(module),
Cole Faust6b29f592022-08-09 09:50:56 -07002877 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liuf01a0f02022-12-07 15:45:30 -08002878 Native_coverage: baseAttributes.Native_coverage,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002879 }
2880
Sam Delmericoc9b8fbd2022-10-25 15:47:17 -04002881 module.convertTidyAttributes(ctx, &commonAttrs.tidyAttributes)
Sam Delmericofb3bb322022-10-21 10:42:24 -04002882
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002883 var attrs interface{}
2884 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002885 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002886 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002887 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002888
Liz Kammerbaced712022-09-16 09:01:29 -04002889 Use_libcrt: linkerAttrs.useLibcrt,
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002890
Liz Kammer1263d9b2021-12-10 14:28:20 -05002891 Rtti: compilerAttrs.rtti,
2892 Stl: compilerAttrs.stl,
2893 Cpp_std: compilerAttrs.cppStd,
2894 C_std: compilerAttrs.cStd,
2895
2896 Export_includes: exportedIncludes.Includes,
2897 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2898 Export_system_includes: exportedIncludes.SystemIncludes,
2899 Local_includes: compilerAttrs.localIncludes,
2900 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002901
2902 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002903 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002904 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002905
Cole Faust5fa4e962022-08-22 14:31:04 -07002906 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002907 }
2908 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002909 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2910
Wei Li81852ca2022-07-27 00:22:06 -07002911 sharedLibAttrs := &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002912 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002913
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002914 Cppflags: compilerAttrs.cppFlags,
2915 Conlyflags: compilerAttrs.conlyFlags,
2916 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002917
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002918 Linkopts: linkerAttrs.linkopts,
2919 Link_crt: linkerAttrs.linkCrt,
2920 Use_libcrt: linkerAttrs.useLibcrt,
2921 Use_version_lib: linkerAttrs.useVersionLib,
2922
2923 Rtti: compilerAttrs.rtti,
2924 Stl: compilerAttrs.stl,
2925 Cpp_std: compilerAttrs.cppStd,
2926 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002927
Liz Kammerd2871182021-10-04 13:54:37 -04002928 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002929 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002930 Export_system_includes: exportedIncludes.SystemIncludes,
2931 Local_includes: compilerAttrs.localIncludes,
2932 Absolute_includes: compilerAttrs.absoluteIncludes,
2933 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002934
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00002935 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
Liz Kammer0eae52e2021-10-06 10:32:26 -04002936
Cole Faust5fa4e962022-08-22 14:31:04 -07002937 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05002938
2939 Suffix: compilerAttrs.suffix,
Yu Liu56ccb1a2022-11-12 10:47:07 -08002940
2941 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, module),
Vinh Tran99270ea2022-11-28 11:15:23 -05002942
2943 Fdo_profile: compilerAttrs.fdoProfile,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002944 }
Wei Li81852ca2022-07-27 00:22:06 -07002945 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
Yu Liu56ccb1a2022-11-12 10:47:07 -08002946 sharedLibAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Wei Li81852ca2022-07-27 00:22:06 -07002947 }
2948 attrs = sharedLibAttrs
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002949 }
2950
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002951 var modType string
2952 if isStatic {
2953 modType = "cc_library_static"
2954 } else {
2955 modType = "cc_library_shared"
Trevor Radcliffef19d8a72022-09-20 23:04:39 +00002956 createStubsBazelTargetIfNeeded(ctx, module, compilerAttrs, exportedIncludes, baseAttributes)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002957 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002958 props := bazel.BazelTargetModuleProperties{
2959 Rule_class: modType,
Liz Kammer2b376bc2022-01-12 12:00:49 -05002960 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 +00002961 }
2962
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002963 tags := android.ApexAvailableTags(module)
Yu Liuf01a0f02022-12-07 15:45:30 -08002964
2965 // This lib needs some special handling in bazel, so add this tag to the build
2966 // file.
2967 if module.Name() == "libprofile-clang-extras" {
2968 tags.Append(bazel.MakeStringListAttribute([]string{"NO_EXPORTING"}))
2969 }
2970
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002971 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 +00002972}
2973
2974// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002975type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002976 staticOrSharedAttributes
2977
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002978 Use_libcrt bazel.BoolAttribute
2979 Use_version_lib bazel.BoolAttribute
2980
2981 Rtti bazel.BoolAttribute
2982 Stl *string
2983 Cpp_std *string
2984 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002985
Liz Kammer1263d9b2021-12-10 14:28:20 -05002986 Export_includes bazel.StringListAttribute
2987 Export_absolute_includes bazel.StringListAttribute
2988 Export_system_includes bazel.StringListAttribute
2989 Local_includes bazel.StringListAttribute
2990 Absolute_includes bazel.StringListAttribute
2991 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002992
2993 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002994 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002995 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002996
2997 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002998}
2999
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003000// TODO(b/199902614): Can this be factored to share with the other Attributes?
3001type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04003002 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003003
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05003004 Linkopts bazel.StringListAttribute
3005 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
3006
3007 Use_libcrt bazel.BoolAttribute
3008 Use_version_lib bazel.BoolAttribute
3009
3010 Rtti bazel.BoolAttribute
3011 Stl *string
3012 Cpp_std *string
3013 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003014
Liz Kammer1263d9b2021-12-10 14:28:20 -05003015 Export_includes bazel.StringListAttribute
3016 Export_absolute_includes bazel.StringListAttribute
3017 Export_system_includes bazel.StringListAttribute
3018 Local_includes bazel.StringListAttribute
3019 Absolute_includes bazel.StringListAttribute
3020 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003021
Liz Kammerd2871182021-10-04 13:54:37 -04003022 Strip stripAttributes
3023 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04003024
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003025 Cppflags bazel.StringListAttribute
3026 Conlyflags bazel.StringListAttribute
3027 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04003028
3029 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00003030
Yu Liu56ccb1a2022-11-12 10:47:07 -08003031 Stubs_symbol_file *string
Wei Li81852ca2022-07-27 00:22:06 -07003032
3033 Inject_bssl_hash bazel.BoolAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05003034
3035 Suffix bazel.StringAttribute
Yu Liu56ccb1a2022-11-12 10:47:07 -08003036
3037 bazelCcHeaderAbiCheckerAttributes
Vinh Tran99270ea2022-11-28 11:15:23 -05003038
3039 Fdo_profile bazel.LabelAttribute
Wei Li81852ca2022-07-27 00:22:06 -07003040}
3041
3042type bazelCcStubSuiteAttributes struct {
3043 Symbol_file *string
3044 Versions bazel.StringListAttribute
3045 Export_includes bazel.StringListAttribute
3046 Source_library bazel.LabelAttribute
3047 Soname *string
3048 Deps bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003049}
Yu Liu56ccb1a2022-11-12 10:47:07 -08003050
3051type bazelCcHeaderAbiCheckerAttributes struct {
3052 Abi_checker_enabled *bool
3053 Abi_checker_symbol_file *bazel.Label
3054 Abi_checker_exclude_symbol_versions []string
3055 Abi_checker_exclude_symbol_tags []string
3056 Abi_checker_check_all_apis *bool
3057 Abi_checker_diff_flags []string
3058}