blob: 1f9ff7c8d3553e822a09384f5e8e4a94302ddf25 [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"
Colin Cross4d9c2d12016-07-29 12:48:20 -070033)
34
Chris Parsons3c27ca32020-11-20 12:42:07 -050035// LibraryProperties is a collection of properties shared by cc library rules.
Colin Crossb916a382016-07-29 17:28:03 -070036type LibraryProperties struct {
Colin Cross4d9c2d12016-07-29 12:48:20 -070037 // local file name to pass to the linker as -unexported_symbols_list
Colin Cross27b922f2019-03-04 22:35:41 -080038 Unexported_symbols_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070039 // local file name to pass to the linker as -force_symbols_not_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080040 Force_symbols_not_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070041 // local file name to pass to the linker as -force_symbols_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080042 Force_symbols_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070043
44 // rename host libraries to prevent overlap with system installed libraries
45 Unique_host_soname *bool
46
Dan Willemsene1240db2016-11-03 14:28:51 -070047 Aidl struct {
48 // export headers generated from .aidl sources
Nan Zhang0007d812017-11-07 10:57:05 -080049 Export_aidl_headers *bool
Dan Willemsene1240db2016-11-03 14:28:51 -070050 }
51
Colin Cross0c461f12016-10-20 16:11:43 -070052 Proto struct {
53 // export headers generated from .proto sources
Nan Zhang0007d812017-11-07 10:57:05 -080054 Export_proto_headers *bool
Colin Cross0c461f12016-10-20 16:11:43 -070055 }
Dan Albertf563d252017-10-13 00:29:00 -070056
Inseob Kimc0907f12019-02-08 21:00:45 +090057 Sysprop struct {
58 // Whether platform owns this sysprop library.
59 Platform *bool
Inseob Kimb3f22ca2019-03-05 12:40:24 +090060 } `blueprint:"mutated"`
Inseob Kimc0907f12019-02-08 21:00:45 +090061
Nan Zhang0007d812017-11-07 10:57:05 -080062 Static_ndk_lib *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090063
Florian Mayer6dab96c2020-12-31 11:39:48 +000064 // Generate stubs to make this library accessible to APEXes.
Jiyong Park7ed9de32018-10-15 22:25:07 +090065 Stubs struct {
66 // Relative path to the symbol map. The symbol map provides the list of
67 // symbols that are exported for stubs variant of this library.
Colin Cross27b922f2019-03-04 22:35:41 -080068 Symbol_file *string `android:"path"`
Jiyong Park7ed9de32018-10-15 22:25:07 +090069
Jiyong Parkd4a3a132021-03-17 20:21:35 +090070 // List versions to generate stubs libs for. The version name "current" is always
71 // implicitly added.
Jiyong Park7ed9de32018-10-15 22:25:07 +090072 Versions []string
73 }
dimitryd95964a2018-11-07 13:43:34 +010074
75 // set the name of the output
76 Stem *string `android:"arch_variant"`
77
Colin Cross0fd6a412019-08-16 14:22:10 -070078 // set suffix of the name of the output
79 Suffix *string `android:"arch_variant"`
80
81 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +090082 Vendor, Product struct {
Colin Cross0fd6a412019-08-16 14:22:10 -070083 // set suffix of the name of the output
84 Suffix *string `android:"arch_variant"`
85 }
86 }
87
dimitryd95964a2018-11-07 13:43:34 +010088 // Names of modules to be overridden. Listed modules can only be other shared libraries
89 // (in Make or Soong).
90 // This does not completely prevent installation of the overridden libraries, but if both
91 // binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
92 // from PRODUCT_PACKAGES.
93 Overrides []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +080094
95 // Properties for ABI compatibility checker
96 Header_abi_checker struct {
Logan Chien41eabe62019-04-10 13:33:58 +080097 // Enable ABI checks (even if this is not an LLNDK/VNDK lib)
98 Enabled *bool
99
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800100 // Path to a symbol file that specifies the symbols to be included in the generated
101 // ABI dump file
Colin Cross27b922f2019-03-04 22:35:41 -0800102 Symbol_file *string `android:"path"`
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800103
104 // Symbol versions that should be ignored from the symbol file
105 Exclude_symbol_versions []string
106
107 // Symbol tags that should be ignored from the symbol file
108 Exclude_symbol_tags []string
Logan Chien2a65dda2019-10-01 15:58:07 -0700109
110 // Run checks on all APIs (in addition to the ones referred by
111 // one of exported ELF symbols.)
112 Check_all_apis *bool
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800113 }
Vic Yang6cd1be82019-06-24 16:08:48 -0700114
Pete Bentley803e1612019-08-06 22:19:59 +0100115 // Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
116 Inject_bssl_hash *bool `android:"arch_variant"`
Colin Cross0477b422020-10-13 18:43:54 -0700117
Colin Cross127bb8b2020-12-16 16:46:01 -0800118 // If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
119 // the module pointed to by llndk_stubs if it is set.
120 Llndk llndkLibraryProperties
Colin Cross5271fea2021-04-27 13:06:04 -0700121
122 // If this is a vendor public library, properties to describe the vendor public library stubs.
123 Vendor_public_library vendorPublicLibraryProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800124}
Colin Cross0c461f12016-10-20 16:11:43 -0700125
Chris Parsons3c27ca32020-11-20 12:42:07 -0500126// StaticProperties is a properties stanza to affect only attributes of the "static" variants of a
127// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700128type StaticProperties struct {
129 Static StaticOrSharedProperties `android:"arch_variant"`
130}
131
Chris Parsons3c27ca32020-11-20 12:42:07 -0500132// SharedProperties is a properties stanza to affect only attributes of the "shared" variants of a
133// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700134type SharedProperties struct {
135 Shared StaticOrSharedProperties `android:"arch_variant"`
136}
137
Chris Parsons3c27ca32020-11-20 12:42:07 -0500138// StaticOrSharedProperties is an embedded struct representing properties to affect attributes of
139// either only the "static" variants or only the "shared" variants of a library module. These override
140// the base properties of the same name.
141// Use `StaticProperties` or `SharedProperties`, depending on which variant is needed.
142// `StaticOrSharedProperties` exists only to avoid duplication.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700143type StaticOrSharedProperties struct {
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700144 Srcs []string `android:"path,arch_variant"`
145
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700146 Tidy_disabled_srcs []string `android:"path,arch_variant"`
147
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700148 Sanitized Sanitized `android:"arch_variant"`
149
Colin Crosse1bb5d02019-09-24 14:55:04 -0700150 Cflags []string `android:"arch_variant"`
151
Colin Cross6b8f4252021-07-22 11:39:44 -0700152 Enabled *bool `android:"arch_variant"`
153 Whole_static_libs []string `android:"arch_variant"`
154 Static_libs []string `android:"arch_variant"`
155 Shared_libs []string `android:"arch_variant"`
156 System_shared_libs []string `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700157
158 Export_shared_lib_headers []string `android:"arch_variant"`
159 Export_static_lib_headers []string `android:"arch_variant"`
Jiyong Parka90ca002019-10-07 15:47:24 +0900160
161 Apex_available []string `android:"arch_variant"`
Colin Cross1bc94122021-10-28 13:25:54 -0700162
163 Installable *bool `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700164}
165
Colin Crossa48ab5b2017-02-14 15:28:44 -0800166type LibraryMutatedProperties struct {
Colin Crossb916a382016-07-29 17:28:03 -0700167 // Build a static variant
168 BuildStatic bool `blueprint:"mutated"`
169 // Build a shared variant
170 BuildShared bool `blueprint:"mutated"`
171 // This variant is shared
172 VariantIsShared bool `blueprint:"mutated"`
173 // This variant is static
174 VariantIsStatic bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900175
176 // This variant is a stubs lib
177 BuildStubs bool `blueprint:"mutated"`
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900178 // This variant is the latest version
179 IsLatestVersion bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900180 // Version of the stubs lib
181 StubsVersion string `blueprint:"mutated"`
Colin Crossd1f898e2020-08-18 18:35:15 -0700182 // List of all stubs versions associated with an implementation lib
183 AllStubsVersions []string `blueprint:"mutated"`
Colin Crossb916a382016-07-29 17:28:03 -0700184}
185
186type FlagExporterProperties struct {
187 // list of directories relative to the Blueprints file that will
Dan Willemsen273af7f2016-11-03 15:53:42 -0700188 // be added to the include path (using -I) for this module and any module that links
Colin Cross5d195602017-10-17 16:15:50 -0700189 // against this module. Directories listed in export_include_dirs do not need to be
190 // listed in local_include_dirs.
Colin Cross0ed579e2021-06-29 00:51:12 +0000191 Export_include_dirs []string `android:"arch_variant,variant_prepend"`
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700192
Jiyong Park73c54ee2019-10-22 20:31:18 +0900193 // list of directories that will be added to the system include path
194 // using -isystem for this module and any module that links against this module.
Colin Cross0ed579e2021-06-29 00:51:12 +0000195 Export_system_include_dirs []string `android:"arch_variant,variant_prepend"`
Jiyong Park73c54ee2019-10-22 20:31:18 +0900196
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700197 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900198 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700199 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900200 // export_include_dirs, that will be applied to
201 // vendor or product variant of this library.
202 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800203 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700204 }
205 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700206}
207
208func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000209 RegisterLibraryBuildComponents(android.InitRegistrationContext)
210}
211
212func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
213 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
214 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
215 ctx.RegisterModuleType("cc_library", LibraryFactory)
216 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
217 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700218}
219
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +0000220// TODO(b/199902614): Can this be factored to share with the other Attributes?
Jingwen Chen63930982021-03-24 10:04:33 -0400221// For bp2build conversion.
222type bazelCcLibraryAttributes struct {
Chris Parsons08648312021-05-06 16:23:19 -0400223 // Attributes pertaining to both static and shared variants.
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000224 Srcs bazel.LabelListAttribute
225 Srcs_c bazel.LabelListAttribute
226 Srcs_as bazel.LabelListAttribute
227
228 Copts bazel.StringListAttribute
229 Cppflags bazel.StringListAttribute
230 Conlyflags bazel.StringListAttribute
231 Asflags bazel.StringListAttribute
232
Liz Kammer7a210ac2021-09-22 15:52:58 -0400233 Hdrs bazel.LabelListAttribute
234
Liz Kammer12615db2021-09-28 09:19:17 -0400235 Deps bazel.LabelListAttribute
236 Implementation_deps bazel.LabelListAttribute
237 Dynamic_deps bazel.LabelListAttribute
238 Implementation_dynamic_deps bazel.LabelListAttribute
239 Whole_archive_deps bazel.LabelListAttribute
240 Implementation_whole_archive_deps bazel.LabelListAttribute
241 System_dynamic_deps bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -0400242
Liz Kammer5fad5012021-09-09 14:08:21 -0400243 Export_includes bazel.StringListAttribute
244 Export_system_includes bazel.StringListAttribute
Liz Kammer35687bc2021-09-10 10:07:07 -0400245 Local_includes bazel.StringListAttribute
246 Absolute_includes bazel.StringListAttribute
Liz Kammer5fad5012021-09-09 14:08:21 -0400247 Linkopts bazel.StringListAttribute
248 Use_libcrt bazel.BoolAttribute
249 Rtti bazel.BoolAttribute
Jingwen Chen5b11ab12021-10-11 17:44:33 +0000250
251 Stl *string
252 Cpp_std *string
Chris Parsons79bd2b72021-11-29 17:52:41 -0500253 C_std *string
Chris Parsons990c4f42021-05-25 12:10:58 -0400254
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000255 // This is shared only.
Liz Kammerd2871182021-10-04 13:54:37 -0400256 Link_crt bazel.BoolAttribute
257 Additional_linker_inputs bazel.LabelListAttribute
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000258
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000259 // Common properties shared between both shared and static variants.
260 Shared staticOrSharedAttributes
261 Static staticOrSharedAttributes
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000262
263 Strip stripAttributes
Liz Kammer0eae52e2021-10-06 10:32:26 -0400264
265 Features bazel.StringListAttribute
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000266}
267
268type stripAttributes struct {
269 Keep_symbols bazel.BoolAttribute
270 Keep_symbols_and_debug_frame bazel.BoolAttribute
271 Keep_symbols_list bazel.StringListAttribute
272 All bazel.BoolAttribute
273 None bazel.BoolAttribute
Jingwen Chen63930982021-03-24 10:04:33 -0400274}
275
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400276func libraryBp2Build(ctx android.TopDownMutatorContext, m *Module) {
Jingwen Chen179856a2021-05-03 09:15:48 +0000277 // For some cc_library modules, their static variants are ready to be
278 // converted, but not their shared variants. For these modules, delegate to
279 // the cc_library_static bp2build converter temporarily instead.
Chris Parsons953b3562021-09-20 15:14:39 -0400280 if android.GenerateCcLibraryStaticOnly(ctx.Module().Name()) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400281 sharedOrStaticLibraryBp2Build(ctx, m, true)
Jingwen Chen179856a2021-05-03 09:15:48 +0000282 return
283 }
284
Jingwen Chen53681ef2021-04-29 08:15:13 +0000285 sharedAttrs := bp2BuildParseSharedProps(ctx, m)
286 staticAttrs := bp2BuildParseStaticProps(ctx, m)
Liz Kammere6583482021-10-19 13:56:10 -0400287 baseAttributes := bp2BuildParseBaseProps(ctx, m)
288 compilerAttrs := baseAttributes.compilerAttributes
289 linkerAttrs := baseAttributes.linkerAttributes
Liz Kammer1263d9b2021-12-10 14:28:20 -0500290 exportedIncludes := bp2BuildParseExportedIncludes(ctx, m, compilerAttrs.includes)
Jingwen Chen63930982021-03-24 10:04:33 -0400291
Liz Kammer9abd62d2021-05-21 08:37:59 -0400292 srcs := compilerAttrs.srcs
Jingwen Chen53681ef2021-04-29 08:15:13 +0000293
Liz Kammer12615db2021-09-28 09:19:17 -0400294 sharedAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
295 staticAttrs.Deps.Add(baseAttributes.protoDependency)
296
Chris Parsons69fa9f92021-07-13 11:47:44 -0400297 asFlags := compilerAttrs.asFlags
298 if compilerAttrs.asSrcs.IsEmpty() && sharedAttrs.Srcs_as.IsEmpty() && staticAttrs.Srcs_as.IsEmpty() {
299 // Skip asflags for BUILD file simplicity if there are no assembly sources.
300 asFlags = bazel.MakeStringListAttribute(nil)
301 }
302
Chris Parsons77acf2e2021-12-03 17:27:16 -0500303 staticCommonAttrs := staticOrSharedAttributes{
304 Srcs: *srcs.Clone().Append(staticAttrs.Srcs),
305 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(staticAttrs.Srcs_c),
306 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(staticAttrs.Srcs_as),
307 Copts: *compilerAttrs.copts.Clone().Append(staticAttrs.Copts),
308 Hdrs: *compilerAttrs.hdrs.Clone().Append(staticAttrs.Hdrs),
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000309
Chris Parsons77acf2e2021-12-03 17:27:16 -0500310 Deps: *linkerAttrs.deps.Clone().Append(staticAttrs.Deps),
311 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(staticAttrs.Implementation_deps),
312 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(staticAttrs.Dynamic_deps),
313 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(staticAttrs.Implementation_dynamic_deps),
314 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
315 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(staticAttrs.Whole_archive_deps),
316 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(staticAttrs.System_dynamic_deps),
317 }
318
319 sharedCommonAttrs := staticOrSharedAttributes{
320 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
321 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
322 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
323 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
324 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
325
326 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
327 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
328 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
329 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
330 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
331 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
332 }
333
334 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
335 staticOrSharedAttributes: staticCommonAttrs,
336
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000337 Cppflags: compilerAttrs.cppFlags,
338 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400339 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000340
Liz Kammer1263d9b2021-12-10 14:28:20 -0500341 Export_includes: exportedIncludes.Includes,
342 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
343 Export_system_includes: exportedIncludes.SystemIncludes,
344 Local_includes: compilerAttrs.localIncludes,
345 Absolute_includes: compilerAttrs.absoluteIncludes,
346 Use_libcrt: linkerAttrs.useLibcrt,
347 Rtti: compilerAttrs.rtti,
348 Stl: compilerAttrs.stl,
349 Cpp_std: compilerAttrs.cppStd,
350 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500351
352 Features: linkerAttrs.features,
353 }
354
355 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
356 staticOrSharedAttributes: sharedCommonAttrs,
357 Cppflags: compilerAttrs.cppFlags,
358 Conlyflags: compilerAttrs.conlyFlags,
359 Asflags: asFlags,
360
Liz Kammer1263d9b2021-12-10 14:28:20 -0500361 Export_includes: exportedIncludes.Includes,
362 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
363 Export_system_includes: exportedIncludes.SystemIncludes,
364 Local_includes: compilerAttrs.localIncludes,
365 Absolute_includes: compilerAttrs.absoluteIncludes,
366 Linkopts: linkerAttrs.linkopts,
367 Link_crt: linkerAttrs.linkCrt,
368 Use_libcrt: linkerAttrs.useLibcrt,
369 Rtti: compilerAttrs.rtti,
370 Stl: compilerAttrs.stl,
371 Cpp_std: compilerAttrs.cppStd,
372 C_std: compilerAttrs.cStd,
Chris Parsons990c4f42021-05-25 12:10:58 -0400373
Liz Kammerd2871182021-10-04 13:54:37 -0400374 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000375
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000376 Strip: stripAttributes{
377 Keep_symbols: linkerAttrs.stripKeepSymbols,
378 Keep_symbols_and_debug_frame: linkerAttrs.stripKeepSymbolsAndDebugFrame,
379 Keep_symbols_list: linkerAttrs.stripKeepSymbolsList,
380 All: linkerAttrs.stripAll,
381 None: linkerAttrs.stripNone,
382 },
Liz Kammer0eae52e2021-10-06 10:32:26 -0400383 Features: linkerAttrs.features,
Jingwen Chen63930982021-03-24 10:04:33 -0400384 }
385
Chris Parsons77acf2e2021-12-03 17:27:16 -0500386 staticProps := bazel.BazelTargetModuleProperties{
387 Rule_class: "cc_library_static",
388 Bzl_load_location: "//build/bazel/rules:cc_library_static.bzl",
389 }
390 sharedProps := bazel.BazelTargetModuleProperties{
391 Rule_class: "cc_library_shared",
392 Bzl_load_location: "//build/bazel/rules:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400393 }
394
Chris Parsons58852a02021-12-09 18:10:18 -0500395 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
396 android.CommonAttributes{Name: m.Name() + "_bp2build_cc_library_static"},
397 staticTargetAttrs, staticAttrs.Enabled)
398 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
399 android.CommonAttributes{Name: m.Name()},
400 sharedTargetAttrs, sharedAttrs.Enabled)
Jingwen Chen63930982021-03-24 10:04:33 -0400401}
402
Patrice Arruda83c89e02019-03-25 15:32:39 -0700403// cc_library creates both static and/or shared libraries for a device and/or
404// host. By default, a cc_library has a single variant that targets the device.
405// Specifying `host_supported: true` also creates a library that targets the
406// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700407func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800408 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000409 // Can be used as both a static and a shared library.
410 module.sdkMemberTypes = []android.SdkMemberType{
411 sharedLibrarySdkMemberType,
412 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000413 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000414 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400415 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400416 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700417 return module.Init()
418}
419
Patrice Arruda83c89e02019-03-25 15:32:39 -0700420// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700421func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800422 module, library := NewLibrary(android.HostAndDeviceSupported)
423 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000424 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400425 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400426 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700427 return module.Init()
428}
429
Patrice Arruda83c89e02019-03-25 15:32:39 -0700430// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700431func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800432 module, library := NewLibrary(android.HostAndDeviceSupported)
433 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000434 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400435 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000436 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700437 return module.Init()
438}
439
Patrice Arruda83c89e02019-03-25 15:32:39 -0700440// cc_library_host_static creates a static library that is linkable to a host
441// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700442func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800443 module, library := NewLibrary(android.HostSupported)
444 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000445 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000446 module.bazelable = true
447 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700448 return module.Init()
449}
450
Patrice Arruda83c89e02019-03-25 15:32:39 -0700451// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700452func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800453 module, library := NewLibrary(android.HostSupported)
454 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000455 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800456 module.bazelable = true
457 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700458 return module.Init()
459}
460
Chris Parsons3c27ca32020-11-20 12:42:07 -0500461// flagExporter is a separated portion of libraryDecorator pertaining to exported
462// include paths and flags. Keeping this dependency-related information separate
463// from the rest of library information is helpful in keeping data more structured
464// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700465type flagExporter struct {
466 Properties FlagExporterProperties
467
Chris Parsons3c27ca32020-11-20 12:42:07 -0500468 dirs android.Paths // Include directories to be included with -I
469 systemDirs android.Paths // System include directories to be included with -isystem
470 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900471 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900472 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700473}
474
Chris Parsons3c27ca32020-11-20 12:42:07 -0500475// exportedIncludes returns the effective include paths for this module and
476// any module that links against this module. This is obtained from
477// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700478func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900479 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800480 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700481 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900482 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
483 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
484 }
485 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700486}
487
Chris Parsons3c27ca32020-11-20 12:42:07 -0500488// exportIncludes registers the include directories and system include directories to be exported
489// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900490func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900491 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900492 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700493}
494
Chris Parsons3c27ca32020-11-20 12:42:07 -0500495// exportIncludesAsSystem registers the include directories and system include directories to be
496// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900497func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900498 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900499 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900500 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900501}
502
Chris Parsons3c27ca32020-11-20 12:42:07 -0500503// reexportDirs registers the given directories as include directories to be exported transitively
504// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900505func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900506 f.dirs = append(f.dirs, dirs...)
507}
508
Chris Parsons3c27ca32020-11-20 12:42:07 -0500509// reexportSystemDirs registers the given directories as system include directories
510// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900511func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900512 f.systemDirs = append(f.systemDirs, dirs...)
513}
514
Chris Parsons3c27ca32020-11-20 12:42:07 -0500515// reexportFlags registers the flags to be exported transitively to modules depending on this
516// module.
Inseob Kim69378442019-06-03 19:10:47 +0900517func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800518 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
519 panic(fmt.Errorf("Exporting invalid flag %q: "+
520 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900521 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700522 f.flags = append(f.flags, flags...)
523}
524
Inseob Kim69378442019-06-03 19:10:47 +0900525func (f *flagExporter) reexportDeps(deps ...android.Path) {
526 f.deps = append(f.deps, deps...)
527}
528
Inseob Kimd110f872019-12-06 13:15:38 +0900529// addExportedGeneratedHeaders does nothing but collects generated header files.
530// This can be differ to exportedDeps which may contain phony files to minimize ninja.
531func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
532 f.headers = append(f.headers, headers...)
533}
534
Colin Cross0de8a1e2020-09-18 14:15:30 -0700535func (f *flagExporter) setProvider(ctx android.ModuleContext) {
536 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400537 // Comes from Export_include_dirs property, and those of exported transitive deps
538 IncludeDirs: android.FirstUniquePaths(f.dirs),
539 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700540 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400541 // Used in very few places as a one-off way of adding extra defines.
542 Flags: f.flags,
543 // Used sparingly, for extra files that need to be explicitly exported to dependers,
544 // or for phony files to minimize ninja.
545 Deps: f.deps,
546 // For exported generated headers, such as exported aidl headers, proto headers, or
547 // sysprop headers.
548 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700549 })
Inseob Kim69378442019-06-03 19:10:47 +0900550}
551
Colin Crossb916a382016-07-29 17:28:03 -0700552// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
553// functionality: static vs. shared linkage, reusing object files for shared libraries
554type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800555 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700556 StaticProperties StaticProperties
557 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800558 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700559
560 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900561 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700562
Colin Cross26c34ed2016-09-30 17:10:16 -0700563 // table-of-contents file to optimize out relinking when possible
564 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700565
Colin Cross4d9c2d12016-07-29 12:48:20 -0700566 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400567 flagExporterInfo *FlagExporterInfo
568 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700569
Colin Cross4d9c2d12016-07-29 12:48:20 -0700570 // For whole_static_libs
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700571 objects Objects
Colin Cross4d9c2d12016-07-29 12:48:20 -0700572
573 // Uses the module's name if empty, but can be overridden. Does not include
574 // shlib suffix.
575 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700576
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800577 sabi *sabi
578
Dan Willemsen581341d2017-02-09 16:16:31 -0800579 // Output archive of gcno coverage information files
580 coverageOutputFile android.OptionalPath
581
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800582 // linked Source Abi Dump
583 sAbiOutputFile android.OptionalPath
584
585 // Source Abi Diff
586 sAbiDiff android.OptionalPath
587
Colin Cross0875c522017-11-28 17:34:01 -0800588 // Location of the static library in the sysroot. Empty if the library is
589 // not included in the NDK.
590 ndkSysrootPath android.Path
591
Colin Crossb60190a2018-09-04 16:28:17 -0700592 // Location of the linked, unstripped library for shared libraries
593 unstrippedOutputFile android.Path
594
Dan Willemsen569edc52018-11-19 09:33:29 -0800595 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000596 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800597
Colin Cross8e21aa52020-09-28 18:28:02 -0700598 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900599
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800600 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900601
Vic Yangefd249e2018-11-12 20:19:56 -0800602 // If useCoreVariant is true, the vendor variant of a VNDK library is
603 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800604 useCoreVariant bool
605 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800606
Colin Cross5ec407b2020-09-30 11:41:33 -0700607 skipAPIDefine bool
608
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100609 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700610 *baseCompiler
611 *baseLinker
612 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900613
614 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700615
616 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900617}
618
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400619type ccLibraryBazelHandler struct {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000620 android.BazelHandler
Chris Parsons808d84c2021-03-09 20:43:32 -0500621
622 module *Module
623}
624
Chris Parsons94a0bba2021-06-04 15:03:47 -0400625// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
626// provider from a Bazel shared library's CcInfo provider.
627func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) bool {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400628 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400629 if len(rootStaticArchives) != 1 {
630 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsons944e7d02021-03-11 11:08:46 -0500631 return false
632 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400633 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500634 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
635
Chris Parsons94a0bba2021-06-04 15:03:47 -0400636 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500637 objFiles := make(android.Paths, len(objPaths))
638 for i, objPath := range objPaths {
639 objFiles[i] = android.PathForBazelOut(ctx, objPath)
640 }
641 objects := Objects{
642 objFiles: objFiles,
643 }
644
645 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
646 StaticLibrary: outputFilePath,
647 ReuseObjects: objects,
648 Objects: objects,
649
Chris Parsons94a0bba2021-06-04 15:03:47 -0400650 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500651 // static libraries with deps.
652 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
653 Direct(outputFilePath).
654 Build(),
655 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400656
Chris Parsons94a0bba2021-06-04 15:03:47 -0400657 return true
658}
659
660// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
661// provider from a Bazel shared library's CcInfo provider.
662func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) bool {
663 rootDynamicLibraries := ccInfo.RootDynamicLibraries
664
665 if len(rootDynamicLibraries) != 1 {
666 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
667 return false
668 }
669 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
670 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
671
672 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = outputFilePath
673
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000674 var tocFile android.OptionalPath
675 if len(ccInfo.TocFile) > 0 {
676 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
677 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400678 handler.module.linker.(*libraryDecorator).tocFile = tocFile
679
680 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
681 TableOfContents: tocFile,
682 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000683 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400684 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000685 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400686 })
687 return true
688}
689
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000690func (handler *ccLibraryBazelHandler) GenerateBazelBuildActions(ctx android.ModuleContext, label string) bool {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400691 bazelCtx := ctx.Config().BazelContext
Chris Parsons787fb362021-10-14 18:43:51 -0400692 ccInfo, ok, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400693 if err != nil {
694 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
695 return false
696 }
697 if !ok {
698 return ok
699 }
700
701 if handler.module.static() {
702 if ok := handler.generateStaticBazelBuildActions(ctx, label, ccInfo); !ok {
703 return false
704 }
705 } else if handler.module.Shared() {
706 if ok := handler.generateSharedBazelBuildActions(ctx, label, ccInfo); !ok {
707 return false
708 }
709 } else {
710 return false
711 }
712
713 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
714 handler.module.maybeUnhideFromMake()
715
Chris Parsonseefc9e62021-04-02 17:36:47 -0400716 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
717 // Dependencies on this library will expect collectedSnapshotHeaders to
718 // be set, otherwise validation will fail. For now, set this to an empty
719 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400720 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400721 // implementation.
722 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
723 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500724 return ok
725}
726
Chris Parsons94a0bba2021-06-04 15:03:47 -0400727func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
728 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
729 // flag exporters consolidates properties like includes, flags, dependencies that should be
730 // exported from this module to other modules
731 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
732 // Store flag info to be passed along to androidmk
733 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
734 library.flagExporterInfo = &flagExporterInfo
735}
736
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400737func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900738 ret := android.Paths{}
739
740 // Headers in the source tree should be globbed. On the contrast, generated headers
741 // can't be globbed, and they should be manually collected.
742 // So, we first filter out intermediate directories (which contains generated headers)
743 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400744 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900745 dir := path.String()
746 // Skip if dir is for generated headers
747 if strings.HasPrefix(dir, android.PathForOutput(ctx).String()) {
748 continue
749 }
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900750 // libeigen wrongly exports the root directory "external/eigen". But only two
751 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
752 // some of them have no extension. So we need special treatment for libeigen in order
753 // to glob correctly.
754 if dir == "external/eigen" {
755 // Only these two directories contains exported headers.
756 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
757 glob, err := ctx.GlobWithDeps("external/eigen/"+subdir+"/**/*", nil)
758 if err != nil {
759 ctx.ModuleErrorf("glob failed: %#v", err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400760 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900761 }
762 for _, header := range glob {
763 if strings.HasSuffix(header, "/") {
764 continue
765 }
766 ext := filepath.Ext(header)
767 if ext != "" && ext != ".h" {
768 continue
769 }
770 ret = append(ret, android.PathForSource(ctx, header))
771 }
772 }
773 continue
774 }
Colin Crossec118d02021-01-22 18:05:59 +0000775 glob, err := ctx.GlobWithDeps(dir+"/**/*", nil)
776 if err != nil {
777 ctx.ModuleErrorf("glob failed: %#v", err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400778 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900779 }
Colin Crossec118d02021-01-22 18:05:59 +0000780 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -0700781 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +0000782 if isLibcxx {
783 // Glob all files under this special directory, because of C++ headers with no
784 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -0700785 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900786 continue
787 }
Colin Crossec118d02021-01-22 18:05:59 +0000788 } else {
789 // Filter out only the files with extensions that are headers.
790 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400791 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +0000792 if strings.HasSuffix(header, ext) {
793 found = true
794 break
795 }
796 }
797 if !found {
798 continue
799 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900800 }
Jose Galmes0d736912021-03-30 11:00:06 -0700801 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900802 }
803 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400804 return ret
805}
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900806
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400807func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
808 ret := android.Paths{}
809 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900810 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
811 if strings.HasSuffix(header.Base(), "-phony") {
812 continue
813 }
814 ret = append(ret, header)
815 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400816 return ret
817}
818
819// collectHeadersForSnapshot collects all exported headers from library.
820// It globs header files in the source tree for exported include directories,
821// and tracks generated header files separately.
822//
823// This is to be called from GenerateAndroidBuildActions, and then collected
824// header files can be retrieved by snapshotHeaders().
825func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
826 ret := android.Paths{}
827
828 // Headers in the source tree should be globbed. On the contrast, generated headers
829 // can't be globbed, and they should be manually collected.
830 // So, we first filter out intermediate directories (which contains generated headers)
831 // from exported directories, and then glob headers under remaining directories.
832 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
833
834 // Collect generated headers
835 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900836
837 l.collectedSnapshotHeaders = ret
838}
839
840// This returns all exported header files, both generated ones and headers from source tree.
841// collectHeadersForSnapshot() must be called before calling this.
842func (l *libraryDecorator) snapshotHeaders() android.Paths {
843 if l.collectedSnapshotHeaders == nil {
844 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
845 }
846 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -0700847}
848
Chris Parsons3c27ca32020-11-20 12:42:07 -0500849// linkerProps returns the list of properties structs relevant for this library. (For example, if
850// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -0700851func (library *libraryDecorator) linkerProps() []interface{} {
852 var props []interface{}
853 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700854 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700855 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -0800856 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700857 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -0700858 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700859
860 if library.MutatedProperties.BuildShared {
861 props = append(props, &library.SharedProperties)
862 }
863 if library.MutatedProperties.BuildStatic {
864 props = append(props, &library.StaticProperties)
865 }
866
867 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -0700868}
869
Chris Parsons3c27ca32020-11-20 12:42:07 -0500870// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
871// library, or that are implied by attributes of this library (such as whether this library is a
872// shared library).
Colin Crossb916a382016-07-29 17:28:03 -0700873func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -0700874 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700875
Colin Crossb916a382016-07-29 17:28:03 -0700876 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
877 // all code is position independent, and then those warnings get promoted to
878 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -0700879 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800880 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -0700881 }
882
883 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800884 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -0800885 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800886 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -0700887 }
888
Colin Crossa48ab5b2017-02-14 15:28:44 -0800889 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700890 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700891 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -0700892 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700893 f = append(f,
894 "-nostdlib",
895 "-Wl,--gc-sections",
896 )
897 }
898
899 if ctx.Darwin() {
900 f = append(f,
901 "-dynamiclib",
902 "-single_module",
Colin Cross4d9c2d12016-07-29 12:48:20 -0700903 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
904 )
Colin Cross7863cf52016-10-20 10:47:21 -0700905 if ctx.Arch().ArchType == android.X86 {
906 f = append(f,
907 "-read_only_relocs suppress",
908 )
909 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700910 } else {
Josh Gao75a50a22019-06-07 17:58:59 -0700911 f = append(f, "-shared")
912 if !ctx.Windows() {
913 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
914 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700915 }
916
Colin Cross4af21ed2019-11-04 09:37:55 -0800917 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700918 }
919
920 return flags
921}
922
Chris Parsons3c27ca32020-11-20 12:42:07 -0500923// compilerFlags takes a Flags and augments it to contain compile flags from global values,
924// per-target values, module type values, per-module Blueprints properties, extra flags from
925// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -0800926func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700927 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700928 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -0700929 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -0800930 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
931 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700932 }
933
Jiyong Park7ed9de32018-10-15 22:25:07 +0900934 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -0800935 if ctx.IsLlndk() {
936 // LLNDK libraries ignore most of the properties on the cc_library and use the
937 // LLNDK-specific properties instead.
938 // Wipe all the module-local properties, leaving only the global properties.
939 flags.Local = LocalOrGlobalFlags{}
940 }
Jiyong Park7ed9de32018-10-15 22:25:07 +0900941 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +0900942 // Remove -include <file> when compiling stubs. Otherwise, the force included
943 // headers might cause conflicting types error with the symbols in the
944 // generated stubs source code. e.g.
945 // double acos(double); // in header
946 // void acos() {} // in the generated source code
947 removeInclude := func(flags []string) []string {
948 ret := flags[:0]
949 for _, f := range flags {
950 if strings.HasPrefix(f, "-include ") {
951 continue
952 }
953 ret = append(ret, f)
954 }
955 return ret
956 }
Colin Cross4af21ed2019-11-04 09:37:55 -0800957 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
958 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +0900959
Jiyong Park7ed9de32018-10-15 22:25:07 +0900960 flags = addStubLibraryCompilerFlags(flags)
961 }
962 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -0700963}
964
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800965func (library *libraryDecorator) headerAbiCheckerEnabled() bool {
966 return Bool(library.Properties.Header_abi_checker.Enabled)
Hsin-Yi Chen53489642019-07-31 17:10:45 +0800967}
968
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800969func (library *libraryDecorator) headerAbiCheckerExplicitlyDisabled() bool {
970 return !BoolDefault(library.Properties.Header_abi_checker.Enabled, true)
Logan Chien41eabe62019-04-10 13:33:58 +0800971}
972
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700973func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -0800974 if ctx.IsLlndk() {
975 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
976 vndkVer := ctx.Module().(*Module).VndkVersion()
977 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
978 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
979 vndkVer = "current"
980 }
981 if library.stubsVersion() != "" {
982 vndkVer = library.stubsVersion()
983 }
Dan Albertf1d14c72020-07-30 14:32:55 -0700984 nativeAbiResult := parseNativeAbiDefinition(ctx,
985 String(library.Properties.Llndk.Symbol_file),
986 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
987 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -0800988 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -0700989 library.versionScriptPath = android.OptionalPathForPath(
990 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -0800991 }
992 return objs
993 }
Colin Cross5271fea2021-04-27 13:06:04 -0700994 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -0700995 nativeAbiResult := parseNativeAbiDefinition(ctx,
996 String(library.Properties.Vendor_public_library.Symbol_file),
997 android.FutureApiLevel, "")
998 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -0700999 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001000 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001001 }
1002 return objs
1003 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001004 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001005 symbolFile := String(library.Properties.Stubs.Symbol_file)
1006 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1007 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1008 return Objects{}
1009 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001010 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
1011 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion),
1012 "--apex")
1013 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1014 library.versionScriptPath = android.OptionalPathForPath(
1015 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001016
1017 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001018 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001019 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1020 }
1021
Jiyong Park7ed9de32018-10-15 22:25:07 +09001022 return objs
1023 }
1024
Colin Cross5950f382016-12-13 12:50:57 -08001025 if !library.buildShared() && !library.buildStatic() {
1026 if len(library.baseCompiler.Properties.Srcs) > 0 {
1027 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1028 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001029 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001030 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1031 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001032 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001033 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1034 }
1035 return Objects{}
1036 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001037 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001038 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001039 var SourceAbiFlags []string
1040 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001041 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001042 }
Inseob Kim69378442019-06-03 19:10:47 +09001043 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1044 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001045 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001046 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001047 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001048 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001049 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001050 flags.SAbiDump = true
1051 }
1052 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001053 objs := library.baseCompiler.compile(ctx, flags, deps)
1054 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001055 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001056
Colin Cross4d9c2d12016-07-29 12:48:20 -07001057 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001058 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001059 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1060 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
1061 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001062 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001063 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001064 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1065 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
1066 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001067 }
1068
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001069 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001070}
1071
1072type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001073 versionedInterface
1074
Colin Crossb916a382016-07-29 17:28:03 -07001075 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001076 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001077 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001078 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001079 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001080
1081 // Returns true if the build options for the module have selected a static or shared build
1082 buildStatic() bool
1083 buildShared() bool
1084
1085 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001086 setStatic()
1087 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001088
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001089 // Check whether header_abi_checker is enabled or explicitly disabled.
1090 headerAbiCheckerEnabled() bool
1091 headerAbiCheckerExplicitlyDisabled() bool
1092
Logan Chien41eabe62019-04-10 13:33:58 +08001093 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1094 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001095
1096 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001097
1098 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001099
1100 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001101}
1102
Colin Crossc88c2722020-09-28 17:32:47 -07001103type versionedInterface interface {
1104 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001105 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001106 hasStubsVariants() bool
1107 setStubsVersion(string)
1108 stubsVersion() string
1109
Colin Cross3572cf72020-10-01 15:58:11 -07001110 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001111 setAllStubsVersions([]string)
1112 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001113
1114 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001115 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001116 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001117 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001118}
1119
1120var _ libraryInterface = (*libraryDecorator)(nil)
1121var _ versionedInterface = (*libraryDecorator)(nil)
1122
Justin Yun6977e8a2020-10-29 18:24:11 +09001123func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001124 name := library.libName
1125 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001126 name = String(library.Properties.Stem)
1127 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001128 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001129 }
Colin Crossb916a382016-07-29 17:28:03 -07001130 }
1131
Colin Cross0fd6a412019-08-16 14:22:10 -07001132 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001133 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001134 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001135 } else if inProduct {
1136 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001137 }
1138 if suffix == "" {
1139 suffix = String(library.Properties.Suffix)
1140 }
1141
Jooyung Han0302a842019-10-30 18:43:49 +09001142 return name + suffix
1143}
1144
Chris Parsons3c27ca32020-11-20 12:42:07 -05001145// getLibName returns the actual canonical name of the library (the name which
1146// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001147func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001148 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001149
Ivan Lozanof9e21722020-12-02 09:00:51 -05001150 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001151 // vndk-ext lib should have the same name with original lib
1152 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1153 originalName := module.(*Module).outputFile.Path()
1154 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1155 })
Logan Chienf3511742017-10-31 18:04:35 +08001156 }
1157
Colin Crossb916a382016-07-29 17:28:03 -07001158 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1159 if !strings.HasSuffix(name, "-host") {
1160 name = name + "-host"
1161 }
1162 }
1163
Inseob Kim0ce291e2019-07-04 14:38:27 +09001164 return name
Colin Crossb916a382016-07-29 17:28:03 -07001165}
1166
Jiyong Parkda732bd2018-11-02 18:23:15 +09001167var versioningMacroNamesListMutex sync.Mutex
1168
Colin Crossb916a382016-07-29 17:28:03 -07001169func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1170 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001171 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001172 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001173 }
1174 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001175 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001176 // Let baseLinker know whether this variant is for stubs or not, so that
1177 // it can omit things that are not required for linking stubs.
1178 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001179
1180 if library.buildStubs() {
1181 macroNames := versioningMacroNamesList(ctx.Config())
1182 myName := versioningMacroName(ctx.ModuleName())
1183 versioningMacroNamesListMutex.Lock()
1184 defer versioningMacroNamesListMutex.Unlock()
1185 if (*macroNames)[myName] == "" {
1186 (*macroNames)[myName] = ctx.ModuleName()
1187 } else if (*macroNames)[myName] != ctx.ModuleName() {
1188 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1189 }
1190 }
Colin Crossb916a382016-07-29 17:28:03 -07001191}
1192
dimitry0345ad82018-12-05 16:28:14 +01001193func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001194 if ctx.IsLlndk() {
1195 // LLNDK libraries ignore most of the properties on the cc_library and use the
1196 // LLNDK-specific properties instead.
1197 return deps
1198 }
1199
dimitry0345ad82018-12-05 16:28:14 +01001200 deps = library.baseCompiler.compilerDeps(ctx, deps)
1201
dimitry0345ad82018-12-05 16:28:14 +01001202 return deps
1203}
1204
Colin Cross37047f12016-12-13 17:06:13 -08001205func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001206 if ctx.IsLlndk() {
1207 // LLNDK libraries ignore most of the properties on the cc_library and use the
1208 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001209 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1210 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001211 return deps
1212 }
Colin Cross5271fea2021-04-27 13:06:04 -07001213 if ctx.IsVendorPublicLibrary() {
1214 headers := library.Properties.Vendor_public_library.Export_public_headers
1215 deps.HeaderLibs = append([]string(nil), headers...)
1216 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1217 return deps
1218 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001219
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001220 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001221 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001222 if library.StaticProperties.Static.System_shared_libs != nil {
1223 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001224 }
1225 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001226 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001227 if library.SharedProperties.Shared.System_shared_libs != nil {
1228 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001229 }
1230 }
1231
Colin Crossb916a382016-07-29 17:28:03 -07001232 deps = library.baseLinker.linkerDeps(ctx, deps)
1233
1234 if library.static() {
1235 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001236 library.StaticProperties.Static.Whole_static_libs...)
1237 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1238 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001239
Colin Crosse1bb5d02019-09-24 14:55:04 -07001240 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1241 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001242 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001243 if !Bool(library.baseLinker.Properties.Nocrt) {
1244 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1245 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001246 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001247 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1248 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1249 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001250
Colin Crosse1bb5d02019-09-24 14:55:04 -07001251 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1252 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001253 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001254 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001255 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1256 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1257 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001258 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1259 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001260 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001261 if ctx.inProduct() {
1262 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1263 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1264 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1265 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1266 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1267 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001268 if ctx.inRecovery() {
1269 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1270 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1271 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001272 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1273 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001274 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001275 if ctx.inRamdisk() {
1276 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1277 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1278 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1279 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1280 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1281 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001282 if ctx.inVendorRamdisk() {
1283 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1284 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1285 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1286 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1287 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1288 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001289
Colin Cross4d9c2d12016-07-29 12:48:20 -07001290 return deps
1291}
1292
Paul Duffin13f02712020-03-06 12:30:43 +00001293func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1294 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1295 var properties StaticOrSharedProperties
1296 if library.static() {
1297 properties = library.StaticProperties.Static
1298 } else if library.shared() {
1299 properties = library.SharedProperties.Shared
1300 }
1301
1302 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001303
1304 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1305 // either input list doesn't come out as nil.
1306 if specifiedDeps.systemSharedLibs == nil {
1307 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1308 } else {
1309 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1310 }
Paul Duffin13f02712020-03-06 12:30:43 +00001311
1312 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001313 if len(specifiedDeps.systemSharedLibs) > 0 {
1314 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1315 // retained.
1316 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1317 }
Paul Duffin13f02712020-03-06 12:30:43 +00001318 return specifiedDeps
1319}
1320
Colin Crossb916a382016-07-29 17:28:03 -07001321func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001322 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001323
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001324 library.objects = deps.WholeStaticLibObjs.Copy()
1325 library.objects = library.objects.Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001326
Inseob Kim0ce291e2019-07-04 14:38:27 +09001327 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001328 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001329 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001330
Dan Willemsen569edc52018-11-19 09:33:29 -08001331 if Bool(library.baseLinker.Properties.Use_version_lib) {
1332 if ctx.Host() {
1333 versionedOutputFile := outputFile
1334 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1335 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1336 } else {
1337 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001338 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001339 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1340 }
Colin Cross86803cf2018-02-15 14:12:26 -08001341 }
1342
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001343 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001344
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001345 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001346
Colin Cross4d9c2d12016-07-29 12:48:20 -07001347 ctx.CheckbuildFile(outputFile)
1348
Colin Cross649d8172020-12-10 12:30:21 -08001349 if library.static() {
1350 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
1351 StaticLibrary: outputFile,
1352 ReuseObjects: library.reuseObjects,
1353 Objects: library.objects,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001354
Colin Cross649d8172020-12-10 12:30:21 -08001355 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1356 Direct(outputFile).
1357 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1358 Build(),
1359 })
1360 }
1361
1362 if library.header() {
1363 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1364 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001365
Colin Cross4d9c2d12016-07-29 12:48:20 -07001366 return outputFile
1367}
1368
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001369func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1370 if ctx.Module().(*Module).IsSdkVariant() {
1371 // The NDK sysroot timestamp file depends on all the NDK
1372 // sysroot header and shared library files.
1373 return android.Paths{getNdkBaseTimestampFile(ctx)}
1374 }
1375 return nil
1376}
1377
Colin Crossb916a382016-07-29 17:28:03 -07001378func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001379 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001380
1381 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001382 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001383 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001384
Colin Cross2383f3b2018-02-06 14:40:13 -08001385 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1386 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1387 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001388 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001389 if unexportedSymbols.Valid() {
1390 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1391 }
1392 if forceNotWeakSymbols.Valid() {
1393 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1394 }
1395 if forceWeakSymbols.Valid() {
1396 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1397 }
1398 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001399 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001400 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001401 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1402 }
1403 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001404 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001405 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1406 }
1407 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001408 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001409 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1410 }
1411 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001412 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001413 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001414 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001415 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001416 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001417
1418 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1419 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001420 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001421
Josh Gao75a50a22019-06-07 17:58:59 -07001422 var implicitOutputs android.WritablePaths
1423 if ctx.Windows() {
1424 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1425
Colin Cross4af21ed2019-11-04 09:37:55 -08001426 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001427 implicitOutputs = append(implicitOutputs, importLibraryPath)
1428 }
1429
Colin Cross4d9c2d12016-07-29 12:48:20 -07001430 builderFlags := flagsToBuilderFlags(flags)
1431
Dan Willemsen47450072021-10-19 20:24:49 -07001432 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1433 fatOutputFile := outputFile
1434 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1435 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1436 }
1437
Colin Crossb496cfd2018-09-10 16:50:05 -07001438 // Optimize out relinking against shared libraries whose interface hasn't changed by
1439 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001440 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001441 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001442 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001443
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001444 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001445 needsStrip := library.stripper.NeedsStrip(ctx)
1446 if library.buildStubs() {
1447 // No need to strip stubs libraries
1448 needsStrip = false
1449 }
1450 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001451 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001452 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001453 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001454 strippedOutputFile := outputFile
1455 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001456 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001457 }
Colin Crossb60190a2018-09-04 16:28:17 -07001458 library.unstrippedOutputFile = outputFile
1459
Colin Crossd7227f92019-09-05 14:26:33 -07001460 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001461
Dan Willemsen569edc52018-11-19 09:33:29 -08001462 if Bool(library.baseLinker.Properties.Use_version_lib) {
1463 if ctx.Host() {
1464 versionedOutputFile := outputFile
1465 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1466 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1467 } else {
1468 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001469 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001470
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001471 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001472 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001473 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001474 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001475 }
1476
1477 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1478 }
Colin Cross86803cf2018-02-15 14:12:26 -08001479 }
1480
Jiyong Park64a44f22019-01-18 14:37:08 +09001481 sharedLibs := deps.EarlySharedLibs
1482 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001483 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1484
Jiyong Park64a44f22019-01-18 14:37:08 +09001485 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001486 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1487 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001488 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001489 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001490 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001491
Dan Willemsen581341d2017-02-09 16:16:31 -08001492 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1493 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001494
1495 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1496 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1497
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001498 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001499 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001500
Liz Kammeref6dfea2021-06-08 15:37:09 -04001501 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001502 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1503 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001504 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001505 }
1506
1507 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001508 TableOfContents: android.OptionalPathForPath(tocFile),
1509 SharedLibrary: unstrippedOutputFile,
1510 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1511 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001512 })
1513
1514 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1515 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001516 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001517 for _, stub := range stubs {
1518 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1519 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001520 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001521 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001522 SharedLibraryInfo: stubInfo,
1523 FlagExporterInfo: flagInfo,
1524 })
1525 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001526 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1527 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001528
Colin Cross127bb8b2020-12-16 16:46:01 -08001529 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001530 })
1531 }
1532
1533 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001534}
1535
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001536func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1537 return library.unstrippedOutputFile
1538}
1539
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001540func (library *libraryDecorator) disableStripping() {
1541 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1542}
1543
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001544func (library *libraryDecorator) nativeCoverage() bool {
1545 if library.header() || library.buildStubs() {
1546 return false
1547 }
1548 return true
1549}
1550
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001551func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1552 return library.coverageOutputFile
1553}
1554
Logan Chien7eefdc42018-07-11 18:10:41 +08001555func getRefAbiDumpFile(ctx ModuleContext, vndkVersion, fileName string) android.Path {
Hsin-Yi Chen27d235f2020-03-26 17:50:29 +08001556 // The logic must be consistent with classifySourceAbiDump.
Colin Cross95f1ca02020-10-29 20:47:22 -07001557 isNdk := ctx.isNdk(ctx.Config())
Colin Cross127bb8b2020-12-16 16:46:01 -08001558 isLlndkOrVndk := ctx.IsLlndkPublic() || (ctx.useVndk() && ctx.isVndk())
Logan Chien7eefdc42018-07-11 18:10:41 +08001559
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001560 refAbiDumpTextFile := android.PathForVndkRefAbiDump(ctx, vndkVersion, fileName, isNdk, isLlndkOrVndk, false)
1561 refAbiDumpGzipFile := android.PathForVndkRefAbiDump(ctx, vndkVersion, fileName, isNdk, isLlndkOrVndk, true)
Logan Chien7eefdc42018-07-11 18:10:41 +08001562
1563 if refAbiDumpTextFile.Valid() {
1564 if refAbiDumpGzipFile.Valid() {
1565 ctx.ModuleErrorf(
1566 "Two reference ABI dump files are found: %q and %q. Please delete the stale one.",
1567 refAbiDumpTextFile, refAbiDumpGzipFile)
1568 return nil
1569 }
1570 return refAbiDumpTextFile.Path()
1571 }
1572 if refAbiDumpGzipFile.Valid() {
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001573 return unzipRefDump(ctx, refAbiDumpGzipFile.Path(), fileName)
Logan Chien7eefdc42018-07-11 18:10:41 +08001574 }
1575 return nil
1576}
1577
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001578func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001579 if library.sabi.shouldCreateSourceAbiDump() {
Inseob Kim96f17f02020-06-09 22:05:09 +09001580 var vndkVersion string
1581
1582 if ctx.useVndk() {
1583 // For modules linking against vndk, follow its vndk version
1584 vndkVersion = ctx.Module().(*Module).VndkVersion()
1585 } else {
1586 // Regard the other modules as PLATFORM_VNDK_VERSION
1587 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
Logan Chienf3511742017-10-31 18:04:35 +08001588 }
1589
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001590 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001591 var SourceAbiFlags []string
1592 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001593 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1594 }
Inseob Kim69378442019-06-03 19:10:47 +09001595 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1596 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001597 }
1598 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001599 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001600 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001601 library.Properties.Header_abi_checker.Exclude_symbol_versions,
1602 library.Properties.Header_abi_checker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001603
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001604 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001605
Logan Chien7eefdc42018-07-11 18:10:41 +08001606 refAbiDumpFile := getRefAbiDumpFile(ctx, vndkVersion, fileName)
1607 if refAbiDumpFile != nil {
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001608 library.sAbiDiff = sourceAbiDiff(ctx, library.sAbiOutputFile.Path(),
Logan Chien2a65dda2019-10-01 15:58:07 -07001609 refAbiDumpFile, fileName, exportedHeaderFlags,
1610 Bool(library.Properties.Header_abi_checker.Check_all_apis),
Colin Cross127bb8b2020-12-16 16:46:01 -08001611 ctx.IsLlndk(), ctx.isNdk(ctx.Config()), ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001612 }
1613 }
1614}
1615
Inseob Kimcc12d902021-05-14 20:15:55 +09001616func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001617 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1618 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1619
Colin Cross127bb8b2020-12-16 16:46:01 -08001620 for _, header := range srcFiles {
1621 headerDir := filepath.Dir(header.String())
1622 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1623 if err != nil {
1624 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1625 srcDir.String(), headerDir, err)
1626 continue
1627 }
1628
1629 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1630 }
1631
Inseob Kimcc12d902021-05-14 20:15:55 +09001632 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001633}
1634
Chris Parsons3c27ca32020-11-20 12:42:07 -05001635// link registers actions to link this library, and sets various fields
1636// on this library to reflect information that should be exported up the build
1637// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07001638func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001639 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001640
Colin Cross127bb8b2020-12-16 16:46:01 -08001641 if ctx.IsLlndk() {
1642 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
1643 // This is the vendor variant of an LLNDK library with preprocessed headers.
1644 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
1645
1646 var timestampFiles android.Paths
1647 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09001648 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
1649 timestampFiles = append(timestampFiles, timestampFile)
1650 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001651 }
1652
1653 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1654 library.reexportSystemDirs(genHeaderOutDir)
1655 } else {
1656 library.reexportDirs(genHeaderOutDir)
1657 }
1658
1659 library.reexportDeps(timestampFiles...)
1660 }
1661
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001662 // override the module's export_include_dirs with llndk.override_export_include_dirs
1663 // if it is set.
1664 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
1665 library.flagExporter.Properties.Export_include_dirs = override
1666 }
1667
Colin Cross127bb8b2020-12-16 16:46:01 -08001668 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1669 library.flagExporter.Properties.Export_system_include_dirs = append(
1670 library.flagExporter.Properties.Export_system_include_dirs,
1671 library.flagExporter.Properties.Export_include_dirs...)
1672 library.flagExporter.Properties.Export_include_dirs = nil
1673 }
1674 }
1675
Colin Cross5271fea2021-04-27 13:06:04 -07001676 if ctx.IsVendorPublicLibrary() {
1677 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
1678 // if it is set.
1679 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
1680 library.flagExporter.Properties.Export_include_dirs = override
1681 }
1682 }
1683
Chris Parsons3c27ca32020-11-20 12:42:07 -05001684 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
1685 // of this library), together with `objs` (.o files created by compiling this
1686 // library).
Colin Crossad59e752017-11-16 14:29:11 -08001687 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001688 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08001689 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001690 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001691 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001692 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001693 }
1694
Chris Parsons3c27ca32020-11-20 12:42:07 -05001695 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09001696 library.exportIncludes(ctx)
1697 library.reexportDirs(deps.ReexportedDirs...)
1698 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
1699 library.reexportFlags(deps.ReexportedFlags...)
1700 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09001701 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001702
Chris Parsons3c27ca32020-11-20 12:42:07 -05001703 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001704 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001705 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09001706 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09001707 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09001708
Paul Duffin33056e82021-02-19 13:49:08 +00001709 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
1710 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07001711 }
1712 }
1713
Chris Parsons3c27ca32020-11-20 12:42:07 -05001714 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001715 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001716 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09001717 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07001718 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09001719 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07001720 }
Jiyong Park74955042019-10-22 20:19:51 +09001721 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09001722 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09001723
Paul Duffin33056e82021-02-19 13:49:08 +00001724 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
1725 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07001726 }
1727 }
1728
Inseob Kim07def122020-11-23 14:43:02 +09001729 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09001730 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09001731 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001732 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09001733 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
1734
Inseob Kim07def122020-11-23 14:43:02 +09001735 // If the owner is different from the user, expose public header. That is,
1736 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09001737 // 2) if the owner is platform and the client is vendor
1738 // We don't care Platform -> Vendor dependency as it's already forbidden.
1739 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09001740 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001741 }
1742 }
1743
Paul Duffin37e0de52021-02-19 17:05:39 +00001744 // Make sure to only export headers which are within the include directory.
1745 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
1746 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
1747 return isRel
1748 })
1749
Chris Parsons3c27ca32020-11-20 12:42:07 -05001750 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09001751 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00001752 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00001753 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09001754 }
1755
Chris Parsons3c27ca32020-11-20 12:42:07 -05001756 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09001757 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09001758
Chris Parsons3c27ca32020-11-20 12:42:07 -05001759 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07001760 library.flagExporter.setProvider(ctx)
1761
Colin Cross4d9c2d12016-07-29 12:48:20 -07001762 return out
1763}
1764
Jiyong Park892a98f2020-12-14 09:20:00 +09001765func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001766 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09001767 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09001768 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
1769 if err != nil {
1770 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
1771 }
1772 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09001773 }
1774}
1775
Chris Parsons3c27ca32020-11-20 12:42:07 -05001776// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07001777func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001778 return library.MutatedProperties.BuildStatic &&
1779 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001780}
1781
Chris Parsons3c27ca32020-11-20 12:42:07 -05001782// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07001783func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001784 return library.MutatedProperties.BuildShared &&
1785 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001786}
1787
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001788func (library *libraryDecorator) objs() Objects {
1789 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001790}
1791
Colin Cross0de8a1e2020-09-18 14:15:30 -07001792func (library *libraryDecorator) reuseObjs() Objects {
1793 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001794}
1795
Colin Cross26c34ed2016-09-30 17:10:16 -07001796func (library *libraryDecorator) toc() android.OptionalPath {
1797 return library.tocFile
1798}
1799
Jiyong Parkf1194352019-02-25 11:05:47 +09001800func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
1801 dir := library.baseInstaller.installDir(ctx)
1802 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
1803 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
1804 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001805 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09001806}
1807
Colin Crossb916a382016-07-29 17:28:03 -07001808func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07001809 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09001810 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09001811 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05001812 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09001813 if ctx.isVndkSp() {
1814 library.baseInstaller.subDir = "vndk-sp"
1815 } else {
1816 library.baseInstaller.subDir = "vndk"
1817 }
1818 }
1819
Justin Yun31094b12020-12-24 16:11:23 +09001820 // In some cases we want to use core variant for VNDK-Core libs.
1821 // Skip product variant since VNDKs use only the vendor variant.
1822 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08001823 mayUseCoreVariant := true
1824
1825 if ctx.mustUseVendorVariant() {
1826 mayUseCoreVariant = false
1827 }
1828
Elvis Chien9c993542021-06-25 01:15:17 +08001829 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08001830 mayUseCoreVariant = false
1831 }
1832
1833 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08001834 library.checkSameCoreVariant = true
1835 if ctx.DeviceConfig().VndkUseCoreVariant() {
1836 library.useCoreVariant = true
1837 }
Vic Yangefd249e2018-11-12 20:19:56 -08001838 }
Justin Yun8fe12122017-12-07 17:18:15 +09001839 }
Logan Chienf3511742017-10-31 18:04:35 +08001840
Jooyung Han261e1582020-10-20 18:54:21 +09001841 // do not install vndk libs
1842 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05001843 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09001844 return
Justin Yun8effde42017-06-23 19:24:43 +09001845 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001846 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09001847 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
1848 // The original path becomes a symlink to the corresponding file in the
1849 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07001850 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07001851 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001852 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01001853 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09001854 library.installSymlinkToRuntimeApex(ctx, file)
1855 }
Jiyong Park429660f2019-01-16 22:31:11 +09001856 library.baseInstaller.subDir = "bootstrap"
1857 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001858 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001859 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001860 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09001861 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001862
Colin Cross4d9c2d12016-07-29 12:48:20 -07001863 library.baseInstaller.install(ctx, file)
1864 }
Dan Albertf563d252017-10-13 00:29:00 -07001865
Dan Albert281f22b2017-12-13 15:03:47 -08001866 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001867 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09001868 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08001869 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07001870 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07001871 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07001872
1873 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
1874 Rule: android.Cp,
1875 Description: "install " + installPath.Base(),
1876 Output: installPath,
1877 Input: file,
1878 })
1879
Colin Cross0875c522017-11-28 17:34:01 -08001880 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07001881 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001882}
1883
Paul Duffin0cb37b92020-03-04 14:52:46 +00001884func (library *libraryDecorator) everInstallable() bool {
1885 // Only shared and static libraries are installed. Header libraries (which are
1886 // neither static or shared) are not installed.
1887 return library.shared() || library.static()
1888}
1889
Chris Parsons3c27ca32020-11-20 12:42:07 -05001890// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07001891func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001892 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07001893}
1894
Chris Parsons3c27ca32020-11-20 12:42:07 -05001895// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001896func (library *libraryDecorator) shared() bool {
1897 return library.MutatedProperties.VariantIsShared
1898}
1899
Chris Parsons3c27ca32020-11-20 12:42:07 -05001900// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001901func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001902 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001903 return !library.static() && !library.shared()
1904}
1905
Chris Parsons3c27ca32020-11-20 12:42:07 -05001906// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001907func (library *libraryDecorator) setStatic() {
1908 library.MutatedProperties.VariantIsStatic = true
1909 library.MutatedProperties.VariantIsShared = false
1910}
1911
Chris Parsons3c27ca32020-11-20 12:42:07 -05001912// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001913func (library *libraryDecorator) setShared() {
1914 library.MutatedProperties.VariantIsStatic = false
1915 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07001916}
1917
Chris Parsons3c27ca32020-11-20 12:42:07 -05001918// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08001919func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001920 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08001921}
1922
Chris Parsons3c27ca32020-11-20 12:42:07 -05001923// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08001924func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001925 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08001926}
1927
Chris Parsons3c27ca32020-11-20 12:42:07 -05001928// HeaderOnly disables building this library as a shared or static library;
1929// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08001930func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001931 library.MutatedProperties.BuildShared = false
1932 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08001933}
1934
Colin Cross127bb8b2020-12-16 16:46:01 -08001935// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
1936func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07001937 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001938}
1939
Colin Cross203b4212021-04-26 17:19:41 -07001940// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07001941func (library *libraryDecorator) hasLLNDKHeaders() bool {
1942 return Bool(library.Properties.Llndk.Llndk_headers)
1943}
1944
Colin Cross5271fea2021-04-27 13:06:04 -07001945// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
1946// vendor public library stubs.
1947func (library *libraryDecorator) hasVendorPublicLibrary() bool {
1948 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
1949}
1950
Colin Cross0477b422020-10-13 18:43:54 -07001951func (library *libraryDecorator) implementationModuleName(name string) string {
1952 return name
1953}
1954
Jiyong Park7ed9de32018-10-15 22:25:07 +09001955func (library *libraryDecorator) buildStubs() bool {
1956 return library.MutatedProperties.BuildStubs
1957}
1958
Jiyong Parka034b832019-08-27 14:02:19 +09001959func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
1960 if library.Properties.Header_abi_checker.Symbol_file != nil {
1961 return library.Properties.Header_abi_checker.Symbol_file
1962 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001963 if ctx.Module().(*Module).IsLlndk() {
1964 return library.Properties.Llndk.Symbol_file
1965 }
Colin Cross31076b32020-10-23 17:22:06 -07001966 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09001967 return library.Properties.Stubs.Symbol_file
1968 }
1969 return nil
1970}
1971
Colin Crossc88c2722020-09-28 17:32:47 -07001972func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001973 // Just having stubs.symbol_file is enough to create a stub variant. In that case
1974 // the stub for the future API level is created.
1975 return library.Properties.Stubs.Symbol_file != nil ||
1976 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07001977}
1978
Colin Cross3572cf72020-10-01 15:58:11 -07001979func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001980 if !library.hasStubsVariants() {
1981 return nil
1982 }
1983
Colin Crossc1b36442021-05-06 13:42:48 -07001984 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
1985 // LLNDK libraries only need a single stubs variant.
1986 return []string{android.FutureApiLevel.String()}
1987 }
1988
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001989 // Future API level is implicitly added if there isn't
1990 vers := library.Properties.Stubs.Versions
1991 if inList(android.FutureApiLevel.String(), vers) {
1992 return vers
1993 }
1994 // In some cases, people use the raw value "10000" in the versions property.
1995 // We shouldn't add the future API level in that case, otherwise there will
1996 // be two identical versions.
1997 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
1998 return vers
1999 }
2000 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002001}
2002
2003func (library *libraryDecorator) setStubsVersion(version string) {
2004 library.MutatedProperties.StubsVersion = version
2005}
2006
Jiyong Park7ed9de32018-10-15 22:25:07 +09002007func (library *libraryDecorator) stubsVersion() string {
2008 return library.MutatedProperties.StubsVersion
2009}
2010
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002011func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002012 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002013 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002014}
2015
2016func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2017 library.MutatedProperties.AllStubsVersions = versions
2018}
2019
2020func (library *libraryDecorator) allStubsVersions() []string {
2021 return library.MutatedProperties.AllStubsVersions
2022}
2023
Jooyung Hanad4c1872020-02-27 17:56:44 +09002024func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002025 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002026}
2027
Jiyong Parka90ca002019-10-07 15:47:24 +09002028func (library *libraryDecorator) availableFor(what string) bool {
2029 var list []string
2030 if library.static() {
2031 list = library.StaticProperties.Static.Apex_available
2032 } else if library.shared() {
2033 list = library.SharedProperties.Shared.Apex_available
2034 }
2035 if len(list) == 0 {
2036 return false
2037 }
2038 return android.CheckAvailableForApex(what, list)
2039}
2040
Colin Cross1bc94122021-10-28 13:25:54 -07002041func (library *libraryDecorator) installable() *bool {
2042 if library.static() {
2043 return library.StaticProperties.Static.Installable
2044 } else if library.shared() {
2045 return library.SharedProperties.Shared.Installable
2046 }
2047 return nil
2048}
2049
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002050func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002051 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002052 // If we're asked to make a static library uninstallable we don't do
2053 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2054 // for these entries. This is done to still get the make targets for NOTICE
2055 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002056 return
2057 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002058 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002059}
2060
Colin Crossceaa5322021-09-28 16:37:50 -07002061func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2062 return library.apiListCoverageXmlPath
2063}
2064
Colin Cross571cccf2019-02-04 11:22:08 -08002065var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2066
Chris Parsons3c27ca32020-11-20 12:42:07 -05002067// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2068// and values are the module name responsible for registering the version macro name.
2069//
2070// Version macros are used when building against stubs, to provide version information about
2071// the stub. Only stub libraries should have an entry in this list.
2072//
2073// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2074// that headers from libFoo can be conditionally compiled (this may hide APIs
2075// that are not available for the version).
2076//
2077// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002078func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002079 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002080 m := make(map[string]string)
2081 return &m
2082 }).(*map[string]string)
2083}
2084
2085// alphanumeric and _ characters are preserved.
2086// other characters are all converted to _
2087var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2088
Chris Parsons3c27ca32020-11-20 12:42:07 -05002089// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002090func versioningMacroName(moduleName string) string {
2091 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002092 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002093 return "__" + macroName + "_API__"
2094}
2095
Chris Parsons3c27ca32020-11-20 12:42:07 -05002096// NewLibrary builds and returns a new Module corresponding to a C++ library.
2097// Individual module implementations which comprise a C++ library (or something like
2098// a C++ library) should call this function, set some fields on the result, and
2099// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002100func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002101 module := newModule(hod, android.MultilibBoth)
2102
Colin Crossb916a382016-07-29 17:28:03 -07002103 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002104 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002105 BuildShared: true,
2106 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002107 },
Colin Crossb916a382016-07-29 17:28:03 -07002108 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002109 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002110 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002111 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002112 }
2113
Colin Crossb916a382016-07-29 17:28:03 -07002114 module.compiler = library
2115 module.linker = library
2116 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002117 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002118
2119 return module, library
2120}
2121
Colin Cross10d22312017-05-03 11:01:58 -07002122// connects a shared library to a static library in order to reuse its .o files to avoid
2123// compiling source files twice.
2124func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2125 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2126 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002127
2128 // Check libraries in addition to cflags, since libraries may be exporting different
2129 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002130 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2131 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2132 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2133 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2134 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2135 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2136 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2137 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002138 // Compare System_shared_libs properties with nil because empty lists are
2139 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002140 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2141 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002142
2143 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2144 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2145 sharedCompiler.baseCompiler.Properties.Srcs
2146 sharedCompiler.baseCompiler.Properties.Srcs = nil
2147 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2148 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002149
2150 // This dep is just to reference static variant from shared variant
2151 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002152 }
2153}
2154
Chris Parsons3c27ca32020-11-20 12:42:07 -05002155// LinkageMutator adds "static" or "shared" variants for modules depending
2156// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002157func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002158 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002159 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002160 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002161 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002162 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002163 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002164
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002165 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002166 buildStatic := library.buildStatic()
2167 buildShared := library.buildShared()
2168 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002169 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2170 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2171 // all the variants of the cc_library also exist on the prebuilt.
2172 modules := mctx.CreateLocalVariations("static", "shared")
2173 static := modules[0].(*Module)
2174 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002175
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002176 static.linker.(prebuiltLibraryInterface).setStatic()
2177 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002178
Colin Cross127bb8b2020-12-16 16:46:01 -08002179 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002180 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002181 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002182 mctx.AliasVariation("static")
2183 }
2184
Colin Cross127bb8b2020-12-16 16:46:01 -08002185 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002186 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2187 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002188 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002189 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2190 }
2191 } else {
2192 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002193 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002194
Ivan Lozano52767be2019-10-18 14:49:46 -07002195 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002196
Ivan Lozano2b262972019-11-21 12:30:50 -08002197 // Non-cc.Modules may need an empty variant for their mutators.
2198 variations := []string{}
2199 if library.NonCcVariants() {
2200 variations = append(variations, "")
2201 }
2202
Colin Cross127bb8b2020-12-16 16:46:01 -08002203 isLLNDK := false
2204 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002205 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002206 }
2207 buildStatic := library.BuildStaticVariant() && !isLLNDK
2208 buildShared := library.BuildSharedVariant()
2209 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002210 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002211
2212 modules := mctx.CreateLocalVariations(variations...)
2213 static := modules[0].(LinkableInterface)
2214 shared := modules[1].(LinkableInterface)
2215
2216 static.SetStatic()
2217 shared.SetShared()
2218
2219 if _, ok := library.(*Module); ok {
2220 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2221 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002222 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002223 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002224 variations := append([]string{"static"}, variations...)
2225
2226 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002227 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002228 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002229 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002230 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002231
Ivan Lozano2b262972019-11-21 12:30:50 -08002232 modules := mctx.CreateLocalVariations(variations...)
2233 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002234 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002235 } else if len(variations) > 0 {
2236 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002237 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002238 }
Colin Crossb916a382016-07-29 17:28:03 -07002239 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002240}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002241
Chris Parsons3c27ca32020-11-20 12:42:07 -05002242// normalizeVersions modifies `versions` in place, so that each raw version
2243// string becomes its normalized canonical form.
2244// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002245func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002246 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002247 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002248 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002249 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002250 ctx.PropertyErrorf("versions", "%s", err.Error())
2251 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002252 }
Dan Albertc8060532020-07-22 22:32:17 -07002253 if i > 0 && ver.LessThanOrEqualTo(previous) {
2254 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2255 }
2256 versions[i] = ver.String()
2257 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002258 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002259}
2260
Jooyung Han61b66e92020-03-21 14:21:46 +00002261func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002262 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2263 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002264 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002265
Colin Cross127bb8b2020-12-16 16:46:01 -08002266 m := mctx.Module().(*Module)
2267 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002268 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002269
Colin Crossd1f898e2020-08-18 18:35:15 -07002270 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002271 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002272
Colin Cross5271fea2021-04-27 13:06:04 -07002273 if variants[i] != "" || isLLNDK || isVendorPublicLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002274 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002275 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002276 c.sanitize = nil
2277 c.stl = nil
2278 c.Properties.PreventInstall = true
2279 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002280 isLatest := i == (len(versions) - 1)
2281 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002282
2283 if variants[i] != "" {
2284 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2285 // implementation module to the stubs module.
2286 c.Properties.HideFromMake = true
2287 lib.setStubsVersion(variants[i])
2288 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2289 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002290 }
2291 }
Colin Cross094faa52020-08-06 17:38:25 -07002292 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002293 latestVersion := ""
2294 if len(versions) > 0 {
2295 latestVersion = versions[len(versions)-1]
2296 }
2297 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002298}
2299
Colin Crossbbc941b2020-09-30 12:27:01 -07002300func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2301 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2302 if err != nil {
2303 mctx.PropertyErrorf("min_sdk_version", err.Error())
2304 return
2305 }
2306
2307 versionStrs := ndkLibraryVersions(mctx, from)
2308 modules := mctx.CreateLocalVariations(versionStrs...)
2309
2310 for i, module := range modules {
2311 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002312 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002313 }
2314}
2315
Colin Cross3146c5c2020-09-30 15:34:40 -07002316func CanBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002317 Host() bool
2318 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002319 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002320}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002321 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002322}
2323
Colin Cross3146c5c2020-09-30 15:34:40 -07002324func CanBeVersionVariant(module interface {
2325 Host() bool
2326 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002327 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002328 InRecovery() bool
2329 CcLibraryInterface() bool
2330 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002331}) bool {
2332 return CanBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002333 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002334}
2335
Colin Cross127bb8b2020-12-16 16:46:01 -08002336func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002337 if m, ok := module.(*Module); ok {
2338 return m.library
2339 }
2340 return nil
2341}
2342
Colin Crossc1b36442021-05-06 13:42:48 -07002343// versionSelector normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
Colin Crossd1f898e2020-08-18 18:35:15 -07002344func versionSelectorMutator(mctx android.BottomUpMutatorContext) {
Colin Cross31076b32020-10-23 17:22:06 -07002345 if library := moduleLibraryInterface(mctx.Module()); library != nil && CanBeVersionVariant(mctx.Module().(*Module)) {
2346 if library.buildShared() {
2347 versions := library.stubsVersions(mctx)
Colin Cross3572cf72020-10-01 15:58:11 -07002348 if len(versions) > 0 {
2349 normalizeVersions(mctx, versions)
2350 if mctx.Failed() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002351 return
2352 }
Colin Cross3572cf72020-10-01 15:58:11 -07002353 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2354 // depend on the implementation library and haven't been mutated yet.
Colin Cross31076b32020-10-23 17:22:06 -07002355 library.setAllStubsVersions(versions)
Colin Cross127bb8b2020-12-16 16:46:01 -08002356 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002357 }
Colin Crossd1f898e2020-08-18 18:35:15 -07002358 }
2359}
Jooyung Han61b66e92020-03-21 14:21:46 +00002360
Colin Crossd1f898e2020-08-18 18:35:15 -07002361// versionMutator splits a module into the mandatory non-stubs variant
2362// (which is unnamed) and zero or more stubs variants.
2363func versionMutator(mctx android.BottomUpMutatorContext) {
Colin Cross31076b32020-10-23 17:22:06 -07002364 if library := moduleLibraryInterface(mctx.Module()); library != nil && CanBeVersionVariant(mctx.Module().(*Module)) {
2365 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002366 return
2367 }
2368
2369 if m, ok := mctx.Module().(*Module); ok {
2370 if m.SplitPerApiLevel() && m.IsSdkVariant() {
2371 if mctx.Os() != android.Android {
2372 return
2373 }
2374 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2375 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002376 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002377}
Colin Crossd7227f92019-09-05 14:26:33 -07002378
2379// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2380// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2381// that the linked output file should be written to.
2382// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2383func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2384 inject *bool, fileName string) android.ModuleOutPath {
2385 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2386 injectBoringSSLHash := Bool(inject)
2387 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002388 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002389 if cc, ok := dep.(*Module); ok {
2390 if library, ok := cc.linker.(*libraryDecorator); ok {
2391 if Bool(library.Properties.Inject_bssl_hash) {
2392 injectBoringSSLHash = true
2393 }
2394 }
2395 }
2396 }
2397 })
2398 if injectBoringSSLHash {
2399 hashedOutputfile := outputFile
2400 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2401
Colin Crossf1a035e2020-11-16 17:32:30 -08002402 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002403 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002404 BuiltTool("bssl_inject_hash").
Pete Bentley5c4be822019-10-01 17:03:17 +01002405 Flag("-sha256").
Colin Crossd7227f92019-09-05 14:26:33 -07002406 FlagWithInput("-in-object ", outputFile).
2407 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002408 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002409 }
2410
2411 return outputFile
2412}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002413
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002414func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002415 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2416 compilerAttrs := baseAttributes.compilerAttributes
2417 linkerAttrs := baseAttributes.linkerAttributes
2418
Liz Kammer1263d9b2021-12-10 14:28:20 -05002419 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002420
2421 // Append shared/static{} stanza properties. These won't be specified on
2422 // cc_library_* itself, but may be specified in cc_defaults that this module
2423 // depends on.
2424 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2425
2426 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2427 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2428 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2429 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002430
2431 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2432 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002433 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002434 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002435 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2436
2437 asFlags := compilerAttrs.asFlags
2438 if compilerAttrs.asSrcs.IsEmpty() {
2439 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2440 asFlags = bazel.MakeStringListAttribute(nil)
2441 }
2442
Liz Kammer7a210ac2021-09-22 15:52:58 -04002443 commonAttrs := staticOrSharedAttributes{
2444 Srcs: compilerAttrs.srcs,
2445 Srcs_c: compilerAttrs.cSrcs,
2446 Srcs_as: compilerAttrs.asSrcs,
2447 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002448 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002449
Liz Kammer12615db2021-09-28 09:19:17 -04002450 Deps: linkerAttrs.deps,
2451 Implementation_deps: linkerAttrs.implementationDeps,
2452 Dynamic_deps: linkerAttrs.dynamicDeps,
2453 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2454 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2455 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2456 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002457 }
2458
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002459 var attrs interface{}
2460 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002461 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002462 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002463 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002464
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002465 Use_libcrt: linkerAttrs.useLibcrt,
2466 Use_version_lib: linkerAttrs.useVersionLib,
2467
Liz Kammer1263d9b2021-12-10 14:28:20 -05002468 Rtti: compilerAttrs.rtti,
2469 Stl: compilerAttrs.stl,
2470 Cpp_std: compilerAttrs.cppStd,
2471 C_std: compilerAttrs.cStd,
2472
2473 Export_includes: exportedIncludes.Includes,
2474 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2475 Export_system_includes: exportedIncludes.SystemIncludes,
2476 Local_includes: compilerAttrs.localIncludes,
2477 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002478
2479 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002480 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002481 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002482
2483 Features: linkerAttrs.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002484 }
2485 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002486 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2487
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002488 attrs = &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002489 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002490
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002491 Cppflags: compilerAttrs.cppFlags,
2492 Conlyflags: compilerAttrs.conlyFlags,
2493 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002494
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002495 Linkopts: linkerAttrs.linkopts,
2496 Link_crt: linkerAttrs.linkCrt,
2497 Use_libcrt: linkerAttrs.useLibcrt,
2498 Use_version_lib: linkerAttrs.useVersionLib,
2499
2500 Rtti: compilerAttrs.rtti,
2501 Stl: compilerAttrs.stl,
2502 Cpp_std: compilerAttrs.cppStd,
2503 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002504
Liz Kammerd2871182021-10-04 13:54:37 -04002505 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002506 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002507 Export_system_includes: exportedIncludes.SystemIncludes,
2508 Local_includes: compilerAttrs.localIncludes,
2509 Absolute_includes: compilerAttrs.absoluteIncludes,
2510 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002511
2512 Strip: stripAttributes{
2513 Keep_symbols: linkerAttrs.stripKeepSymbols,
2514 Keep_symbols_and_debug_frame: linkerAttrs.stripKeepSymbolsAndDebugFrame,
2515 Keep_symbols_list: linkerAttrs.stripKeepSymbolsList,
2516 All: linkerAttrs.stripAll,
2517 None: linkerAttrs.stripNone,
2518 },
Liz Kammer0eae52e2021-10-06 10:32:26 -04002519
2520 Features: linkerAttrs.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002521 }
2522 }
2523
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002524 var modType string
2525 if isStatic {
2526 modType = "cc_library_static"
2527 } else {
2528 modType = "cc_library_shared"
2529 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002530 props := bazel.BazelTargetModuleProperties{
2531 Rule_class: modType,
2532 Bzl_load_location: fmt.Sprintf("//build/bazel/rules:%s.bzl", modType),
2533 }
2534
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +00002535 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name()}, attrs)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002536}
2537
2538// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002539type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002540 staticOrSharedAttributes
2541
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002542 Use_libcrt bazel.BoolAttribute
2543 Use_version_lib bazel.BoolAttribute
2544
2545 Rtti bazel.BoolAttribute
2546 Stl *string
2547 Cpp_std *string
2548 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002549
Liz Kammer1263d9b2021-12-10 14:28:20 -05002550 Export_includes bazel.StringListAttribute
2551 Export_absolute_includes bazel.StringListAttribute
2552 Export_system_includes bazel.StringListAttribute
2553 Local_includes bazel.StringListAttribute
2554 Absolute_includes bazel.StringListAttribute
2555 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002556
2557 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002558 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002559 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002560
2561 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002562}
2563
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002564// TODO(b/199902614): Can this be factored to share with the other Attributes?
2565type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002566 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002567
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002568 Linkopts bazel.StringListAttribute
2569 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
2570
2571 Use_libcrt bazel.BoolAttribute
2572 Use_version_lib bazel.BoolAttribute
2573
2574 Rtti bazel.BoolAttribute
2575 Stl *string
2576 Cpp_std *string
2577 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002578
Liz Kammer1263d9b2021-12-10 14:28:20 -05002579 Export_includes bazel.StringListAttribute
2580 Export_absolute_includes bazel.StringListAttribute
2581 Export_system_includes bazel.StringListAttribute
2582 Local_includes bazel.StringListAttribute
2583 Absolute_includes bazel.StringListAttribute
2584 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002585
Liz Kammerd2871182021-10-04 13:54:37 -04002586 Strip stripAttributes
2587 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04002588
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002589 Cppflags bazel.StringListAttribute
2590 Conlyflags bazel.StringListAttribute
2591 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002592
2593 Features bazel.StringListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002594}