blob: 7059023101c9b7cccf1f05937fd914a9f66ef7ea [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),
Chris Parsons77acf2e2021-12-03 17:27:16 -0500354 }
355
356 sharedCommonAttrs := staticOrSharedAttributes{
357 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
358 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
359 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
360 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
361 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
362
Liz Kammer84b0ecb2022-09-14 10:49:13 -0400363 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
364 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
365 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
366 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
367 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
368 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
369 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
370 Runtime_deps: linkerAttrs.runtimeDeps,
371 sdkAttributes: bp2BuildParseSdkAttributes(m),
Chris Parsons77acf2e2021-12-03 17:27:16 -0500372 }
373
374 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
375 staticOrSharedAttributes: staticCommonAttrs,
376
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000377 Cppflags: compilerAttrs.cppFlags,
378 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400379 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000380
Liz Kammer1263d9b2021-12-10 14:28:20 -0500381 Export_includes: exportedIncludes.Includes,
382 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
383 Export_system_includes: exportedIncludes.SystemIncludes,
384 Local_includes: compilerAttrs.localIncludes,
385 Absolute_includes: compilerAttrs.absoluteIncludes,
386 Use_libcrt: linkerAttrs.useLibcrt,
387 Rtti: compilerAttrs.rtti,
388 Stl: compilerAttrs.stl,
389 Cpp_std: compilerAttrs.cppStd,
390 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500391
Cole Faust5fa4e962022-08-22 14:31:04 -0700392 Features: baseAttributes.features,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500393 }
394
395 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
396 staticOrSharedAttributes: sharedCommonAttrs,
397 Cppflags: compilerAttrs.cppFlags,
398 Conlyflags: compilerAttrs.conlyFlags,
399 Asflags: asFlags,
400
Liz Kammer1263d9b2021-12-10 14:28:20 -0500401 Export_includes: exportedIncludes.Includes,
402 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
403 Export_system_includes: exportedIncludes.SystemIncludes,
404 Local_includes: compilerAttrs.localIncludes,
405 Absolute_includes: compilerAttrs.absoluteIncludes,
406 Linkopts: linkerAttrs.linkopts,
407 Link_crt: linkerAttrs.linkCrt,
408 Use_libcrt: linkerAttrs.useLibcrt,
409 Rtti: compilerAttrs.rtti,
410 Stl: compilerAttrs.stl,
411 Cpp_std: compilerAttrs.cppStd,
412 C_std: compilerAttrs.cStd,
Yu Liua79c9462022-03-22 16:35:22 -0700413 Use_version_lib: linkerAttrs.useVersionLib,
Chris Parsons990c4f42021-05-25 12:10:58 -0400414
Liz Kammerd2871182021-10-04 13:54:37 -0400415 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000416
Yu Liu56ccb1a2022-11-12 10:47:07 -0800417 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
418 Features: baseAttributes.features,
419 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, m),
Wei Li81852ca2022-07-27 00:22:06 -0700420 }
Jingwen Chen0ee88a62022-01-07 14:55:29 +0000421
Wei Li81852ca2022-07-27 00:22:06 -0700422 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
423 hasStubs := true
424 sharedTargetAttrs.Has_stubs.SetValue(&hasStubs)
Yu Liu56ccb1a2022-11-12 10:47:07 -0800425 sharedTargetAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Jingwen Chen63930982021-03-24 10:04:33 -0400426 }
427
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -0500428 sharedTargetAttrs.Suffix = compilerAttrs.suffix
429
Yu Liu75be7b92022-02-01 09:54:09 -0800430 for axis, configToProps := range m.GetArchVariantProperties(ctx, &LibraryProperties{}) {
431 for config, props := range configToProps {
432 if props, ok := props.(*LibraryProperties); ok {
433 if props.Inject_bssl_hash != nil {
434 // This is an edge case applies only to libcrypto
Sam Delmericofae47f92022-08-08 13:35:08 -0400435 if m.Name() == "libcrypto" || m.Name() == "libcrypto_for_testing" {
Yu Liu75be7b92022-02-01 09:54:09 -0800436 sharedTargetAttrs.Inject_bssl_hash.SetSelectValue(axis, config, props.Inject_bssl_hash)
437 } else {
438 ctx.PropertyErrorf("inject_bssl_hash", "only applies to libcrypto")
439 }
440 }
441 }
442 }
443 }
444
Chris Parsons77acf2e2021-12-03 17:27:16 -0500445 staticProps := bazel.BazelTargetModuleProperties{
446 Rule_class: "cc_library_static",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500447 Bzl_load_location: "//build/bazel/rules/cc:cc_library_static.bzl",
Chris Parsons77acf2e2021-12-03 17:27:16 -0500448 }
449 sharedProps := bazel.BazelTargetModuleProperties{
450 Rule_class: "cc_library_shared",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500451 Bzl_load_location: "//build/bazel/rules/cc:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400452 }
453
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000454 tags := android.ApexAvailableTags(m)
Chris Parsons58852a02021-12-09 18:10:18 -0500455 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000456 android.CommonAttributes{
457 Name: m.Name() + "_bp2build_cc_library_static",
458 Tags: tags,
459 },
Chris Parsons58852a02021-12-09 18:10:18 -0500460 staticTargetAttrs, staticAttrs.Enabled)
461 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000462 android.CommonAttributes{
463 Name: m.Name(),
464 Tags: tags,
465 },
Chris Parsons58852a02021-12-09 18:10:18 -0500466 sharedTargetAttrs, sharedAttrs.Enabled)
Wei Li81852ca2022-07-27 00:22:06 -0700467
Trevor Radcliffe087af542022-09-16 15:36:10 +0000468 createStubsBazelTargetIfNeeded(ctx, m, compilerAttrs, exportedIncludes, baseAttributes)
469}
470
471func createStubsBazelTargetIfNeeded(ctx android.TopDownMutatorContext, m *Module, compilerAttrs compilerAttributes, exportedIncludes BazelIncludes, baseAttributes baseAttributes) {
Wei Li81852ca2022-07-27 00:22:06 -0700472 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
473 stubSuitesProps := bazel.BazelTargetModuleProperties{
474 Rule_class: "cc_stub_suite",
475 Bzl_load_location: "//build/bazel/rules/cc:cc_stub_library.bzl",
476 }
477 soname := m.Name() + ".so"
478 stubSuitesAttrs := &bazelCcStubSuiteAttributes{
479 Symbol_file: compilerAttrs.stubsSymbolFile,
480 Versions: compilerAttrs.stubsVersions,
481 Export_includes: exportedIncludes.Includes,
482 Soname: &soname,
483 Source_library: *bazel.MakeLabelAttribute(":" + m.Name()),
484 Deps: baseAttributes.deps,
485 }
486 ctx.CreateBazelTargetModule(stubSuitesProps,
487 android.CommonAttributes{Name: m.Name() + "_stub_libs"},
488 stubSuitesAttrs)
489 }
Jingwen Chen63930982021-03-24 10:04:33 -0400490}
491
Spandan Das4238c652022-09-09 01:38:47 +0000492func apiContributionBp2Build(ctx android.TopDownMutatorContext, module *Module) {
493 apiSurfaces := make([]string, 0)
494 apiHeaders := make([]string, 0)
495 // systemapi (non-null `stubs` property)
496 if module.HasStubsVariants() {
497 apiSurfaces = append(apiSurfaces, android.SystemApi.String())
498 apiIncludes := getSystemApiIncludes(ctx, module)
499 if !apiIncludes.isEmpty() {
500 createApiHeaderTarget(ctx, apiIncludes)
501 apiHeaders = append(apiHeaders, apiIncludes.name)
502 }
503 }
504 // vendorapi (non-null `llndk` property)
505 if module.HasLlndkStubs() {
506 apiSurfaces = append(apiSurfaces, android.VendorApi.String())
507 apiIncludes := getVendorApiIncludes(ctx, module)
508 if !apiIncludes.isEmpty() {
509 createApiHeaderTarget(ctx, apiIncludes)
510 apiHeaders = append(apiHeaders, apiIncludes.name)
511 }
512 }
513 // create a target only if this module contributes to an api surface
514 // TODO: Currently this does not distinguish systemapi-only headers and vendrorapi-only headers
515 // TODO: Update so that systemapi-only headers do not get exported to vendorapi (and vice-versa)
516 if len(apiSurfaces) > 0 {
517 props := bazel.BazelTargetModuleProperties{
518 Rule_class: "cc_api_contribution",
519 Bzl_load_location: "//build/bazel/rules/apis:cc_api_contribution.bzl",
520 }
521 attrs := &bazelCcApiContributionAttributes{
522 Library_name: module.Name(),
523 Api_surfaces: bazel.MakeStringListAttribute(apiSurfaces),
524 Api: apiLabelAttribute(ctx, module),
525 Hdrs: bazel.MakeLabelListAttribute(
526 bazel.MakeLabelListFromTargetNames(apiHeaders),
527 ),
528 }
529 ctx.CreateBazelTargetModule(
530 props,
531 android.CommonAttributes{
532 Name: android.ApiContributionTargetName(module.Name()),
533 SkipData: proptools.BoolPtr(true),
534 },
535 attrs,
536 )
537 }
538}
539
540// Native apis are versioned in a single .map.txt for all api surfaces
541// Pick any one of the .map.txt files
542func apiLabelAttribute(ctx android.TopDownMutatorContext, module *Module) bazel.LabelAttribute {
543 var apiFile *string
544 linker := module.linker.(*libraryDecorator)
545 if llndkApi := linker.Properties.Llndk.Symbol_file; llndkApi != nil {
546 apiFile = llndkApi
547 } else if systemApi := linker.Properties.Stubs.Symbol_file; systemApi != nil {
548 apiFile = systemApi
549 } else {
550 ctx.ModuleErrorf("API surface library does not have any API file")
551 }
552 apiLabel := android.BazelLabelForModuleSrcSingle(ctx, proptools.String(apiFile)).Label
553 return *bazel.MakeLabelAttribute(apiLabel)
554}
555
556// wrapper struct to flatten the arch and os specific export_include_dirs
557// flattening is necessary since we want to export apis of all arches even when we build for x86 (e.g.)
558type bazelCcApiLibraryHeadersAttributes struct {
559 bazelCcLibraryHeadersAttributes
560
561 Arch *string
562}
563
564func (a *bazelCcApiLibraryHeadersAttributes) isEmpty() bool {
565 return a.Export_includes.IsEmpty() &&
566 a.Export_system_includes.IsEmpty() &&
567 a.Deps.IsEmpty()
568}
569
570type apiIncludes struct {
571 name string // name of the Bazel target in the generated bp2build workspace
572 attrs bazelCcApiLibraryHeadersAttributes
573}
574
575func (includes *apiIncludes) isEmpty() bool {
576 return includes.attrs.isEmpty()
577}
578
579func (includes *apiIncludes) addDep(name string) {
580 l := bazel.Label{Label: ":" + name}
581 ll := bazel.MakeLabelList([]bazel.Label{l})
582 lla := bazel.MakeLabelListAttribute(ll)
583 includes.attrs.Deps.Append(lla)
584}
585
586func getSystemApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
587 flagProps := c.library.(*libraryDecorator).flagExporter.Properties
588 linkProps := c.library.(*libraryDecorator).baseLinker.Properties
589 includes := android.FirstUniqueStrings(flagProps.Export_include_dirs)
590 systemIncludes := android.FirstUniqueStrings(flagProps.Export_system_include_dirs)
591 headerLibs := android.FirstUniqueStrings(linkProps.Export_header_lib_headers)
592 attrs := bazelCcLibraryHeadersAttributes{
593 Export_includes: bazel.MakeStringListAttribute(includes),
594 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
595 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, headerLibs)),
596 }
597
598 return apiIncludes{
599 name: c.Name() + ".systemapi.headers",
600 attrs: bazelCcApiLibraryHeadersAttributes{
601 bazelCcLibraryHeadersAttributes: attrs,
602 },
603 }
604}
605
606func getVendorApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
607 baseProps := c.library.(*libraryDecorator).flagExporter.Properties
608 llndkProps := c.library.(*libraryDecorator).Properties.Llndk
609 includes := baseProps.Export_include_dirs
610 systemIncludes := baseProps.Export_system_include_dirs
611 // LLNDK can override the base includes
612 if llndkIncludes := llndkProps.Override_export_include_dirs; llndkIncludes != nil {
613 includes = llndkIncludes
614 }
615 if proptools.Bool(llndkProps.Export_headers_as_system) {
616 systemIncludes = append(systemIncludes, includes...)
617 includes = nil
618 }
619
620 attrs := bazelCcLibraryHeadersAttributes{
621 Export_includes: bazel.MakeStringListAttribute(includes),
622 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
623 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, llndkProps.Export_llndk_headers)),
624 }
625 return apiIncludes{
626 name: c.Name() + ".vendorapi.headers",
627 attrs: bazelCcApiLibraryHeadersAttributes{
628 bazelCcLibraryHeadersAttributes: attrs,
629 },
630 }
631}
632
Patrice Arruda83c89e02019-03-25 15:32:39 -0700633// cc_library creates both static and/or shared libraries for a device and/or
634// host. By default, a cc_library has a single variant that targets the device.
635// Specifying `host_supported: true` also creates a library that targets the
636// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700637func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800638 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000639 // Can be used as both a static and a shared library.
640 module.sdkMemberTypes = []android.SdkMemberType{
641 sharedLibrarySdkMemberType,
642 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000643 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000644 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400645 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400646 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700647 return module.Init()
648}
649
Patrice Arruda83c89e02019-03-25 15:32:39 -0700650// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700651func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800652 module, library := NewLibrary(android.HostAndDeviceSupported)
653 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000654 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400655 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400656 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700657 return module.Init()
658}
659
Patrice Arruda83c89e02019-03-25 15:32:39 -0700660// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700661func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800662 module, library := NewLibrary(android.HostAndDeviceSupported)
663 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000664 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400665 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000666 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700667 return module.Init()
668}
669
Patrice Arruda83c89e02019-03-25 15:32:39 -0700670// cc_library_host_static creates a static library that is linkable to a host
671// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700672func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800673 module, library := NewLibrary(android.HostSupported)
674 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000675 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000676 module.bazelable = true
677 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700678 return module.Init()
679}
680
Patrice Arruda83c89e02019-03-25 15:32:39 -0700681// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700682func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800683 module, library := NewLibrary(android.HostSupported)
684 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000685 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800686 module.bazelable = true
687 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700688 return module.Init()
689}
690
Chris Parsons3c27ca32020-11-20 12:42:07 -0500691// flagExporter is a separated portion of libraryDecorator pertaining to exported
692// include paths and flags. Keeping this dependency-related information separate
693// from the rest of library information is helpful in keeping data more structured
694// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700695type flagExporter struct {
696 Properties FlagExporterProperties
697
Chris Parsons3c27ca32020-11-20 12:42:07 -0500698 dirs android.Paths // Include directories to be included with -I
699 systemDirs android.Paths // System include directories to be included with -isystem
700 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900701 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900702 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700703}
704
Chris Parsons3c27ca32020-11-20 12:42:07 -0500705// exportedIncludes returns the effective include paths for this module and
706// any module that links against this module. This is obtained from
707// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700708func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900709 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800710 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700711 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900712 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
713 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
714 }
715 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700716}
717
Chris Parsons3c27ca32020-11-20 12:42:07 -0500718// exportIncludes registers the include directories and system include directories to be exported
719// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900720func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900721 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900722 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700723}
724
Chris Parsons3c27ca32020-11-20 12:42:07 -0500725// exportIncludesAsSystem registers the include directories and system include directories to be
726// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900727func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900728 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900729 f.systemDirs = append(f.systemDirs, 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)...)
Inseob Kim69378442019-06-03 19:10:47 +0900731}
732
Chris Parsons3c27ca32020-11-20 12:42:07 -0500733// reexportDirs registers the given directories as include directories to be exported transitively
734// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900735func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900736 f.dirs = append(f.dirs, dirs...)
737}
738
Chris Parsons3c27ca32020-11-20 12:42:07 -0500739// reexportSystemDirs registers the given directories as system include directories
740// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900741func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900742 f.systemDirs = append(f.systemDirs, dirs...)
743}
744
Chris Parsons3c27ca32020-11-20 12:42:07 -0500745// reexportFlags registers the flags to be exported transitively to modules depending on this
746// module.
Inseob Kim69378442019-06-03 19:10:47 +0900747func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800748 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
749 panic(fmt.Errorf("Exporting invalid flag %q: "+
750 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900751 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700752 f.flags = append(f.flags, flags...)
753}
754
Inseob Kim69378442019-06-03 19:10:47 +0900755func (f *flagExporter) reexportDeps(deps ...android.Path) {
756 f.deps = append(f.deps, deps...)
757}
758
Inseob Kimd110f872019-12-06 13:15:38 +0900759// addExportedGeneratedHeaders does nothing but collects generated header files.
760// This can be differ to exportedDeps which may contain phony files to minimize ninja.
761func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
762 f.headers = append(f.headers, headers...)
763}
764
Colin Cross0de8a1e2020-09-18 14:15:30 -0700765func (f *flagExporter) setProvider(ctx android.ModuleContext) {
766 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400767 // Comes from Export_include_dirs property, and those of exported transitive deps
768 IncludeDirs: android.FirstUniquePaths(f.dirs),
769 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700770 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400771 // Used in very few places as a one-off way of adding extra defines.
772 Flags: f.flags,
773 // Used sparingly, for extra files that need to be explicitly exported to dependers,
774 // or for phony files to minimize ninja.
775 Deps: f.deps,
776 // For exported generated headers, such as exported aidl headers, proto headers, or
777 // sysprop headers.
778 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700779 })
Inseob Kim69378442019-06-03 19:10:47 +0900780}
781
Colin Crossb916a382016-07-29 17:28:03 -0700782// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
783// functionality: static vs. shared linkage, reusing object files for shared libraries
784type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800785 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700786 StaticProperties StaticProperties
787 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800788 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700789
790 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900791 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700792
Colin Cross26c34ed2016-09-30 17:10:16 -0700793 // table-of-contents file to optimize out relinking when possible
794 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700795
Colin Cross4d9c2d12016-07-29 12:48:20 -0700796 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400797 flagExporterInfo *FlagExporterInfo
798 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700799
Colin Cross4d9c2d12016-07-29 12:48:20 -0700800 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800801 objects Objects
802 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700803
804 // Uses the module's name if empty, but can be overridden. Does not include
805 // shlib suffix.
806 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700807
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800808 sabi *sabi
809
Dan Willemsen581341d2017-02-09 16:16:31 -0800810 // Output archive of gcno coverage information files
811 coverageOutputFile android.OptionalPath
812
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800813 // linked Source Abi Dump
814 sAbiOutputFile android.OptionalPath
815
816 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800817 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000818
Colin Cross0875c522017-11-28 17:34:01 -0800819 // Location of the static library in the sysroot. Empty if the library is
820 // not included in the NDK.
821 ndkSysrootPath android.Path
822
Colin Crossb60190a2018-09-04 16:28:17 -0700823 // Location of the linked, unstripped library for shared libraries
824 unstrippedOutputFile android.Path
825
Dan Willemsen569edc52018-11-19 09:33:29 -0800826 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000827 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800828
Colin Cross8e21aa52020-09-28 18:28:02 -0700829 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900830
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800831 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900832
Vic Yangefd249e2018-11-12 20:19:56 -0800833 // If useCoreVariant is true, the vendor variant of a VNDK library is
834 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800835 useCoreVariant bool
836 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800837
Colin Cross5ec407b2020-09-30 11:41:33 -0700838 skipAPIDefine bool
839
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100840 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700841 *baseCompiler
842 *baseLinker
843 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900844
845 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700846
847 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900848}
849
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400850type ccLibraryBazelHandler struct {
Chris Parsons808d84c2021-03-09 20:43:32 -0500851 module *Module
852}
853
Chris Parsons6ce2cf92022-05-20 10:54:17 -0400854var _ BazelHandler = (*ccLibraryBazelHandler)(nil)
855
Chris Parsons94a0bba2021-06-04 15:03:47 -0400856// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
857// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400858func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400859 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400860 if len(rootStaticArchives) != 1 {
861 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsonsf874e462022-05-10 13:50:12 -0400862 return
Chris Parsons944e7d02021-03-11 11:08:46 -0500863 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400864 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500865 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
866
Chris Parsons94a0bba2021-06-04 15:03:47 -0400867 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500868 objFiles := make(android.Paths, len(objPaths))
869 for i, objPath := range objPaths {
870 objFiles[i] = android.PathForBazelOut(ctx, objPath)
871 }
872 objects := Objects{
873 objFiles: objFiles,
874 }
875
876 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
877 StaticLibrary: outputFilePath,
878 ReuseObjects: objects,
879 Objects: objects,
880
Chris Parsons94a0bba2021-06-04 15:03:47 -0400881 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500882 // static libraries with deps.
883 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
884 Direct(outputFilePath).
885 Build(),
886 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400887
Chris Parsonsf874e462022-05-10 13:50:12 -0400888 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400889}
890
891// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
892// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400893func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400894 rootDynamicLibraries := ccInfo.RootDynamicLibraries
895
896 if len(rootDynamicLibraries) != 1 {
897 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
Chris Parsonsf874e462022-05-10 13:50:12 -0400898 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400899 }
900 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
901 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
902
Sasha Smundakedd16662022-10-07 14:44:50 -0700903 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = android.PathForBazelOut(ctx, ccInfo.UnstrippedOutput)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400904
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000905 var tocFile android.OptionalPath
906 if len(ccInfo.TocFile) > 0 {
907 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
908 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400909 handler.module.linker.(*libraryDecorator).tocFile = tocFile
910
Yu Liu24214aa2022-11-22 12:30:59 -0800911 if len(ccInfo.AbiDiffFiles) > 0 {
912 handler.module.linker.(*libraryDecorator).sAbiDiff = android.PathsForBazelOut(ctx, ccInfo.AbiDiffFiles)
913 }
914
Chris Parsons94a0bba2021-06-04 15:03:47 -0400915 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
916 TableOfContents: tocFile,
917 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000918 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400919 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000920 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400921 })
Chris Parsons94a0bba2021-06-04 15:03:47 -0400922}
923
Chris Parsonsf874e462022-05-10 13:50:12 -0400924func (handler *ccLibraryBazelHandler) QueueBazelCall(ctx android.BaseModuleContext, label string) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400925 bazelCtx := ctx.Config().BazelContext
Chris Parsonsf874e462022-05-10 13:50:12 -0400926 bazelCtx.QueueBazelRequest(label, cquery.GetCcInfo, android.GetConfigKey(ctx))
927}
928
929func (handler *ccLibraryBazelHandler) ProcessBazelQueryResponse(ctx android.ModuleContext, label string) {
930 bazelCtx := ctx.Config().BazelContext
931 ccInfo, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400932 if err != nil {
933 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
Chris Parsonsf874e462022-05-10 13:50:12 -0400934 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400935 }
936
937 if handler.module.static() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400938 handler.generateStaticBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400939 } else if handler.module.Shared() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400940 handler.generateSharedBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400941 } else {
Chris Parsonsf874e462022-05-10 13:50:12 -0400942 ctx.ModuleErrorf("Unhandled bazel case for %s (neither shared nor static!)", ctx.ModuleName())
Chris Parsons94a0bba2021-06-04 15:03:47 -0400943 }
944
945 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
946 handler.module.maybeUnhideFromMake()
947
Chris Parsonseefc9e62021-04-02 17:36:47 -0400948 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
949 // Dependencies on this library will expect collectedSnapshotHeaders to
950 // be set, otherwise validation will fail. For now, set this to an empty
951 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400952 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400953 // implementation.
954 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
955 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500956}
957
Chris Parsons94a0bba2021-06-04 15:03:47 -0400958func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
959 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
960 // flag exporters consolidates properties like includes, flags, dependencies that should be
961 // exported from this module to other modules
962 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
963 // Store flag info to be passed along to androidmk
964 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
965 library.flagExporterInfo = &flagExporterInfo
966}
967
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400968func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900969 ret := android.Paths{}
970
971 // Headers in the source tree should be globbed. On the contrast, generated headers
972 // can't be globbed, and they should be manually collected.
973 // So, we first filter out intermediate directories (which contains generated headers)
974 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400975 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900976 dir := path.String()
977 // Skip if dir is for generated headers
Spandan Das925cb2a2022-11-03 16:34:12 +0000978 if strings.HasPrefix(dir, ctx.Config().OutDir()) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900979 continue
980 }
Yu Liu1175c052022-08-15 10:21:31 -0700981
982 // Filter out the generated headers from bazel.
983 if strings.HasPrefix(dir, android.PathForBazelOut(ctx, "bazel-out").String()) {
984 continue
985 }
986
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900987 // libeigen wrongly exports the root directory "external/eigen". But only two
988 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
989 // some of them have no extension. So we need special treatment for libeigen in order
990 // to glob correctly.
991 if dir == "external/eigen" {
992 // Only these two directories contains exported headers.
993 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
Liz Kammer0ea79982022-02-07 08:51:47 -0500994 globDir := "external/eigen/" + subdir + "/**/*"
995 glob, err := ctx.GlobWithDeps(globDir, nil)
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900996 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500997 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400998 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900999 }
1000 for _, header := range glob {
1001 if strings.HasSuffix(header, "/") {
1002 continue
1003 }
1004 ext := filepath.Ext(header)
1005 if ext != "" && ext != ".h" {
1006 continue
1007 }
1008 ret = append(ret, android.PathForSource(ctx, header))
1009 }
1010 }
1011 continue
1012 }
Liz Kammer0ea79982022-02-07 08:51:47 -05001013 globDir := dir + "/**/*"
1014 glob, err := ctx.GlobWithDeps(globDir, nil)
Colin Crossec118d02021-01-22 18:05:59 +00001015 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -05001016 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001017 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001018 }
Colin Crossec118d02021-01-22 18:05:59 +00001019 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -07001020 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +00001021 if isLibcxx {
1022 // Glob all files under this special directory, because of C++ headers with no
1023 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -07001024 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001025 continue
1026 }
Colin Crossec118d02021-01-22 18:05:59 +00001027 } else {
1028 // Filter out only the files with extensions that are headers.
1029 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001030 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +00001031 if strings.HasSuffix(header, ext) {
1032 found = true
1033 break
1034 }
1035 }
1036 if !found {
1037 continue
1038 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001039 }
Jose Galmes0d736912021-03-30 11:00:06 -07001040 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001041 }
1042 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001043 return ret
1044}
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001045
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001046func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
1047 ret := android.Paths{}
1048 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001049 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
1050 if strings.HasSuffix(header.Base(), "-phony") {
1051 continue
1052 }
1053 ret = append(ret, header)
1054 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001055 return ret
1056}
1057
1058// collectHeadersForSnapshot collects all exported headers from library.
1059// It globs header files in the source tree for exported include directories,
1060// and tracks generated header files separately.
1061//
1062// This is to be called from GenerateAndroidBuildActions, and then collected
1063// header files can be retrieved by snapshotHeaders().
1064func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
1065 ret := android.Paths{}
1066
1067 // Headers in the source tree should be globbed. On the contrast, generated headers
1068 // can't be globbed, and they should be manually collected.
1069 // So, we first filter out intermediate directories (which contains generated headers)
1070 // from exported directories, and then glob headers under remaining directories.
1071 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
1072
1073 // Collect generated headers
1074 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001075
1076 l.collectedSnapshotHeaders = ret
1077}
1078
1079// This returns all exported header files, both generated ones and headers from source tree.
1080// collectHeadersForSnapshot() must be called before calling this.
1081func (l *libraryDecorator) snapshotHeaders() android.Paths {
1082 if l.collectedSnapshotHeaders == nil {
1083 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
1084 }
1085 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -07001086}
1087
Chris Parsons3c27ca32020-11-20 12:42:07 -05001088// linkerProps returns the list of properties structs relevant for this library. (For example, if
1089// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -07001090func (library *libraryDecorator) linkerProps() []interface{} {
1091 var props []interface{}
1092 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001093 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001094 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -08001095 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001096 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -07001097 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001098
1099 if library.MutatedProperties.BuildShared {
1100 props = append(props, &library.SharedProperties)
1101 }
1102 if library.MutatedProperties.BuildStatic {
1103 props = append(props, &library.StaticProperties)
1104 }
1105
1106 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -07001107}
1108
Chris Parsons3c27ca32020-11-20 12:42:07 -05001109// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
1110// library, or that are implied by attributes of this library (such as whether this library is a
1111// shared library).
Colin Crossb916a382016-07-29 17:28:03 -07001112func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -07001113 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001114
Colin Crossb916a382016-07-29 17:28:03 -07001115 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
1116 // all code is position independent, and then those warnings get promoted to
1117 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -07001118 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001119 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -07001120 }
1121
1122 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001123 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001124 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001125 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -07001126 }
1127
Colin Crossa48ab5b2017-02-14 15:28:44 -08001128 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001129 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001130 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -07001131 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001132 f = append(f,
1133 "-nostdlib",
1134 "-Wl,--gc-sections",
1135 )
1136 }
1137
1138 if ctx.Darwin() {
1139 f = append(f,
1140 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -07001141 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
1142 )
Colin Cross7863cf52016-10-20 10:47:21 -07001143 if ctx.Arch().ArchType == android.X86 {
1144 f = append(f,
1145 "-read_only_relocs suppress",
1146 )
1147 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001148 } else {
Josh Gao75a50a22019-06-07 17:58:59 -07001149 f = append(f, "-shared")
1150 if !ctx.Windows() {
1151 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
1152 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001153 }
1154
Colin Cross4af21ed2019-11-04 09:37:55 -08001155 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001156 }
1157
1158 return flags
1159}
1160
Chris Parsons3c27ca32020-11-20 12:42:07 -05001161// compilerFlags takes a Flags and augments it to contain compile flags from global values,
1162// per-target values, module type values, per-module Blueprints properties, extra flags from
1163// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -08001164func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001165 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001166 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -07001167 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -08001168 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
1169 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001170 }
1171
Jiyong Park7ed9de32018-10-15 22:25:07 +09001172 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -08001173 if ctx.IsLlndk() {
1174 // LLNDK libraries ignore most of the properties on the cc_library and use the
1175 // LLNDK-specific properties instead.
1176 // Wipe all the module-local properties, leaving only the global properties.
1177 flags.Local = LocalOrGlobalFlags{}
1178 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001179 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +09001180 // Remove -include <file> when compiling stubs. Otherwise, the force included
1181 // headers might cause conflicting types error with the symbols in the
1182 // generated stubs source code. e.g.
1183 // double acos(double); // in header
1184 // void acos() {} // in the generated source code
1185 removeInclude := func(flags []string) []string {
1186 ret := flags[:0]
1187 for _, f := range flags {
1188 if strings.HasPrefix(f, "-include ") {
1189 continue
1190 }
1191 ret = append(ret, f)
1192 }
1193 return ret
1194 }
Colin Cross4af21ed2019-11-04 09:37:55 -08001195 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
1196 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +09001197
Jiyong Park7ed9de32018-10-15 22:25:07 +09001198 flags = addStubLibraryCompilerFlags(flags)
1199 }
1200 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -07001201}
1202
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001203func (library *libraryDecorator) headerAbiCheckerEnabled() bool {
1204 return Bool(library.Properties.Header_abi_checker.Enabled)
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001205}
1206
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001207func (library *libraryDecorator) headerAbiCheckerExplicitlyDisabled() bool {
1208 return !BoolDefault(library.Properties.Header_abi_checker.Enabled, true)
Logan Chien41eabe62019-04-10 13:33:58 +08001209}
1210
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001211func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -08001212 if ctx.IsLlndk() {
1213 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
1214 vndkVer := ctx.Module().(*Module).VndkVersion()
1215 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
1216 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
1217 vndkVer = "current"
1218 }
1219 if library.stubsVersion() != "" {
1220 vndkVer = library.stubsVersion()
1221 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001222 nativeAbiResult := parseNativeAbiDefinition(ctx,
1223 String(library.Properties.Llndk.Symbol_file),
1224 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
1225 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -08001226 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001227 library.versionScriptPath = android.OptionalPathForPath(
1228 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -08001229 }
1230 return objs
1231 }
Colin Cross5271fea2021-04-27 13:06:04 -07001232 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -07001233 nativeAbiResult := parseNativeAbiDefinition(ctx,
1234 String(library.Properties.Vendor_public_library.Symbol_file),
1235 android.FutureApiLevel, "")
1236 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001237 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001238 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001239 }
1240 return objs
1241 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001242 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001243 symbolFile := String(library.Properties.Stubs.Symbol_file)
1244 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1245 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1246 return Objects{}
1247 }
Jiyong Park85cc35a2022-07-17 11:30:47 +09001248 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
1249 // systemapi, respectively. The former is for symbols defined in platform libraries
1250 // and the latter is for symbols defined in APEXes.
1251 var flag string
1252 if ctx.Module().(android.ApexModule).NotInPlatform() {
1253 flag = "--apex"
1254 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +09001255 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +09001256 }
Jiyong Parkaa27c082022-09-26 21:16:09 +09001257 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
1258 // the stub so that it is mandated that all symbols are explicitly marked with
1259 // either apex or systemapi.
1260 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
1261 flag = flag + " --no-ndk"
1262 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001263 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +09001264 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -07001265 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1266 library.versionScriptPath = android.OptionalPathForPath(
1267 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001268
1269 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001270 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001271 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1272 }
1273
Jiyong Park7ed9de32018-10-15 22:25:07 +09001274 return objs
1275 }
1276
Colin Cross5950f382016-12-13 12:50:57 -08001277 if !library.buildShared() && !library.buildStatic() {
1278 if len(library.baseCompiler.Properties.Srcs) > 0 {
1279 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1280 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001281 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001282 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1283 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001284 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001285 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1286 }
1287 return Objects{}
1288 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001289 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001290 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001291 var SourceAbiFlags []string
1292 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001293 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001294 }
Inseob Kim69378442019-06-03 19:10:47 +09001295 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1296 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001297 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001298 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001299 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001300 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001301 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001302 flags.SAbiDump = true
1303 }
1304 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001305 objs := library.baseCompiler.compile(ctx, flags, deps)
1306 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001307 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001308
Colin Cross4d9c2d12016-07-29 12:48:20 -07001309 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001310 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001311 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1312 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001313 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001314 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001315 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001316 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001317 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1318 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001319 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001320 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001321 }
1322
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001323 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001324}
1325
1326type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001327 versionedInterface
1328
Colin Crossb916a382016-07-29 17:28:03 -07001329 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001330 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001331 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001332 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001333 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001334
1335 // Returns true if the build options for the module have selected a static or shared build
1336 buildStatic() bool
1337 buildShared() bool
1338
1339 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001340 setStatic()
1341 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001342
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001343 // Check whether header_abi_checker is enabled or explicitly disabled.
1344 headerAbiCheckerEnabled() bool
1345 headerAbiCheckerExplicitlyDisabled() bool
1346
Logan Chien41eabe62019-04-10 13:33:58 +08001347 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1348 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001349
1350 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001351
1352 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001353
1354 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001355}
1356
Colin Crossc88c2722020-09-28 17:32:47 -07001357type versionedInterface interface {
1358 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001359 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001360 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +00001361 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001362 setStubsVersion(string)
1363 stubsVersion() string
1364
Colin Cross3572cf72020-10-01 15:58:11 -07001365 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001366 setAllStubsVersions([]string)
1367 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001368
1369 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001370 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001371 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001372 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001373}
1374
1375var _ libraryInterface = (*libraryDecorator)(nil)
1376var _ versionedInterface = (*libraryDecorator)(nil)
1377
Justin Yun6977e8a2020-10-29 18:24:11 +09001378func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001379 name := library.libName
1380 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001381 name = String(library.Properties.Stem)
1382 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001383 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001384 }
Colin Crossb916a382016-07-29 17:28:03 -07001385 }
1386
Colin Cross0fd6a412019-08-16 14:22:10 -07001387 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001388 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001389 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001390 } else if inProduct {
1391 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001392 }
1393 if suffix == "" {
1394 suffix = String(library.Properties.Suffix)
1395 }
1396
Jooyung Han0302a842019-10-30 18:43:49 +09001397 return name + suffix
1398}
1399
Chris Parsons3c27ca32020-11-20 12:42:07 -05001400// getLibName returns the actual canonical name of the library (the name which
1401// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001402func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001403 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001404
Ivan Lozanof9e21722020-12-02 09:00:51 -05001405 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001406 // vndk-ext lib should have the same name with original lib
1407 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1408 originalName := module.(*Module).outputFile.Path()
1409 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1410 })
Logan Chienf3511742017-10-31 18:04:35 +08001411 }
1412
Colin Crossb916a382016-07-29 17:28:03 -07001413 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1414 if !strings.HasSuffix(name, "-host") {
1415 name = name + "-host"
1416 }
1417 }
1418
Inseob Kim0ce291e2019-07-04 14:38:27 +09001419 return name
Colin Crossb916a382016-07-29 17:28:03 -07001420}
1421
Jiyong Parkda732bd2018-11-02 18:23:15 +09001422var versioningMacroNamesListMutex sync.Mutex
1423
Colin Crossb916a382016-07-29 17:28:03 -07001424func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1425 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001426 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001427 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001428 }
1429 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001430 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001431 // Let baseLinker know whether this variant is for stubs or not, so that
1432 // it can omit things that are not required for linking stubs.
1433 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001434
1435 if library.buildStubs() {
1436 macroNames := versioningMacroNamesList(ctx.Config())
1437 myName := versioningMacroName(ctx.ModuleName())
1438 versioningMacroNamesListMutex.Lock()
1439 defer versioningMacroNamesListMutex.Unlock()
1440 if (*macroNames)[myName] == "" {
1441 (*macroNames)[myName] = ctx.ModuleName()
1442 } else if (*macroNames)[myName] != ctx.ModuleName() {
1443 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1444 }
1445 }
Colin Crossb916a382016-07-29 17:28:03 -07001446}
1447
dimitry0345ad82018-12-05 16:28:14 +01001448func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001449 if ctx.IsLlndk() {
1450 // LLNDK libraries ignore most of the properties on the cc_library and use the
1451 // LLNDK-specific properties instead.
1452 return deps
1453 }
1454
dimitry0345ad82018-12-05 16:28:14 +01001455 deps = library.baseCompiler.compilerDeps(ctx, deps)
1456
dimitry0345ad82018-12-05 16:28:14 +01001457 return deps
1458}
1459
Colin Cross37047f12016-12-13 17:06:13 -08001460func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001461 if ctx.IsLlndk() {
1462 // LLNDK libraries ignore most of the properties on the cc_library and use the
1463 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001464 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1465 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001466 return deps
1467 }
Colin Cross5271fea2021-04-27 13:06:04 -07001468 if ctx.IsVendorPublicLibrary() {
1469 headers := library.Properties.Vendor_public_library.Export_public_headers
1470 deps.HeaderLibs = append([]string(nil), headers...)
1471 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1472 return deps
1473 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001474
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001475 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001476 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001477 if library.StaticProperties.Static.System_shared_libs != nil {
1478 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001479 }
1480 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001481 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001482 if library.SharedProperties.Shared.System_shared_libs != nil {
1483 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001484 }
1485 }
1486
Colin Crossb916a382016-07-29 17:28:03 -07001487 deps = library.baseLinker.linkerDeps(ctx, deps)
1488
1489 if library.static() {
1490 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001491 library.StaticProperties.Static.Whole_static_libs...)
1492 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1493 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001494
Colin Crosse1bb5d02019-09-24 14:55:04 -07001495 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1496 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001497 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001498 if !Bool(library.baseLinker.Properties.Nocrt) {
1499 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1500 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001501 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001502 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1503 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1504 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001505
Colin Crosse1bb5d02019-09-24 14:55:04 -07001506 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1507 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001508 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001509 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001510 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1511 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1512 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001513 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1514 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001515 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001516 if ctx.inProduct() {
1517 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1518 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1519 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1520 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1521 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1522 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001523 if ctx.inRecovery() {
1524 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1525 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1526 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001527 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1528 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001529 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001530 if ctx.inRamdisk() {
1531 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1532 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1533 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1534 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1535 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1536 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001537 if ctx.inVendorRamdisk() {
1538 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1539 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1540 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1541 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1542 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1543 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001544
Colin Cross4d9c2d12016-07-29 12:48:20 -07001545 return deps
1546}
1547
Paul Duffin13f02712020-03-06 12:30:43 +00001548func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1549 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1550 var properties StaticOrSharedProperties
1551 if library.static() {
1552 properties = library.StaticProperties.Static
1553 } else if library.shared() {
1554 properties = library.SharedProperties.Shared
1555 }
1556
1557 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001558
1559 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1560 // either input list doesn't come out as nil.
1561 if specifiedDeps.systemSharedLibs == nil {
1562 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1563 } else {
1564 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1565 }
Paul Duffin13f02712020-03-06 12:30:43 +00001566
1567 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001568 if len(specifiedDeps.systemSharedLibs) > 0 {
1569 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1570 // retained.
1571 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1572 }
Paul Duffin13f02712020-03-06 12:30:43 +00001573 return specifiedDeps
1574}
1575
Colin Crossb916a382016-07-29 17:28:03 -07001576func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001577 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001578
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001579 library.objects = deps.WholeStaticLibObjs.Copy()
1580 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001581 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001582
Inseob Kim0ce291e2019-07-04 14:38:27 +09001583 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001584 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001585 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001586
Dan Willemsen569edc52018-11-19 09:33:29 -08001587 if Bool(library.baseLinker.Properties.Use_version_lib) {
1588 if ctx.Host() {
1589 versionedOutputFile := outputFile
1590 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1591 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1592 } else {
1593 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001594 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001595 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1596 }
Colin Cross86803cf2018-02-15 14:12:26 -08001597 }
1598
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001599 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001600
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001601 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001602
Colin Cross4d9c2d12016-07-29 12:48:20 -07001603 ctx.CheckbuildFile(outputFile)
1604
Colin Cross649d8172020-12-10 12:30:21 -08001605 if library.static() {
1606 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001607 StaticLibrary: outputFile,
1608 ReuseObjects: library.reuseObjects,
1609 Objects: library.objects,
1610 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001611
Colin Cross649d8172020-12-10 12:30:21 -08001612 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1613 Direct(outputFile).
1614 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1615 Build(),
1616 })
1617 }
1618
1619 if library.header() {
1620 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1621 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001622
Colin Cross4d9c2d12016-07-29 12:48:20 -07001623 return outputFile
1624}
1625
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001626func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1627 if ctx.Module().(*Module).IsSdkVariant() {
1628 // The NDK sysroot timestamp file depends on all the NDK
1629 // sysroot header and shared library files.
1630 return android.Paths{getNdkBaseTimestampFile(ctx)}
1631 }
1632 return nil
1633}
1634
Colin Crossb916a382016-07-29 17:28:03 -07001635func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001636 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001637
1638 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001639 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001640 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001641
Colin Cross2383f3b2018-02-06 14:40:13 -08001642 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1643 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1644 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001645 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001646 if unexportedSymbols.Valid() {
1647 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1648 }
1649 if forceNotWeakSymbols.Valid() {
1650 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1651 }
1652 if forceWeakSymbols.Valid() {
1653 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1654 }
1655 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001656 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001657 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001658 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1659 }
1660 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001661 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001662 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1663 }
1664 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001665 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001666 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1667 }
1668 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001669 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001670 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001671 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001672 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001673 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001674
1675 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1676 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001677 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001678
Josh Gao75a50a22019-06-07 17:58:59 -07001679 var implicitOutputs android.WritablePaths
1680 if ctx.Windows() {
1681 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1682
Colin Cross4af21ed2019-11-04 09:37:55 -08001683 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001684 implicitOutputs = append(implicitOutputs, importLibraryPath)
1685 }
1686
Colin Cross4d9c2d12016-07-29 12:48:20 -07001687 builderFlags := flagsToBuilderFlags(flags)
1688
Dan Willemsen47450072021-10-19 20:24:49 -07001689 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1690 fatOutputFile := outputFile
1691 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1692 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1693 }
1694
Colin Crossb496cfd2018-09-10 16:50:05 -07001695 // Optimize out relinking against shared libraries whose interface hasn't changed by
1696 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001697 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001698 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001699 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001700
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001701 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001702 needsStrip := library.stripper.NeedsStrip(ctx)
1703 if library.buildStubs() {
1704 // No need to strip stubs libraries
1705 needsStrip = false
1706 }
1707 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001708 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001709 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001710 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001711 strippedOutputFile := outputFile
1712 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001713 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001714 }
Colin Crossb60190a2018-09-04 16:28:17 -07001715 library.unstrippedOutputFile = outputFile
1716
Colin Crossd7227f92019-09-05 14:26:33 -07001717 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001718
Dan Willemsen569edc52018-11-19 09:33:29 -08001719 if Bool(library.baseLinker.Properties.Use_version_lib) {
1720 if ctx.Host() {
1721 versionedOutputFile := outputFile
1722 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1723 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1724 } else {
1725 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001726 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001727
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001728 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001729 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001730 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001731 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001732 }
1733
1734 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1735 }
Colin Cross86803cf2018-02-15 14:12:26 -08001736 }
1737
Jiyong Park64a44f22019-01-18 14:37:08 +09001738 sharedLibs := deps.EarlySharedLibs
1739 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001740 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1741
Jiyong Park64a44f22019-01-18 14:37:08 +09001742 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001743 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1744 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001745 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001746 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001747 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001748
Dan Willemsen581341d2017-02-09 16:16:31 -08001749 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1750 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001751 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1752 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1753
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001754 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001755 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001756
Liz Kammeref6dfea2021-06-08 15:37:09 -04001757 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001758 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1759 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001760 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001761 }
1762
1763 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001764 TableOfContents: android.OptionalPathForPath(tocFile),
1765 SharedLibrary: unstrippedOutputFile,
1766 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1767 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001768 })
1769
1770 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1771 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001772 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001773 for _, stub := range stubs {
1774 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1775 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001776 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001777 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001778 SharedLibraryInfo: stubInfo,
1779 FlagExporterInfo: flagInfo,
1780 })
1781 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001782 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1783 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001784
Colin Cross127bb8b2020-12-16 16:46:01 -08001785 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001786 })
1787 }
1788
1789 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001790}
1791
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001792func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1793 return library.unstrippedOutputFile
1794}
1795
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001796func (library *libraryDecorator) disableStripping() {
1797 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1798}
1799
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001800func (library *libraryDecorator) nativeCoverage() bool {
1801 if library.header() || library.buildStubs() {
1802 return false
1803 }
1804 return true
1805}
1806
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001807func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1808 return library.coverageOutputFile
1809}
1810
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001811func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1812 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001813
1814 currentArchType := ctx.Arch().ArchType
1815 primaryArchType := ctx.Config().DevicePrimaryArchType()
1816 archName := currentArchType.String()
1817 if currentArchType != primaryArchType {
1818 archName += "_" + primaryArchType.String()
1819 }
1820
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001821 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001822 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001823}
1824
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001825func getRefAbiDumpDir(isNdk, isVndk bool) string {
1826 var dirName string
1827 if isNdk {
1828 dirName = "ndk"
1829 } else if isVndk {
1830 dirName = "vndk"
1831 } else {
1832 dirName = "platform"
1833 }
1834 return filepath.Join("prebuilts", "abi-dumps", dirName)
1835}
Logan Chien7eefdc42018-07-11 18:10:41 +08001836
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001837func prevRefAbiDumpVersion(ctx ModuleContext, dumpDir string) int {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001838 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
1839 sdkVersionStr := ctx.Config().PlatformSdkVersion().String()
1840
1841 if ctx.Config().PlatformSdkFinal() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001842 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001843 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001844 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1845 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1846 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001847 versionedDumpDir := android.ExistentPathForSource(ctx, dumpDir, sdkVersionStr)
1848 if versionedDumpDir.Valid() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001849 return sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001850 } else {
Mu-Le Lee13043932022-08-27 08:55:25 +00001851 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001852 }
1853 }
1854}
1855
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001856func currRefAbiDumpVersion(ctx ModuleContext, isVndk bool) string {
1857 if isVndk {
1858 // Each version of VNDK is independent, so follow the VNDK version which is the codename or PLATFORM_SDK_VERSION.
1859 return ctx.Module().(*Module).VndkVersion()
1860 } else if ctx.Config().PlatformSdkFinal() {
1861 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1862 // so choose PLATFORM_SDK_VERSION as the current version.
1863 return ctx.Config().PlatformSdkVersion().String()
1864 } else {
1865 return "current"
1866 }
1867}
1868
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001869// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
1870func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1871 baseName, nameExt string, isLlndkOrNdk, allowExtensions bool,
1872 sourceVersion, errorMessage string) {
1873
1874 sourceDump := library.sAbiOutputFile.Path()
1875
1876 extraFlags := []string{"-target-version", sourceVersion}
1877 if Bool(library.Properties.Header_abi_checker.Check_all_apis) {
1878 extraFlags = append(extraFlags, "-check-all-apis")
1879 } else {
1880 extraFlags = append(extraFlags,
1881 "-allow-unreferenced-changes",
1882 "-allow-unreferenced-elf-symbol-changes")
1883 }
1884 if isLlndkOrNdk {
1885 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1886 }
1887 if allowExtensions {
1888 extraFlags = append(extraFlags, "-allow-extensions")
1889 }
1890 extraFlags = append(extraFlags, library.Properties.Header_abi_checker.Diff_flags...)
1891
1892 library.sAbiDiff = append(
1893 library.sAbiDiff,
1894 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1895 baseName, nameExt, extraFlags, errorMessage))
1896}
1897
1898func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1899 baseName string, isLlndkOrNdk bool, sourceVersion, prevVersion string) {
1900
1901 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 + "."
1902
1903 library.sourceAbiDiff(ctx, referenceDump, baseName, prevVersion,
1904 isLlndkOrNdk, /* allowExtensions */ true, sourceVersion, errorMessage)
1905}
1906
1907func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1908 baseName string, isLlndkOrNdk, allowExtensions bool) {
1909
1910 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1911 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName
1912
1913 library.sourceAbiDiff(ctx, referenceDump, baseName, /* nameExt */ "",
1914 isLlndkOrNdk, allowExtensions, "current", errorMessage)
1915}
1916
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001917func (library *libraryDecorator) optInAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1918 baseName, nameExt string, isLlndkOrNdk bool, refDumpDir string) {
1919
1920 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1921 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
1922
1923 library.sourceAbiDiff(ctx, referenceDump, baseName, nameExt,
1924 isLlndkOrNdk, /* allowExtensions */ false, "current", errorMessage)
1925}
1926
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001927func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001928 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001929 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001930 var SourceAbiFlags []string
1931 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001932 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1933 }
Inseob Kim69378442019-06-03 19:10:47 +09001934 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1935 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001936 }
1937 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001938 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001939 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001940 library.Properties.Header_abi_checker.Exclude_symbol_versions,
1941 library.Properties.Header_abi_checker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001942
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001943 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001944
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001945 // The logic must be consistent with classifySourceAbiDump.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001946 isVndk := ctx.useVndk() && ctx.isVndk()
Hsin-Yi Chen7584bda2022-11-08 22:51:02 +08001947 isNdk := ctx.isNdk(ctx.Config())
1948 isLlndk := ctx.isImplementationForLLNDKPublic()
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001949 dumpDir := getRefAbiDumpDir(isNdk, isVndk)
1950 binderBitness := ctx.DeviceConfig().BinderBitness()
Mu-Le Lee13043932022-08-27 08:55:25 +00001951 // If NDK or PLATFORM library, check against previous version ABI.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001952 if !isVndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001953 prevVersionInt := prevRefAbiDumpVersion(ctx, dumpDir)
1954 prevVersion := strconv.Itoa(prevVersionInt)
1955 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1956 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001957 if prevDumpFile.Valid() {
1958 library.crossVersionAbiDiff(ctx, prevDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001959 fileName, isLlndk || isNdk,
1960 strconv.Itoa(prevVersionInt+1), prevVersion)
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001961 }
1962 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001963 // Check against the current version.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001964 currVersion := currRefAbiDumpVersion(ctx, isVndk)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001965 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1966 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001967 if currDumpFile.Valid() {
1968 library.sameVersionAbiDiff(ctx, currDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001969 fileName, isLlndk || isNdk, ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001970 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001971 // Check against the opt-in reference dumps.
1972 for i, optInDumpDir := range library.Properties.Header_abi_checker.Ref_dump_dirs {
1973 optInDumpDirPath := android.PathForModuleSrc(ctx, optInDumpDir)
1974 // Ref_dump_dirs are not versioned.
1975 // They do not contain subdir for binder bitness because 64-bit binder has been mandatory.
1976 optInDumpFile := getRefAbiDumpFile(ctx, optInDumpDirPath.String(), fileName)
1977 if !optInDumpFile.Valid() {
1978 continue
1979 }
1980 library.optInAbiDiff(ctx, optInDumpFile.Path(),
1981 fileName, "opt"+strconv.Itoa(i), isLlndk || isNdk,
1982 optInDumpDirPath.String())
1983 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001984 }
1985}
1986
Inseob Kimcc12d902021-05-14 20:15:55 +09001987func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001988 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1989 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1990
Colin Cross127bb8b2020-12-16 16:46:01 -08001991 for _, header := range srcFiles {
1992 headerDir := filepath.Dir(header.String())
1993 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1994 if err != nil {
1995 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1996 srcDir.String(), headerDir, err)
1997 continue
1998 }
1999
2000 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
2001 }
2002
Inseob Kimcc12d902021-05-14 20:15:55 +09002003 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08002004}
2005
Chris Parsons3c27ca32020-11-20 12:42:07 -05002006// link registers actions to link this library, and sets various fields
2007// on this library to reflect information that should be exported up the build
2008// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07002009func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002010 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002011
Colin Cross127bb8b2020-12-16 16:46:01 -08002012 if ctx.IsLlndk() {
2013 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
2014 // This is the vendor variant of an LLNDK library with preprocessed headers.
2015 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
2016
2017 var timestampFiles android.Paths
2018 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09002019 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
2020 timestampFiles = append(timestampFiles, timestampFile)
2021 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08002022 }
2023
2024 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2025 library.reexportSystemDirs(genHeaderOutDir)
2026 } else {
2027 library.reexportDirs(genHeaderOutDir)
2028 }
2029
2030 library.reexportDeps(timestampFiles...)
2031 }
2032
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002033 // override the module's export_include_dirs with llndk.override_export_include_dirs
2034 // if it is set.
2035 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
2036 library.flagExporter.Properties.Export_include_dirs = override
2037 }
2038
Colin Cross127bb8b2020-12-16 16:46:01 -08002039 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2040 library.flagExporter.Properties.Export_system_include_dirs = append(
2041 library.flagExporter.Properties.Export_system_include_dirs,
2042 library.flagExporter.Properties.Export_include_dirs...)
2043 library.flagExporter.Properties.Export_include_dirs = nil
2044 }
2045 }
2046
Colin Cross5271fea2021-04-27 13:06:04 -07002047 if ctx.IsVendorPublicLibrary() {
2048 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
2049 // if it is set.
2050 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
2051 library.flagExporter.Properties.Export_include_dirs = override
2052 }
2053 }
2054
Chris Parsons3c27ca32020-11-20 12:42:07 -05002055 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
2056 // of this library), together with `objs` (.o files created by compiling this
2057 // library).
Colin Crossad59e752017-11-16 14:29:11 -08002058 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002059 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08002060 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002061 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002062 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002063 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002064 }
2065
Chris Parsons3c27ca32020-11-20 12:42:07 -05002066 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09002067 library.exportIncludes(ctx)
2068 library.reexportDirs(deps.ReexportedDirs...)
2069 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
2070 library.reexportFlags(deps.ReexportedFlags...)
2071 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09002072 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002073
Chris Parsons3c27ca32020-11-20 12:42:07 -05002074 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002075 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002076 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09002077 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09002078 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09002079
Paul Duffin33056e82021-02-19 13:49:08 +00002080 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
2081 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07002082 }
2083 }
2084
Chris Parsons3c27ca32020-11-20 12:42:07 -05002085 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002086 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002087 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09002088 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07002089 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09002090 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07002091 }
Jiyong Park74955042019-10-22 20:19:51 +09002092 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09002093 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09002094
Paul Duffin33056e82021-02-19 13:49:08 +00002095 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
2096 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07002097 }
2098 }
2099
Inseob Kim07def122020-11-23 14:43:02 +09002100 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09002101 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09002102 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002103 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09002104 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
2105
Inseob Kim07def122020-11-23 14:43:02 +09002106 // If the owner is different from the user, expose public header. That is,
2107 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09002108 // 2) if the owner is platform and the client is vendor
2109 // We don't care Platform -> Vendor dependency as it's already forbidden.
2110 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09002111 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002112 }
2113 }
2114
Paul Duffin37e0de52021-02-19 17:05:39 +00002115 // Make sure to only export headers which are within the include directory.
2116 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
2117 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
2118 return isRel
2119 })
2120
Chris Parsons3c27ca32020-11-20 12:42:07 -05002121 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09002122 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00002123 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00002124 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09002125 }
2126
Chris Parsons3c27ca32020-11-20 12:42:07 -05002127 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09002128 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002129
Chris Parsons3c27ca32020-11-20 12:42:07 -05002130 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002131 library.flagExporter.setProvider(ctx)
2132
Colin Cross4d9c2d12016-07-29 12:48:20 -07002133 return out
2134}
2135
Jiyong Park892a98f2020-12-14 09:20:00 +09002136func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002137 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09002138 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09002139 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
2140 if err != nil {
2141 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
2142 }
2143 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09002144 }
2145}
2146
Chris Parsons3c27ca32020-11-20 12:42:07 -05002147// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07002148func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002149 return library.MutatedProperties.BuildStatic &&
2150 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002151}
2152
Chris Parsons3c27ca32020-11-20 12:42:07 -05002153// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07002154func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002155 return library.MutatedProperties.BuildShared &&
2156 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002157}
2158
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002159func (library *libraryDecorator) objs() Objects {
2160 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002161}
2162
Colin Cross0de8a1e2020-09-18 14:15:30 -07002163func (library *libraryDecorator) reuseObjs() Objects {
2164 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002165}
2166
Colin Cross26c34ed2016-09-30 17:10:16 -07002167func (library *libraryDecorator) toc() android.OptionalPath {
2168 return library.tocFile
2169}
2170
Jiyong Parkf1194352019-02-25 11:05:47 +09002171func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
2172 dir := library.baseInstaller.installDir(ctx)
2173 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
2174 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
2175 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002176 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09002177}
2178
Colin Crossb916a382016-07-29 17:28:03 -07002179func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07002180 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09002181 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09002182 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05002183 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002184 if ctx.isVndkSp() {
2185 library.baseInstaller.subDir = "vndk-sp"
2186 } else {
2187 library.baseInstaller.subDir = "vndk"
2188 }
2189 }
2190
Justin Yun31094b12020-12-24 16:11:23 +09002191 // In some cases we want to use core variant for VNDK-Core libs.
2192 // Skip product variant since VNDKs use only the vendor variant.
2193 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08002194 mayUseCoreVariant := true
2195
2196 if ctx.mustUseVendorVariant() {
2197 mayUseCoreVariant = false
2198 }
2199
Elvis Chien9c993542021-06-25 01:15:17 +08002200 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08002201 mayUseCoreVariant = false
2202 }
2203
2204 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08002205 library.checkSameCoreVariant = true
2206 if ctx.DeviceConfig().VndkUseCoreVariant() {
2207 library.useCoreVariant = true
2208 }
Vic Yangefd249e2018-11-12 20:19:56 -08002209 }
Justin Yun8fe12122017-12-07 17:18:15 +09002210 }
Logan Chienf3511742017-10-31 18:04:35 +08002211
Jooyung Han261e1582020-10-20 18:54:21 +09002212 // do not install vndk libs
2213 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05002214 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002215 return
Justin Yun8effde42017-06-23 19:24:43 +09002216 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002217 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09002218 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
2219 // The original path becomes a symlink to the corresponding file in the
2220 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07002221 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07002222 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002223 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01002224 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09002225 library.installSymlinkToRuntimeApex(ctx, file)
2226 }
Jiyong Park429660f2019-01-16 22:31:11 +09002227 library.baseInstaller.subDir = "bootstrap"
2228 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002229 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002230 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002231 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09002232 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002233
Colin Cross4d9c2d12016-07-29 12:48:20 -07002234 library.baseInstaller.install(ctx, file)
2235 }
Dan Albertf563d252017-10-13 00:29:00 -07002236
Dan Albert281f22b2017-12-13 15:03:47 -08002237 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002238 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09002239 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08002240 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07002241 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07002242 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07002243
2244 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
2245 Rule: android.Cp,
2246 Description: "install " + installPath.Base(),
2247 Output: installPath,
2248 Input: file,
2249 })
2250
Colin Cross0875c522017-11-28 17:34:01 -08002251 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07002252 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002253}
2254
Paul Duffin0cb37b92020-03-04 14:52:46 +00002255func (library *libraryDecorator) everInstallable() bool {
2256 // Only shared and static libraries are installed. Header libraries (which are
2257 // neither static or shared) are not installed.
2258 return library.shared() || library.static()
2259}
2260
Chris Parsons3c27ca32020-11-20 12:42:07 -05002261// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07002262func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002263 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07002264}
2265
Chris Parsons3c27ca32020-11-20 12:42:07 -05002266// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002267func (library *libraryDecorator) shared() bool {
2268 return library.MutatedProperties.VariantIsShared
2269}
2270
Chris Parsons3c27ca32020-11-20 12:42:07 -05002271// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002272func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002273 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002274 return !library.static() && !library.shared()
2275}
2276
Chris Parsons3c27ca32020-11-20 12:42:07 -05002277// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002278func (library *libraryDecorator) setStatic() {
2279 library.MutatedProperties.VariantIsStatic = true
2280 library.MutatedProperties.VariantIsShared = false
2281}
2282
Chris Parsons3c27ca32020-11-20 12:42:07 -05002283// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002284func (library *libraryDecorator) setShared() {
2285 library.MutatedProperties.VariantIsStatic = false
2286 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07002287}
2288
Chris Parsons3c27ca32020-11-20 12:42:07 -05002289// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08002290func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002291 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08002292}
2293
Chris Parsons3c27ca32020-11-20 12:42:07 -05002294// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08002295func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002296 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08002297}
2298
Chris Parsons3c27ca32020-11-20 12:42:07 -05002299// HeaderOnly disables building this library as a shared or static library;
2300// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08002301func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002302 library.MutatedProperties.BuildShared = false
2303 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08002304}
2305
Colin Cross127bb8b2020-12-16 16:46:01 -08002306// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
2307func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07002308 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002309}
2310
Colin Cross203b4212021-04-26 17:19:41 -07002311// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07002312func (library *libraryDecorator) hasLLNDKHeaders() bool {
2313 return Bool(library.Properties.Llndk.Llndk_headers)
2314}
2315
Colin Cross5271fea2021-04-27 13:06:04 -07002316// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
2317// vendor public library stubs.
2318func (library *libraryDecorator) hasVendorPublicLibrary() bool {
2319 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
2320}
2321
Colin Cross0477b422020-10-13 18:43:54 -07002322func (library *libraryDecorator) implementationModuleName(name string) string {
2323 return name
2324}
2325
Jiyong Park7ed9de32018-10-15 22:25:07 +09002326func (library *libraryDecorator) buildStubs() bool {
2327 return library.MutatedProperties.BuildStubs
2328}
2329
Jiyong Parka034b832019-08-27 14:02:19 +09002330func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
2331 if library.Properties.Header_abi_checker.Symbol_file != nil {
2332 return library.Properties.Header_abi_checker.Symbol_file
2333 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002334 if ctx.Module().(*Module).IsLlndk() {
2335 return library.Properties.Llndk.Symbol_file
2336 }
Colin Cross31076b32020-10-23 17:22:06 -07002337 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09002338 return library.Properties.Stubs.Symbol_file
2339 }
2340 return nil
2341}
2342
Colin Crossc88c2722020-09-28 17:32:47 -07002343func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002344 // Just having stubs.symbol_file is enough to create a stub variant. In that case
2345 // the stub for the future API level is created.
2346 return library.Properties.Stubs.Symbol_file != nil ||
2347 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07002348}
2349
Alan Stokes73feba32022-11-14 12:21:24 +00002350func (library *libraryDecorator) isStubsImplementationRequired() bool {
2351 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
2352}
2353
Colin Cross3572cf72020-10-01 15:58:11 -07002354func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002355 if !library.hasStubsVariants() {
2356 return nil
2357 }
2358
Colin Crossc1b36442021-05-06 13:42:48 -07002359 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
2360 // LLNDK libraries only need a single stubs variant.
2361 return []string{android.FutureApiLevel.String()}
2362 }
2363
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002364 // Future API level is implicitly added if there isn't
2365 vers := library.Properties.Stubs.Versions
2366 if inList(android.FutureApiLevel.String(), vers) {
2367 return vers
2368 }
2369 // In some cases, people use the raw value "10000" in the versions property.
2370 // We shouldn't add the future API level in that case, otherwise there will
2371 // be two identical versions.
2372 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2373 return vers
2374 }
2375 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002376}
2377
2378func (library *libraryDecorator) setStubsVersion(version string) {
2379 library.MutatedProperties.StubsVersion = version
2380}
2381
Jiyong Park7ed9de32018-10-15 22:25:07 +09002382func (library *libraryDecorator) stubsVersion() string {
2383 return library.MutatedProperties.StubsVersion
2384}
2385
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002386func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002387 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002388 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002389}
2390
2391func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2392 library.MutatedProperties.AllStubsVersions = versions
2393}
2394
2395func (library *libraryDecorator) allStubsVersions() []string {
2396 return library.MutatedProperties.AllStubsVersions
2397}
2398
Jooyung Hanad4c1872020-02-27 17:56:44 +09002399func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002400 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002401}
2402
Jiyong Parka90ca002019-10-07 15:47:24 +09002403func (library *libraryDecorator) availableFor(what string) bool {
2404 var list []string
2405 if library.static() {
2406 list = library.StaticProperties.Static.Apex_available
2407 } else if library.shared() {
2408 list = library.SharedProperties.Shared.Apex_available
2409 }
2410 if len(list) == 0 {
2411 return false
2412 }
2413 return android.CheckAvailableForApex(what, list)
2414}
2415
Colin Cross1bc94122021-10-28 13:25:54 -07002416func (library *libraryDecorator) installable() *bool {
2417 if library.static() {
2418 return library.StaticProperties.Static.Installable
2419 } else if library.shared() {
2420 return library.SharedProperties.Shared.Installable
2421 }
2422 return nil
2423}
2424
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002425func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002426 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002427 // If we're asked to make a static library uninstallable we don't do
2428 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2429 // for these entries. This is done to still get the make targets for NOTICE
2430 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002431 return
2432 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002433 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002434}
2435
Jihoon Kangf78a8902022-09-01 22:47:07 +00002436func (library *libraryDecorator) getPartition() string {
2437 return library.path.Partition()
2438}
2439
Colin Crossceaa5322021-09-28 16:37:50 -07002440func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2441 return library.apiListCoverageXmlPath
2442}
2443
Inseob Kima1888ce2022-10-04 14:42:02 +09002444func (library *libraryDecorator) overriddenModules() []string {
2445 return library.Properties.Overrides
2446}
2447
2448var _ overridable = (*libraryDecorator)(nil)
2449
Colin Cross571cccf2019-02-04 11:22:08 -08002450var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2451
Chris Parsons3c27ca32020-11-20 12:42:07 -05002452// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2453// and values are the module name responsible for registering the version macro name.
2454//
2455// Version macros are used when building against stubs, to provide version information about
2456// the stub. Only stub libraries should have an entry in this list.
2457//
2458// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2459// that headers from libFoo can be conditionally compiled (this may hide APIs
2460// that are not available for the version).
2461//
2462// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002463func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002464 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002465 m := make(map[string]string)
2466 return &m
2467 }).(*map[string]string)
2468}
2469
2470// alphanumeric and _ characters are preserved.
2471// other characters are all converted to _
2472var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2473
Chris Parsons3c27ca32020-11-20 12:42:07 -05002474// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002475func versioningMacroName(moduleName string) string {
2476 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002477 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002478 return "__" + macroName + "_API__"
2479}
2480
Chris Parsons3c27ca32020-11-20 12:42:07 -05002481// NewLibrary builds and returns a new Module corresponding to a C++ library.
2482// Individual module implementations which comprise a C++ library (or something like
2483// a C++ library) should call this function, set some fields on the result, and
2484// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002485func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002486 module := newModule(hod, android.MultilibBoth)
2487
Colin Crossb916a382016-07-29 17:28:03 -07002488 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002489 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002490 BuildShared: true,
2491 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002492 },
Colin Crossb916a382016-07-29 17:28:03 -07002493 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002494 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002495 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002496 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002497 }
2498
Colin Crossb916a382016-07-29 17:28:03 -07002499 module.compiler = library
2500 module.linker = library
2501 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002502 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002503
2504 return module, library
2505}
2506
Colin Cross10d22312017-05-03 11:01:58 -07002507// connects a shared library to a static library in order to reuse its .o files to avoid
2508// compiling source files twice.
2509func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2510 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2511 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002512
2513 // Check libraries in addition to cflags, since libraries may be exporting different
2514 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002515 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2516 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2517 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2518 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2519 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2520 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2521 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2522 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002523 // Compare System_shared_libs properties with nil because empty lists are
2524 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002525 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2526 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002527
2528 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2529 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2530 sharedCompiler.baseCompiler.Properties.Srcs
2531 sharedCompiler.baseCompiler.Properties.Srcs = nil
2532 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2533 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002534
2535 // This dep is just to reference static variant from shared variant
2536 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002537 }
2538}
2539
Chris Parsons3c27ca32020-11-20 12:42:07 -05002540// LinkageMutator adds "static" or "shared" variants for modules depending
2541// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002542func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002543 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002544 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002545 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002546 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002547 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002548 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002549
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002550 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002551 buildStatic := library.buildStatic()
2552 buildShared := library.buildShared()
2553 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002554 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2555 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2556 // all the variants of the cc_library also exist on the prebuilt.
2557 modules := mctx.CreateLocalVariations("static", "shared")
2558 static := modules[0].(*Module)
2559 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002560
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002561 static.linker.(prebuiltLibraryInterface).setStatic()
2562 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002563
Colin Cross127bb8b2020-12-16 16:46:01 -08002564 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002565 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002566 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002567 mctx.AliasVariation("static")
2568 }
2569
Colin Cross127bb8b2020-12-16 16:46:01 -08002570 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002571 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2572 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002573 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002574 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2575 }
2576 } else {
2577 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002578 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002579
Ivan Lozano52767be2019-10-18 14:49:46 -07002580 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002581
Ivan Lozano2b262972019-11-21 12:30:50 -08002582 // Non-cc.Modules may need an empty variant for their mutators.
2583 variations := []string{}
2584 if library.NonCcVariants() {
2585 variations = append(variations, "")
2586 }
2587
Colin Cross127bb8b2020-12-16 16:46:01 -08002588 isLLNDK := false
2589 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002590 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002591 }
2592 buildStatic := library.BuildStaticVariant() && !isLLNDK
2593 buildShared := library.BuildSharedVariant()
2594 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002595 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002596
2597 modules := mctx.CreateLocalVariations(variations...)
2598 static := modules[0].(LinkableInterface)
2599 shared := modules[1].(LinkableInterface)
2600
2601 static.SetStatic()
2602 shared.SetShared()
2603
2604 if _, ok := library.(*Module); ok {
2605 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2606 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002607 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002608 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002609 variations := append([]string{"static"}, variations...)
2610
2611 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002612 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002613 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002614 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002615 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002616
Ivan Lozano2b262972019-11-21 12:30:50 -08002617 modules := mctx.CreateLocalVariations(variations...)
2618 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002619 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002620 } else if len(variations) > 0 {
2621 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002622 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002623 }
Colin Crossb916a382016-07-29 17:28:03 -07002624 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002625}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002626
Chris Parsons3c27ca32020-11-20 12:42:07 -05002627// normalizeVersions modifies `versions` in place, so that each raw version
2628// string becomes its normalized canonical form.
2629// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002630func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002631 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002632 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002633 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002634 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002635 ctx.PropertyErrorf("versions", "%s", err.Error())
2636 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002637 }
Dan Albertc8060532020-07-22 22:32:17 -07002638 if i > 0 && ver.LessThanOrEqualTo(previous) {
2639 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2640 }
2641 versions[i] = ver.String()
2642 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002643 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002644}
2645
Jooyung Han61b66e92020-03-21 14:21:46 +00002646func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002647 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2648 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002649 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002650
Colin Cross127bb8b2020-12-16 16:46:01 -08002651 m := mctx.Module().(*Module)
2652 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002653 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002654 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002655
Colin Crossd1f898e2020-08-18 18:35:15 -07002656 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002657 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002658
Kiyoung Kimee58c932022-10-25 22:59:41 +09002659 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002660 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002661 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002662 c.sanitize = nil
2663 c.stl = nil
2664 c.Properties.PreventInstall = true
2665 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002666 isLatest := i == (len(versions) - 1)
2667 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002668
2669 if variants[i] != "" {
2670 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2671 // implementation module to the stubs module.
2672 c.Properties.HideFromMake = true
2673 lib.setStubsVersion(variants[i])
2674 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2675 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002676 }
2677 }
Colin Cross094faa52020-08-06 17:38:25 -07002678 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002679 latestVersion := ""
2680 if len(versions) > 0 {
2681 latestVersion = versions[len(versions)-1]
2682 }
2683 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002684}
2685
Colin Crossbbc941b2020-09-30 12:27:01 -07002686func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2687 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2688 if err != nil {
2689 mctx.PropertyErrorf("min_sdk_version", err.Error())
2690 return
2691 }
2692
2693 versionStrs := ndkLibraryVersions(mctx, from)
2694 modules := mctx.CreateLocalVariations(versionStrs...)
2695
2696 for i, module := range modules {
2697 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002698 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002699 }
2700}
2701
Liz Kammer23942242022-04-08 15:41:00 -04002702func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002703 Host() bool
2704 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002705 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002706}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002707 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002708}
2709
Liz Kammer23942242022-04-08 15:41:00 -04002710func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002711 Host() bool
2712 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002713 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002714 CcLibraryInterface() bool
2715 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002716}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002717 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002718 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002719}
2720
Colin Cross127bb8b2020-12-16 16:46:01 -08002721func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002722 if m, ok := module.(*Module); ok {
2723 return m.library
2724 }
2725 return nil
2726}
2727
Liz Kammer23942242022-04-08 15:41:00 -04002728// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2729func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2730 if !library.buildShared() || !canBeVersionVariant(module) {
2731 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002732 }
Liz Kammer23942242022-04-08 15:41:00 -04002733 versions := library.stubsVersions(mctx)
2734 if len(versions) <= 0 {
2735 return
2736 }
2737 normalizeVersions(mctx, versions)
2738 if mctx.Failed() {
2739 return
2740 }
2741 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2742 // depend on the implementation library and haven't been mutated yet.
2743 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002744}
Jooyung Han61b66e92020-03-21 14:21:46 +00002745
Colin Crossd1f898e2020-08-18 18:35:15 -07002746// versionMutator splits a module into the mandatory non-stubs variant
2747// (which is unnamed) and zero or more stubs variants.
2748func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002749 if mctx.Os() != android.Android {
2750 return
2751 }
2752
2753 m, ok := mctx.Module().(*Module)
2754 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2755 setStubsVersions(mctx, library, m)
2756
Colin Cross31076b32020-10-23 17:22:06 -07002757 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002758 return
2759 }
2760
Liz Kammer23942242022-04-08 15:41:00 -04002761 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002762 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002763 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2764 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002765 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002766}
Colin Crossd7227f92019-09-05 14:26:33 -07002767
2768// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2769// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2770// that the linked output file should be written to.
2771// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2772func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2773 inject *bool, fileName string) android.ModuleOutPath {
2774 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2775 injectBoringSSLHash := Bool(inject)
2776 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002777 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002778 if cc, ok := dep.(*Module); ok {
2779 if library, ok := cc.linker.(*libraryDecorator); ok {
2780 if Bool(library.Properties.Inject_bssl_hash) {
2781 injectBoringSSLHash = true
2782 }
2783 }
2784 }
2785 }
2786 })
2787 if injectBoringSSLHash {
2788 hashedOutputfile := outputFile
2789 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2790
Colin Crossf1a035e2020-11-16 17:32:30 -08002791 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002792 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002793 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002794 FlagWithInput("-in-object ", outputFile).
2795 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002796 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002797 }
2798
2799 return outputFile
2800}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002801
Yu Liu56ccb1a2022-11-12 10:47:07 -08002802func bp2buildParseAbiCheckerProps(ctx android.TopDownMutatorContext, module *Module) bazelCcHeaderAbiCheckerAttributes {
2803 lib, ok := module.linker.(*libraryDecorator)
2804 if !ok {
2805 return bazelCcHeaderAbiCheckerAttributes{}
2806 }
2807
2808 abiChecker := lib.Properties.Header_abi_checker
2809
2810 abiCheckerAttrs := bazelCcHeaderAbiCheckerAttributes{
2811 Abi_checker_enabled: abiChecker.Enabled,
2812 Abi_checker_exclude_symbol_versions: abiChecker.Exclude_symbol_versions,
2813 Abi_checker_exclude_symbol_tags: abiChecker.Exclude_symbol_tags,
2814 Abi_checker_check_all_apis: abiChecker.Check_all_apis,
2815 Abi_checker_diff_flags: abiChecker.Diff_flags,
2816 }
2817 if abiChecker.Symbol_file != nil {
2818 symbolFile := android.BazelLabelForModuleSrcSingle(ctx, *abiChecker.Symbol_file)
2819 abiCheckerAttrs.Abi_checker_symbol_file = &symbolFile
2820 }
2821
2822 return abiCheckerAttrs
2823}
2824
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002825func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002826 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2827 compilerAttrs := baseAttributes.compilerAttributes
2828 linkerAttrs := baseAttributes.linkerAttributes
2829
Liz Kammer54549442022-05-11 13:55:06 -04002830 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, &compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002831
2832 // Append shared/static{} stanza properties. These won't be specified on
2833 // cc_library_* itself, but may be specified in cc_defaults that this module
2834 // depends on.
2835 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2836
2837 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2838 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2839 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2840 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002841
2842 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2843 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002844 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002845 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002846 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2847
2848 asFlags := compilerAttrs.asFlags
2849 if compilerAttrs.asSrcs.IsEmpty() {
2850 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2851 asFlags = bazel.MakeStringListAttribute(nil)
2852 }
2853
Liz Kammer7a210ac2021-09-22 15:52:58 -04002854 commonAttrs := staticOrSharedAttributes{
2855 Srcs: compilerAttrs.srcs,
2856 Srcs_c: compilerAttrs.cSrcs,
2857 Srcs_as: compilerAttrs.asSrcs,
2858 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002859 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002860
Liz Kammer12615db2021-09-28 09:19:17 -04002861 Deps: linkerAttrs.deps,
2862 Implementation_deps: linkerAttrs.implementationDeps,
2863 Dynamic_deps: linkerAttrs.dynamicDeps,
2864 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2865 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2866 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2867 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Yu Liufc603162022-03-01 15:44:08 -08002868 sdkAttributes: bp2BuildParseSdkAttributes(module),
Cole Faust6b29f592022-08-09 09:50:56 -07002869 Runtime_deps: linkerAttrs.runtimeDeps,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002870 }
2871
Sam Delmericoc9b8fbd2022-10-25 15:47:17 -04002872 module.convertTidyAttributes(ctx, &commonAttrs.tidyAttributes)
Sam Delmericofb3bb322022-10-21 10:42:24 -04002873
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002874 var attrs interface{}
2875 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002876 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002877 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002878 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002879
Liz Kammerbaced712022-09-16 09:01:29 -04002880 Use_libcrt: linkerAttrs.useLibcrt,
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002881
Liz Kammer1263d9b2021-12-10 14:28:20 -05002882 Rtti: compilerAttrs.rtti,
2883 Stl: compilerAttrs.stl,
2884 Cpp_std: compilerAttrs.cppStd,
2885 C_std: compilerAttrs.cStd,
2886
2887 Export_includes: exportedIncludes.Includes,
2888 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2889 Export_system_includes: exportedIncludes.SystemIncludes,
2890 Local_includes: compilerAttrs.localIncludes,
2891 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002892
2893 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002894 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002895 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002896
Cole Faust5fa4e962022-08-22 14:31:04 -07002897 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002898 }
2899 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002900 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2901
Wei Li81852ca2022-07-27 00:22:06 -07002902 sharedLibAttrs := &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002903 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002904
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002905 Cppflags: compilerAttrs.cppFlags,
2906 Conlyflags: compilerAttrs.conlyFlags,
2907 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002908
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002909 Linkopts: linkerAttrs.linkopts,
2910 Link_crt: linkerAttrs.linkCrt,
2911 Use_libcrt: linkerAttrs.useLibcrt,
2912 Use_version_lib: linkerAttrs.useVersionLib,
2913
2914 Rtti: compilerAttrs.rtti,
2915 Stl: compilerAttrs.stl,
2916 Cpp_std: compilerAttrs.cppStd,
2917 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002918
Liz Kammerd2871182021-10-04 13:54:37 -04002919 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002920 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002921 Export_system_includes: exportedIncludes.SystemIncludes,
2922 Local_includes: compilerAttrs.localIncludes,
2923 Absolute_includes: compilerAttrs.absoluteIncludes,
2924 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002925
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00002926 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
Liz Kammer0eae52e2021-10-06 10:32:26 -04002927
Cole Faust5fa4e962022-08-22 14:31:04 -07002928 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05002929
2930 Suffix: compilerAttrs.suffix,
Yu Liu56ccb1a2022-11-12 10:47:07 -08002931
2932 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, module),
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002933 }
Wei Li81852ca2022-07-27 00:22:06 -07002934 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
2935 hasStubs := true
2936 sharedLibAttrs.Has_stubs.SetValue(&hasStubs)
Yu Liu56ccb1a2022-11-12 10:47:07 -08002937 sharedLibAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Wei Li81852ca2022-07-27 00:22:06 -07002938 }
2939 attrs = sharedLibAttrs
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002940 }
2941
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002942 var modType string
2943 if isStatic {
2944 modType = "cc_library_static"
2945 } else {
2946 modType = "cc_library_shared"
Trevor Radcliffef19d8a72022-09-20 23:04:39 +00002947 createStubsBazelTargetIfNeeded(ctx, module, compilerAttrs, exportedIncludes, baseAttributes)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002948 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002949 props := bazel.BazelTargetModuleProperties{
2950 Rule_class: modType,
Liz Kammer2b376bc2022-01-12 12:00:49 -05002951 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 +00002952 }
2953
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002954 tags := android.ApexAvailableTags(module)
2955 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 +00002956}
2957
2958// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002959type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002960 staticOrSharedAttributes
2961
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002962 Use_libcrt bazel.BoolAttribute
2963 Use_version_lib bazel.BoolAttribute
2964
2965 Rtti bazel.BoolAttribute
2966 Stl *string
2967 Cpp_std *string
2968 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002969
Liz Kammer1263d9b2021-12-10 14:28:20 -05002970 Export_includes bazel.StringListAttribute
2971 Export_absolute_includes bazel.StringListAttribute
2972 Export_system_includes bazel.StringListAttribute
2973 Local_includes bazel.StringListAttribute
2974 Absolute_includes bazel.StringListAttribute
2975 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002976
2977 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002978 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002979 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002980
2981 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002982}
2983
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002984// TODO(b/199902614): Can this be factored to share with the other Attributes?
2985type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002986 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002987
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002988 Linkopts bazel.StringListAttribute
2989 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
2990
2991 Use_libcrt bazel.BoolAttribute
2992 Use_version_lib bazel.BoolAttribute
2993
2994 Rtti bazel.BoolAttribute
2995 Stl *string
2996 Cpp_std *string
2997 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002998
Liz Kammer1263d9b2021-12-10 14:28:20 -05002999 Export_includes bazel.StringListAttribute
3000 Export_absolute_includes bazel.StringListAttribute
3001 Export_system_includes bazel.StringListAttribute
3002 Local_includes bazel.StringListAttribute
3003 Absolute_includes bazel.StringListAttribute
3004 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003005
Liz Kammerd2871182021-10-04 13:54:37 -04003006 Strip stripAttributes
3007 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04003008
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003009 Cppflags bazel.StringListAttribute
3010 Conlyflags bazel.StringListAttribute
3011 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04003012
3013 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00003014
Yu Liu56ccb1a2022-11-12 10:47:07 -08003015 Has_stubs bazel.BoolAttribute
3016 Stubs_symbol_file *string
Wei Li81852ca2022-07-27 00:22:06 -07003017
3018 Inject_bssl_hash bazel.BoolAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05003019
3020 Suffix bazel.StringAttribute
Yu Liu56ccb1a2022-11-12 10:47:07 -08003021
3022 bazelCcHeaderAbiCheckerAttributes
Wei Li81852ca2022-07-27 00:22:06 -07003023}
3024
3025type bazelCcStubSuiteAttributes struct {
3026 Symbol_file *string
3027 Versions bazel.StringListAttribute
3028 Export_includes bazel.StringListAttribute
3029 Source_library bazel.LabelAttribute
3030 Soname *string
3031 Deps bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003032}
Yu Liu56ccb1a2022-11-12 10:47:07 -08003033
3034type bazelCcHeaderAbiCheckerAttributes struct {
3035 Abi_checker_enabled *bool
3036 Abi_checker_symbol_file *bazel.Label
3037 Abi_checker_exclude_symbol_versions []string
3038 Abi_checker_exclude_symbol_tags []string
3039 Abi_checker_check_all_apis *bool
3040 Abi_checker_diff_flags []string
3041}