blob: 708aa10456a66b4aa3e89cf774b784dc5b9db753 [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
Liz Kammer2b376bc2022-01-12 12:00:49 -050035// LibraryProperties is a collection of properties shared by cc library rules/cc.
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 Chen0ee88a62022-01-07 14:55:29 +0000384
385 Stubs_symbol_file: compilerAttrs.stubsSymbolFile,
386 Stubs_versions: compilerAttrs.stubsVersions,
Jingwen Chen63930982021-03-24 10:04:33 -0400387 }
388
Yu Liu75be7b92022-02-01 09:54:09 -0800389 for axis, configToProps := range m.GetArchVariantProperties(ctx, &LibraryProperties{}) {
390 for config, props := range configToProps {
391 if props, ok := props.(*LibraryProperties); ok {
392 if props.Inject_bssl_hash != nil {
393 // This is an edge case applies only to libcrypto
394 if m.Name() == "libcrypto" {
395 sharedTargetAttrs.Inject_bssl_hash.SetSelectValue(axis, config, props.Inject_bssl_hash)
396 } else {
397 ctx.PropertyErrorf("inject_bssl_hash", "only applies to libcrypto")
398 }
399 }
400 }
401 }
402 }
403
Chris Parsons77acf2e2021-12-03 17:27:16 -0500404 staticProps := bazel.BazelTargetModuleProperties{
405 Rule_class: "cc_library_static",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500406 Bzl_load_location: "//build/bazel/rules/cc:cc_library_static.bzl",
Chris Parsons77acf2e2021-12-03 17:27:16 -0500407 }
408 sharedProps := bazel.BazelTargetModuleProperties{
409 Rule_class: "cc_library_shared",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500410 Bzl_load_location: "//build/bazel/rules/cc:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400411 }
412
Chris Parsons58852a02021-12-09 18:10:18 -0500413 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
414 android.CommonAttributes{Name: m.Name() + "_bp2build_cc_library_static"},
415 staticTargetAttrs, staticAttrs.Enabled)
416 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
417 android.CommonAttributes{Name: m.Name()},
418 sharedTargetAttrs, sharedAttrs.Enabled)
Jingwen Chen63930982021-03-24 10:04:33 -0400419}
420
Patrice Arruda83c89e02019-03-25 15:32:39 -0700421// cc_library creates both static and/or shared libraries for a device and/or
422// host. By default, a cc_library has a single variant that targets the device.
423// Specifying `host_supported: true` also creates a library that targets the
424// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700425func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800426 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000427 // Can be used as both a static and a shared library.
428 module.sdkMemberTypes = []android.SdkMemberType{
429 sharedLibrarySdkMemberType,
430 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000431 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000432 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400433 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400434 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700435 return module.Init()
436}
437
Patrice Arruda83c89e02019-03-25 15:32:39 -0700438// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700439func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800440 module, library := NewLibrary(android.HostAndDeviceSupported)
441 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000442 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400443 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400444 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700445 return module.Init()
446}
447
Patrice Arruda83c89e02019-03-25 15:32:39 -0700448// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700449func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800450 module, library := NewLibrary(android.HostAndDeviceSupported)
451 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000452 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400453 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000454 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700455 return module.Init()
456}
457
Patrice Arruda83c89e02019-03-25 15:32:39 -0700458// cc_library_host_static creates a static library that is linkable to a host
459// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700460func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800461 module, library := NewLibrary(android.HostSupported)
462 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000463 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000464 module.bazelable = true
465 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700466 return module.Init()
467}
468
Patrice Arruda83c89e02019-03-25 15:32:39 -0700469// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700470func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800471 module, library := NewLibrary(android.HostSupported)
472 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000473 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800474 module.bazelable = true
475 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700476 return module.Init()
477}
478
Chris Parsons3c27ca32020-11-20 12:42:07 -0500479// flagExporter is a separated portion of libraryDecorator pertaining to exported
480// include paths and flags. Keeping this dependency-related information separate
481// from the rest of library information is helpful in keeping data more structured
482// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700483type flagExporter struct {
484 Properties FlagExporterProperties
485
Chris Parsons3c27ca32020-11-20 12:42:07 -0500486 dirs android.Paths // Include directories to be included with -I
487 systemDirs android.Paths // System include directories to be included with -isystem
488 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900489 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900490 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700491}
492
Chris Parsons3c27ca32020-11-20 12:42:07 -0500493// exportedIncludes returns the effective include paths for this module and
494// any module that links against this module. This is obtained from
495// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700496func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900497 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800498 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700499 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900500 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
501 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
502 }
503 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700504}
505
Chris Parsons3c27ca32020-11-20 12:42:07 -0500506// exportIncludes registers the include directories and system include directories to be exported
507// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900508func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900509 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900510 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700511}
512
Chris Parsons3c27ca32020-11-20 12:42:07 -0500513// exportIncludesAsSystem registers the include directories and system include directories to be
514// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900515func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900516 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900517 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900518 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900519}
520
Chris Parsons3c27ca32020-11-20 12:42:07 -0500521// reexportDirs registers the given directories as include directories to be exported transitively
522// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900523func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900524 f.dirs = append(f.dirs, dirs...)
525}
526
Chris Parsons3c27ca32020-11-20 12:42:07 -0500527// reexportSystemDirs registers the given directories as system include directories
528// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900529func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900530 f.systemDirs = append(f.systemDirs, dirs...)
531}
532
Chris Parsons3c27ca32020-11-20 12:42:07 -0500533// reexportFlags registers the flags to be exported transitively to modules depending on this
534// module.
Inseob Kim69378442019-06-03 19:10:47 +0900535func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800536 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
537 panic(fmt.Errorf("Exporting invalid flag %q: "+
538 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900539 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700540 f.flags = append(f.flags, flags...)
541}
542
Inseob Kim69378442019-06-03 19:10:47 +0900543func (f *flagExporter) reexportDeps(deps ...android.Path) {
544 f.deps = append(f.deps, deps...)
545}
546
Inseob Kimd110f872019-12-06 13:15:38 +0900547// addExportedGeneratedHeaders does nothing but collects generated header files.
548// This can be differ to exportedDeps which may contain phony files to minimize ninja.
549func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
550 f.headers = append(f.headers, headers...)
551}
552
Colin Cross0de8a1e2020-09-18 14:15:30 -0700553func (f *flagExporter) setProvider(ctx android.ModuleContext) {
554 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400555 // Comes from Export_include_dirs property, and those of exported transitive deps
556 IncludeDirs: android.FirstUniquePaths(f.dirs),
557 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700558 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400559 // Used in very few places as a one-off way of adding extra defines.
560 Flags: f.flags,
561 // Used sparingly, for extra files that need to be explicitly exported to dependers,
562 // or for phony files to minimize ninja.
563 Deps: f.deps,
564 // For exported generated headers, such as exported aidl headers, proto headers, or
565 // sysprop headers.
566 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700567 })
Inseob Kim69378442019-06-03 19:10:47 +0900568}
569
Colin Crossb916a382016-07-29 17:28:03 -0700570// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
571// functionality: static vs. shared linkage, reusing object files for shared libraries
572type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800573 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700574 StaticProperties StaticProperties
575 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800576 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700577
578 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900579 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700580
Colin Cross26c34ed2016-09-30 17:10:16 -0700581 // table-of-contents file to optimize out relinking when possible
582 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700583
Colin Cross4d9c2d12016-07-29 12:48:20 -0700584 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400585 flagExporterInfo *FlagExporterInfo
586 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700587
Colin Cross4d9c2d12016-07-29 12:48:20 -0700588 // For whole_static_libs
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700589 objects Objects
Colin Cross4d9c2d12016-07-29 12:48:20 -0700590
591 // Uses the module's name if empty, but can be overridden. Does not include
592 // shlib suffix.
593 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700594
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800595 sabi *sabi
596
Dan Willemsen581341d2017-02-09 16:16:31 -0800597 // Output archive of gcno coverage information files
598 coverageOutputFile android.OptionalPath
599
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800600 // linked Source Abi Dump
601 sAbiOutputFile android.OptionalPath
602
603 // Source Abi Diff
604 sAbiDiff android.OptionalPath
605
Colin Cross0875c522017-11-28 17:34:01 -0800606 // Location of the static library in the sysroot. Empty if the library is
607 // not included in the NDK.
608 ndkSysrootPath android.Path
609
Colin Crossb60190a2018-09-04 16:28:17 -0700610 // Location of the linked, unstripped library for shared libraries
611 unstrippedOutputFile android.Path
612
Dan Willemsen569edc52018-11-19 09:33:29 -0800613 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000614 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800615
Colin Cross8e21aa52020-09-28 18:28:02 -0700616 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900617
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800618 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900619
Vic Yangefd249e2018-11-12 20:19:56 -0800620 // If useCoreVariant is true, the vendor variant of a VNDK library is
621 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800622 useCoreVariant bool
623 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800624
Colin Cross5ec407b2020-09-30 11:41:33 -0700625 skipAPIDefine bool
626
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100627 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700628 *baseCompiler
629 *baseLinker
630 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900631
632 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700633
634 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900635}
636
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400637type ccLibraryBazelHandler struct {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000638 android.BazelHandler
Chris Parsons808d84c2021-03-09 20:43:32 -0500639
640 module *Module
641}
642
Chris Parsons94a0bba2021-06-04 15:03:47 -0400643// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
644// provider from a Bazel shared library's CcInfo provider.
645func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) bool {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400646 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400647 if len(rootStaticArchives) != 1 {
648 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsons944e7d02021-03-11 11:08:46 -0500649 return false
650 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400651 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500652 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
653
Chris Parsons94a0bba2021-06-04 15:03:47 -0400654 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500655 objFiles := make(android.Paths, len(objPaths))
656 for i, objPath := range objPaths {
657 objFiles[i] = android.PathForBazelOut(ctx, objPath)
658 }
659 objects := Objects{
660 objFiles: objFiles,
661 }
662
663 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
664 StaticLibrary: outputFilePath,
665 ReuseObjects: objects,
666 Objects: objects,
667
Chris Parsons94a0bba2021-06-04 15:03:47 -0400668 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500669 // static libraries with deps.
670 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
671 Direct(outputFilePath).
672 Build(),
673 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400674
Chris Parsons94a0bba2021-06-04 15:03:47 -0400675 return true
676}
677
678// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
679// provider from a Bazel shared library's CcInfo provider.
680func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) bool {
681 rootDynamicLibraries := ccInfo.RootDynamicLibraries
682
683 if len(rootDynamicLibraries) != 1 {
684 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
685 return false
686 }
687 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
688 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
689
690 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = outputFilePath
691
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000692 var tocFile android.OptionalPath
693 if len(ccInfo.TocFile) > 0 {
694 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
695 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400696 handler.module.linker.(*libraryDecorator).tocFile = tocFile
697
698 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
699 TableOfContents: tocFile,
700 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000701 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400702 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000703 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400704 })
705 return true
706}
707
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000708func (handler *ccLibraryBazelHandler) GenerateBazelBuildActions(ctx android.ModuleContext, label string) bool {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400709 bazelCtx := ctx.Config().BazelContext
Chris Parsons787fb362021-10-14 18:43:51 -0400710 ccInfo, ok, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400711 if err != nil {
712 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
713 return false
714 }
715 if !ok {
716 return ok
717 }
718
719 if handler.module.static() {
720 if ok := handler.generateStaticBazelBuildActions(ctx, label, ccInfo); !ok {
721 return false
722 }
723 } else if handler.module.Shared() {
724 if ok := handler.generateSharedBazelBuildActions(ctx, label, ccInfo); !ok {
725 return false
726 }
727 } else {
728 return false
729 }
730
731 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
732 handler.module.maybeUnhideFromMake()
733
Chris Parsonseefc9e62021-04-02 17:36:47 -0400734 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
735 // Dependencies on this library will expect collectedSnapshotHeaders to
736 // be set, otherwise validation will fail. For now, set this to an empty
737 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400738 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400739 // implementation.
740 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
741 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500742 return ok
743}
744
Chris Parsons94a0bba2021-06-04 15:03:47 -0400745func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
746 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
747 // flag exporters consolidates properties like includes, flags, dependencies that should be
748 // exported from this module to other modules
749 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
750 // Store flag info to be passed along to androidmk
751 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
752 library.flagExporterInfo = &flagExporterInfo
753}
754
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400755func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900756 ret := android.Paths{}
757
758 // Headers in the source tree should be globbed. On the contrast, generated headers
759 // can't be globbed, and they should be manually collected.
760 // So, we first filter out intermediate directories (which contains generated headers)
761 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400762 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900763 dir := path.String()
764 // Skip if dir is for generated headers
765 if strings.HasPrefix(dir, android.PathForOutput(ctx).String()) {
766 continue
767 }
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900768 // libeigen wrongly exports the root directory "external/eigen". But only two
769 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
770 // some of them have no extension. So we need special treatment for libeigen in order
771 // to glob correctly.
772 if dir == "external/eigen" {
773 // Only these two directories contains exported headers.
774 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
Liz Kammer0ea79982022-02-07 08:51:47 -0500775 globDir := "external/eigen/" + subdir + "/**/*"
776 glob, err := ctx.GlobWithDeps(globDir, nil)
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900777 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500778 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400779 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900780 }
781 for _, header := range glob {
782 if strings.HasSuffix(header, "/") {
783 continue
784 }
785 ext := filepath.Ext(header)
786 if ext != "" && ext != ".h" {
787 continue
788 }
789 ret = append(ret, android.PathForSource(ctx, header))
790 }
791 }
792 continue
793 }
Liz Kammer0ea79982022-02-07 08:51:47 -0500794 globDir := dir + "/**/*"
795 glob, err := ctx.GlobWithDeps(globDir, nil)
Colin Crossec118d02021-01-22 18:05:59 +0000796 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500797 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400798 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900799 }
Colin Crossec118d02021-01-22 18:05:59 +0000800 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -0700801 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +0000802 if isLibcxx {
803 // Glob all files under this special directory, because of C++ headers with no
804 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -0700805 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900806 continue
807 }
Colin Crossec118d02021-01-22 18:05:59 +0000808 } else {
809 // Filter out only the files with extensions that are headers.
810 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400811 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +0000812 if strings.HasSuffix(header, ext) {
813 found = true
814 break
815 }
816 }
817 if !found {
818 continue
819 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900820 }
Jose Galmes0d736912021-03-30 11:00:06 -0700821 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900822 }
823 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400824 return ret
825}
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900826
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400827func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
828 ret := android.Paths{}
829 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900830 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
831 if strings.HasSuffix(header.Base(), "-phony") {
832 continue
833 }
834 ret = append(ret, header)
835 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400836 return ret
837}
838
839// collectHeadersForSnapshot collects all exported headers from library.
840// It globs header files in the source tree for exported include directories,
841// and tracks generated header files separately.
842//
843// This is to be called from GenerateAndroidBuildActions, and then collected
844// header files can be retrieved by snapshotHeaders().
845func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
846 ret := android.Paths{}
847
848 // Headers in the source tree should be globbed. On the contrast, generated headers
849 // can't be globbed, and they should be manually collected.
850 // So, we first filter out intermediate directories (which contains generated headers)
851 // from exported directories, and then glob headers under remaining directories.
852 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
853
854 // Collect generated headers
855 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900856
857 l.collectedSnapshotHeaders = ret
858}
859
860// This returns all exported header files, both generated ones and headers from source tree.
861// collectHeadersForSnapshot() must be called before calling this.
862func (l *libraryDecorator) snapshotHeaders() android.Paths {
863 if l.collectedSnapshotHeaders == nil {
864 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
865 }
866 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -0700867}
868
Chris Parsons3c27ca32020-11-20 12:42:07 -0500869// linkerProps returns the list of properties structs relevant for this library. (For example, if
870// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -0700871func (library *libraryDecorator) linkerProps() []interface{} {
872 var props []interface{}
873 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700874 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700875 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -0800876 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700877 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -0700878 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700879
880 if library.MutatedProperties.BuildShared {
881 props = append(props, &library.SharedProperties)
882 }
883 if library.MutatedProperties.BuildStatic {
884 props = append(props, &library.StaticProperties)
885 }
886
887 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -0700888}
889
Chris Parsons3c27ca32020-11-20 12:42:07 -0500890// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
891// library, or that are implied by attributes of this library (such as whether this library is a
892// shared library).
Colin Crossb916a382016-07-29 17:28:03 -0700893func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -0700894 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700895
Colin Crossb916a382016-07-29 17:28:03 -0700896 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
897 // all code is position independent, and then those warnings get promoted to
898 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -0700899 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800900 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -0700901 }
902
903 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800904 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -0800905 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800906 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -0700907 }
908
Colin Crossa48ab5b2017-02-14 15:28:44 -0800909 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700910 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700911 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -0700912 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700913 f = append(f,
914 "-nostdlib",
915 "-Wl,--gc-sections",
916 )
917 }
918
919 if ctx.Darwin() {
920 f = append(f,
921 "-dynamiclib",
922 "-single_module",
Colin Cross4d9c2d12016-07-29 12:48:20 -0700923 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
924 )
Colin Cross7863cf52016-10-20 10:47:21 -0700925 if ctx.Arch().ArchType == android.X86 {
926 f = append(f,
927 "-read_only_relocs suppress",
928 )
929 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700930 } else {
Josh Gao75a50a22019-06-07 17:58:59 -0700931 f = append(f, "-shared")
932 if !ctx.Windows() {
933 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
934 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700935 }
936
Colin Cross4af21ed2019-11-04 09:37:55 -0800937 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700938 }
939
940 return flags
941}
942
Chris Parsons3c27ca32020-11-20 12:42:07 -0500943// compilerFlags takes a Flags and augments it to contain compile flags from global values,
944// per-target values, module type values, per-module Blueprints properties, extra flags from
945// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -0800946func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700947 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700948 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -0700949 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -0800950 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
951 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700952 }
953
Jiyong Park7ed9de32018-10-15 22:25:07 +0900954 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -0800955 if ctx.IsLlndk() {
956 // LLNDK libraries ignore most of the properties on the cc_library and use the
957 // LLNDK-specific properties instead.
958 // Wipe all the module-local properties, leaving only the global properties.
959 flags.Local = LocalOrGlobalFlags{}
960 }
Jiyong Park7ed9de32018-10-15 22:25:07 +0900961 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +0900962 // Remove -include <file> when compiling stubs. Otherwise, the force included
963 // headers might cause conflicting types error with the symbols in the
964 // generated stubs source code. e.g.
965 // double acos(double); // in header
966 // void acos() {} // in the generated source code
967 removeInclude := func(flags []string) []string {
968 ret := flags[:0]
969 for _, f := range flags {
970 if strings.HasPrefix(f, "-include ") {
971 continue
972 }
973 ret = append(ret, f)
974 }
975 return ret
976 }
Colin Cross4af21ed2019-11-04 09:37:55 -0800977 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
978 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +0900979
Jiyong Park7ed9de32018-10-15 22:25:07 +0900980 flags = addStubLibraryCompilerFlags(flags)
981 }
982 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -0700983}
984
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800985func (library *libraryDecorator) headerAbiCheckerEnabled() bool {
986 return Bool(library.Properties.Header_abi_checker.Enabled)
Hsin-Yi Chen53489642019-07-31 17:10:45 +0800987}
988
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800989func (library *libraryDecorator) headerAbiCheckerExplicitlyDisabled() bool {
990 return !BoolDefault(library.Properties.Header_abi_checker.Enabled, true)
Logan Chien41eabe62019-04-10 13:33:58 +0800991}
992
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700993func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -0800994 if ctx.IsLlndk() {
995 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
996 vndkVer := ctx.Module().(*Module).VndkVersion()
997 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
998 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
999 vndkVer = "current"
1000 }
1001 if library.stubsVersion() != "" {
1002 vndkVer = library.stubsVersion()
1003 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001004 nativeAbiResult := parseNativeAbiDefinition(ctx,
1005 String(library.Properties.Llndk.Symbol_file),
1006 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
1007 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -08001008 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001009 library.versionScriptPath = android.OptionalPathForPath(
1010 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -08001011 }
1012 return objs
1013 }
Colin Cross5271fea2021-04-27 13:06:04 -07001014 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -07001015 nativeAbiResult := parseNativeAbiDefinition(ctx,
1016 String(library.Properties.Vendor_public_library.Symbol_file),
1017 android.FutureApiLevel, "")
1018 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001019 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001020 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001021 }
1022 return objs
1023 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001024 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001025 symbolFile := String(library.Properties.Stubs.Symbol_file)
1026 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1027 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1028 return Objects{}
1029 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001030 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
1031 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion),
1032 "--apex")
1033 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1034 library.versionScriptPath = android.OptionalPathForPath(
1035 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001036
1037 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001038 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001039 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1040 }
1041
Jiyong Park7ed9de32018-10-15 22:25:07 +09001042 return objs
1043 }
1044
Colin Cross5950f382016-12-13 12:50:57 -08001045 if !library.buildShared() && !library.buildStatic() {
1046 if len(library.baseCompiler.Properties.Srcs) > 0 {
1047 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1048 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001049 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001050 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1051 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001052 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001053 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1054 }
1055 return Objects{}
1056 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001057 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001058 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001059 var SourceAbiFlags []string
1060 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001061 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001062 }
Inseob Kim69378442019-06-03 19:10:47 +09001063 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1064 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001065 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001066 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001067 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001068 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001069 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001070 flags.SAbiDump = true
1071 }
1072 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001073 objs := library.baseCompiler.compile(ctx, flags, deps)
1074 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001075 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001076
Colin Cross4d9c2d12016-07-29 12:48:20 -07001077 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001078 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001079 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1080 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
1081 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001082 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001083 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001084 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1085 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
1086 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001087 }
1088
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001089 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001090}
1091
1092type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001093 versionedInterface
1094
Colin Crossb916a382016-07-29 17:28:03 -07001095 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001096 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001097 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001098 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001099 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001100
1101 // Returns true if the build options for the module have selected a static or shared build
1102 buildStatic() bool
1103 buildShared() bool
1104
1105 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001106 setStatic()
1107 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001108
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001109 // Check whether header_abi_checker is enabled or explicitly disabled.
1110 headerAbiCheckerEnabled() bool
1111 headerAbiCheckerExplicitlyDisabled() bool
1112
Logan Chien41eabe62019-04-10 13:33:58 +08001113 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1114 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001115
1116 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001117
1118 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001119
1120 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001121}
1122
Colin Crossc88c2722020-09-28 17:32:47 -07001123type versionedInterface interface {
1124 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001125 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001126 hasStubsVariants() bool
1127 setStubsVersion(string)
1128 stubsVersion() string
1129
Colin Cross3572cf72020-10-01 15:58:11 -07001130 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001131 setAllStubsVersions([]string)
1132 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001133
1134 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001135 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001136 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001137 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001138}
1139
1140var _ libraryInterface = (*libraryDecorator)(nil)
1141var _ versionedInterface = (*libraryDecorator)(nil)
1142
Justin Yun6977e8a2020-10-29 18:24:11 +09001143func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001144 name := library.libName
1145 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001146 name = String(library.Properties.Stem)
1147 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001148 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001149 }
Colin Crossb916a382016-07-29 17:28:03 -07001150 }
1151
Colin Cross0fd6a412019-08-16 14:22:10 -07001152 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001153 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001154 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001155 } else if inProduct {
1156 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001157 }
1158 if suffix == "" {
1159 suffix = String(library.Properties.Suffix)
1160 }
1161
Jooyung Han0302a842019-10-30 18:43:49 +09001162 return name + suffix
1163}
1164
Chris Parsons3c27ca32020-11-20 12:42:07 -05001165// getLibName returns the actual canonical name of the library (the name which
1166// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001167func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001168 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001169
Ivan Lozanof9e21722020-12-02 09:00:51 -05001170 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001171 // vndk-ext lib should have the same name with original lib
1172 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1173 originalName := module.(*Module).outputFile.Path()
1174 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1175 })
Logan Chienf3511742017-10-31 18:04:35 +08001176 }
1177
Colin Crossb916a382016-07-29 17:28:03 -07001178 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1179 if !strings.HasSuffix(name, "-host") {
1180 name = name + "-host"
1181 }
1182 }
1183
Inseob Kim0ce291e2019-07-04 14:38:27 +09001184 return name
Colin Crossb916a382016-07-29 17:28:03 -07001185}
1186
Jiyong Parkda732bd2018-11-02 18:23:15 +09001187var versioningMacroNamesListMutex sync.Mutex
1188
Colin Crossb916a382016-07-29 17:28:03 -07001189func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1190 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001191 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001192 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001193 }
1194 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001195 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001196 // Let baseLinker know whether this variant is for stubs or not, so that
1197 // it can omit things that are not required for linking stubs.
1198 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001199
1200 if library.buildStubs() {
1201 macroNames := versioningMacroNamesList(ctx.Config())
1202 myName := versioningMacroName(ctx.ModuleName())
1203 versioningMacroNamesListMutex.Lock()
1204 defer versioningMacroNamesListMutex.Unlock()
1205 if (*macroNames)[myName] == "" {
1206 (*macroNames)[myName] = ctx.ModuleName()
1207 } else if (*macroNames)[myName] != ctx.ModuleName() {
1208 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1209 }
1210 }
Colin Crossb916a382016-07-29 17:28:03 -07001211}
1212
dimitry0345ad82018-12-05 16:28:14 +01001213func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001214 if ctx.IsLlndk() {
1215 // LLNDK libraries ignore most of the properties on the cc_library and use the
1216 // LLNDK-specific properties instead.
1217 return deps
1218 }
1219
dimitry0345ad82018-12-05 16:28:14 +01001220 deps = library.baseCompiler.compilerDeps(ctx, deps)
1221
dimitry0345ad82018-12-05 16:28:14 +01001222 return deps
1223}
1224
Colin Cross37047f12016-12-13 17:06:13 -08001225func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001226 if ctx.IsLlndk() {
1227 // LLNDK libraries ignore most of the properties on the cc_library and use the
1228 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001229 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1230 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001231 return deps
1232 }
Colin Cross5271fea2021-04-27 13:06:04 -07001233 if ctx.IsVendorPublicLibrary() {
1234 headers := library.Properties.Vendor_public_library.Export_public_headers
1235 deps.HeaderLibs = append([]string(nil), headers...)
1236 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1237 return deps
1238 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001239
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001240 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001241 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001242 if library.StaticProperties.Static.System_shared_libs != nil {
1243 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001244 }
1245 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001246 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001247 if library.SharedProperties.Shared.System_shared_libs != nil {
1248 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001249 }
1250 }
1251
Colin Crossb916a382016-07-29 17:28:03 -07001252 deps = library.baseLinker.linkerDeps(ctx, deps)
1253
1254 if library.static() {
1255 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001256 library.StaticProperties.Static.Whole_static_libs...)
1257 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1258 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001259
Colin Crosse1bb5d02019-09-24 14:55:04 -07001260 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1261 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001262 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001263 if !Bool(library.baseLinker.Properties.Nocrt) {
1264 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1265 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001266 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001267 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1268 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1269 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001270
Colin Crosse1bb5d02019-09-24 14:55:04 -07001271 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1272 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001273 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001274 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001275 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1276 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1277 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001278 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1279 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001280 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001281 if ctx.inProduct() {
1282 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1283 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1284 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1285 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1286 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1287 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001288 if ctx.inRecovery() {
1289 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1290 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1291 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001292 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1293 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001294 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001295 if ctx.inRamdisk() {
1296 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1297 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1298 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1299 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1300 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1301 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001302 if ctx.inVendorRamdisk() {
1303 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1304 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1305 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1306 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1307 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1308 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001309
Colin Cross4d9c2d12016-07-29 12:48:20 -07001310 return deps
1311}
1312
Paul Duffin13f02712020-03-06 12:30:43 +00001313func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1314 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1315 var properties StaticOrSharedProperties
1316 if library.static() {
1317 properties = library.StaticProperties.Static
1318 } else if library.shared() {
1319 properties = library.SharedProperties.Shared
1320 }
1321
1322 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001323
1324 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1325 // either input list doesn't come out as nil.
1326 if specifiedDeps.systemSharedLibs == nil {
1327 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1328 } else {
1329 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1330 }
Paul Duffin13f02712020-03-06 12:30:43 +00001331
1332 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001333 if len(specifiedDeps.systemSharedLibs) > 0 {
1334 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1335 // retained.
1336 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1337 }
Paul Duffin13f02712020-03-06 12:30:43 +00001338 return specifiedDeps
1339}
1340
Colin Crossb916a382016-07-29 17:28:03 -07001341func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001342 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001343
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001344 library.objects = deps.WholeStaticLibObjs.Copy()
1345 library.objects = library.objects.Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001346
Inseob Kim0ce291e2019-07-04 14:38:27 +09001347 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001348 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001349 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001350
Dan Willemsen569edc52018-11-19 09:33:29 -08001351 if Bool(library.baseLinker.Properties.Use_version_lib) {
1352 if ctx.Host() {
1353 versionedOutputFile := outputFile
1354 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1355 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1356 } else {
1357 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001358 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001359 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1360 }
Colin Cross86803cf2018-02-15 14:12:26 -08001361 }
1362
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001363 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001364
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001365 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001366
Colin Cross4d9c2d12016-07-29 12:48:20 -07001367 ctx.CheckbuildFile(outputFile)
1368
Colin Cross649d8172020-12-10 12:30:21 -08001369 if library.static() {
1370 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
1371 StaticLibrary: outputFile,
1372 ReuseObjects: library.reuseObjects,
1373 Objects: library.objects,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001374
Colin Cross649d8172020-12-10 12:30:21 -08001375 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1376 Direct(outputFile).
1377 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1378 Build(),
1379 })
1380 }
1381
1382 if library.header() {
1383 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1384 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001385
Colin Cross4d9c2d12016-07-29 12:48:20 -07001386 return outputFile
1387}
1388
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001389func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1390 if ctx.Module().(*Module).IsSdkVariant() {
1391 // The NDK sysroot timestamp file depends on all the NDK
1392 // sysroot header and shared library files.
1393 return android.Paths{getNdkBaseTimestampFile(ctx)}
1394 }
1395 return nil
1396}
1397
Colin Crossb916a382016-07-29 17:28:03 -07001398func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001399 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001400
1401 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001402 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001403 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001404
Colin Cross2383f3b2018-02-06 14:40:13 -08001405 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1406 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1407 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001408 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001409 if unexportedSymbols.Valid() {
1410 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1411 }
1412 if forceNotWeakSymbols.Valid() {
1413 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1414 }
1415 if forceWeakSymbols.Valid() {
1416 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1417 }
1418 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001419 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001420 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001421 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1422 }
1423 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001424 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001425 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1426 }
1427 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001428 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001429 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1430 }
1431 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001432 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001433 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001434 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001435 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001436 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001437
1438 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1439 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001440 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001441
Josh Gao75a50a22019-06-07 17:58:59 -07001442 var implicitOutputs android.WritablePaths
1443 if ctx.Windows() {
1444 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1445
Colin Cross4af21ed2019-11-04 09:37:55 -08001446 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001447 implicitOutputs = append(implicitOutputs, importLibraryPath)
1448 }
1449
Colin Cross4d9c2d12016-07-29 12:48:20 -07001450 builderFlags := flagsToBuilderFlags(flags)
1451
Dan Willemsen47450072021-10-19 20:24:49 -07001452 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1453 fatOutputFile := outputFile
1454 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1455 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1456 }
1457
Colin Crossb496cfd2018-09-10 16:50:05 -07001458 // Optimize out relinking against shared libraries whose interface hasn't changed by
1459 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001460 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001461 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001462 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001463
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001464 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001465 needsStrip := library.stripper.NeedsStrip(ctx)
1466 if library.buildStubs() {
1467 // No need to strip stubs libraries
1468 needsStrip = false
1469 }
1470 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001471 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001472 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001473 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001474 strippedOutputFile := outputFile
1475 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001476 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001477 }
Colin Crossb60190a2018-09-04 16:28:17 -07001478 library.unstrippedOutputFile = outputFile
1479
Colin Crossd7227f92019-09-05 14:26:33 -07001480 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001481
Dan Willemsen569edc52018-11-19 09:33:29 -08001482 if Bool(library.baseLinker.Properties.Use_version_lib) {
1483 if ctx.Host() {
1484 versionedOutputFile := outputFile
1485 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1486 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1487 } else {
1488 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001489 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001490
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001491 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001492 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001493 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001494 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001495 }
1496
1497 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1498 }
Colin Cross86803cf2018-02-15 14:12:26 -08001499 }
1500
Jiyong Park64a44f22019-01-18 14:37:08 +09001501 sharedLibs := deps.EarlySharedLibs
1502 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001503 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1504
Jiyong Park64a44f22019-01-18 14:37:08 +09001505 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001506 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1507 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001508 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001509 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001510 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001511
Dan Willemsen581341d2017-02-09 16:16:31 -08001512 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1513 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001514
1515 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1516 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1517
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001518 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001519 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001520
Liz Kammeref6dfea2021-06-08 15:37:09 -04001521 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001522 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1523 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001524 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001525 }
1526
1527 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001528 TableOfContents: android.OptionalPathForPath(tocFile),
1529 SharedLibrary: unstrippedOutputFile,
1530 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1531 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001532 })
1533
1534 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1535 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001536 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001537 for _, stub := range stubs {
1538 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1539 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001540 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001541 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001542 SharedLibraryInfo: stubInfo,
1543 FlagExporterInfo: flagInfo,
1544 })
1545 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001546 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1547 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001548
Colin Cross127bb8b2020-12-16 16:46:01 -08001549 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001550 })
1551 }
1552
1553 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001554}
1555
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001556func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1557 return library.unstrippedOutputFile
1558}
1559
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001560func (library *libraryDecorator) disableStripping() {
1561 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1562}
1563
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001564func (library *libraryDecorator) nativeCoverage() bool {
1565 if library.header() || library.buildStubs() {
1566 return false
1567 }
1568 return true
1569}
1570
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001571func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1572 return library.coverageOutputFile
1573}
1574
Logan Chien7eefdc42018-07-11 18:10:41 +08001575func getRefAbiDumpFile(ctx ModuleContext, vndkVersion, fileName string) android.Path {
Hsin-Yi Chen27d235f2020-03-26 17:50:29 +08001576 // The logic must be consistent with classifySourceAbiDump.
Colin Cross95f1ca02020-10-29 20:47:22 -07001577 isNdk := ctx.isNdk(ctx.Config())
Colin Cross127bb8b2020-12-16 16:46:01 -08001578 isLlndkOrVndk := ctx.IsLlndkPublic() || (ctx.useVndk() && ctx.isVndk())
Logan Chien7eefdc42018-07-11 18:10:41 +08001579
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001580 refAbiDumpTextFile := android.PathForVndkRefAbiDump(ctx, vndkVersion, fileName, isNdk, isLlndkOrVndk, false)
1581 refAbiDumpGzipFile := android.PathForVndkRefAbiDump(ctx, vndkVersion, fileName, isNdk, isLlndkOrVndk, true)
Logan Chien7eefdc42018-07-11 18:10:41 +08001582
1583 if refAbiDumpTextFile.Valid() {
1584 if refAbiDumpGzipFile.Valid() {
1585 ctx.ModuleErrorf(
1586 "Two reference ABI dump files are found: %q and %q. Please delete the stale one.",
1587 refAbiDumpTextFile, refAbiDumpGzipFile)
1588 return nil
1589 }
1590 return refAbiDumpTextFile.Path()
1591 }
1592 if refAbiDumpGzipFile.Valid() {
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001593 return unzipRefDump(ctx, refAbiDumpGzipFile.Path(), fileName)
Logan Chien7eefdc42018-07-11 18:10:41 +08001594 }
1595 return nil
1596}
1597
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001598func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001599 if library.sabi.shouldCreateSourceAbiDump() {
Inseob Kim96f17f02020-06-09 22:05:09 +09001600 var vndkVersion string
1601
1602 if ctx.useVndk() {
1603 // For modules linking against vndk, follow its vndk version
1604 vndkVersion = ctx.Module().(*Module).VndkVersion()
1605 } else {
1606 // Regard the other modules as PLATFORM_VNDK_VERSION
1607 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
Logan Chienf3511742017-10-31 18:04:35 +08001608 }
1609
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001610 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001611 var SourceAbiFlags []string
1612 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001613 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1614 }
Inseob Kim69378442019-06-03 19:10:47 +09001615 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1616 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001617 }
1618 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001619 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001620 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001621 library.Properties.Header_abi_checker.Exclude_symbol_versions,
1622 library.Properties.Header_abi_checker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001623
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001624 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001625
Logan Chien7eefdc42018-07-11 18:10:41 +08001626 refAbiDumpFile := getRefAbiDumpFile(ctx, vndkVersion, fileName)
1627 if refAbiDumpFile != nil {
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001628 library.sAbiDiff = sourceAbiDiff(ctx, library.sAbiOutputFile.Path(),
Logan Chien2a65dda2019-10-01 15:58:07 -07001629 refAbiDumpFile, fileName, exportedHeaderFlags,
1630 Bool(library.Properties.Header_abi_checker.Check_all_apis),
Colin Cross127bb8b2020-12-16 16:46:01 -08001631 ctx.IsLlndk(), ctx.isNdk(ctx.Config()), ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001632 }
1633 }
1634}
1635
Inseob Kimcc12d902021-05-14 20:15:55 +09001636func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001637 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1638 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1639
Colin Cross127bb8b2020-12-16 16:46:01 -08001640 for _, header := range srcFiles {
1641 headerDir := filepath.Dir(header.String())
1642 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1643 if err != nil {
1644 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1645 srcDir.String(), headerDir, err)
1646 continue
1647 }
1648
1649 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1650 }
1651
Inseob Kimcc12d902021-05-14 20:15:55 +09001652 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001653}
1654
Chris Parsons3c27ca32020-11-20 12:42:07 -05001655// link registers actions to link this library, and sets various fields
1656// on this library to reflect information that should be exported up the build
1657// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07001658func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001659 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001660
Colin Cross127bb8b2020-12-16 16:46:01 -08001661 if ctx.IsLlndk() {
1662 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
1663 // This is the vendor variant of an LLNDK library with preprocessed headers.
1664 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
1665
1666 var timestampFiles android.Paths
1667 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09001668 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
1669 timestampFiles = append(timestampFiles, timestampFile)
1670 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001671 }
1672
1673 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1674 library.reexportSystemDirs(genHeaderOutDir)
1675 } else {
1676 library.reexportDirs(genHeaderOutDir)
1677 }
1678
1679 library.reexportDeps(timestampFiles...)
1680 }
1681
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001682 // override the module's export_include_dirs with llndk.override_export_include_dirs
1683 // if it is set.
1684 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
1685 library.flagExporter.Properties.Export_include_dirs = override
1686 }
1687
Colin Cross127bb8b2020-12-16 16:46:01 -08001688 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1689 library.flagExporter.Properties.Export_system_include_dirs = append(
1690 library.flagExporter.Properties.Export_system_include_dirs,
1691 library.flagExporter.Properties.Export_include_dirs...)
1692 library.flagExporter.Properties.Export_include_dirs = nil
1693 }
1694 }
1695
Colin Cross5271fea2021-04-27 13:06:04 -07001696 if ctx.IsVendorPublicLibrary() {
1697 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
1698 // if it is set.
1699 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
1700 library.flagExporter.Properties.Export_include_dirs = override
1701 }
1702 }
1703
Chris Parsons3c27ca32020-11-20 12:42:07 -05001704 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
1705 // of this library), together with `objs` (.o files created by compiling this
1706 // library).
Colin Crossad59e752017-11-16 14:29:11 -08001707 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001708 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08001709 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001710 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001711 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001712 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001713 }
1714
Chris Parsons3c27ca32020-11-20 12:42:07 -05001715 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09001716 library.exportIncludes(ctx)
1717 library.reexportDirs(deps.ReexportedDirs...)
1718 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
1719 library.reexportFlags(deps.ReexportedFlags...)
1720 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09001721 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001722
Chris Parsons3c27ca32020-11-20 12:42:07 -05001723 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001724 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001725 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09001726 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09001727 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09001728
Paul Duffin33056e82021-02-19 13:49:08 +00001729 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
1730 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07001731 }
1732 }
1733
Chris Parsons3c27ca32020-11-20 12:42:07 -05001734 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001735 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001736 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09001737 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07001738 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09001739 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07001740 }
Jiyong Park74955042019-10-22 20:19:51 +09001741 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09001742 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09001743
Paul Duffin33056e82021-02-19 13:49:08 +00001744 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
1745 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07001746 }
1747 }
1748
Inseob Kim07def122020-11-23 14:43:02 +09001749 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09001750 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09001751 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001752 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09001753 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
1754
Inseob Kim07def122020-11-23 14:43:02 +09001755 // If the owner is different from the user, expose public header. That is,
1756 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09001757 // 2) if the owner is platform and the client is vendor
1758 // We don't care Platform -> Vendor dependency as it's already forbidden.
1759 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09001760 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001761 }
1762 }
1763
Paul Duffin37e0de52021-02-19 17:05:39 +00001764 // Make sure to only export headers which are within the include directory.
1765 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
1766 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
1767 return isRel
1768 })
1769
Chris Parsons3c27ca32020-11-20 12:42:07 -05001770 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09001771 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00001772 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00001773 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09001774 }
1775
Chris Parsons3c27ca32020-11-20 12:42:07 -05001776 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09001777 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09001778
Chris Parsons3c27ca32020-11-20 12:42:07 -05001779 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07001780 library.flagExporter.setProvider(ctx)
1781
Colin Cross4d9c2d12016-07-29 12:48:20 -07001782 return out
1783}
1784
Jiyong Park892a98f2020-12-14 09:20:00 +09001785func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001786 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09001787 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09001788 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
1789 if err != nil {
1790 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
1791 }
1792 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09001793 }
1794}
1795
Chris Parsons3c27ca32020-11-20 12:42:07 -05001796// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07001797func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001798 return library.MutatedProperties.BuildStatic &&
1799 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001800}
1801
Chris Parsons3c27ca32020-11-20 12:42:07 -05001802// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07001803func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001804 return library.MutatedProperties.BuildShared &&
1805 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001806}
1807
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001808func (library *libraryDecorator) objs() Objects {
1809 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001810}
1811
Colin Cross0de8a1e2020-09-18 14:15:30 -07001812func (library *libraryDecorator) reuseObjs() Objects {
1813 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001814}
1815
Colin Cross26c34ed2016-09-30 17:10:16 -07001816func (library *libraryDecorator) toc() android.OptionalPath {
1817 return library.tocFile
1818}
1819
Jiyong Parkf1194352019-02-25 11:05:47 +09001820func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
1821 dir := library.baseInstaller.installDir(ctx)
1822 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
1823 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
1824 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001825 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09001826}
1827
Colin Crossb916a382016-07-29 17:28:03 -07001828func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07001829 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09001830 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09001831 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05001832 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09001833 if ctx.isVndkSp() {
1834 library.baseInstaller.subDir = "vndk-sp"
1835 } else {
1836 library.baseInstaller.subDir = "vndk"
1837 }
1838 }
1839
Justin Yun31094b12020-12-24 16:11:23 +09001840 // In some cases we want to use core variant for VNDK-Core libs.
1841 // Skip product variant since VNDKs use only the vendor variant.
1842 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08001843 mayUseCoreVariant := true
1844
1845 if ctx.mustUseVendorVariant() {
1846 mayUseCoreVariant = false
1847 }
1848
Elvis Chien9c993542021-06-25 01:15:17 +08001849 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08001850 mayUseCoreVariant = false
1851 }
1852
1853 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08001854 library.checkSameCoreVariant = true
1855 if ctx.DeviceConfig().VndkUseCoreVariant() {
1856 library.useCoreVariant = true
1857 }
Vic Yangefd249e2018-11-12 20:19:56 -08001858 }
Justin Yun8fe12122017-12-07 17:18:15 +09001859 }
Logan Chienf3511742017-10-31 18:04:35 +08001860
Jooyung Han261e1582020-10-20 18:54:21 +09001861 // do not install vndk libs
1862 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05001863 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09001864 return
Justin Yun8effde42017-06-23 19:24:43 +09001865 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001866 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09001867 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
1868 // The original path becomes a symlink to the corresponding file in the
1869 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07001870 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07001871 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001872 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01001873 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09001874 library.installSymlinkToRuntimeApex(ctx, file)
1875 }
Jiyong Park429660f2019-01-16 22:31:11 +09001876 library.baseInstaller.subDir = "bootstrap"
1877 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001878 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001879 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001880 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09001881 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001882
Colin Cross4d9c2d12016-07-29 12:48:20 -07001883 library.baseInstaller.install(ctx, file)
1884 }
Dan Albertf563d252017-10-13 00:29:00 -07001885
Dan Albert281f22b2017-12-13 15:03:47 -08001886 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001887 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09001888 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08001889 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07001890 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07001891 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07001892
1893 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
1894 Rule: android.Cp,
1895 Description: "install " + installPath.Base(),
1896 Output: installPath,
1897 Input: file,
1898 })
1899
Colin Cross0875c522017-11-28 17:34:01 -08001900 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07001901 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001902}
1903
Paul Duffin0cb37b92020-03-04 14:52:46 +00001904func (library *libraryDecorator) everInstallable() bool {
1905 // Only shared and static libraries are installed. Header libraries (which are
1906 // neither static or shared) are not installed.
1907 return library.shared() || library.static()
1908}
1909
Chris Parsons3c27ca32020-11-20 12:42:07 -05001910// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07001911func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001912 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07001913}
1914
Chris Parsons3c27ca32020-11-20 12:42:07 -05001915// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001916func (library *libraryDecorator) shared() bool {
1917 return library.MutatedProperties.VariantIsShared
1918}
1919
Chris Parsons3c27ca32020-11-20 12:42:07 -05001920// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001921func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001922 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001923 return !library.static() && !library.shared()
1924}
1925
Chris Parsons3c27ca32020-11-20 12:42:07 -05001926// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001927func (library *libraryDecorator) setStatic() {
1928 library.MutatedProperties.VariantIsStatic = true
1929 library.MutatedProperties.VariantIsShared = false
1930}
1931
Chris Parsons3c27ca32020-11-20 12:42:07 -05001932// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001933func (library *libraryDecorator) setShared() {
1934 library.MutatedProperties.VariantIsStatic = false
1935 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07001936}
1937
Chris Parsons3c27ca32020-11-20 12:42:07 -05001938// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08001939func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001940 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08001941}
1942
Chris Parsons3c27ca32020-11-20 12:42:07 -05001943// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08001944func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001945 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08001946}
1947
Chris Parsons3c27ca32020-11-20 12:42:07 -05001948// HeaderOnly disables building this library as a shared or static library;
1949// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08001950func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001951 library.MutatedProperties.BuildShared = false
1952 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08001953}
1954
Colin Cross127bb8b2020-12-16 16:46:01 -08001955// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
1956func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07001957 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001958}
1959
Colin Cross203b4212021-04-26 17:19:41 -07001960// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07001961func (library *libraryDecorator) hasLLNDKHeaders() bool {
1962 return Bool(library.Properties.Llndk.Llndk_headers)
1963}
1964
Colin Cross5271fea2021-04-27 13:06:04 -07001965// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
1966// vendor public library stubs.
1967func (library *libraryDecorator) hasVendorPublicLibrary() bool {
1968 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
1969}
1970
Colin Cross0477b422020-10-13 18:43:54 -07001971func (library *libraryDecorator) implementationModuleName(name string) string {
1972 return name
1973}
1974
Jiyong Park7ed9de32018-10-15 22:25:07 +09001975func (library *libraryDecorator) buildStubs() bool {
1976 return library.MutatedProperties.BuildStubs
1977}
1978
Jiyong Parka034b832019-08-27 14:02:19 +09001979func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
1980 if library.Properties.Header_abi_checker.Symbol_file != nil {
1981 return library.Properties.Header_abi_checker.Symbol_file
1982 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001983 if ctx.Module().(*Module).IsLlndk() {
1984 return library.Properties.Llndk.Symbol_file
1985 }
Colin Cross31076b32020-10-23 17:22:06 -07001986 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09001987 return library.Properties.Stubs.Symbol_file
1988 }
1989 return nil
1990}
1991
Colin Crossc88c2722020-09-28 17:32:47 -07001992func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001993 // Just having stubs.symbol_file is enough to create a stub variant. In that case
1994 // the stub for the future API level is created.
1995 return library.Properties.Stubs.Symbol_file != nil ||
1996 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07001997}
1998
Colin Cross3572cf72020-10-01 15:58:11 -07001999func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002000 if !library.hasStubsVariants() {
2001 return nil
2002 }
2003
Colin Crossc1b36442021-05-06 13:42:48 -07002004 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
2005 // LLNDK libraries only need a single stubs variant.
2006 return []string{android.FutureApiLevel.String()}
2007 }
2008
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002009 // Future API level is implicitly added if there isn't
2010 vers := library.Properties.Stubs.Versions
2011 if inList(android.FutureApiLevel.String(), vers) {
2012 return vers
2013 }
2014 // In some cases, people use the raw value "10000" in the versions property.
2015 // We shouldn't add the future API level in that case, otherwise there will
2016 // be two identical versions.
2017 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2018 return vers
2019 }
2020 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002021}
2022
2023func (library *libraryDecorator) setStubsVersion(version string) {
2024 library.MutatedProperties.StubsVersion = version
2025}
2026
Jiyong Park7ed9de32018-10-15 22:25:07 +09002027func (library *libraryDecorator) stubsVersion() string {
2028 return library.MutatedProperties.StubsVersion
2029}
2030
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002031func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002032 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002033 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002034}
2035
2036func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2037 library.MutatedProperties.AllStubsVersions = versions
2038}
2039
2040func (library *libraryDecorator) allStubsVersions() []string {
2041 return library.MutatedProperties.AllStubsVersions
2042}
2043
Jooyung Hanad4c1872020-02-27 17:56:44 +09002044func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002045 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002046}
2047
Jiyong Parka90ca002019-10-07 15:47:24 +09002048func (library *libraryDecorator) availableFor(what string) bool {
2049 var list []string
2050 if library.static() {
2051 list = library.StaticProperties.Static.Apex_available
2052 } else if library.shared() {
2053 list = library.SharedProperties.Shared.Apex_available
2054 }
2055 if len(list) == 0 {
2056 return false
2057 }
2058 return android.CheckAvailableForApex(what, list)
2059}
2060
Colin Cross1bc94122021-10-28 13:25:54 -07002061func (library *libraryDecorator) installable() *bool {
2062 if library.static() {
2063 return library.StaticProperties.Static.Installable
2064 } else if library.shared() {
2065 return library.SharedProperties.Shared.Installable
2066 }
2067 return nil
2068}
2069
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002070func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002071 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002072 // If we're asked to make a static library uninstallable we don't do
2073 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2074 // for these entries. This is done to still get the make targets for NOTICE
2075 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002076 return
2077 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002078 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002079}
2080
Colin Crossceaa5322021-09-28 16:37:50 -07002081func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2082 return library.apiListCoverageXmlPath
2083}
2084
Colin Cross571cccf2019-02-04 11:22:08 -08002085var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2086
Chris Parsons3c27ca32020-11-20 12:42:07 -05002087// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2088// and values are the module name responsible for registering the version macro name.
2089//
2090// Version macros are used when building against stubs, to provide version information about
2091// the stub. Only stub libraries should have an entry in this list.
2092//
2093// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2094// that headers from libFoo can be conditionally compiled (this may hide APIs
2095// that are not available for the version).
2096//
2097// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002098func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002099 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002100 m := make(map[string]string)
2101 return &m
2102 }).(*map[string]string)
2103}
2104
2105// alphanumeric and _ characters are preserved.
2106// other characters are all converted to _
2107var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2108
Chris Parsons3c27ca32020-11-20 12:42:07 -05002109// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002110func versioningMacroName(moduleName string) string {
2111 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002112 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002113 return "__" + macroName + "_API__"
2114}
2115
Chris Parsons3c27ca32020-11-20 12:42:07 -05002116// NewLibrary builds and returns a new Module corresponding to a C++ library.
2117// Individual module implementations which comprise a C++ library (or something like
2118// a C++ library) should call this function, set some fields on the result, and
2119// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002120func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002121 module := newModule(hod, android.MultilibBoth)
2122
Colin Crossb916a382016-07-29 17:28:03 -07002123 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002124 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002125 BuildShared: true,
2126 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002127 },
Colin Crossb916a382016-07-29 17:28:03 -07002128 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002129 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002130 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002131 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002132 }
2133
Colin Crossb916a382016-07-29 17:28:03 -07002134 module.compiler = library
2135 module.linker = library
2136 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002137 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002138
2139 return module, library
2140}
2141
Colin Cross10d22312017-05-03 11:01:58 -07002142// connects a shared library to a static library in order to reuse its .o files to avoid
2143// compiling source files twice.
2144func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2145 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2146 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002147
2148 // Check libraries in addition to cflags, since libraries may be exporting different
2149 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002150 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2151 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2152 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2153 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2154 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2155 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2156 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2157 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002158 // Compare System_shared_libs properties with nil because empty lists are
2159 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002160 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2161 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002162
2163 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2164 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2165 sharedCompiler.baseCompiler.Properties.Srcs
2166 sharedCompiler.baseCompiler.Properties.Srcs = nil
2167 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2168 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002169
2170 // This dep is just to reference static variant from shared variant
2171 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002172 }
2173}
2174
Chris Parsons3c27ca32020-11-20 12:42:07 -05002175// LinkageMutator adds "static" or "shared" variants for modules depending
2176// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002177func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002178 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002179 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002180 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002181 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002182 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002183 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002184
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002185 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002186 buildStatic := library.buildStatic()
2187 buildShared := library.buildShared()
2188 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002189 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2190 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2191 // all the variants of the cc_library also exist on the prebuilt.
2192 modules := mctx.CreateLocalVariations("static", "shared")
2193 static := modules[0].(*Module)
2194 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002195
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002196 static.linker.(prebuiltLibraryInterface).setStatic()
2197 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002198
Colin Cross127bb8b2020-12-16 16:46:01 -08002199 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002200 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002201 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002202 mctx.AliasVariation("static")
2203 }
2204
Colin Cross127bb8b2020-12-16 16:46:01 -08002205 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002206 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2207 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002208 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002209 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2210 }
2211 } else {
2212 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002213 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002214
Ivan Lozano52767be2019-10-18 14:49:46 -07002215 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002216
Ivan Lozano2b262972019-11-21 12:30:50 -08002217 // Non-cc.Modules may need an empty variant for their mutators.
2218 variations := []string{}
2219 if library.NonCcVariants() {
2220 variations = append(variations, "")
2221 }
2222
Colin Cross127bb8b2020-12-16 16:46:01 -08002223 isLLNDK := false
2224 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002225 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002226 }
2227 buildStatic := library.BuildStaticVariant() && !isLLNDK
2228 buildShared := library.BuildSharedVariant()
2229 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002230 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002231
2232 modules := mctx.CreateLocalVariations(variations...)
2233 static := modules[0].(LinkableInterface)
2234 shared := modules[1].(LinkableInterface)
2235
2236 static.SetStatic()
2237 shared.SetShared()
2238
2239 if _, ok := library.(*Module); ok {
2240 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2241 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002242 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002243 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002244 variations := append([]string{"static"}, variations...)
2245
2246 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002247 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002248 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002249 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002250 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002251
Ivan Lozano2b262972019-11-21 12:30:50 -08002252 modules := mctx.CreateLocalVariations(variations...)
2253 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002254 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002255 } else if len(variations) > 0 {
2256 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002257 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002258 }
Colin Crossb916a382016-07-29 17:28:03 -07002259 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002260}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002261
Chris Parsons3c27ca32020-11-20 12:42:07 -05002262// normalizeVersions modifies `versions` in place, so that each raw version
2263// string becomes its normalized canonical form.
2264// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002265func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002266 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002267 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002268 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002269 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002270 ctx.PropertyErrorf("versions", "%s", err.Error())
2271 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002272 }
Dan Albertc8060532020-07-22 22:32:17 -07002273 if i > 0 && ver.LessThanOrEqualTo(previous) {
2274 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2275 }
2276 versions[i] = ver.String()
2277 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002278 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002279}
2280
Jooyung Han61b66e92020-03-21 14:21:46 +00002281func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002282 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2283 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002284 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002285
Colin Cross127bb8b2020-12-16 16:46:01 -08002286 m := mctx.Module().(*Module)
2287 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002288 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002289
Colin Crossd1f898e2020-08-18 18:35:15 -07002290 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002291 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002292
Colin Cross5271fea2021-04-27 13:06:04 -07002293 if variants[i] != "" || isLLNDK || isVendorPublicLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002294 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002295 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002296 c.sanitize = nil
2297 c.stl = nil
2298 c.Properties.PreventInstall = true
2299 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002300 isLatest := i == (len(versions) - 1)
2301 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002302
2303 if variants[i] != "" {
2304 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2305 // implementation module to the stubs module.
2306 c.Properties.HideFromMake = true
2307 lib.setStubsVersion(variants[i])
2308 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2309 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002310 }
2311 }
Colin Cross094faa52020-08-06 17:38:25 -07002312 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002313 latestVersion := ""
2314 if len(versions) > 0 {
2315 latestVersion = versions[len(versions)-1]
2316 }
2317 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002318}
2319
Colin Crossbbc941b2020-09-30 12:27:01 -07002320func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2321 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2322 if err != nil {
2323 mctx.PropertyErrorf("min_sdk_version", err.Error())
2324 return
2325 }
2326
2327 versionStrs := ndkLibraryVersions(mctx, from)
2328 modules := mctx.CreateLocalVariations(versionStrs...)
2329
2330 for i, module := range modules {
2331 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002332 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002333 }
2334}
2335
Colin Cross3146c5c2020-09-30 15:34:40 -07002336func CanBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002337 Host() bool
2338 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002339 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002340}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002341 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002342}
2343
Colin Cross3146c5c2020-09-30 15:34:40 -07002344func CanBeVersionVariant(module interface {
2345 Host() bool
2346 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002347 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002348 InRecovery() bool
2349 CcLibraryInterface() bool
2350 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002351}) bool {
2352 return CanBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002353 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002354}
2355
Colin Cross127bb8b2020-12-16 16:46:01 -08002356func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002357 if m, ok := module.(*Module); ok {
2358 return m.library
2359 }
2360 return nil
2361}
2362
Colin Crossc1b36442021-05-06 13:42:48 -07002363// versionSelector normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
Colin Crossd1f898e2020-08-18 18:35:15 -07002364func versionSelectorMutator(mctx android.BottomUpMutatorContext) {
Colin Cross31076b32020-10-23 17:22:06 -07002365 if library := moduleLibraryInterface(mctx.Module()); library != nil && CanBeVersionVariant(mctx.Module().(*Module)) {
2366 if library.buildShared() {
2367 versions := library.stubsVersions(mctx)
Colin Cross3572cf72020-10-01 15:58:11 -07002368 if len(versions) > 0 {
2369 normalizeVersions(mctx, versions)
2370 if mctx.Failed() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002371 return
2372 }
Colin Cross3572cf72020-10-01 15:58:11 -07002373 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2374 // depend on the implementation library and haven't been mutated yet.
Colin Cross31076b32020-10-23 17:22:06 -07002375 library.setAllStubsVersions(versions)
Colin Cross127bb8b2020-12-16 16:46:01 -08002376 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002377 }
Colin Crossd1f898e2020-08-18 18:35:15 -07002378 }
2379}
Jooyung Han61b66e92020-03-21 14:21:46 +00002380
Colin Crossd1f898e2020-08-18 18:35:15 -07002381// versionMutator splits a module into the mandatory non-stubs variant
2382// (which is unnamed) and zero or more stubs variants.
2383func versionMutator(mctx android.BottomUpMutatorContext) {
Colin Cross31076b32020-10-23 17:22:06 -07002384 if library := moduleLibraryInterface(mctx.Module()); library != nil && CanBeVersionVariant(mctx.Module().(*Module)) {
2385 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002386 return
2387 }
2388
2389 if m, ok := mctx.Module().(*Module); ok {
2390 if m.SplitPerApiLevel() && m.IsSdkVariant() {
2391 if mctx.Os() != android.Android {
2392 return
2393 }
2394 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2395 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002396 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002397}
Colin Crossd7227f92019-09-05 14:26:33 -07002398
2399// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2400// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2401// that the linked output file should be written to.
2402// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2403func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2404 inject *bool, fileName string) android.ModuleOutPath {
2405 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2406 injectBoringSSLHash := Bool(inject)
2407 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002408 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002409 if cc, ok := dep.(*Module); ok {
2410 if library, ok := cc.linker.(*libraryDecorator); ok {
2411 if Bool(library.Properties.Inject_bssl_hash) {
2412 injectBoringSSLHash = true
2413 }
2414 }
2415 }
2416 }
2417 })
2418 if injectBoringSSLHash {
2419 hashedOutputfile := outputFile
2420 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2421
Colin Crossf1a035e2020-11-16 17:32:30 -08002422 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002423 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002424 BuiltTool("bssl_inject_hash").
Pete Bentley5c4be822019-10-01 17:03:17 +01002425 Flag("-sha256").
Colin Crossd7227f92019-09-05 14:26:33 -07002426 FlagWithInput("-in-object ", outputFile).
2427 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002428 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002429 }
2430
2431 return outputFile
2432}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002433
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002434func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002435 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2436 compilerAttrs := baseAttributes.compilerAttributes
2437 linkerAttrs := baseAttributes.linkerAttributes
2438
Liz Kammer1263d9b2021-12-10 14:28:20 -05002439 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002440
2441 // Append shared/static{} stanza properties. These won't be specified on
2442 // cc_library_* itself, but may be specified in cc_defaults that this module
2443 // depends on.
2444 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2445
2446 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2447 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2448 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2449 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002450
2451 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2452 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002453 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002454 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002455 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2456
2457 asFlags := compilerAttrs.asFlags
2458 if compilerAttrs.asSrcs.IsEmpty() {
2459 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2460 asFlags = bazel.MakeStringListAttribute(nil)
2461 }
2462
Liz Kammer7a210ac2021-09-22 15:52:58 -04002463 commonAttrs := staticOrSharedAttributes{
2464 Srcs: compilerAttrs.srcs,
2465 Srcs_c: compilerAttrs.cSrcs,
2466 Srcs_as: compilerAttrs.asSrcs,
2467 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002468 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002469
Liz Kammer12615db2021-09-28 09:19:17 -04002470 Deps: linkerAttrs.deps,
2471 Implementation_deps: linkerAttrs.implementationDeps,
2472 Dynamic_deps: linkerAttrs.dynamicDeps,
2473 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2474 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2475 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2476 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002477 }
2478
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002479 var attrs interface{}
2480 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002481 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002482 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002483 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002484
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002485 Use_libcrt: linkerAttrs.useLibcrt,
2486 Use_version_lib: linkerAttrs.useVersionLib,
2487
Liz Kammer1263d9b2021-12-10 14:28:20 -05002488 Rtti: compilerAttrs.rtti,
2489 Stl: compilerAttrs.stl,
2490 Cpp_std: compilerAttrs.cppStd,
2491 C_std: compilerAttrs.cStd,
2492
2493 Export_includes: exportedIncludes.Includes,
2494 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2495 Export_system_includes: exportedIncludes.SystemIncludes,
2496 Local_includes: compilerAttrs.localIncludes,
2497 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002498
2499 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002500 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002501 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002502
2503 Features: linkerAttrs.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002504 }
2505 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002506 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2507
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002508 attrs = &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002509 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002510
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002511 Cppflags: compilerAttrs.cppFlags,
2512 Conlyflags: compilerAttrs.conlyFlags,
2513 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002514
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002515 Linkopts: linkerAttrs.linkopts,
2516 Link_crt: linkerAttrs.linkCrt,
2517 Use_libcrt: linkerAttrs.useLibcrt,
2518 Use_version_lib: linkerAttrs.useVersionLib,
2519
2520 Rtti: compilerAttrs.rtti,
2521 Stl: compilerAttrs.stl,
2522 Cpp_std: compilerAttrs.cppStd,
2523 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002524
Liz Kammerd2871182021-10-04 13:54:37 -04002525 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002526 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002527 Export_system_includes: exportedIncludes.SystemIncludes,
2528 Local_includes: compilerAttrs.localIncludes,
2529 Absolute_includes: compilerAttrs.absoluteIncludes,
2530 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002531
2532 Strip: stripAttributes{
2533 Keep_symbols: linkerAttrs.stripKeepSymbols,
2534 Keep_symbols_and_debug_frame: linkerAttrs.stripKeepSymbolsAndDebugFrame,
2535 Keep_symbols_list: linkerAttrs.stripKeepSymbolsList,
2536 All: linkerAttrs.stripAll,
2537 None: linkerAttrs.stripNone,
2538 },
Liz Kammer0eae52e2021-10-06 10:32:26 -04002539
2540 Features: linkerAttrs.features,
Jingwen Chen0ee88a62022-01-07 14:55:29 +00002541
2542 Stubs_symbol_file: compilerAttrs.stubsSymbolFile,
2543 Stubs_versions: compilerAttrs.stubsVersions,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002544 }
2545 }
2546
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002547 var modType string
2548 if isStatic {
2549 modType = "cc_library_static"
2550 } else {
2551 modType = "cc_library_shared"
2552 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002553 props := bazel.BazelTargetModuleProperties{
2554 Rule_class: modType,
Liz Kammer2b376bc2022-01-12 12:00:49 -05002555 Bzl_load_location: fmt.Sprintf("//build/bazel/rules/cc:%s.bzl", modType),
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002556 }
2557
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +00002558 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 +00002559}
2560
2561// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002562type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002563 staticOrSharedAttributes
2564
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002565 Use_libcrt bazel.BoolAttribute
2566 Use_version_lib bazel.BoolAttribute
2567
2568 Rtti bazel.BoolAttribute
2569 Stl *string
2570 Cpp_std *string
2571 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002572
Liz Kammer1263d9b2021-12-10 14:28:20 -05002573 Export_includes bazel.StringListAttribute
2574 Export_absolute_includes bazel.StringListAttribute
2575 Export_system_includes bazel.StringListAttribute
2576 Local_includes bazel.StringListAttribute
2577 Absolute_includes bazel.StringListAttribute
2578 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002579
2580 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002581 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002582 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002583
2584 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002585}
2586
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002587// TODO(b/199902614): Can this be factored to share with the other Attributes?
2588type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002589 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002590
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002591 Linkopts bazel.StringListAttribute
2592 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
2593
2594 Use_libcrt bazel.BoolAttribute
2595 Use_version_lib bazel.BoolAttribute
2596
2597 Rtti bazel.BoolAttribute
2598 Stl *string
2599 Cpp_std *string
2600 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002601
Liz Kammer1263d9b2021-12-10 14:28:20 -05002602 Export_includes bazel.StringListAttribute
2603 Export_absolute_includes bazel.StringListAttribute
2604 Export_system_includes bazel.StringListAttribute
2605 Local_includes bazel.StringListAttribute
2606 Absolute_includes bazel.StringListAttribute
2607 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002608
Liz Kammerd2871182021-10-04 13:54:37 -04002609 Strip stripAttributes
2610 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04002611
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002612 Cppflags bazel.StringListAttribute
2613 Conlyflags bazel.StringListAttribute
2614 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002615
2616 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00002617
2618 Stubs_symbol_file *string
2619 Stubs_versions bazel.StringListAttribute
Yu Liu75be7b92022-02-01 09:54:09 -08002620 Inject_bssl_hash bazel.BoolAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002621}