blob: cefbf6c44bd35ce91c25d2286ddd0f4f4cd1e8eb [file] [log] [blame]
Colin Cross4d9c2d12016-07-29 12:48:20 -07001// Copyright 2016 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17import (
Inseob Kim69378442019-06-03 19:10:47 +090018 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080019 "io"
Jiyong Parkf1194352019-02-25 11:05:47 +090020 "path/filepath"
Jiyong Parkda732bd2018-11-02 18:23:15 +090021 "regexp"
Jooyung Han11b0fbd2021-02-05 02:28:22 +090022 "strconv"
Colin Cross4d9c2d12016-07-29 12:48:20 -070023 "strings"
Jiyong Parkda732bd2018-11-02 18:23:15 +090024 "sync"
Colin Cross4d9c2d12016-07-29 12:48:20 -070025
Colin Cross4d9c2d12016-07-29 12:48:20 -070026 "android/soong/android"
Rupert Shuttleworth095081c2021-03-25 09:06:03 +000027 "android/soong/bazel"
Chris Parsons94a0bba2021-06-04 15:03:47 -040028 "android/soong/bazel/cquery"
Dan Albertea4b7b92018-04-25 16:05:30 -070029 "android/soong/cc/config"
Liz Kammer2ada09a2021-08-11 00:17:36 -040030
Chris Parsons51f8c392021-08-03 21:01:05 -040031 "github.com/google/blueprint"
32 "github.com/google/blueprint/pathtools"
Colin Cross4d9c2d12016-07-29 12:48:20 -070033)
34
Chris Parsons3c27ca32020-11-20 12:42:07 -050035// LibraryProperties is a collection of properties shared by cc library rules.
Colin Crossb916a382016-07-29 17:28:03 -070036type LibraryProperties struct {
Colin Cross4d9c2d12016-07-29 12:48:20 -070037 // local file name to pass to the linker as -unexported_symbols_list
Colin Cross27b922f2019-03-04 22:35:41 -080038 Unexported_symbols_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070039 // local file name to pass to the linker as -force_symbols_not_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080040 Force_symbols_not_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070041 // local file name to pass to the linker as -force_symbols_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080042 Force_symbols_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070043
44 // rename host libraries to prevent overlap with system installed libraries
45 Unique_host_soname *bool
46
Dan Willemsene1240db2016-11-03 14:28:51 -070047 Aidl struct {
48 // export headers generated from .aidl sources
Nan Zhang0007d812017-11-07 10:57:05 -080049 Export_aidl_headers *bool
Dan Willemsene1240db2016-11-03 14:28:51 -070050 }
51
Colin Cross0c461f12016-10-20 16:11:43 -070052 Proto struct {
53 // export headers generated from .proto sources
Nan Zhang0007d812017-11-07 10:57:05 -080054 Export_proto_headers *bool
Colin Cross0c461f12016-10-20 16:11:43 -070055 }
Dan Albertf563d252017-10-13 00:29:00 -070056
Inseob Kimc0907f12019-02-08 21:00:45 +090057 Sysprop struct {
58 // Whether platform owns this sysprop library.
59 Platform *bool
Inseob Kimb3f22ca2019-03-05 12:40:24 +090060 } `blueprint:"mutated"`
Inseob Kimc0907f12019-02-08 21:00:45 +090061
Nan Zhang0007d812017-11-07 10:57:05 -080062 Static_ndk_lib *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090063
Florian Mayer6dab96c2020-12-31 11:39:48 +000064 // Generate stubs to make this library accessible to APEXes.
Jiyong Park7ed9de32018-10-15 22:25:07 +090065 Stubs struct {
66 // Relative path to the symbol map. The symbol map provides the list of
67 // symbols that are exported for stubs variant of this library.
Colin Cross27b922f2019-03-04 22:35:41 -080068 Symbol_file *string `android:"path"`
Jiyong Park7ed9de32018-10-15 22:25:07 +090069
Jiyong Parkd4a3a132021-03-17 20:21:35 +090070 // List versions to generate stubs libs for. The version name "current" is always
71 // implicitly added.
Jiyong Park7ed9de32018-10-15 22:25:07 +090072 Versions []string
73 }
dimitryd95964a2018-11-07 13:43:34 +010074
75 // set the name of the output
76 Stem *string `android:"arch_variant"`
77
Colin Cross0fd6a412019-08-16 14:22:10 -070078 // set suffix of the name of the output
79 Suffix *string `android:"arch_variant"`
80
81 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +090082 Vendor, Product struct {
Colin Cross0fd6a412019-08-16 14:22:10 -070083 // set suffix of the name of the output
84 Suffix *string `android:"arch_variant"`
85 }
86 }
87
dimitryd95964a2018-11-07 13:43:34 +010088 // Names of modules to be overridden. Listed modules can only be other shared libraries
89 // (in Make or Soong).
90 // This does not completely prevent installation of the overridden libraries, but if both
91 // binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
92 // from PRODUCT_PACKAGES.
93 Overrides []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +080094
95 // Properties for ABI compatibility checker
96 Header_abi_checker struct {
Logan Chien41eabe62019-04-10 13:33:58 +080097 // Enable ABI checks (even if this is not an LLNDK/VNDK lib)
98 Enabled *bool
99
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800100 // Path to a symbol file that specifies the symbols to be included in the generated
101 // ABI dump file
Colin Cross27b922f2019-03-04 22:35:41 -0800102 Symbol_file *string `android:"path"`
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800103
104 // Symbol versions that should be ignored from the symbol file
105 Exclude_symbol_versions []string
106
107 // Symbol tags that should be ignored from the symbol file
108 Exclude_symbol_tags []string
Logan Chien2a65dda2019-10-01 15:58:07 -0700109
110 // Run checks on all APIs (in addition to the ones referred by
111 // one of exported ELF symbols.)
112 Check_all_apis *bool
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800113 }
Vic Yang6cd1be82019-06-24 16:08:48 -0700114
Pete Bentley803e1612019-08-06 22:19:59 +0100115 // Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
116 Inject_bssl_hash *bool `android:"arch_variant"`
Colin Cross0477b422020-10-13 18:43:54 -0700117
Colin Cross127bb8b2020-12-16 16:46:01 -0800118 // If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
119 // the module pointed to by llndk_stubs if it is set.
120 Llndk llndkLibraryProperties
Colin Cross5271fea2021-04-27 13:06:04 -0700121
122 // If this is a vendor public library, properties to describe the vendor public library stubs.
123 Vendor_public_library vendorPublicLibraryProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800124}
Colin Cross0c461f12016-10-20 16:11:43 -0700125
Chris Parsons3c27ca32020-11-20 12:42:07 -0500126// StaticProperties is a properties stanza to affect only attributes of the "static" variants of a
127// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700128type StaticProperties struct {
129 Static StaticOrSharedProperties `android:"arch_variant"`
130}
131
Chris Parsons3c27ca32020-11-20 12:42:07 -0500132// SharedProperties is a properties stanza to affect only attributes of the "shared" variants of a
133// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700134type SharedProperties struct {
135 Shared StaticOrSharedProperties `android:"arch_variant"`
136}
137
Chris Parsons3c27ca32020-11-20 12:42:07 -0500138// StaticOrSharedProperties is an embedded struct representing properties to affect attributes of
139// either only the "static" variants or only the "shared" variants of a library module. These override
140// the base properties of the same name.
141// Use `StaticProperties` or `SharedProperties`, depending on which variant is needed.
142// `StaticOrSharedProperties` exists only to avoid duplication.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700143type StaticOrSharedProperties struct {
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700144 Srcs []string `android:"path,arch_variant"`
145
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700146 Tidy_disabled_srcs []string `android:"path,arch_variant"`
147
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700148 Sanitized Sanitized `android:"arch_variant"`
149
Colin Crosse1bb5d02019-09-24 14:55:04 -0700150 Cflags []string `android:"arch_variant"`
151
Colin Cross6b8f4252021-07-22 11:39:44 -0700152 Enabled *bool `android:"arch_variant"`
153 Whole_static_libs []string `android:"arch_variant"`
154 Static_libs []string `android:"arch_variant"`
155 Shared_libs []string `android:"arch_variant"`
156 System_shared_libs []string `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700157
158 Export_shared_lib_headers []string `android:"arch_variant"`
159 Export_static_lib_headers []string `android:"arch_variant"`
Jiyong Parka90ca002019-10-07 15:47:24 +0900160
161 Apex_available []string `android:"arch_variant"`
Colin Cross1bc94122021-10-28 13:25:54 -0700162
163 Installable *bool `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700164}
165
Colin Crossa48ab5b2017-02-14 15:28:44 -0800166type LibraryMutatedProperties struct {
Colin Crossb916a382016-07-29 17:28:03 -0700167 // Build a static variant
168 BuildStatic bool `blueprint:"mutated"`
169 // Build a shared variant
170 BuildShared bool `blueprint:"mutated"`
171 // This variant is shared
172 VariantIsShared bool `blueprint:"mutated"`
173 // This variant is static
174 VariantIsStatic bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900175
176 // This variant is a stubs lib
177 BuildStubs bool `blueprint:"mutated"`
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900178 // This variant is the latest version
179 IsLatestVersion bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900180 // Version of the stubs lib
181 StubsVersion string `blueprint:"mutated"`
Colin Crossd1f898e2020-08-18 18:35:15 -0700182 // List of all stubs versions associated with an implementation lib
183 AllStubsVersions []string `blueprint:"mutated"`
Colin Crossb916a382016-07-29 17:28:03 -0700184}
185
186type FlagExporterProperties struct {
187 // list of directories relative to the Blueprints file that will
Dan Willemsen273af7f2016-11-03 15:53:42 -0700188 // be added to the include path (using -I) for this module and any module that links
Colin Cross5d195602017-10-17 16:15:50 -0700189 // against this module. Directories listed in export_include_dirs do not need to be
190 // listed in local_include_dirs.
Colin Cross0ed579e2021-06-29 00:51:12 +0000191 Export_include_dirs []string `android:"arch_variant,variant_prepend"`
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700192
Jiyong Park73c54ee2019-10-22 20:31:18 +0900193 // list of directories that will be added to the system include path
194 // using -isystem for this module and any module that links against this module.
Colin Cross0ed579e2021-06-29 00:51:12 +0000195 Export_system_include_dirs []string `android:"arch_variant,variant_prepend"`
Jiyong Park73c54ee2019-10-22 20:31:18 +0900196
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700197 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900198 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700199 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900200 // export_include_dirs, that will be applied to
201 // vendor or product variant of this library.
202 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800203 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700204 }
205 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700206}
207
208func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000209 RegisterLibraryBuildComponents(android.InitRegistrationContext)
210}
211
212func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
213 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
214 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
215 ctx.RegisterModuleType("cc_library", LibraryFactory)
216 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
217 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700218}
219
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +0000220// TODO(b/199902614): Can this be factored to share with the other Attributes?
Jingwen Chen63930982021-03-24 10:04:33 -0400221// For bp2build conversion.
222type bazelCcLibraryAttributes struct {
Chris Parsons08648312021-05-06 16:23:19 -0400223 // Attributes pertaining to both static and shared variants.
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000224 Srcs bazel.LabelListAttribute
225 Srcs_c bazel.LabelListAttribute
226 Srcs_as bazel.LabelListAttribute
227
228 Copts bazel.StringListAttribute
229 Cppflags bazel.StringListAttribute
230 Conlyflags bazel.StringListAttribute
231 Asflags bazel.StringListAttribute
232
Liz Kammer7a210ac2021-09-22 15:52:58 -0400233 Hdrs bazel.LabelListAttribute
234
Liz Kammer12615db2021-09-28 09:19:17 -0400235 Deps bazel.LabelListAttribute
236 Implementation_deps bazel.LabelListAttribute
237 Dynamic_deps bazel.LabelListAttribute
238 Implementation_dynamic_deps bazel.LabelListAttribute
239 Whole_archive_deps bazel.LabelListAttribute
240 Implementation_whole_archive_deps bazel.LabelListAttribute
241 System_dynamic_deps bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -0400242
Liz Kammer5fad5012021-09-09 14:08:21 -0400243 Export_includes bazel.StringListAttribute
244 Export_system_includes bazel.StringListAttribute
Liz Kammer35687bc2021-09-10 10:07:07 -0400245 Local_includes bazel.StringListAttribute
246 Absolute_includes bazel.StringListAttribute
Liz Kammer5fad5012021-09-09 14:08:21 -0400247 Linkopts bazel.StringListAttribute
248 Use_libcrt bazel.BoolAttribute
249 Rtti bazel.BoolAttribute
Jingwen Chen5b11ab12021-10-11 17:44:33 +0000250
251 Stl *string
252 Cpp_std *string
Chris Parsons79bd2b72021-11-29 17:52:41 -0500253 C_std *string
Chris Parsons990c4f42021-05-25 12:10:58 -0400254
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000255 // This is shared only.
Liz Kammerd2871182021-10-04 13:54:37 -0400256 Link_crt bazel.BoolAttribute
257 Additional_linker_inputs bazel.LabelListAttribute
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000258
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000259 // Common properties shared between both shared and static variants.
260 Shared staticOrSharedAttributes
261 Static staticOrSharedAttributes
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000262
263 Strip stripAttributes
Liz Kammer0eae52e2021-10-06 10:32:26 -0400264
265 Features bazel.StringListAttribute
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000266}
267
268type stripAttributes struct {
269 Keep_symbols bazel.BoolAttribute
270 Keep_symbols_and_debug_frame bazel.BoolAttribute
271 Keep_symbols_list bazel.StringListAttribute
272 All bazel.BoolAttribute
273 None bazel.BoolAttribute
Jingwen Chen63930982021-03-24 10:04:33 -0400274}
275
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400276func libraryBp2Build(ctx android.TopDownMutatorContext, m *Module) {
Jingwen Chen179856a2021-05-03 09:15:48 +0000277 // For some cc_library modules, their static variants are ready to be
278 // converted, but not their shared variants. For these modules, delegate to
279 // the cc_library_static bp2build converter temporarily instead.
Chris Parsons953b3562021-09-20 15:14:39 -0400280 if android.GenerateCcLibraryStaticOnly(ctx.Module().Name()) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400281 sharedOrStaticLibraryBp2Build(ctx, m, true)
Jingwen Chen179856a2021-05-03 09:15:48 +0000282 return
283 }
284
Jingwen Chen53681ef2021-04-29 08:15:13 +0000285 sharedAttrs := bp2BuildParseSharedProps(ctx, m)
286 staticAttrs := bp2BuildParseStaticProps(ctx, m)
Liz Kammere6583482021-10-19 13:56:10 -0400287 baseAttributes := bp2BuildParseBaseProps(ctx, m)
288 compilerAttrs := baseAttributes.compilerAttributes
289 linkerAttrs := baseAttributes.linkerAttributes
Liz Kammer1263d9b2021-12-10 14:28:20 -0500290 exportedIncludes := bp2BuildParseExportedIncludes(ctx, m, compilerAttrs.includes)
Jingwen Chen63930982021-03-24 10:04:33 -0400291
Liz Kammer9abd62d2021-05-21 08:37:59 -0400292 srcs := compilerAttrs.srcs
Jingwen Chen53681ef2021-04-29 08:15:13 +0000293
Liz Kammer12615db2021-09-28 09:19:17 -0400294 sharedAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
295 staticAttrs.Deps.Add(baseAttributes.protoDependency)
296
Chris Parsons69fa9f92021-07-13 11:47:44 -0400297 asFlags := compilerAttrs.asFlags
298 if compilerAttrs.asSrcs.IsEmpty() && sharedAttrs.Srcs_as.IsEmpty() && staticAttrs.Srcs_as.IsEmpty() {
299 // Skip asflags for BUILD file simplicity if there are no assembly sources.
300 asFlags = bazel.MakeStringListAttribute(nil)
301 }
302
Chris Parsons77acf2e2021-12-03 17:27:16 -0500303 staticCommonAttrs := staticOrSharedAttributes{
304 Srcs: *srcs.Clone().Append(staticAttrs.Srcs),
305 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(staticAttrs.Srcs_c),
306 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(staticAttrs.Srcs_as),
307 Copts: *compilerAttrs.copts.Clone().Append(staticAttrs.Copts),
308 Hdrs: *compilerAttrs.hdrs.Clone().Append(staticAttrs.Hdrs),
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000309
Chris Parsons77acf2e2021-12-03 17:27:16 -0500310 Deps: *linkerAttrs.deps.Clone().Append(staticAttrs.Deps),
311 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(staticAttrs.Implementation_deps),
312 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(staticAttrs.Dynamic_deps),
313 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(staticAttrs.Implementation_dynamic_deps),
314 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
315 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(staticAttrs.Whole_archive_deps),
316 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(staticAttrs.System_dynamic_deps),
317 }
318
319 sharedCommonAttrs := staticOrSharedAttributes{
320 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
321 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
322 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
323 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
324 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
325
326 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
327 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
328 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
329 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
330 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
331 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
332 }
333
334 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
335 staticOrSharedAttributes: staticCommonAttrs,
336
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000337 Cppflags: compilerAttrs.cppFlags,
338 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400339 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000340
Liz Kammer1263d9b2021-12-10 14:28:20 -0500341 Export_includes: exportedIncludes.Includes,
342 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
343 Export_system_includes: exportedIncludes.SystemIncludes,
344 Local_includes: compilerAttrs.localIncludes,
345 Absolute_includes: compilerAttrs.absoluteIncludes,
346 Use_libcrt: linkerAttrs.useLibcrt,
347 Rtti: compilerAttrs.rtti,
348 Stl: compilerAttrs.stl,
349 Cpp_std: compilerAttrs.cppStd,
350 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500351
352 Features: linkerAttrs.features,
353 }
354
355 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
356 staticOrSharedAttributes: sharedCommonAttrs,
357 Cppflags: compilerAttrs.cppFlags,
358 Conlyflags: compilerAttrs.conlyFlags,
359 Asflags: asFlags,
360
Liz Kammer1263d9b2021-12-10 14:28:20 -0500361 Export_includes: exportedIncludes.Includes,
362 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
363 Export_system_includes: exportedIncludes.SystemIncludes,
364 Local_includes: compilerAttrs.localIncludes,
365 Absolute_includes: compilerAttrs.absoluteIncludes,
366 Linkopts: linkerAttrs.linkopts,
367 Link_crt: linkerAttrs.linkCrt,
368 Use_libcrt: linkerAttrs.useLibcrt,
369 Rtti: compilerAttrs.rtti,
370 Stl: compilerAttrs.stl,
371 Cpp_std: compilerAttrs.cppStd,
372 C_std: compilerAttrs.cStd,
Chris Parsons990c4f42021-05-25 12:10:58 -0400373
Liz Kammerd2871182021-10-04 13:54:37 -0400374 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000375
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000376 Strip: stripAttributes{
377 Keep_symbols: linkerAttrs.stripKeepSymbols,
378 Keep_symbols_and_debug_frame: linkerAttrs.stripKeepSymbolsAndDebugFrame,
379 Keep_symbols_list: linkerAttrs.stripKeepSymbolsList,
380 All: linkerAttrs.stripAll,
381 None: linkerAttrs.stripNone,
382 },
Liz Kammer0eae52e2021-10-06 10:32:26 -0400383 Features: linkerAttrs.features,
Jingwen 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
Chris Parsons77acf2e2021-12-03 17:27:16 -0500389 staticProps := bazel.BazelTargetModuleProperties{
390 Rule_class: "cc_library_static",
391 Bzl_load_location: "//build/bazel/rules:cc_library_static.bzl",
392 }
393 sharedProps := bazel.BazelTargetModuleProperties{
394 Rule_class: "cc_library_shared",
395 Bzl_load_location: "//build/bazel/rules:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400396 }
397
Chris Parsons58852a02021-12-09 18:10:18 -0500398 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
399 android.CommonAttributes{Name: m.Name() + "_bp2build_cc_library_static"},
400 staticTargetAttrs, staticAttrs.Enabled)
401 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
402 android.CommonAttributes{Name: m.Name()},
403 sharedTargetAttrs, sharedAttrs.Enabled)
Jingwen Chen63930982021-03-24 10:04:33 -0400404}
405
Patrice Arruda83c89e02019-03-25 15:32:39 -0700406// cc_library creates both static and/or shared libraries for a device and/or
407// host. By default, a cc_library has a single variant that targets the device.
408// Specifying `host_supported: true` also creates a library that targets the
409// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700410func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800411 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000412 // Can be used as both a static and a shared library.
413 module.sdkMemberTypes = []android.SdkMemberType{
414 sharedLibrarySdkMemberType,
415 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000416 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000417 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400418 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400419 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700420 return module.Init()
421}
422
Patrice Arruda83c89e02019-03-25 15:32:39 -0700423// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700424func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800425 module, library := NewLibrary(android.HostAndDeviceSupported)
426 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000427 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400428 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400429 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700430 return module.Init()
431}
432
Patrice Arruda83c89e02019-03-25 15:32:39 -0700433// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700434func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800435 module, library := NewLibrary(android.HostAndDeviceSupported)
436 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000437 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400438 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000439 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700440 return module.Init()
441}
442
Patrice Arruda83c89e02019-03-25 15:32:39 -0700443// cc_library_host_static creates a static library that is linkable to a host
444// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700445func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800446 module, library := NewLibrary(android.HostSupported)
447 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000448 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000449 module.bazelable = true
450 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700451 return module.Init()
452}
453
Patrice Arruda83c89e02019-03-25 15:32:39 -0700454// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700455func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800456 module, library := NewLibrary(android.HostSupported)
457 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000458 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800459 module.bazelable = true
460 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700461 return module.Init()
462}
463
Chris Parsons3c27ca32020-11-20 12:42:07 -0500464// flagExporter is a separated portion of libraryDecorator pertaining to exported
465// include paths and flags. Keeping this dependency-related information separate
466// from the rest of library information is helpful in keeping data more structured
467// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700468type flagExporter struct {
469 Properties FlagExporterProperties
470
Chris Parsons3c27ca32020-11-20 12:42:07 -0500471 dirs android.Paths // Include directories to be included with -I
472 systemDirs android.Paths // System include directories to be included with -isystem
473 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900474 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900475 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700476}
477
Chris Parsons3c27ca32020-11-20 12:42:07 -0500478// exportedIncludes returns the effective include paths for this module and
479// any module that links against this module. This is obtained from
480// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700481func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900482 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800483 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700484 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900485 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
486 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
487 }
488 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700489}
490
Chris Parsons3c27ca32020-11-20 12:42:07 -0500491// exportIncludes registers the include directories and system include directories to be exported
492// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900493func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900494 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900495 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700496}
497
Chris Parsons3c27ca32020-11-20 12:42:07 -0500498// exportIncludesAsSystem registers the include directories and system include directories to be
499// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900500func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900501 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900502 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900503 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900504}
505
Chris Parsons3c27ca32020-11-20 12:42:07 -0500506// reexportDirs registers the given directories as include directories to be exported transitively
507// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900508func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900509 f.dirs = append(f.dirs, dirs...)
510}
511
Chris Parsons3c27ca32020-11-20 12:42:07 -0500512// reexportSystemDirs registers the given directories as system include directories
513// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900514func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900515 f.systemDirs = append(f.systemDirs, dirs...)
516}
517
Chris Parsons3c27ca32020-11-20 12:42:07 -0500518// reexportFlags registers the flags to be exported transitively to modules depending on this
519// module.
Inseob Kim69378442019-06-03 19:10:47 +0900520func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800521 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
522 panic(fmt.Errorf("Exporting invalid flag %q: "+
523 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900524 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700525 f.flags = append(f.flags, flags...)
526}
527
Inseob Kim69378442019-06-03 19:10:47 +0900528func (f *flagExporter) reexportDeps(deps ...android.Path) {
529 f.deps = append(f.deps, deps...)
530}
531
Inseob Kimd110f872019-12-06 13:15:38 +0900532// addExportedGeneratedHeaders does nothing but collects generated header files.
533// This can be differ to exportedDeps which may contain phony files to minimize ninja.
534func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
535 f.headers = append(f.headers, headers...)
536}
537
Colin Cross0de8a1e2020-09-18 14:15:30 -0700538func (f *flagExporter) setProvider(ctx android.ModuleContext) {
539 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400540 // Comes from Export_include_dirs property, and those of exported transitive deps
541 IncludeDirs: android.FirstUniquePaths(f.dirs),
542 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700543 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400544 // Used in very few places as a one-off way of adding extra defines.
545 Flags: f.flags,
546 // Used sparingly, for extra files that need to be explicitly exported to dependers,
547 // or for phony files to minimize ninja.
548 Deps: f.deps,
549 // For exported generated headers, such as exported aidl headers, proto headers, or
550 // sysprop headers.
551 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700552 })
Inseob Kim69378442019-06-03 19:10:47 +0900553}
554
Colin Crossb916a382016-07-29 17:28:03 -0700555// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
556// functionality: static vs. shared linkage, reusing object files for shared libraries
557type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800558 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700559 StaticProperties StaticProperties
560 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800561 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700562
563 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900564 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700565
Colin Cross26c34ed2016-09-30 17:10:16 -0700566 // table-of-contents file to optimize out relinking when possible
567 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700568
Colin Cross4d9c2d12016-07-29 12:48:20 -0700569 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400570 flagExporterInfo *FlagExporterInfo
571 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700572
Colin Cross4d9c2d12016-07-29 12:48:20 -0700573 // For whole_static_libs
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700574 objects Objects
Colin Cross4d9c2d12016-07-29 12:48:20 -0700575
576 // Uses the module's name if empty, but can be overridden. Does not include
577 // shlib suffix.
578 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700579
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800580 sabi *sabi
581
Dan Willemsen581341d2017-02-09 16:16:31 -0800582 // Output archive of gcno coverage information files
583 coverageOutputFile android.OptionalPath
584
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800585 // linked Source Abi Dump
586 sAbiOutputFile android.OptionalPath
587
588 // Source Abi Diff
589 sAbiDiff android.OptionalPath
590
Colin Cross0875c522017-11-28 17:34:01 -0800591 // Location of the static library in the sysroot. Empty if the library is
592 // not included in the NDK.
593 ndkSysrootPath android.Path
594
Colin Crossb60190a2018-09-04 16:28:17 -0700595 // Location of the linked, unstripped library for shared libraries
596 unstrippedOutputFile android.Path
597
Dan Willemsen569edc52018-11-19 09:33:29 -0800598 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000599 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800600
Colin Cross8e21aa52020-09-28 18:28:02 -0700601 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900602
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800603 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900604
Vic Yangefd249e2018-11-12 20:19:56 -0800605 // If useCoreVariant is true, the vendor variant of a VNDK library is
606 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800607 useCoreVariant bool
608 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800609
Colin Cross5ec407b2020-09-30 11:41:33 -0700610 skipAPIDefine bool
611
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100612 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700613 *baseCompiler
614 *baseLinker
615 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900616
617 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700618
619 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900620}
621
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400622type ccLibraryBazelHandler struct {
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000623 android.BazelHandler
Chris Parsons808d84c2021-03-09 20:43:32 -0500624
625 module *Module
626}
627
Chris Parsons94a0bba2021-06-04 15:03:47 -0400628// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
629// provider from a Bazel shared library's CcInfo provider.
630func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) bool {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400631 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400632 if len(rootStaticArchives) != 1 {
633 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsons944e7d02021-03-11 11:08:46 -0500634 return false
635 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400636 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500637 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
638
Chris Parsons94a0bba2021-06-04 15:03:47 -0400639 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500640 objFiles := make(android.Paths, len(objPaths))
641 for i, objPath := range objPaths {
642 objFiles[i] = android.PathForBazelOut(ctx, objPath)
643 }
644 objects := Objects{
645 objFiles: objFiles,
646 }
647
648 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
649 StaticLibrary: outputFilePath,
650 ReuseObjects: objects,
651 Objects: objects,
652
Chris Parsons94a0bba2021-06-04 15:03:47 -0400653 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500654 // static libraries with deps.
655 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
656 Direct(outputFilePath).
657 Build(),
658 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400659
Chris Parsons94a0bba2021-06-04 15:03:47 -0400660 return true
661}
662
663// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
664// provider from a Bazel shared library's CcInfo provider.
665func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) bool {
666 rootDynamicLibraries := ccInfo.RootDynamicLibraries
667
668 if len(rootDynamicLibraries) != 1 {
669 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
670 return false
671 }
672 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
673 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
674
675 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = outputFilePath
676
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000677 var tocFile android.OptionalPath
678 if len(ccInfo.TocFile) > 0 {
679 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
680 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400681 handler.module.linker.(*libraryDecorator).tocFile = tocFile
682
683 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
684 TableOfContents: tocFile,
685 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000686 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400687 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000688 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400689 })
690 return true
691}
692
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux0d990452021-08-11 16:46:13 +0000693func (handler *ccLibraryBazelHandler) GenerateBazelBuildActions(ctx android.ModuleContext, label string) bool {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400694 bazelCtx := ctx.Config().BazelContext
Chris Parsons787fb362021-10-14 18:43:51 -0400695 ccInfo, ok, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400696 if err != nil {
697 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
698 return false
699 }
700 if !ok {
701 return ok
702 }
703
704 if handler.module.static() {
705 if ok := handler.generateStaticBazelBuildActions(ctx, label, ccInfo); !ok {
706 return false
707 }
708 } else if handler.module.Shared() {
709 if ok := handler.generateSharedBazelBuildActions(ctx, label, ccInfo); !ok {
710 return false
711 }
712 } else {
713 return false
714 }
715
716 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
717 handler.module.maybeUnhideFromMake()
718
Chris Parsonseefc9e62021-04-02 17:36:47 -0400719 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
720 // Dependencies on this library will expect collectedSnapshotHeaders to
721 // be set, otherwise validation will fail. For now, set this to an empty
722 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400723 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400724 // implementation.
725 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
726 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500727 return ok
728}
729
Chris Parsons94a0bba2021-06-04 15:03:47 -0400730func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
731 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
732 // flag exporters consolidates properties like includes, flags, dependencies that should be
733 // exported from this module to other modules
734 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
735 // Store flag info to be passed along to androidmk
736 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
737 library.flagExporterInfo = &flagExporterInfo
738}
739
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400740func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900741 ret := android.Paths{}
742
743 // Headers in the source tree should be globbed. On the contrast, generated headers
744 // can't be globbed, and they should be manually collected.
745 // So, we first filter out intermediate directories (which contains generated headers)
746 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400747 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900748 dir := path.String()
749 // Skip if dir is for generated headers
750 if strings.HasPrefix(dir, android.PathForOutput(ctx).String()) {
751 continue
752 }
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900753 // libeigen wrongly exports the root directory "external/eigen". But only two
754 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
755 // some of them have no extension. So we need special treatment for libeigen in order
756 // to glob correctly.
757 if dir == "external/eigen" {
758 // Only these two directories contains exported headers.
759 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
760 glob, err := ctx.GlobWithDeps("external/eigen/"+subdir+"/**/*", nil)
761 if err != nil {
762 ctx.ModuleErrorf("glob failed: %#v", err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400763 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900764 }
765 for _, header := range glob {
766 if strings.HasSuffix(header, "/") {
767 continue
768 }
769 ext := filepath.Ext(header)
770 if ext != "" && ext != ".h" {
771 continue
772 }
773 ret = append(ret, android.PathForSource(ctx, header))
774 }
775 }
776 continue
777 }
Colin Crossec118d02021-01-22 18:05:59 +0000778 glob, err := ctx.GlobWithDeps(dir+"/**/*", nil)
779 if err != nil {
780 ctx.ModuleErrorf("glob failed: %#v", err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400781 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900782 }
Colin Crossec118d02021-01-22 18:05:59 +0000783 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -0700784 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +0000785 if isLibcxx {
786 // Glob all files under this special directory, because of C++ headers with no
787 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -0700788 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900789 continue
790 }
Colin Crossec118d02021-01-22 18:05:59 +0000791 } else {
792 // Filter out only the files with extensions that are headers.
793 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400794 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +0000795 if strings.HasSuffix(header, ext) {
796 found = true
797 break
798 }
799 }
800 if !found {
801 continue
802 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900803 }
Jose Galmes0d736912021-03-30 11:00:06 -0700804 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900805 }
806 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400807 return ret
808}
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900809
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400810func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
811 ret := android.Paths{}
812 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900813 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
814 if strings.HasSuffix(header.Base(), "-phony") {
815 continue
816 }
817 ret = append(ret, header)
818 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400819 return ret
820}
821
822// collectHeadersForSnapshot collects all exported headers from library.
823// It globs header files in the source tree for exported include directories,
824// and tracks generated header files separately.
825//
826// This is to be called from GenerateAndroidBuildActions, and then collected
827// header files can be retrieved by snapshotHeaders().
828func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
829 ret := android.Paths{}
830
831 // Headers in the source tree should be globbed. On the contrast, generated headers
832 // can't be globbed, and they should be manually collected.
833 // So, we first filter out intermediate directories (which contains generated headers)
834 // from exported directories, and then glob headers under remaining directories.
835 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
836
837 // Collect generated headers
838 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900839
840 l.collectedSnapshotHeaders = ret
841}
842
843// This returns all exported header files, both generated ones and headers from source tree.
844// collectHeadersForSnapshot() must be called before calling this.
845func (l *libraryDecorator) snapshotHeaders() android.Paths {
846 if l.collectedSnapshotHeaders == nil {
847 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
848 }
849 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -0700850}
851
Chris Parsons3c27ca32020-11-20 12:42:07 -0500852// linkerProps returns the list of properties structs relevant for this library. (For example, if
853// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -0700854func (library *libraryDecorator) linkerProps() []interface{} {
855 var props []interface{}
856 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700857 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700858 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -0800859 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -0700860 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -0700861 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -0700862
863 if library.MutatedProperties.BuildShared {
864 props = append(props, &library.SharedProperties)
865 }
866 if library.MutatedProperties.BuildStatic {
867 props = append(props, &library.StaticProperties)
868 }
869
870 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -0700871}
872
Chris Parsons3c27ca32020-11-20 12:42:07 -0500873// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
874// library, or that are implied by attributes of this library (such as whether this library is a
875// shared library).
Colin Crossb916a382016-07-29 17:28:03 -0700876func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -0700877 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700878
Colin Crossb916a382016-07-29 17:28:03 -0700879 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
880 // all code is position independent, and then those warnings get promoted to
881 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -0700882 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800883 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -0700884 }
885
886 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800887 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -0800888 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800889 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -0700890 }
891
Colin Crossa48ab5b2017-02-14 15:28:44 -0800892 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700893 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700894 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -0700895 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700896 f = append(f,
897 "-nostdlib",
898 "-Wl,--gc-sections",
899 )
900 }
901
902 if ctx.Darwin() {
903 f = append(f,
904 "-dynamiclib",
905 "-single_module",
Colin Cross4d9c2d12016-07-29 12:48:20 -0700906 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
907 )
Colin Cross7863cf52016-10-20 10:47:21 -0700908 if ctx.Arch().ArchType == android.X86 {
909 f = append(f,
910 "-read_only_relocs suppress",
911 )
912 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700913 } else {
Josh Gao75a50a22019-06-07 17:58:59 -0700914 f = append(f, "-shared")
915 if !ctx.Windows() {
916 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
917 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700918 }
919
Colin Cross4af21ed2019-11-04 09:37:55 -0800920 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700921 }
922
923 return flags
924}
925
Chris Parsons3c27ca32020-11-20 12:42:07 -0500926// compilerFlags takes a Flags and augments it to contain compile flags from global values,
927// per-target values, module type values, per-module Blueprints properties, extra flags from
928// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -0800929func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700930 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700931 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -0700932 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -0800933 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
934 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -0700935 }
936
Jiyong Park7ed9de32018-10-15 22:25:07 +0900937 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -0800938 if ctx.IsLlndk() {
939 // LLNDK libraries ignore most of the properties on the cc_library and use the
940 // LLNDK-specific properties instead.
941 // Wipe all the module-local properties, leaving only the global properties.
942 flags.Local = LocalOrGlobalFlags{}
943 }
Jiyong Park7ed9de32018-10-15 22:25:07 +0900944 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +0900945 // Remove -include <file> when compiling stubs. Otherwise, the force included
946 // headers might cause conflicting types error with the symbols in the
947 // generated stubs source code. e.g.
948 // double acos(double); // in header
949 // void acos() {} // in the generated source code
950 removeInclude := func(flags []string) []string {
951 ret := flags[:0]
952 for _, f := range flags {
953 if strings.HasPrefix(f, "-include ") {
954 continue
955 }
956 ret = append(ret, f)
957 }
958 return ret
959 }
Colin Cross4af21ed2019-11-04 09:37:55 -0800960 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
961 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +0900962
Jiyong Park7ed9de32018-10-15 22:25:07 +0900963 flags = addStubLibraryCompilerFlags(flags)
964 }
965 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -0700966}
967
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800968func (library *libraryDecorator) headerAbiCheckerEnabled() bool {
969 return Bool(library.Properties.Header_abi_checker.Enabled)
Hsin-Yi Chen53489642019-07-31 17:10:45 +0800970}
971
Yo Chiang2bbadfa2020-12-14 11:42:16 +0800972func (library *libraryDecorator) headerAbiCheckerExplicitlyDisabled() bool {
973 return !BoolDefault(library.Properties.Header_abi_checker.Enabled, true)
Logan Chien41eabe62019-04-10 13:33:58 +0800974}
975
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700976func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -0800977 if ctx.IsLlndk() {
978 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
979 vndkVer := ctx.Module().(*Module).VndkVersion()
980 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
981 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
982 vndkVer = "current"
983 }
984 if library.stubsVersion() != "" {
985 vndkVer = library.stubsVersion()
986 }
Dan Albertf1d14c72020-07-30 14:32:55 -0700987 nativeAbiResult := parseNativeAbiDefinition(ctx,
988 String(library.Properties.Llndk.Symbol_file),
989 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
990 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -0800991 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -0700992 library.versionScriptPath = android.OptionalPathForPath(
993 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -0800994 }
995 return objs
996 }
Colin Cross5271fea2021-04-27 13:06:04 -0700997 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -0700998 nativeAbiResult := parseNativeAbiDefinition(ctx,
999 String(library.Properties.Vendor_public_library.Symbol_file),
1000 android.FutureApiLevel, "")
1001 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001002 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001003 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001004 }
1005 return objs
1006 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001007 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001008 symbolFile := String(library.Properties.Stubs.Symbol_file)
1009 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1010 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1011 return Objects{}
1012 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001013 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
1014 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion),
1015 "--apex")
1016 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1017 library.versionScriptPath = android.OptionalPathForPath(
1018 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001019
1020 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001021 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001022 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1023 }
1024
Jiyong Park7ed9de32018-10-15 22:25:07 +09001025 return objs
1026 }
1027
Colin Cross5950f382016-12-13 12:50:57 -08001028 if !library.buildShared() && !library.buildStatic() {
1029 if len(library.baseCompiler.Properties.Srcs) > 0 {
1030 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1031 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001032 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001033 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1034 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001035 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001036 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1037 }
1038 return Objects{}
1039 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001040 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001041 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001042 var SourceAbiFlags []string
1043 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001044 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001045 }
Inseob Kim69378442019-06-03 19:10:47 +09001046 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1047 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001048 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001049 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001050 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001051 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001052 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001053 flags.SAbiDump = true
1054 }
1055 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001056 objs := library.baseCompiler.compile(ctx, flags, deps)
1057 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001058 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001059
Colin Cross4d9c2d12016-07-29 12:48:20 -07001060 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001061 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001062 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1063 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
1064 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001065 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001066 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001067 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1068 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
1069 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001070 }
1071
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001072 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001073}
1074
1075type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001076 versionedInterface
1077
Colin Crossb916a382016-07-29 17:28:03 -07001078 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001079 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001080 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001081 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001082 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001083
1084 // Returns true if the build options for the module have selected a static or shared build
1085 buildStatic() bool
1086 buildShared() bool
1087
1088 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001089 setStatic()
1090 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001091
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001092 // Check whether header_abi_checker is enabled or explicitly disabled.
1093 headerAbiCheckerEnabled() bool
1094 headerAbiCheckerExplicitlyDisabled() bool
1095
Logan Chien41eabe62019-04-10 13:33:58 +08001096 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1097 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001098
1099 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001100
1101 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001102
1103 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001104}
1105
Colin Crossc88c2722020-09-28 17:32:47 -07001106type versionedInterface interface {
1107 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001108 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001109 hasStubsVariants() bool
1110 setStubsVersion(string)
1111 stubsVersion() string
1112
Colin Cross3572cf72020-10-01 15:58:11 -07001113 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001114 setAllStubsVersions([]string)
1115 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001116
1117 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001118 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001119 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001120 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001121}
1122
1123var _ libraryInterface = (*libraryDecorator)(nil)
1124var _ versionedInterface = (*libraryDecorator)(nil)
1125
Justin Yun6977e8a2020-10-29 18:24:11 +09001126func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001127 name := library.libName
1128 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001129 name = String(library.Properties.Stem)
1130 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001131 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001132 }
Colin Crossb916a382016-07-29 17:28:03 -07001133 }
1134
Colin Cross0fd6a412019-08-16 14:22:10 -07001135 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001136 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001137 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001138 } else if inProduct {
1139 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001140 }
1141 if suffix == "" {
1142 suffix = String(library.Properties.Suffix)
1143 }
1144
Jooyung Han0302a842019-10-30 18:43:49 +09001145 return name + suffix
1146}
1147
Chris Parsons3c27ca32020-11-20 12:42:07 -05001148// getLibName returns the actual canonical name of the library (the name which
1149// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001150func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001151 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001152
Ivan Lozanof9e21722020-12-02 09:00:51 -05001153 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001154 // vndk-ext lib should have the same name with original lib
1155 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1156 originalName := module.(*Module).outputFile.Path()
1157 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1158 })
Logan Chienf3511742017-10-31 18:04:35 +08001159 }
1160
Colin Crossb916a382016-07-29 17:28:03 -07001161 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1162 if !strings.HasSuffix(name, "-host") {
1163 name = name + "-host"
1164 }
1165 }
1166
Inseob Kim0ce291e2019-07-04 14:38:27 +09001167 return name
Colin Crossb916a382016-07-29 17:28:03 -07001168}
1169
Jiyong Parkda732bd2018-11-02 18:23:15 +09001170var versioningMacroNamesListMutex sync.Mutex
1171
Colin Crossb916a382016-07-29 17:28:03 -07001172func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1173 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001174 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001175 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001176 }
1177 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001178 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001179 // Let baseLinker know whether this variant is for stubs or not, so that
1180 // it can omit things that are not required for linking stubs.
1181 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001182
1183 if library.buildStubs() {
1184 macroNames := versioningMacroNamesList(ctx.Config())
1185 myName := versioningMacroName(ctx.ModuleName())
1186 versioningMacroNamesListMutex.Lock()
1187 defer versioningMacroNamesListMutex.Unlock()
1188 if (*macroNames)[myName] == "" {
1189 (*macroNames)[myName] = ctx.ModuleName()
1190 } else if (*macroNames)[myName] != ctx.ModuleName() {
1191 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1192 }
1193 }
Colin Crossb916a382016-07-29 17:28:03 -07001194}
1195
dimitry0345ad82018-12-05 16:28:14 +01001196func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001197 if ctx.IsLlndk() {
1198 // LLNDK libraries ignore most of the properties on the cc_library and use the
1199 // LLNDK-specific properties instead.
1200 return deps
1201 }
1202
dimitry0345ad82018-12-05 16:28:14 +01001203 deps = library.baseCompiler.compilerDeps(ctx, deps)
1204
dimitry0345ad82018-12-05 16:28:14 +01001205 return deps
1206}
1207
Colin Cross37047f12016-12-13 17:06:13 -08001208func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001209 if ctx.IsLlndk() {
1210 // LLNDK libraries ignore most of the properties on the cc_library and use the
1211 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001212 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1213 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001214 return deps
1215 }
Colin Cross5271fea2021-04-27 13:06:04 -07001216 if ctx.IsVendorPublicLibrary() {
1217 headers := library.Properties.Vendor_public_library.Export_public_headers
1218 deps.HeaderLibs = append([]string(nil), headers...)
1219 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1220 return deps
1221 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001222
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001223 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001224 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001225 if library.StaticProperties.Static.System_shared_libs != nil {
1226 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001227 }
1228 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001229 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001230 if library.SharedProperties.Shared.System_shared_libs != nil {
1231 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001232 }
1233 }
1234
Colin Crossb916a382016-07-29 17:28:03 -07001235 deps = library.baseLinker.linkerDeps(ctx, deps)
1236
1237 if library.static() {
1238 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001239 library.StaticProperties.Static.Whole_static_libs...)
1240 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1241 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001242
Colin Crosse1bb5d02019-09-24 14:55:04 -07001243 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1244 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001245 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001246 if !Bool(library.baseLinker.Properties.Nocrt) {
1247 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1248 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001249 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001250 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1251 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1252 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001253
Colin Crosse1bb5d02019-09-24 14:55:04 -07001254 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1255 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001256 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001257 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001258 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1259 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1260 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001261 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1262 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001263 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001264 if ctx.inProduct() {
1265 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1266 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1267 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1268 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1269 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1270 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001271 if ctx.inRecovery() {
1272 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1273 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1274 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001275 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1276 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001277 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001278 if ctx.inRamdisk() {
1279 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1280 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1281 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1282 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1283 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1284 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001285 if ctx.inVendorRamdisk() {
1286 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1287 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1288 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1289 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1290 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1291 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001292
Colin Cross4d9c2d12016-07-29 12:48:20 -07001293 return deps
1294}
1295
Paul Duffin13f02712020-03-06 12:30:43 +00001296func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1297 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1298 var properties StaticOrSharedProperties
1299 if library.static() {
1300 properties = library.StaticProperties.Static
1301 } else if library.shared() {
1302 properties = library.SharedProperties.Shared
1303 }
1304
1305 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001306
1307 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1308 // either input list doesn't come out as nil.
1309 if specifiedDeps.systemSharedLibs == nil {
1310 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1311 } else {
1312 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1313 }
Paul Duffin13f02712020-03-06 12:30:43 +00001314
1315 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001316 if len(specifiedDeps.systemSharedLibs) > 0 {
1317 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1318 // retained.
1319 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1320 }
Paul Duffin13f02712020-03-06 12:30:43 +00001321 return specifiedDeps
1322}
1323
Colin Crossb916a382016-07-29 17:28:03 -07001324func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001325 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001326
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001327 library.objects = deps.WholeStaticLibObjs.Copy()
1328 library.objects = library.objects.Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001329
Inseob Kim0ce291e2019-07-04 14:38:27 +09001330 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001331 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001332 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001333
Dan Willemsen569edc52018-11-19 09:33:29 -08001334 if Bool(library.baseLinker.Properties.Use_version_lib) {
1335 if ctx.Host() {
1336 versionedOutputFile := outputFile
1337 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1338 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1339 } else {
1340 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001341 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001342 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1343 }
Colin Cross86803cf2018-02-15 14:12:26 -08001344 }
1345
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001346 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001347
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001348 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001349
Colin Cross4d9c2d12016-07-29 12:48:20 -07001350 ctx.CheckbuildFile(outputFile)
1351
Colin Cross649d8172020-12-10 12:30:21 -08001352 if library.static() {
1353 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
1354 StaticLibrary: outputFile,
1355 ReuseObjects: library.reuseObjects,
1356 Objects: library.objects,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001357
Colin Cross649d8172020-12-10 12:30:21 -08001358 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1359 Direct(outputFile).
1360 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1361 Build(),
1362 })
1363 }
1364
1365 if library.header() {
1366 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1367 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001368
Colin Cross4d9c2d12016-07-29 12:48:20 -07001369 return outputFile
1370}
1371
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001372func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1373 if ctx.Module().(*Module).IsSdkVariant() {
1374 // The NDK sysroot timestamp file depends on all the NDK
1375 // sysroot header and shared library files.
1376 return android.Paths{getNdkBaseTimestampFile(ctx)}
1377 }
1378 return nil
1379}
1380
Colin Crossb916a382016-07-29 17:28:03 -07001381func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001382 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001383
1384 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001385 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001386 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001387
Colin Cross2383f3b2018-02-06 14:40:13 -08001388 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1389 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1390 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001391 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001392 if unexportedSymbols.Valid() {
1393 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1394 }
1395 if forceNotWeakSymbols.Valid() {
1396 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1397 }
1398 if forceWeakSymbols.Valid() {
1399 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1400 }
1401 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001402 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001403 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001404 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1405 }
1406 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001407 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001408 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1409 }
1410 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001411 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001412 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1413 }
1414 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001415 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001416 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001417 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001418 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001419 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001420
1421 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1422 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001423 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001424
Josh Gao75a50a22019-06-07 17:58:59 -07001425 var implicitOutputs android.WritablePaths
1426 if ctx.Windows() {
1427 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1428
Colin Cross4af21ed2019-11-04 09:37:55 -08001429 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001430 implicitOutputs = append(implicitOutputs, importLibraryPath)
1431 }
1432
Colin Cross4d9c2d12016-07-29 12:48:20 -07001433 builderFlags := flagsToBuilderFlags(flags)
1434
Dan Willemsen47450072021-10-19 20:24:49 -07001435 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1436 fatOutputFile := outputFile
1437 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1438 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1439 }
1440
Colin Crossb496cfd2018-09-10 16:50:05 -07001441 // Optimize out relinking against shared libraries whose interface hasn't changed by
1442 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001443 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001444 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001445 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001446
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001447 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001448 needsStrip := library.stripper.NeedsStrip(ctx)
1449 if library.buildStubs() {
1450 // No need to strip stubs libraries
1451 needsStrip = false
1452 }
1453 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001454 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001455 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001456 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001457 strippedOutputFile := outputFile
1458 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001459 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001460 }
Colin Crossb60190a2018-09-04 16:28:17 -07001461 library.unstrippedOutputFile = outputFile
1462
Colin Crossd7227f92019-09-05 14:26:33 -07001463 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001464
Dan Willemsen569edc52018-11-19 09:33:29 -08001465 if Bool(library.baseLinker.Properties.Use_version_lib) {
1466 if ctx.Host() {
1467 versionedOutputFile := outputFile
1468 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1469 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1470 } else {
1471 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001472 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001473
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001474 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001475 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001476 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001477 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001478 }
1479
1480 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1481 }
Colin Cross86803cf2018-02-15 14:12:26 -08001482 }
1483
Jiyong Park64a44f22019-01-18 14:37:08 +09001484 sharedLibs := deps.EarlySharedLibs
1485 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001486 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1487
Jiyong Park64a44f22019-01-18 14:37:08 +09001488 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001489 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1490 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001491 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001492 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001493 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001494
Dan Willemsen581341d2017-02-09 16:16:31 -08001495 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1496 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001497
1498 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1499 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1500
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001501 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001502 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001503
Liz Kammeref6dfea2021-06-08 15:37:09 -04001504 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001505 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1506 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001507 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001508 }
1509
1510 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001511 TableOfContents: android.OptionalPathForPath(tocFile),
1512 SharedLibrary: unstrippedOutputFile,
1513 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1514 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001515 })
1516
1517 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1518 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001519 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001520 for _, stub := range stubs {
1521 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1522 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001523 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001524 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001525 SharedLibraryInfo: stubInfo,
1526 FlagExporterInfo: flagInfo,
1527 })
1528 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001529 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1530 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001531
Colin Cross127bb8b2020-12-16 16:46:01 -08001532 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001533 })
1534 }
1535
1536 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001537}
1538
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001539func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1540 return library.unstrippedOutputFile
1541}
1542
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001543func (library *libraryDecorator) disableStripping() {
1544 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1545}
1546
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001547func (library *libraryDecorator) nativeCoverage() bool {
1548 if library.header() || library.buildStubs() {
1549 return false
1550 }
1551 return true
1552}
1553
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001554func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1555 return library.coverageOutputFile
1556}
1557
Logan Chien7eefdc42018-07-11 18:10:41 +08001558func getRefAbiDumpFile(ctx ModuleContext, vndkVersion, fileName string) android.Path {
Hsin-Yi Chen27d235f2020-03-26 17:50:29 +08001559 // The logic must be consistent with classifySourceAbiDump.
Colin Cross95f1ca02020-10-29 20:47:22 -07001560 isNdk := ctx.isNdk(ctx.Config())
Colin Cross127bb8b2020-12-16 16:46:01 -08001561 isLlndkOrVndk := ctx.IsLlndkPublic() || (ctx.useVndk() && ctx.isVndk())
Logan Chien7eefdc42018-07-11 18:10:41 +08001562
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001563 refAbiDumpTextFile := android.PathForVndkRefAbiDump(ctx, vndkVersion, fileName, isNdk, isLlndkOrVndk, false)
1564 refAbiDumpGzipFile := android.PathForVndkRefAbiDump(ctx, vndkVersion, fileName, isNdk, isLlndkOrVndk, true)
Logan Chien7eefdc42018-07-11 18:10:41 +08001565
1566 if refAbiDumpTextFile.Valid() {
1567 if refAbiDumpGzipFile.Valid() {
1568 ctx.ModuleErrorf(
1569 "Two reference ABI dump files are found: %q and %q. Please delete the stale one.",
1570 refAbiDumpTextFile, refAbiDumpGzipFile)
1571 return nil
1572 }
1573 return refAbiDumpTextFile.Path()
1574 }
1575 if refAbiDumpGzipFile.Valid() {
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001576 return unzipRefDump(ctx, refAbiDumpGzipFile.Path(), fileName)
Logan Chien7eefdc42018-07-11 18:10:41 +08001577 }
1578 return nil
1579}
1580
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001581func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001582 if library.sabi.shouldCreateSourceAbiDump() {
Inseob Kim96f17f02020-06-09 22:05:09 +09001583 var vndkVersion string
1584
1585 if ctx.useVndk() {
1586 // For modules linking against vndk, follow its vndk version
1587 vndkVersion = ctx.Module().(*Module).VndkVersion()
1588 } else {
1589 // Regard the other modules as PLATFORM_VNDK_VERSION
1590 vndkVersion = ctx.DeviceConfig().PlatformVndkVersion()
Logan Chienf3511742017-10-31 18:04:35 +08001591 }
1592
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001593 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001594 var SourceAbiFlags []string
1595 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001596 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1597 }
Inseob Kim69378442019-06-03 19:10:47 +09001598 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1599 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001600 }
1601 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001602 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001603 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Logan Chiene3d7a0d2019-01-17 00:18:02 +08001604 library.Properties.Header_abi_checker.Exclude_symbol_versions,
1605 library.Properties.Header_abi_checker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001606
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001607 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001608
Logan Chien7eefdc42018-07-11 18:10:41 +08001609 refAbiDumpFile := getRefAbiDumpFile(ctx, vndkVersion, fileName)
1610 if refAbiDumpFile != nil {
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001611 library.sAbiDiff = sourceAbiDiff(ctx, library.sAbiOutputFile.Path(),
Logan Chien2a65dda2019-10-01 15:58:07 -07001612 refAbiDumpFile, fileName, exportedHeaderFlags,
1613 Bool(library.Properties.Header_abi_checker.Check_all_apis),
Colin Cross127bb8b2020-12-16 16:46:01 -08001614 ctx.IsLlndk(), ctx.isNdk(ctx.Config()), ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001615 }
1616 }
1617}
1618
Inseob Kimcc12d902021-05-14 20:15:55 +09001619func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001620 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1621 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1622
Colin Cross127bb8b2020-12-16 16:46:01 -08001623 for _, header := range srcFiles {
1624 headerDir := filepath.Dir(header.String())
1625 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1626 if err != nil {
1627 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1628 srcDir.String(), headerDir, err)
1629 continue
1630 }
1631
1632 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1633 }
1634
Inseob Kimcc12d902021-05-14 20:15:55 +09001635 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001636}
1637
Chris Parsons3c27ca32020-11-20 12:42:07 -05001638// link registers actions to link this library, and sets various fields
1639// on this library to reflect information that should be exported up the build
1640// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07001641func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001642 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001643
Colin Cross127bb8b2020-12-16 16:46:01 -08001644 if ctx.IsLlndk() {
1645 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
1646 // This is the vendor variant of an LLNDK library with preprocessed headers.
1647 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
1648
1649 var timestampFiles android.Paths
1650 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09001651 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
1652 timestampFiles = append(timestampFiles, timestampFile)
1653 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001654 }
1655
1656 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1657 library.reexportSystemDirs(genHeaderOutDir)
1658 } else {
1659 library.reexportDirs(genHeaderOutDir)
1660 }
1661
1662 library.reexportDeps(timestampFiles...)
1663 }
1664
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001665 // override the module's export_include_dirs with llndk.override_export_include_dirs
1666 // if it is set.
1667 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
1668 library.flagExporter.Properties.Export_include_dirs = override
1669 }
1670
Colin Cross127bb8b2020-12-16 16:46:01 -08001671 if Bool(library.Properties.Llndk.Export_headers_as_system) {
1672 library.flagExporter.Properties.Export_system_include_dirs = append(
1673 library.flagExporter.Properties.Export_system_include_dirs,
1674 library.flagExporter.Properties.Export_include_dirs...)
1675 library.flagExporter.Properties.Export_include_dirs = nil
1676 }
1677 }
1678
Colin Cross5271fea2021-04-27 13:06:04 -07001679 if ctx.IsVendorPublicLibrary() {
1680 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
1681 // if it is set.
1682 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
1683 library.flagExporter.Properties.Export_include_dirs = override
1684 }
1685 }
1686
Chris Parsons3c27ca32020-11-20 12:42:07 -05001687 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
1688 // of this library), together with `objs` (.o files created by compiling this
1689 // library).
Colin Crossad59e752017-11-16 14:29:11 -08001690 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001691 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08001692 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001693 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001694 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001695 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001696 }
1697
Chris Parsons3c27ca32020-11-20 12:42:07 -05001698 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09001699 library.exportIncludes(ctx)
1700 library.reexportDirs(deps.ReexportedDirs...)
1701 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
1702 library.reexportFlags(deps.ReexportedFlags...)
1703 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09001704 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001705
Chris Parsons3c27ca32020-11-20 12:42:07 -05001706 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001707 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001708 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09001709 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09001710 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09001711
Paul Duffin33056e82021-02-19 13:49:08 +00001712 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
1713 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07001714 }
1715 }
1716
Chris Parsons3c27ca32020-11-20 12:42:07 -05001717 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08001718 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07001719 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09001720 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07001721 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09001722 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07001723 }
Jiyong Park74955042019-10-22 20:19:51 +09001724 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09001725 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09001726
Paul Duffin33056e82021-02-19 13:49:08 +00001727 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
1728 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07001729 }
1730 }
1731
Inseob Kim07def122020-11-23 14:43:02 +09001732 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09001733 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09001734 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001735 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09001736 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
1737
Inseob Kim07def122020-11-23 14:43:02 +09001738 // If the owner is different from the user, expose public header. That is,
1739 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09001740 // 2) if the owner is platform and the client is vendor
1741 // We don't care Platform -> Vendor dependency as it's already forbidden.
1742 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09001743 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09001744 }
1745 }
1746
Paul Duffin37e0de52021-02-19 17:05:39 +00001747 // Make sure to only export headers which are within the include directory.
1748 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
1749 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
1750 return isRel
1751 })
1752
Chris Parsons3c27ca32020-11-20 12:42:07 -05001753 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09001754 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00001755 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00001756 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09001757 }
1758
Chris Parsons3c27ca32020-11-20 12:42:07 -05001759 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09001760 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09001761
Chris Parsons3c27ca32020-11-20 12:42:07 -05001762 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07001763 library.flagExporter.setProvider(ctx)
1764
Colin Cross4d9c2d12016-07-29 12:48:20 -07001765 return out
1766}
1767
Jiyong Park892a98f2020-12-14 09:20:00 +09001768func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001769 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09001770 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09001771 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
1772 if err != nil {
1773 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
1774 }
1775 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09001776 }
1777}
1778
Chris Parsons3c27ca32020-11-20 12:42:07 -05001779// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07001780func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001781 return library.MutatedProperties.BuildStatic &&
1782 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001783}
1784
Chris Parsons3c27ca32020-11-20 12:42:07 -05001785// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07001786func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001787 return library.MutatedProperties.BuildShared &&
1788 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001789}
1790
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001791func (library *libraryDecorator) objs() Objects {
1792 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001793}
1794
Colin Cross0de8a1e2020-09-18 14:15:30 -07001795func (library *libraryDecorator) reuseObjs() Objects {
1796 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07001797}
1798
Colin Cross26c34ed2016-09-30 17:10:16 -07001799func (library *libraryDecorator) toc() android.OptionalPath {
1800 return library.tocFile
1801}
1802
Jiyong Parkf1194352019-02-25 11:05:47 +09001803func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
1804 dir := library.baseInstaller.installDir(ctx)
1805 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
1806 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
1807 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001808 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09001809}
1810
Colin Crossb916a382016-07-29 17:28:03 -07001811func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07001812 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09001813 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09001814 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05001815 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09001816 if ctx.isVndkSp() {
1817 library.baseInstaller.subDir = "vndk-sp"
1818 } else {
1819 library.baseInstaller.subDir = "vndk"
1820 }
1821 }
1822
Justin Yun31094b12020-12-24 16:11:23 +09001823 // In some cases we want to use core variant for VNDK-Core libs.
1824 // Skip product variant since VNDKs use only the vendor variant.
1825 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08001826 mayUseCoreVariant := true
1827
1828 if ctx.mustUseVendorVariant() {
1829 mayUseCoreVariant = false
1830 }
1831
Elvis Chien9c993542021-06-25 01:15:17 +08001832 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08001833 mayUseCoreVariant = false
1834 }
1835
1836 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08001837 library.checkSameCoreVariant = true
1838 if ctx.DeviceConfig().VndkUseCoreVariant() {
1839 library.useCoreVariant = true
1840 }
Vic Yangefd249e2018-11-12 20:19:56 -08001841 }
Justin Yun8fe12122017-12-07 17:18:15 +09001842 }
Logan Chienf3511742017-10-31 18:04:35 +08001843
Jooyung Han261e1582020-10-20 18:54:21 +09001844 // do not install vndk libs
1845 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05001846 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09001847 return
Justin Yun8effde42017-06-23 19:24:43 +09001848 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001849 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09001850 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
1851 // The original path becomes a symlink to the corresponding file in the
1852 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07001853 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07001854 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001855 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01001856 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09001857 library.installSymlinkToRuntimeApex(ctx, file)
1858 }
Jiyong Park429660f2019-01-16 22:31:11 +09001859 library.baseInstaller.subDir = "bootstrap"
1860 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001861 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001862 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08001863 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09001864 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01001865
Colin Cross4d9c2d12016-07-29 12:48:20 -07001866 library.baseInstaller.install(ctx, file)
1867 }
Dan Albertf563d252017-10-13 00:29:00 -07001868
Dan Albert281f22b2017-12-13 15:03:47 -08001869 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07001870 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09001871 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08001872 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07001873 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07001874 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07001875
1876 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
1877 Rule: android.Cp,
1878 Description: "install " + installPath.Base(),
1879 Output: installPath,
1880 Input: file,
1881 })
1882
Colin Cross0875c522017-11-28 17:34:01 -08001883 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07001884 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001885}
1886
Paul Duffin0cb37b92020-03-04 14:52:46 +00001887func (library *libraryDecorator) everInstallable() bool {
1888 // Only shared and static libraries are installed. Header libraries (which are
1889 // neither static or shared) are not installed.
1890 return library.shared() || library.static()
1891}
1892
Chris Parsons3c27ca32020-11-20 12:42:07 -05001893// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07001894func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001895 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07001896}
1897
Chris Parsons3c27ca32020-11-20 12:42:07 -05001898// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001899func (library *libraryDecorator) shared() bool {
1900 return library.MutatedProperties.VariantIsShared
1901}
1902
Chris Parsons3c27ca32020-11-20 12:42:07 -05001903// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001904func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001905 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08001906 return !library.static() && !library.shared()
1907}
1908
Chris Parsons3c27ca32020-11-20 12:42:07 -05001909// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001910func (library *libraryDecorator) setStatic() {
1911 library.MutatedProperties.VariantIsStatic = true
1912 library.MutatedProperties.VariantIsShared = false
1913}
1914
Chris Parsons3c27ca32020-11-20 12:42:07 -05001915// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08001916func (library *libraryDecorator) setShared() {
1917 library.MutatedProperties.VariantIsStatic = false
1918 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07001919}
1920
Chris Parsons3c27ca32020-11-20 12:42:07 -05001921// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08001922func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001923 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08001924}
1925
Chris Parsons3c27ca32020-11-20 12:42:07 -05001926// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08001927func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001928 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08001929}
1930
Chris Parsons3c27ca32020-11-20 12:42:07 -05001931// HeaderOnly disables building this library as a shared or static library;
1932// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08001933func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08001934 library.MutatedProperties.BuildShared = false
1935 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08001936}
1937
Colin Cross127bb8b2020-12-16 16:46:01 -08001938// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
1939func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07001940 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001941}
1942
Colin Cross203b4212021-04-26 17:19:41 -07001943// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07001944func (library *libraryDecorator) hasLLNDKHeaders() bool {
1945 return Bool(library.Properties.Llndk.Llndk_headers)
1946}
1947
Colin Cross5271fea2021-04-27 13:06:04 -07001948// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
1949// vendor public library stubs.
1950func (library *libraryDecorator) hasVendorPublicLibrary() bool {
1951 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
1952}
1953
Colin Cross0477b422020-10-13 18:43:54 -07001954func (library *libraryDecorator) implementationModuleName(name string) string {
1955 return name
1956}
1957
Jiyong Park7ed9de32018-10-15 22:25:07 +09001958func (library *libraryDecorator) buildStubs() bool {
1959 return library.MutatedProperties.BuildStubs
1960}
1961
Jiyong Parka034b832019-08-27 14:02:19 +09001962func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
1963 if library.Properties.Header_abi_checker.Symbol_file != nil {
1964 return library.Properties.Header_abi_checker.Symbol_file
1965 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001966 if ctx.Module().(*Module).IsLlndk() {
1967 return library.Properties.Llndk.Symbol_file
1968 }
Colin Cross31076b32020-10-23 17:22:06 -07001969 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09001970 return library.Properties.Stubs.Symbol_file
1971 }
1972 return nil
1973}
1974
Colin Crossc88c2722020-09-28 17:32:47 -07001975func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001976 // Just having stubs.symbol_file is enough to create a stub variant. In that case
1977 // the stub for the future API level is created.
1978 return library.Properties.Stubs.Symbol_file != nil ||
1979 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07001980}
1981
Colin Cross3572cf72020-10-01 15:58:11 -07001982func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001983 if !library.hasStubsVariants() {
1984 return nil
1985 }
1986
Colin Crossc1b36442021-05-06 13:42:48 -07001987 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
1988 // LLNDK libraries only need a single stubs variant.
1989 return []string{android.FutureApiLevel.String()}
1990 }
1991
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001992 // Future API level is implicitly added if there isn't
1993 vers := library.Properties.Stubs.Versions
1994 if inList(android.FutureApiLevel.String(), vers) {
1995 return vers
1996 }
1997 // In some cases, people use the raw value "10000" in the versions property.
1998 // We shouldn't add the future API level in that case, otherwise there will
1999 // be two identical versions.
2000 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2001 return vers
2002 }
2003 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002004}
2005
2006func (library *libraryDecorator) setStubsVersion(version string) {
2007 library.MutatedProperties.StubsVersion = version
2008}
2009
Jiyong Park7ed9de32018-10-15 22:25:07 +09002010func (library *libraryDecorator) stubsVersion() string {
2011 return library.MutatedProperties.StubsVersion
2012}
2013
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002014func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002015 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002016 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002017}
2018
2019func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2020 library.MutatedProperties.AllStubsVersions = versions
2021}
2022
2023func (library *libraryDecorator) allStubsVersions() []string {
2024 return library.MutatedProperties.AllStubsVersions
2025}
2026
Jooyung Hanad4c1872020-02-27 17:56:44 +09002027func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002028 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002029}
2030
Jiyong Parka90ca002019-10-07 15:47:24 +09002031func (library *libraryDecorator) availableFor(what string) bool {
2032 var list []string
2033 if library.static() {
2034 list = library.StaticProperties.Static.Apex_available
2035 } else if library.shared() {
2036 list = library.SharedProperties.Shared.Apex_available
2037 }
2038 if len(list) == 0 {
2039 return false
2040 }
2041 return android.CheckAvailableForApex(what, list)
2042}
2043
Colin Cross1bc94122021-10-28 13:25:54 -07002044func (library *libraryDecorator) installable() *bool {
2045 if library.static() {
2046 return library.StaticProperties.Static.Installable
2047 } else if library.shared() {
2048 return library.SharedProperties.Shared.Installable
2049 }
2050 return nil
2051}
2052
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002053func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002054 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002055 // If we're asked to make a static library uninstallable we don't do
2056 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2057 // for these entries. This is done to still get the make targets for NOTICE
2058 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002059 return
2060 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002061 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002062}
2063
Colin Crossceaa5322021-09-28 16:37:50 -07002064func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2065 return library.apiListCoverageXmlPath
2066}
2067
Colin Cross571cccf2019-02-04 11:22:08 -08002068var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2069
Chris Parsons3c27ca32020-11-20 12:42:07 -05002070// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2071// and values are the module name responsible for registering the version macro name.
2072//
2073// Version macros are used when building against stubs, to provide version information about
2074// the stub. Only stub libraries should have an entry in this list.
2075//
2076// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2077// that headers from libFoo can be conditionally compiled (this may hide APIs
2078// that are not available for the version).
2079//
2080// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002081func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002082 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002083 m := make(map[string]string)
2084 return &m
2085 }).(*map[string]string)
2086}
2087
2088// alphanumeric and _ characters are preserved.
2089// other characters are all converted to _
2090var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2091
Chris Parsons3c27ca32020-11-20 12:42:07 -05002092// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002093func versioningMacroName(moduleName string) string {
2094 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002095 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002096 return "__" + macroName + "_API__"
2097}
2098
Chris Parsons3c27ca32020-11-20 12:42:07 -05002099// NewLibrary builds and returns a new Module corresponding to a C++ library.
2100// Individual module implementations which comprise a C++ library (or something like
2101// a C++ library) should call this function, set some fields on the result, and
2102// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002103func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002104 module := newModule(hod, android.MultilibBoth)
2105
Colin Crossb916a382016-07-29 17:28:03 -07002106 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002107 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002108 BuildShared: true,
2109 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002110 },
Colin Crossb916a382016-07-29 17:28:03 -07002111 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002112 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002113 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002114 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002115 }
2116
Colin Crossb916a382016-07-29 17:28:03 -07002117 module.compiler = library
2118 module.linker = library
2119 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002120 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002121
2122 return module, library
2123}
2124
Colin Cross10d22312017-05-03 11:01:58 -07002125// connects a shared library to a static library in order to reuse its .o files to avoid
2126// compiling source files twice.
2127func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2128 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2129 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002130
2131 // Check libraries in addition to cflags, since libraries may be exporting different
2132 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002133 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2134 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2135 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2136 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2137 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2138 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2139 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2140 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002141 // Compare System_shared_libs properties with nil because empty lists are
2142 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002143 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2144 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002145
2146 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2147 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2148 sharedCompiler.baseCompiler.Properties.Srcs
2149 sharedCompiler.baseCompiler.Properties.Srcs = nil
2150 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2151 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002152
2153 // This dep is just to reference static variant from shared variant
2154 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002155 }
2156}
2157
Chris Parsons3c27ca32020-11-20 12:42:07 -05002158// LinkageMutator adds "static" or "shared" variants for modules depending
2159// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002160func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002161 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002162 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002163 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002164 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002165 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002166 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002167
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002168 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002169 buildStatic := library.buildStatic()
2170 buildShared := library.buildShared()
2171 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002172 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2173 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2174 // all the variants of the cc_library also exist on the prebuilt.
2175 modules := mctx.CreateLocalVariations("static", "shared")
2176 static := modules[0].(*Module)
2177 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002178
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002179 static.linker.(prebuiltLibraryInterface).setStatic()
2180 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002181
Colin Cross127bb8b2020-12-16 16:46:01 -08002182 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002183 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002184 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002185 mctx.AliasVariation("static")
2186 }
2187
Colin Cross127bb8b2020-12-16 16:46:01 -08002188 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002189 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2190 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002191 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002192 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2193 }
2194 } else {
2195 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002196 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002197
Ivan Lozano52767be2019-10-18 14:49:46 -07002198 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002199
Ivan Lozano2b262972019-11-21 12:30:50 -08002200 // Non-cc.Modules may need an empty variant for their mutators.
2201 variations := []string{}
2202 if library.NonCcVariants() {
2203 variations = append(variations, "")
2204 }
2205
Colin Cross127bb8b2020-12-16 16:46:01 -08002206 isLLNDK := false
2207 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002208 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002209 }
2210 buildStatic := library.BuildStaticVariant() && !isLLNDK
2211 buildShared := library.BuildSharedVariant()
2212 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002213 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002214
2215 modules := mctx.CreateLocalVariations(variations...)
2216 static := modules[0].(LinkableInterface)
2217 shared := modules[1].(LinkableInterface)
2218
2219 static.SetStatic()
2220 shared.SetShared()
2221
2222 if _, ok := library.(*Module); ok {
2223 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2224 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002225 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002226 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002227 variations := append([]string{"static"}, variations...)
2228
2229 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002230 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002231 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002232 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002233 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002234
Ivan Lozano2b262972019-11-21 12:30:50 -08002235 modules := mctx.CreateLocalVariations(variations...)
2236 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002237 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002238 } else if len(variations) > 0 {
2239 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002240 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002241 }
Colin Crossb916a382016-07-29 17:28:03 -07002242 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002243}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002244
Chris Parsons3c27ca32020-11-20 12:42:07 -05002245// normalizeVersions modifies `versions` in place, so that each raw version
2246// string becomes its normalized canonical form.
2247// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002248func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002249 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002250 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002251 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002252 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002253 ctx.PropertyErrorf("versions", "%s", err.Error())
2254 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002255 }
Dan Albertc8060532020-07-22 22:32:17 -07002256 if i > 0 && ver.LessThanOrEqualTo(previous) {
2257 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2258 }
2259 versions[i] = ver.String()
2260 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002261 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002262}
2263
Jooyung Han61b66e92020-03-21 14:21:46 +00002264func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002265 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2266 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002267 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002268
Colin Cross127bb8b2020-12-16 16:46:01 -08002269 m := mctx.Module().(*Module)
2270 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002271 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002272
Colin Crossd1f898e2020-08-18 18:35:15 -07002273 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002274 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002275
Colin Cross5271fea2021-04-27 13:06:04 -07002276 if variants[i] != "" || isLLNDK || isVendorPublicLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002277 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002278 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002279 c.sanitize = nil
2280 c.stl = nil
2281 c.Properties.PreventInstall = true
2282 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002283 isLatest := i == (len(versions) - 1)
2284 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002285
2286 if variants[i] != "" {
2287 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2288 // implementation module to the stubs module.
2289 c.Properties.HideFromMake = true
2290 lib.setStubsVersion(variants[i])
2291 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2292 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002293 }
2294 }
Colin Cross094faa52020-08-06 17:38:25 -07002295 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002296 latestVersion := ""
2297 if len(versions) > 0 {
2298 latestVersion = versions[len(versions)-1]
2299 }
2300 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002301}
2302
Colin Crossbbc941b2020-09-30 12:27:01 -07002303func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2304 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2305 if err != nil {
2306 mctx.PropertyErrorf("min_sdk_version", err.Error())
2307 return
2308 }
2309
2310 versionStrs := ndkLibraryVersions(mctx, from)
2311 modules := mctx.CreateLocalVariations(versionStrs...)
2312
2313 for i, module := range modules {
2314 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002315 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002316 }
2317}
2318
Colin Cross3146c5c2020-09-30 15:34:40 -07002319func CanBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002320 Host() bool
2321 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002322 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002323}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002324 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002325}
2326
Colin Cross3146c5c2020-09-30 15:34:40 -07002327func CanBeVersionVariant(module interface {
2328 Host() bool
2329 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002330 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002331 InRecovery() bool
2332 CcLibraryInterface() bool
2333 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002334}) bool {
2335 return CanBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002336 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002337}
2338
Colin Cross127bb8b2020-12-16 16:46:01 -08002339func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002340 if m, ok := module.(*Module); ok {
2341 return m.library
2342 }
2343 return nil
2344}
2345
Colin Crossc1b36442021-05-06 13:42:48 -07002346// versionSelector normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
Colin Crossd1f898e2020-08-18 18:35:15 -07002347func versionSelectorMutator(mctx android.BottomUpMutatorContext) {
Colin Cross31076b32020-10-23 17:22:06 -07002348 if library := moduleLibraryInterface(mctx.Module()); library != nil && CanBeVersionVariant(mctx.Module().(*Module)) {
2349 if library.buildShared() {
2350 versions := library.stubsVersions(mctx)
Colin Cross3572cf72020-10-01 15:58:11 -07002351 if len(versions) > 0 {
2352 normalizeVersions(mctx, versions)
2353 if mctx.Failed() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002354 return
2355 }
Colin Cross3572cf72020-10-01 15:58:11 -07002356 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2357 // depend on the implementation library and haven't been mutated yet.
Colin Cross31076b32020-10-23 17:22:06 -07002358 library.setAllStubsVersions(versions)
Colin Cross127bb8b2020-12-16 16:46:01 -08002359 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002360 }
Colin Crossd1f898e2020-08-18 18:35:15 -07002361 }
2362}
Jooyung Han61b66e92020-03-21 14:21:46 +00002363
Colin Crossd1f898e2020-08-18 18:35:15 -07002364// versionMutator splits a module into the mandatory non-stubs variant
2365// (which is unnamed) and zero or more stubs variants.
2366func versionMutator(mctx android.BottomUpMutatorContext) {
Colin Cross31076b32020-10-23 17:22:06 -07002367 if library := moduleLibraryInterface(mctx.Module()); library != nil && CanBeVersionVariant(mctx.Module().(*Module)) {
2368 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002369 return
2370 }
2371
2372 if m, ok := mctx.Module().(*Module); ok {
2373 if m.SplitPerApiLevel() && m.IsSdkVariant() {
2374 if mctx.Os() != android.Android {
2375 return
2376 }
2377 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2378 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002379 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002380}
Colin Crossd7227f92019-09-05 14:26:33 -07002381
2382// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2383// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2384// that the linked output file should be written to.
2385// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2386func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2387 inject *bool, fileName string) android.ModuleOutPath {
2388 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2389 injectBoringSSLHash := Bool(inject)
2390 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002391 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002392 if cc, ok := dep.(*Module); ok {
2393 if library, ok := cc.linker.(*libraryDecorator); ok {
2394 if Bool(library.Properties.Inject_bssl_hash) {
2395 injectBoringSSLHash = true
2396 }
2397 }
2398 }
2399 }
2400 })
2401 if injectBoringSSLHash {
2402 hashedOutputfile := outputFile
2403 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2404
Colin Crossf1a035e2020-11-16 17:32:30 -08002405 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002406 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002407 BuiltTool("bssl_inject_hash").
Pete Bentley5c4be822019-10-01 17:03:17 +01002408 Flag("-sha256").
Colin Crossd7227f92019-09-05 14:26:33 -07002409 FlagWithInput("-in-object ", outputFile).
2410 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002411 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002412 }
2413
2414 return outputFile
2415}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002416
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002417func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002418 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2419 compilerAttrs := baseAttributes.compilerAttributes
2420 linkerAttrs := baseAttributes.linkerAttributes
2421
Liz Kammer1263d9b2021-12-10 14:28:20 -05002422 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002423
2424 // Append shared/static{} stanza properties. These won't be specified on
2425 // cc_library_* itself, but may be specified in cc_defaults that this module
2426 // depends on.
2427 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2428
2429 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2430 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2431 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2432 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002433
2434 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2435 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002436 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002437 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002438 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2439
2440 asFlags := compilerAttrs.asFlags
2441 if compilerAttrs.asSrcs.IsEmpty() {
2442 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2443 asFlags = bazel.MakeStringListAttribute(nil)
2444 }
2445
Liz Kammer7a210ac2021-09-22 15:52:58 -04002446 commonAttrs := staticOrSharedAttributes{
2447 Srcs: compilerAttrs.srcs,
2448 Srcs_c: compilerAttrs.cSrcs,
2449 Srcs_as: compilerAttrs.asSrcs,
2450 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002451 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002452
Liz Kammer12615db2021-09-28 09:19:17 -04002453 Deps: linkerAttrs.deps,
2454 Implementation_deps: linkerAttrs.implementationDeps,
2455 Dynamic_deps: linkerAttrs.dynamicDeps,
2456 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2457 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2458 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2459 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002460 }
2461
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002462 var attrs interface{}
2463 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002464 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002465 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002466 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002467
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002468 Use_libcrt: linkerAttrs.useLibcrt,
2469 Use_version_lib: linkerAttrs.useVersionLib,
2470
Liz Kammer1263d9b2021-12-10 14:28:20 -05002471 Rtti: compilerAttrs.rtti,
2472 Stl: compilerAttrs.stl,
2473 Cpp_std: compilerAttrs.cppStd,
2474 C_std: compilerAttrs.cStd,
2475
2476 Export_includes: exportedIncludes.Includes,
2477 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2478 Export_system_includes: exportedIncludes.SystemIncludes,
2479 Local_includes: compilerAttrs.localIncludes,
2480 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002481
2482 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002483 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002484 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002485
2486 Features: linkerAttrs.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002487 }
2488 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002489 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2490
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002491 attrs = &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002492 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002493
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002494 Cppflags: compilerAttrs.cppFlags,
2495 Conlyflags: compilerAttrs.conlyFlags,
2496 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002497
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002498 Linkopts: linkerAttrs.linkopts,
2499 Link_crt: linkerAttrs.linkCrt,
2500 Use_libcrt: linkerAttrs.useLibcrt,
2501 Use_version_lib: linkerAttrs.useVersionLib,
2502
2503 Rtti: compilerAttrs.rtti,
2504 Stl: compilerAttrs.stl,
2505 Cpp_std: compilerAttrs.cppStd,
2506 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002507
Liz Kammerd2871182021-10-04 13:54:37 -04002508 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002509 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002510 Export_system_includes: exportedIncludes.SystemIncludes,
2511 Local_includes: compilerAttrs.localIncludes,
2512 Absolute_includes: compilerAttrs.absoluteIncludes,
2513 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002514
2515 Strip: stripAttributes{
2516 Keep_symbols: linkerAttrs.stripKeepSymbols,
2517 Keep_symbols_and_debug_frame: linkerAttrs.stripKeepSymbolsAndDebugFrame,
2518 Keep_symbols_list: linkerAttrs.stripKeepSymbolsList,
2519 All: linkerAttrs.stripAll,
2520 None: linkerAttrs.stripNone,
2521 },
Liz Kammer0eae52e2021-10-06 10:32:26 -04002522
2523 Features: linkerAttrs.features,
Jingwen Chen0ee88a62022-01-07 14:55:29 +00002524
2525 Stubs_symbol_file: compilerAttrs.stubsSymbolFile,
2526 Stubs_versions: compilerAttrs.stubsVersions,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002527 }
2528 }
2529
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002530 var modType string
2531 if isStatic {
2532 modType = "cc_library_static"
2533 } else {
2534 modType = "cc_library_shared"
2535 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002536 props := bazel.BazelTargetModuleProperties{
2537 Rule_class: modType,
2538 Bzl_load_location: fmt.Sprintf("//build/bazel/rules:%s.bzl", modType),
2539 }
2540
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +00002541 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 +00002542}
2543
2544// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002545type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002546 staticOrSharedAttributes
2547
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002548 Use_libcrt bazel.BoolAttribute
2549 Use_version_lib bazel.BoolAttribute
2550
2551 Rtti bazel.BoolAttribute
2552 Stl *string
2553 Cpp_std *string
2554 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002555
Liz Kammer1263d9b2021-12-10 14:28:20 -05002556 Export_includes bazel.StringListAttribute
2557 Export_absolute_includes bazel.StringListAttribute
2558 Export_system_includes bazel.StringListAttribute
2559 Local_includes bazel.StringListAttribute
2560 Absolute_includes bazel.StringListAttribute
2561 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002562
2563 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002564 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002565 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002566
2567 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002568}
2569
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002570// TODO(b/199902614): Can this be factored to share with the other Attributes?
2571type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002572 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002573
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002574 Linkopts bazel.StringListAttribute
2575 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
2576
2577 Use_libcrt bazel.BoolAttribute
2578 Use_version_lib bazel.BoolAttribute
2579
2580 Rtti bazel.BoolAttribute
2581 Stl *string
2582 Cpp_std *string
2583 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002584
Liz Kammer1263d9b2021-12-10 14:28:20 -05002585 Export_includes bazel.StringListAttribute
2586 Export_absolute_includes bazel.StringListAttribute
2587 Export_system_includes bazel.StringListAttribute
2588 Local_includes bazel.StringListAttribute
2589 Absolute_includes bazel.StringListAttribute
2590 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002591
Liz Kammerd2871182021-10-04 13:54:37 -04002592 Strip stripAttributes
2593 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04002594
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002595 Cppflags bazel.StringListAttribute
2596 Conlyflags bazel.StringListAttribute
2597 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002598
2599 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00002600
2601 Stubs_symbol_file *string
2602 Stubs_versions bazel.StringListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002603}