blob: 8fd001988018067d435381e885b9a8bc62d660b5 [file] [log] [blame]
Colin Cross4d9c2d12016-07-29 12:48:20 -07001// Copyright 2016 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package cc
16
17import (
Inseob Kim69378442019-06-03 19:10:47 +090018 "fmt"
Logan Chien41eabe62019-04-10 13:33:58 +080019 "io"
Jiyong Parkf1194352019-02-25 11:05:47 +090020 "path/filepath"
Jiyong Parkda732bd2018-11-02 18:23:15 +090021 "regexp"
Jooyung Han11b0fbd2021-02-05 02:28:22 +090022 "strconv"
Colin Cross4d9c2d12016-07-29 12:48:20 -070023 "strings"
Jiyong Parkda732bd2018-11-02 18:23:15 +090024 "sync"
Colin Cross4d9c2d12016-07-29 12:48:20 -070025
Colin Cross4d9c2d12016-07-29 12:48:20 -070026 "android/soong/android"
Rupert Shuttleworth095081c2021-03-25 09:06:03 +000027 "android/soong/bazel"
Chris Parsons94a0bba2021-06-04 15:03:47 -040028 "android/soong/bazel/cquery"
Dan Albertea4b7b92018-04-25 16:05:30 -070029 "android/soong/cc/config"
Liz Kammer2ada09a2021-08-11 00:17:36 -040030
Chris Parsons51f8c392021-08-03 21:01:05 -040031 "github.com/google/blueprint"
32 "github.com/google/blueprint/pathtools"
Spandan Das4238c652022-09-09 01:38:47 +000033 "github.com/google/blueprint/proptools"
Colin Cross4d9c2d12016-07-29 12:48:20 -070034)
35
Liz Kammer2b376bc2022-01-12 12:00:49 -050036// LibraryProperties is a collection of properties shared by cc library rules/cc.
Colin Crossb916a382016-07-29 17:28:03 -070037type LibraryProperties struct {
Colin Cross4d9c2d12016-07-29 12:48:20 -070038 // local file name to pass to the linker as -unexported_symbols_list
Colin Cross27b922f2019-03-04 22:35:41 -080039 Unexported_symbols_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070040 // local file name to pass to the linker as -force_symbols_not_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080041 Force_symbols_not_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070042 // local file name to pass to the linker as -force_symbols_weak_list
Colin Cross27b922f2019-03-04 22:35:41 -080043 Force_symbols_weak_list *string `android:"path,arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070044
45 // rename host libraries to prevent overlap with system installed libraries
46 Unique_host_soname *bool
47
Dan Willemsene1240db2016-11-03 14:28:51 -070048 Aidl struct {
49 // export headers generated from .aidl sources
Nan Zhang0007d812017-11-07 10:57:05 -080050 Export_aidl_headers *bool
Dan Willemsene1240db2016-11-03 14:28:51 -070051 }
52
Colin Cross0c461f12016-10-20 16:11:43 -070053 Proto struct {
54 // export headers generated from .proto sources
Nan Zhang0007d812017-11-07 10:57:05 -080055 Export_proto_headers *bool
Colin Cross0c461f12016-10-20 16:11:43 -070056 }
Dan Albertf563d252017-10-13 00:29:00 -070057
Inseob Kimc0907f12019-02-08 21:00:45 +090058 Sysprop struct {
59 // Whether platform owns this sysprop library.
60 Platform *bool
Inseob Kimb3f22ca2019-03-05 12:40:24 +090061 } `blueprint:"mutated"`
Inseob Kimc0907f12019-02-08 21:00:45 +090062
Nan Zhang0007d812017-11-07 10:57:05 -080063 Static_ndk_lib *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090064
Florian Mayer6dab96c2020-12-31 11:39:48 +000065 // Generate stubs to make this library accessible to APEXes.
Jiyong Park7ed9de32018-10-15 22:25:07 +090066 Stubs struct {
67 // Relative path to the symbol map. The symbol map provides the list of
68 // symbols that are exported for stubs variant of this library.
Colin Cross27b922f2019-03-04 22:35:41 -080069 Symbol_file *string `android:"path"`
Jiyong Park7ed9de32018-10-15 22:25:07 +090070
Jiyong Parkd4a3a132021-03-17 20:21:35 +090071 // List versions to generate stubs libs for. The version name "current" is always
72 // implicitly added.
Jiyong Park7ed9de32018-10-15 22:25:07 +090073 Versions []string
Alan Stokes73feba32022-11-14 12:21:24 +000074
75 // Whether to not require the implementation of the library to be installed if a
76 // client of the stubs is installed. Defaults to true; set to false if the
77 // implementation is made available by some other means, e.g. in a Microdroid
78 // virtual machine.
79 Implementation_installable *bool
Jiyong Park7ed9de32018-10-15 22:25:07 +090080 }
dimitryd95964a2018-11-07 13:43:34 +010081
82 // set the name of the output
83 Stem *string `android:"arch_variant"`
84
Colin Cross0fd6a412019-08-16 14:22:10 -070085 // set suffix of the name of the output
86 Suffix *string `android:"arch_variant"`
87
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +080088 // Properties for ABI compatibility checker.
89 Header_abi_checker headerAbiCheckerProperties
90
Colin Cross0fd6a412019-08-16 14:22:10 -070091 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +090092 Vendor, Product struct {
Colin Cross0fd6a412019-08-16 14:22:10 -070093 // set suffix of the name of the output
94 Suffix *string `android:"arch_variant"`
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +080095
96 Header_abi_checker headerAbiCheckerProperties
97 }
98
99 Platform struct {
100 Header_abi_checker headerAbiCheckerProperties
Colin Cross0fd6a412019-08-16 14:22:10 -0700101 }
102 }
103
dimitryd95964a2018-11-07 13:43:34 +0100104 // Names of modules to be overridden. Listed modules can only be other shared libraries
105 // (in Make or Soong).
106 // This does not completely prevent installation of the overridden libraries, but if both
107 // binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
108 // from PRODUCT_PACKAGES.
109 Overrides []string
Logan Chiene3d7a0d2019-01-17 00:18:02 +0800110
Pete Bentley803e1612019-08-06 22:19:59 +0100111 // Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
112 Inject_bssl_hash *bool `android:"arch_variant"`
Colin Cross0477b422020-10-13 18:43:54 -0700113
Colin Cross127bb8b2020-12-16 16:46:01 -0800114 // If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
115 // the module pointed to by llndk_stubs if it is set.
116 Llndk llndkLibraryProperties
Colin Cross5271fea2021-04-27 13:06:04 -0700117
118 // If this is a vendor public library, properties to describe the vendor public library stubs.
119 Vendor_public_library vendorPublicLibraryProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800120}
Colin Cross0c461f12016-10-20 16:11:43 -0700121
Chris Parsons3c27ca32020-11-20 12:42:07 -0500122// StaticProperties is a properties stanza to affect only attributes of the "static" variants of a
123// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700124type StaticProperties struct {
125 Static StaticOrSharedProperties `android:"arch_variant"`
126}
127
Chris Parsons3c27ca32020-11-20 12:42:07 -0500128// SharedProperties is a properties stanza to affect only attributes of the "shared" variants of a
129// library module.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700130type SharedProperties struct {
131 Shared StaticOrSharedProperties `android:"arch_variant"`
132}
133
Chris Parsons3c27ca32020-11-20 12:42:07 -0500134// StaticOrSharedProperties is an embedded struct representing properties to affect attributes of
135// either only the "static" variants or only the "shared" variants of a library module. These override
136// the base properties of the same name.
137// Use `StaticProperties` or `SharedProperties`, depending on which variant is needed.
138// `StaticOrSharedProperties` exists only to avoid duplication.
Colin Crosse1bb5d02019-09-24 14:55:04 -0700139type StaticOrSharedProperties struct {
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700140 Srcs []string `android:"path,arch_variant"`
141
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -0700142 Tidy_disabled_srcs []string `android:"path,arch_variant"`
143
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -0800144 Tidy_timeout_srcs []string `android:"path,arch_variant"`
145
Evgenii Stepanov2080bfe2020-07-24 15:35:40 -0700146 Sanitized Sanitized `android:"arch_variant"`
147
Colin Crosse1bb5d02019-09-24 14:55:04 -0700148 Cflags []string `android:"arch_variant"`
149
Colin Cross6b8f4252021-07-22 11:39:44 -0700150 Enabled *bool `android:"arch_variant"`
151 Whole_static_libs []string `android:"arch_variant"`
152 Static_libs []string `android:"arch_variant"`
153 Shared_libs []string `android:"arch_variant"`
154 System_shared_libs []string `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700155
156 Export_shared_lib_headers []string `android:"arch_variant"`
157 Export_static_lib_headers []string `android:"arch_variant"`
Jiyong Parka90ca002019-10-07 15:47:24 +0900158
159 Apex_available []string `android:"arch_variant"`
Colin Cross1bc94122021-10-28 13:25:54 -0700160
161 Installable *bool `android:"arch_variant"`
Colin Crosse1bb5d02019-09-24 14:55:04 -0700162}
163
Colin Crossa48ab5b2017-02-14 15:28:44 -0800164type LibraryMutatedProperties struct {
Colin Crossb916a382016-07-29 17:28:03 -0700165 // Build a static variant
166 BuildStatic bool `blueprint:"mutated"`
167 // Build a shared variant
168 BuildShared bool `blueprint:"mutated"`
169 // This variant is shared
170 VariantIsShared bool `blueprint:"mutated"`
171 // This variant is static
172 VariantIsStatic bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900173
174 // This variant is a stubs lib
175 BuildStubs bool `blueprint:"mutated"`
Jiyong Parkd4a3a132021-03-17 20:21:35 +0900176 // This variant is the latest version
177 IsLatestVersion bool `blueprint:"mutated"`
Jiyong Park7ed9de32018-10-15 22:25:07 +0900178 // Version of the stubs lib
179 StubsVersion string `blueprint:"mutated"`
Colin Crossd1f898e2020-08-18 18:35:15 -0700180 // List of all stubs versions associated with an implementation lib
181 AllStubsVersions []string `blueprint:"mutated"`
Colin Crossb916a382016-07-29 17:28:03 -0700182}
183
184type FlagExporterProperties struct {
185 // list of directories relative to the Blueprints file that will
Dan Willemsen273af7f2016-11-03 15:53:42 -0700186 // be added to the include path (using -I) for this module and any module that links
Colin Cross5d195602017-10-17 16:15:50 -0700187 // against this module. Directories listed in export_include_dirs do not need to be
188 // listed in local_include_dirs.
Colin Cross0ed579e2021-06-29 00:51:12 +0000189 Export_include_dirs []string `android:"arch_variant,variant_prepend"`
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700190
Jiyong Park73c54ee2019-10-22 20:31:18 +0900191 // list of directories that will be added to the system include path
192 // using -isystem for this module and any module that links against this module.
Colin Cross0ed579e2021-06-29 00:51:12 +0000193 Export_system_include_dirs []string `android:"arch_variant,variant_prepend"`
Jiyong Park73c54ee2019-10-22 20:31:18 +0900194
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700195 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900196 Vendor, Product struct {
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700197 // list of exported include directories, like
Justin Yun63e9ec72020-10-29 16:49:43 +0900198 // export_include_dirs, that will be applied to
199 // vendor or product variant of this library.
200 // This will overwrite any other declarations.
Steven Morelandb21df8f2018-01-05 14:42:54 -0800201 Override_export_include_dirs []string
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700202 }
203 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700204}
205
206func init() {
Paul Duffin6c26dc72019-12-19 15:02:40 +0000207 RegisterLibraryBuildComponents(android.InitRegistrationContext)
208}
209
210func RegisterLibraryBuildComponents(ctx android.RegistrationContext) {
211 ctx.RegisterModuleType("cc_library_static", LibraryStaticFactory)
212 ctx.RegisterModuleType("cc_library_shared", LibrarySharedFactory)
213 ctx.RegisterModuleType("cc_library", LibraryFactory)
214 ctx.RegisterModuleType("cc_library_host_static", LibraryHostStaticFactory)
215 ctx.RegisterModuleType("cc_library_host_shared", LibraryHostSharedFactory)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700216}
217
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +0000218// TODO(b/199902614): Can this be factored to share with the other Attributes?
Jingwen Chen63930982021-03-24 10:04:33 -0400219// For bp2build conversion.
220type bazelCcLibraryAttributes struct {
Chris Parsons08648312021-05-06 16:23:19 -0400221 // Attributes pertaining to both static and shared variants.
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000222 Srcs bazel.LabelListAttribute
223 Srcs_c bazel.LabelListAttribute
224 Srcs_as bazel.LabelListAttribute
225
226 Copts bazel.StringListAttribute
227 Cppflags bazel.StringListAttribute
228 Conlyflags bazel.StringListAttribute
229 Asflags bazel.StringListAttribute
230
Liz Kammer7a210ac2021-09-22 15:52:58 -0400231 Hdrs bazel.LabelListAttribute
232
Liz Kammer12615db2021-09-28 09:19:17 -0400233 Deps bazel.LabelListAttribute
234 Implementation_deps bazel.LabelListAttribute
235 Dynamic_deps bazel.LabelListAttribute
236 Implementation_dynamic_deps bazel.LabelListAttribute
237 Whole_archive_deps bazel.LabelListAttribute
238 Implementation_whole_archive_deps bazel.LabelListAttribute
239 System_dynamic_deps bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -0400240
Liz Kammer5fad5012021-09-09 14:08:21 -0400241 Export_includes bazel.StringListAttribute
242 Export_system_includes bazel.StringListAttribute
Liz Kammer35687bc2021-09-10 10:07:07 -0400243 Local_includes bazel.StringListAttribute
244 Absolute_includes bazel.StringListAttribute
Liz Kammer5fad5012021-09-09 14:08:21 -0400245 Linkopts bazel.StringListAttribute
246 Use_libcrt bazel.BoolAttribute
247 Rtti bazel.BoolAttribute
Jingwen Chen5b11ab12021-10-11 17:44:33 +0000248
249 Stl *string
250 Cpp_std *string
Chris Parsons79bd2b72021-11-29 17:52:41 -0500251 C_std *string
Chris Parsons990c4f42021-05-25 12:10:58 -0400252
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000253 // This is shared only.
Liz Kammerd2871182021-10-04 13:54:37 -0400254 Link_crt bazel.BoolAttribute
255 Additional_linker_inputs bazel.LabelListAttribute
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000256
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000257 // Common properties shared between both shared and static variants.
258 Shared staticOrSharedAttributes
259 Static staticOrSharedAttributes
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000260
261 Strip stripAttributes
Liz Kammer0eae52e2021-10-06 10:32:26 -0400262
263 Features bazel.StringListAttribute
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000264}
265
Vinh Tran9f6796a2022-08-16 13:10:31 -0400266type aidlLibraryAttributes struct {
267 Srcs bazel.LabelListAttribute
268 Include_dir *string
269}
270
271type ccAidlLibraryAttributes struct {
Vinh Tran395a1e92022-09-16 18:27:29 -0400272 Deps bazel.LabelListAttribute
273 Implementation_dynamic_deps bazel.LabelListAttribute
Vinh Tran9f6796a2022-08-16 13:10:31 -0400274}
275
Jingwen Chen3d383bb2021-06-09 07:18:37 +0000276type stripAttributes struct {
277 Keep_symbols bazel.BoolAttribute
278 Keep_symbols_and_debug_frame bazel.BoolAttribute
279 Keep_symbols_list bazel.StringListAttribute
280 All bazel.BoolAttribute
281 None bazel.BoolAttribute
Jingwen Chen63930982021-03-24 10:04:33 -0400282}
283
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +0000284func stripAttrsFromLinkerAttrs(la *linkerAttributes) stripAttributes {
285 return stripAttributes{
286 Keep_symbols: la.stripKeepSymbols,
287 Keep_symbols_and_debug_frame: la.stripKeepSymbolsAndDebugFrame,
288 Keep_symbols_list: la.stripKeepSymbolsList,
289 All: la.stripAll,
290 None: la.stripNone,
291 }
292}
293
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400294func libraryBp2Build(ctx android.TopDownMutatorContext, m *Module) {
Jingwen Chen53681ef2021-04-29 08:15:13 +0000295 sharedAttrs := bp2BuildParseSharedProps(ctx, m)
296 staticAttrs := bp2BuildParseStaticProps(ctx, m)
Liz Kammere6583482021-10-19 13:56:10 -0400297 baseAttributes := bp2BuildParseBaseProps(ctx, m)
298 compilerAttrs := baseAttributes.compilerAttributes
299 linkerAttrs := baseAttributes.linkerAttributes
Liz Kammer54549442022-05-11 13:55:06 -0400300 exportedIncludes := bp2BuildParseExportedIncludes(ctx, m, &compilerAttrs.includes)
Jingwen Chen63930982021-03-24 10:04:33 -0400301
Liz Kammer9abd62d2021-05-21 08:37:59 -0400302 srcs := compilerAttrs.srcs
Jingwen Chen53681ef2021-04-29 08:15:13 +0000303
Liz Kammer12615db2021-09-28 09:19:17 -0400304 sharedAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
305 staticAttrs.Deps.Add(baseAttributes.protoDependency)
306
Chris Parsons69fa9f92021-07-13 11:47:44 -0400307 asFlags := compilerAttrs.asFlags
308 if compilerAttrs.asSrcs.IsEmpty() && sharedAttrs.Srcs_as.IsEmpty() && staticAttrs.Srcs_as.IsEmpty() {
309 // Skip asflags for BUILD file simplicity if there are no assembly sources.
310 asFlags = bazel.MakeStringListAttribute(nil)
311 }
312
Chris Parsons77acf2e2021-12-03 17:27:16 -0500313 staticCommonAttrs := staticOrSharedAttributes{
314 Srcs: *srcs.Clone().Append(staticAttrs.Srcs),
315 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(staticAttrs.Srcs_c),
316 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(staticAttrs.Srcs_as),
317 Copts: *compilerAttrs.copts.Clone().Append(staticAttrs.Copts),
318 Hdrs: *compilerAttrs.hdrs.Clone().Append(staticAttrs.Hdrs),
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000319
Chris Parsons77acf2e2021-12-03 17:27:16 -0500320 Deps: *linkerAttrs.deps.Clone().Append(staticAttrs.Deps),
321 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(staticAttrs.Implementation_deps),
322 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(staticAttrs.Dynamic_deps),
323 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(staticAttrs.Implementation_dynamic_deps),
324 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
325 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(staticAttrs.Whole_archive_deps),
326 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(staticAttrs.System_dynamic_deps),
Cole Faust6b29f592022-08-09 09:50:56 -0700327 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liufc603162022-03-01 15:44:08 -0800328 sdkAttributes: bp2BuildParseSdkAttributes(m),
Yu Liuf01a0f02022-12-07 15:45:30 -0800329 Native_coverage: baseAttributes.Native_coverage,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500330 }
331
332 sharedCommonAttrs := staticOrSharedAttributes{
333 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
334 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
335 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
336 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
337 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
338
Liz Kammer84b0ecb2022-09-14 10:49:13 -0400339 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
340 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
341 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
342 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
343 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
344 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
345 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
346 Runtime_deps: linkerAttrs.runtimeDeps,
347 sdkAttributes: bp2BuildParseSdkAttributes(m),
Yu Liuf01a0f02022-12-07 15:45:30 -0800348 Native_coverage: baseAttributes.Native_coverage,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500349 }
350
351 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
352 staticOrSharedAttributes: staticCommonAttrs,
353
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000354 Cppflags: compilerAttrs.cppFlags,
355 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400356 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000357
Liz Kammer1263d9b2021-12-10 14:28:20 -0500358 Export_includes: exportedIncludes.Includes,
359 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
360 Export_system_includes: exportedIncludes.SystemIncludes,
361 Local_includes: compilerAttrs.localIncludes,
362 Absolute_includes: compilerAttrs.absoluteIncludes,
363 Use_libcrt: linkerAttrs.useLibcrt,
364 Rtti: compilerAttrs.rtti,
365 Stl: compilerAttrs.stl,
366 Cpp_std: compilerAttrs.cppStd,
367 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500368
Cole Faust5fa4e962022-08-22 14:31:04 -0700369 Features: baseAttributes.features,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500370 }
371
372 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
373 staticOrSharedAttributes: sharedCommonAttrs,
374 Cppflags: compilerAttrs.cppFlags,
375 Conlyflags: compilerAttrs.conlyFlags,
376 Asflags: asFlags,
377
Liz Kammer1263d9b2021-12-10 14:28:20 -0500378 Export_includes: exportedIncludes.Includes,
379 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
380 Export_system_includes: exportedIncludes.SystemIncludes,
381 Local_includes: compilerAttrs.localIncludes,
382 Absolute_includes: compilerAttrs.absoluteIncludes,
383 Linkopts: linkerAttrs.linkopts,
384 Link_crt: linkerAttrs.linkCrt,
385 Use_libcrt: linkerAttrs.useLibcrt,
386 Rtti: compilerAttrs.rtti,
387 Stl: compilerAttrs.stl,
388 Cpp_std: compilerAttrs.cppStd,
389 C_std: compilerAttrs.cStd,
Yu Liua79c9462022-03-22 16:35:22 -0700390 Use_version_lib: linkerAttrs.useVersionLib,
Chris Parsons990c4f42021-05-25 12:10:58 -0400391
Liz Kammerd2871182021-10-04 13:54:37 -0400392 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000393
Yu Liu56ccb1a2022-11-12 10:47:07 -0800394 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
395 Features: baseAttributes.features,
396 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, m),
Vinh Tran99270ea2022-11-28 11:15:23 -0500397
398 Fdo_profile: compilerAttrs.fdoProfile,
Wei Li81852ca2022-07-27 00:22:06 -0700399 }
Jingwen Chen0ee88a62022-01-07 14:55:29 +0000400
Wei Li81852ca2022-07-27 00:22:06 -0700401 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
Yu Liu56ccb1a2022-11-12 10:47:07 -0800402 sharedTargetAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Jingwen Chen63930982021-03-24 10:04:33 -0400403 }
404
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -0500405 sharedTargetAttrs.Suffix = compilerAttrs.suffix
406
Yu Liu75be7b92022-02-01 09:54:09 -0800407 for axis, configToProps := range m.GetArchVariantProperties(ctx, &LibraryProperties{}) {
Sasha Smundak39a301c2022-12-29 17:11:49 -0800408 for cfg, props := range configToProps {
Yu Liu75be7b92022-02-01 09:54:09 -0800409 if props, ok := props.(*LibraryProperties); ok {
410 if props.Inject_bssl_hash != nil {
411 // This is an edge case applies only to libcrypto
Sam Delmericofae47f92022-08-08 13:35:08 -0400412 if m.Name() == "libcrypto" || m.Name() == "libcrypto_for_testing" {
Sasha Smundak39a301c2022-12-29 17:11:49 -0800413 sharedTargetAttrs.Inject_bssl_hash.SetSelectValue(axis, cfg, props.Inject_bssl_hash)
Yu Liu75be7b92022-02-01 09:54:09 -0800414 } else {
415 ctx.PropertyErrorf("inject_bssl_hash", "only applies to libcrypto")
416 }
417 }
418 }
419 }
420 }
421
Chris Parsons77acf2e2021-12-03 17:27:16 -0500422 staticProps := bazel.BazelTargetModuleProperties{
423 Rule_class: "cc_library_static",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500424 Bzl_load_location: "//build/bazel/rules/cc:cc_library_static.bzl",
Chris Parsons77acf2e2021-12-03 17:27:16 -0500425 }
426 sharedProps := bazel.BazelTargetModuleProperties{
427 Rule_class: "cc_library_shared",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500428 Bzl_load_location: "//build/bazel/rules/cc:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400429 }
430
Vinh Tran55225e32022-12-20 10:38:48 -0500431 var tagsForStaticVariant bazel.StringListAttribute
432 if compilerAttrs.stubsSymbolFile == nil && len(compilerAttrs.stubsVersions.Value) == 0 {
433 tagsForStaticVariant = android.ApexAvailableTags(m)
434 }
435
436 tagsForSharedVariant := android.ApexAvailableTags(m)
437
Chris Parsons58852a02021-12-09 18:10:18 -0500438 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000439 android.CommonAttributes{
440 Name: m.Name() + "_bp2build_cc_library_static",
Vinh Tran55225e32022-12-20 10:38:48 -0500441 Tags: tagsForStaticVariant,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000442 },
Chris Parsons58852a02021-12-09 18:10:18 -0500443 staticTargetAttrs, staticAttrs.Enabled)
444 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000445 android.CommonAttributes{
446 Name: m.Name(),
Vinh Tran55225e32022-12-20 10:38:48 -0500447 Tags: tagsForSharedVariant,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000448 },
Chris Parsons58852a02021-12-09 18:10:18 -0500449 sharedTargetAttrs, sharedAttrs.Enabled)
Wei Li81852ca2022-07-27 00:22:06 -0700450
Trevor Radcliffe087af542022-09-16 15:36:10 +0000451 createStubsBazelTargetIfNeeded(ctx, m, compilerAttrs, exportedIncludes, baseAttributes)
452}
453
454func createStubsBazelTargetIfNeeded(ctx android.TopDownMutatorContext, m *Module, compilerAttrs compilerAttributes, exportedIncludes BazelIncludes, baseAttributes baseAttributes) {
Wei Li81852ca2022-07-27 00:22:06 -0700455 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
456 stubSuitesProps := bazel.BazelTargetModuleProperties{
457 Rule_class: "cc_stub_suite",
458 Bzl_load_location: "//build/bazel/rules/cc:cc_stub_library.bzl",
459 }
460 soname := m.Name() + ".so"
461 stubSuitesAttrs := &bazelCcStubSuiteAttributes{
462 Symbol_file: compilerAttrs.stubsSymbolFile,
463 Versions: compilerAttrs.stubsVersions,
464 Export_includes: exportedIncludes.Includes,
465 Soname: &soname,
466 Source_library: *bazel.MakeLabelAttribute(":" + m.Name()),
467 Deps: baseAttributes.deps,
468 }
469 ctx.CreateBazelTargetModule(stubSuitesProps,
470 android.CommonAttributes{Name: m.Name() + "_stub_libs"},
471 stubSuitesAttrs)
472 }
Jingwen Chen63930982021-03-24 10:04:33 -0400473}
474
Spandan Das4238c652022-09-09 01:38:47 +0000475func apiContributionBp2Build(ctx android.TopDownMutatorContext, module *Module) {
476 apiSurfaces := make([]string, 0)
477 apiHeaders := make([]string, 0)
478 // systemapi (non-null `stubs` property)
479 if module.HasStubsVariants() {
480 apiSurfaces = append(apiSurfaces, android.SystemApi.String())
481 apiIncludes := getSystemApiIncludes(ctx, module)
482 if !apiIncludes.isEmpty() {
483 createApiHeaderTarget(ctx, apiIncludes)
484 apiHeaders = append(apiHeaders, apiIncludes.name)
485 }
486 }
487 // vendorapi (non-null `llndk` property)
488 if module.HasLlndkStubs() {
489 apiSurfaces = append(apiSurfaces, android.VendorApi.String())
490 apiIncludes := getVendorApiIncludes(ctx, module)
491 if !apiIncludes.isEmpty() {
492 createApiHeaderTarget(ctx, apiIncludes)
493 apiHeaders = append(apiHeaders, apiIncludes.name)
494 }
495 }
496 // create a target only if this module contributes to an api surface
497 // TODO: Currently this does not distinguish systemapi-only headers and vendrorapi-only headers
498 // TODO: Update so that systemapi-only headers do not get exported to vendorapi (and vice-versa)
499 if len(apiSurfaces) > 0 {
500 props := bazel.BazelTargetModuleProperties{
501 Rule_class: "cc_api_contribution",
502 Bzl_load_location: "//build/bazel/rules/apis:cc_api_contribution.bzl",
503 }
504 attrs := &bazelCcApiContributionAttributes{
505 Library_name: module.Name(),
506 Api_surfaces: bazel.MakeStringListAttribute(apiSurfaces),
507 Api: apiLabelAttribute(ctx, module),
508 Hdrs: bazel.MakeLabelListAttribute(
509 bazel.MakeLabelListFromTargetNames(apiHeaders),
510 ),
511 }
512 ctx.CreateBazelTargetModule(
513 props,
514 android.CommonAttributes{
515 Name: android.ApiContributionTargetName(module.Name()),
516 SkipData: proptools.BoolPtr(true),
517 },
518 attrs,
519 )
520 }
521}
522
523// Native apis are versioned in a single .map.txt for all api surfaces
524// Pick any one of the .map.txt files
525func apiLabelAttribute(ctx android.TopDownMutatorContext, module *Module) bazel.LabelAttribute {
526 var apiFile *string
527 linker := module.linker.(*libraryDecorator)
528 if llndkApi := linker.Properties.Llndk.Symbol_file; llndkApi != nil {
529 apiFile = llndkApi
530 } else if systemApi := linker.Properties.Stubs.Symbol_file; systemApi != nil {
531 apiFile = systemApi
532 } else {
533 ctx.ModuleErrorf("API surface library does not have any API file")
534 }
535 apiLabel := android.BazelLabelForModuleSrcSingle(ctx, proptools.String(apiFile)).Label
536 return *bazel.MakeLabelAttribute(apiLabel)
537}
538
539// wrapper struct to flatten the arch and os specific export_include_dirs
540// flattening is necessary since we want to export apis of all arches even when we build for x86 (e.g.)
541type bazelCcApiLibraryHeadersAttributes struct {
542 bazelCcLibraryHeadersAttributes
543
544 Arch *string
545}
546
547func (a *bazelCcApiLibraryHeadersAttributes) isEmpty() bool {
548 return a.Export_includes.IsEmpty() &&
549 a.Export_system_includes.IsEmpty() &&
550 a.Deps.IsEmpty()
551}
552
553type apiIncludes struct {
554 name string // name of the Bazel target in the generated bp2build workspace
555 attrs bazelCcApiLibraryHeadersAttributes
556}
557
558func (includes *apiIncludes) isEmpty() bool {
559 return includes.attrs.isEmpty()
560}
561
562func (includes *apiIncludes) addDep(name string) {
563 l := bazel.Label{Label: ":" + name}
564 ll := bazel.MakeLabelList([]bazel.Label{l})
565 lla := bazel.MakeLabelListAttribute(ll)
566 includes.attrs.Deps.Append(lla)
567}
568
569func getSystemApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
570 flagProps := c.library.(*libraryDecorator).flagExporter.Properties
571 linkProps := c.library.(*libraryDecorator).baseLinker.Properties
572 includes := android.FirstUniqueStrings(flagProps.Export_include_dirs)
573 systemIncludes := android.FirstUniqueStrings(flagProps.Export_system_include_dirs)
574 headerLibs := android.FirstUniqueStrings(linkProps.Export_header_lib_headers)
575 attrs := bazelCcLibraryHeadersAttributes{
576 Export_includes: bazel.MakeStringListAttribute(includes),
577 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
578 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, headerLibs)),
579 }
580
581 return apiIncludes{
582 name: c.Name() + ".systemapi.headers",
583 attrs: bazelCcApiLibraryHeadersAttributes{
584 bazelCcLibraryHeadersAttributes: attrs,
585 },
586 }
587}
588
589func getVendorApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
590 baseProps := c.library.(*libraryDecorator).flagExporter.Properties
591 llndkProps := c.library.(*libraryDecorator).Properties.Llndk
592 includes := baseProps.Export_include_dirs
593 systemIncludes := baseProps.Export_system_include_dirs
594 // LLNDK can override the base includes
595 if llndkIncludes := llndkProps.Override_export_include_dirs; llndkIncludes != nil {
596 includes = llndkIncludes
597 }
598 if proptools.Bool(llndkProps.Export_headers_as_system) {
599 systemIncludes = append(systemIncludes, includes...)
600 includes = nil
601 }
602
603 attrs := bazelCcLibraryHeadersAttributes{
604 Export_includes: bazel.MakeStringListAttribute(includes),
605 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
606 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, llndkProps.Export_llndk_headers)),
607 }
608 return apiIncludes{
609 name: c.Name() + ".vendorapi.headers",
610 attrs: bazelCcApiLibraryHeadersAttributes{
611 bazelCcLibraryHeadersAttributes: attrs,
612 },
613 }
614}
615
Patrice Arruda83c89e02019-03-25 15:32:39 -0700616// cc_library creates both static and/or shared libraries for a device and/or
617// host. By default, a cc_library has a single variant that targets the device.
618// Specifying `host_supported: true` also creates a library that targets the
619// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700620func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800621 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000622 // Can be used as both a static and a shared library.
623 module.sdkMemberTypes = []android.SdkMemberType{
624 sharedLibrarySdkMemberType,
625 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000626 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000627 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400628 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400629 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700630 return module.Init()
631}
632
Patrice Arruda83c89e02019-03-25 15:32:39 -0700633// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700634func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800635 module, library := NewLibrary(android.HostAndDeviceSupported)
636 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000637 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400638 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400639 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700640 return module.Init()
641}
642
Patrice Arruda83c89e02019-03-25 15:32:39 -0700643// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700644func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800645 module, library := NewLibrary(android.HostAndDeviceSupported)
646 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000647 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400648 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000649 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700650 return module.Init()
651}
652
Patrice Arruda83c89e02019-03-25 15:32:39 -0700653// cc_library_host_static creates a static library that is linkable to a host
654// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700655func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800656 module, library := NewLibrary(android.HostSupported)
657 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000658 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000659 module.bazelable = true
660 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700661 return module.Init()
662}
663
Patrice Arruda83c89e02019-03-25 15:32:39 -0700664// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700665func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800666 module, library := NewLibrary(android.HostSupported)
667 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000668 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800669 module.bazelable = true
670 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700671 return module.Init()
672}
673
Chris Parsons3c27ca32020-11-20 12:42:07 -0500674// flagExporter is a separated portion of libraryDecorator pertaining to exported
675// include paths and flags. Keeping this dependency-related information separate
676// from the rest of library information is helpful in keeping data more structured
677// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700678type flagExporter struct {
679 Properties FlagExporterProperties
680
Chris Parsons3c27ca32020-11-20 12:42:07 -0500681 dirs android.Paths // Include directories to be included with -I
682 systemDirs android.Paths // System include directories to be included with -isystem
683 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900684 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900685 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700686}
687
Chris Parsons3c27ca32020-11-20 12:42:07 -0500688// exportedIncludes returns the effective include paths for this module and
689// any module that links against this module. This is obtained from
690// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700691func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900692 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800693 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700694 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900695 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
696 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
697 }
698 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700699}
700
Chris Parsons3c27ca32020-11-20 12:42:07 -0500701// exportIncludes registers the include directories and system include directories to be exported
702// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900703func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900704 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900705 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700706}
707
Chris Parsons3c27ca32020-11-20 12:42:07 -0500708// exportIncludesAsSystem registers the include directories and system include directories to be
709// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900710func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900711 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900712 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900713 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900714}
715
Chris Parsons3c27ca32020-11-20 12:42:07 -0500716// reexportDirs registers the given directories as include directories to be exported transitively
717// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900718func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900719 f.dirs = append(f.dirs, dirs...)
720}
721
Chris Parsons3c27ca32020-11-20 12:42:07 -0500722// reexportSystemDirs registers the given directories as system include directories
723// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900724func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900725 f.systemDirs = append(f.systemDirs, dirs...)
726}
727
Chris Parsons3c27ca32020-11-20 12:42:07 -0500728// reexportFlags registers the flags to be exported transitively to modules depending on this
729// module.
Inseob Kim69378442019-06-03 19:10:47 +0900730func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800731 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
732 panic(fmt.Errorf("Exporting invalid flag %q: "+
733 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900734 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700735 f.flags = append(f.flags, flags...)
736}
737
Inseob Kim69378442019-06-03 19:10:47 +0900738func (f *flagExporter) reexportDeps(deps ...android.Path) {
739 f.deps = append(f.deps, deps...)
740}
741
Inseob Kimd110f872019-12-06 13:15:38 +0900742// addExportedGeneratedHeaders does nothing but collects generated header files.
743// This can be differ to exportedDeps which may contain phony files to minimize ninja.
744func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
745 f.headers = append(f.headers, headers...)
746}
747
Colin Cross0de8a1e2020-09-18 14:15:30 -0700748func (f *flagExporter) setProvider(ctx android.ModuleContext) {
749 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400750 // Comes from Export_include_dirs property, and those of exported transitive deps
751 IncludeDirs: android.FirstUniquePaths(f.dirs),
752 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700753 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400754 // Used in very few places as a one-off way of adding extra defines.
755 Flags: f.flags,
756 // Used sparingly, for extra files that need to be explicitly exported to dependers,
757 // or for phony files to minimize ninja.
758 Deps: f.deps,
759 // For exported generated headers, such as exported aidl headers, proto headers, or
760 // sysprop headers.
761 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700762 })
Inseob Kim69378442019-06-03 19:10:47 +0900763}
764
Colin Crossb916a382016-07-29 17:28:03 -0700765// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
766// functionality: static vs. shared linkage, reusing object files for shared libraries
767type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800768 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700769 StaticProperties StaticProperties
770 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800771 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700772
773 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900774 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700775
Colin Cross26c34ed2016-09-30 17:10:16 -0700776 // table-of-contents file to optimize out relinking when possible
777 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700778
Colin Cross4d9c2d12016-07-29 12:48:20 -0700779 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400780 flagExporterInfo *FlagExporterInfo
781 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700782
Colin Cross4d9c2d12016-07-29 12:48:20 -0700783 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800784 objects Objects
785 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700786
787 // Uses the module's name if empty, but can be overridden. Does not include
788 // shlib suffix.
789 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700790
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800791 sabi *sabi
792
Dan Willemsen581341d2017-02-09 16:16:31 -0800793 // Output archive of gcno coverage information files
794 coverageOutputFile android.OptionalPath
795
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800796 // linked Source Abi Dump
797 sAbiOutputFile android.OptionalPath
798
799 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800800 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000801
Colin Cross0875c522017-11-28 17:34:01 -0800802 // Location of the static library in the sysroot. Empty if the library is
803 // not included in the NDK.
804 ndkSysrootPath android.Path
805
Colin Crossb60190a2018-09-04 16:28:17 -0700806 // Location of the linked, unstripped library for shared libraries
807 unstrippedOutputFile android.Path
808
Dan Willemsen569edc52018-11-19 09:33:29 -0800809 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000810 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800811
Colin Cross8e21aa52020-09-28 18:28:02 -0700812 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900813
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800814 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900815
Vic Yangefd249e2018-11-12 20:19:56 -0800816 // If useCoreVariant is true, the vendor variant of a VNDK library is
817 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800818 useCoreVariant bool
819 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800820
Colin Cross5ec407b2020-09-30 11:41:33 -0700821 skipAPIDefine bool
822
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100823 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700824 *baseCompiler
825 *baseLinker
826 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900827
828 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700829
830 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900831}
832
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400833type ccLibraryBazelHandler struct {
Chris Parsons808d84c2021-03-09 20:43:32 -0500834 module *Module
835}
836
Chris Parsons6ce2cf92022-05-20 10:54:17 -0400837var _ BazelHandler = (*ccLibraryBazelHandler)(nil)
838
Chris Parsons94a0bba2021-06-04 15:03:47 -0400839// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
840// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400841func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400842 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400843 if len(rootStaticArchives) != 1 {
844 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsonsf874e462022-05-10 13:50:12 -0400845 return
Chris Parsons944e7d02021-03-11 11:08:46 -0500846 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400847 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500848 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
849
Chris Parsons94a0bba2021-06-04 15:03:47 -0400850 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500851 objFiles := make(android.Paths, len(objPaths))
852 for i, objPath := range objPaths {
853 objFiles[i] = android.PathForBazelOut(ctx, objPath)
854 }
855 objects := Objects{
856 objFiles: objFiles,
857 }
858
859 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
860 StaticLibrary: outputFilePath,
861 ReuseObjects: objects,
862 Objects: objects,
863
Chris Parsons94a0bba2021-06-04 15:03:47 -0400864 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500865 // static libraries with deps.
866 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
867 Direct(outputFilePath).
868 Build(),
869 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400870
Chris Parsonsf874e462022-05-10 13:50:12 -0400871 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400872}
873
874// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
875// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400876func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400877 rootDynamicLibraries := ccInfo.RootDynamicLibraries
878
879 if len(rootDynamicLibraries) != 1 {
880 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
Chris Parsonsf874e462022-05-10 13:50:12 -0400881 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400882 }
883 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
884 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
885
Sasha Smundakedd16662022-10-07 14:44:50 -0700886 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = android.PathForBazelOut(ctx, ccInfo.UnstrippedOutput)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400887
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000888 var tocFile android.OptionalPath
889 if len(ccInfo.TocFile) > 0 {
890 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
891 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400892 handler.module.linker.(*libraryDecorator).tocFile = tocFile
893
Yu Liu24214aa2022-11-22 12:30:59 -0800894 if len(ccInfo.AbiDiffFiles) > 0 {
895 handler.module.linker.(*libraryDecorator).sAbiDiff = android.PathsForBazelOut(ctx, ccInfo.AbiDiffFiles)
896 }
897
Chris Parsons94a0bba2021-06-04 15:03:47 -0400898 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
899 TableOfContents: tocFile,
900 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000901 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400902 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000903 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400904 })
Chris Parsons94a0bba2021-06-04 15:03:47 -0400905}
906
Chris Parsonsf874e462022-05-10 13:50:12 -0400907func (handler *ccLibraryBazelHandler) QueueBazelCall(ctx android.BaseModuleContext, label string) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400908 bazelCtx := ctx.Config().BazelContext
Chris Parsonsf874e462022-05-10 13:50:12 -0400909 bazelCtx.QueueBazelRequest(label, cquery.GetCcInfo, android.GetConfigKey(ctx))
910}
911
912func (handler *ccLibraryBazelHandler) ProcessBazelQueryResponse(ctx android.ModuleContext, label string) {
913 bazelCtx := ctx.Config().BazelContext
914 ccInfo, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400915 if err != nil {
916 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
Chris Parsonsf874e462022-05-10 13:50:12 -0400917 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400918 }
919
920 if handler.module.static() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400921 handler.generateStaticBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400922 } else if handler.module.Shared() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400923 handler.generateSharedBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400924 } else {
Chris Parsonsf874e462022-05-10 13:50:12 -0400925 ctx.ModuleErrorf("Unhandled bazel case for %s (neither shared nor static!)", ctx.ModuleName())
Chris Parsons94a0bba2021-06-04 15:03:47 -0400926 }
927
928 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
929 handler.module.maybeUnhideFromMake()
930
Chris Parsonseefc9e62021-04-02 17:36:47 -0400931 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
932 // Dependencies on this library will expect collectedSnapshotHeaders to
933 // be set, otherwise validation will fail. For now, set this to an empty
934 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400935 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400936 // implementation.
937 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
938 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500939}
940
Chris Parsons94a0bba2021-06-04 15:03:47 -0400941func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
942 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
943 // flag exporters consolidates properties like includes, flags, dependencies that should be
944 // exported from this module to other modules
945 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
946 // Store flag info to be passed along to androidmk
947 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
948 library.flagExporterInfo = &flagExporterInfo
949}
950
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400951func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900952 ret := android.Paths{}
953
954 // Headers in the source tree should be globbed. On the contrast, generated headers
955 // can't be globbed, and they should be manually collected.
956 // So, we first filter out intermediate directories (which contains generated headers)
957 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400958 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900959 dir := path.String()
960 // Skip if dir is for generated headers
Spandan Das925cb2a2022-11-03 16:34:12 +0000961 if strings.HasPrefix(dir, ctx.Config().OutDir()) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900962 continue
963 }
Yu Liu1175c052022-08-15 10:21:31 -0700964
965 // Filter out the generated headers from bazel.
966 if strings.HasPrefix(dir, android.PathForBazelOut(ctx, "bazel-out").String()) {
967 continue
968 }
969
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900970 // libeigen wrongly exports the root directory "external/eigen". But only two
971 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
972 // some of them have no extension. So we need special treatment for libeigen in order
973 // to glob correctly.
974 if dir == "external/eigen" {
975 // Only these two directories contains exported headers.
976 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
Liz Kammer0ea79982022-02-07 08:51:47 -0500977 globDir := "external/eigen/" + subdir + "/**/*"
978 glob, err := ctx.GlobWithDeps(globDir, nil)
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900979 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500980 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400981 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900982 }
983 for _, header := range glob {
984 if strings.HasSuffix(header, "/") {
985 continue
986 }
987 ext := filepath.Ext(header)
988 if ext != "" && ext != ".h" {
989 continue
990 }
991 ret = append(ret, android.PathForSource(ctx, header))
992 }
993 }
994 continue
995 }
Liz Kammer0ea79982022-02-07 08:51:47 -0500996 globDir := dir + "/**/*"
997 glob, err := ctx.GlobWithDeps(globDir, nil)
Colin Crossec118d02021-01-22 18:05:59 +0000998 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500999 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001000 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001001 }
Colin Crossec118d02021-01-22 18:05:59 +00001002 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -07001003 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +00001004 if isLibcxx {
1005 // Glob all files under this special directory, because of C++ headers with no
1006 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -07001007 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001008 continue
1009 }
Colin Crossec118d02021-01-22 18:05:59 +00001010 } else {
1011 // Filter out only the files with extensions that are headers.
1012 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001013 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +00001014 if strings.HasSuffix(header, ext) {
1015 found = true
1016 break
1017 }
1018 }
1019 if !found {
1020 continue
1021 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001022 }
Jose Galmes0d736912021-03-30 11:00:06 -07001023 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001024 }
1025 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001026 return ret
1027}
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001028
Sasha Smundak39a301c2022-12-29 17:11:49 -08001029func GlobGeneratedHeadersForSnapshot(_ android.ModuleContext, paths android.Paths) android.Paths {
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001030 ret := android.Paths{}
1031 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001032 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
1033 if strings.HasSuffix(header.Base(), "-phony") {
1034 continue
1035 }
1036 ret = append(ret, header)
1037 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001038 return ret
1039}
1040
1041// collectHeadersForSnapshot collects all exported headers from library.
1042// It globs header files in the source tree for exported include directories,
1043// and tracks generated header files separately.
1044//
1045// This is to be called from GenerateAndroidBuildActions, and then collected
1046// header files can be retrieved by snapshotHeaders().
1047func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
1048 ret := android.Paths{}
1049
1050 // Headers in the source tree should be globbed. On the contrast, generated headers
1051 // can't be globbed, and they should be manually collected.
1052 // So, we first filter out intermediate directories (which contains generated headers)
1053 // from exported directories, and then glob headers under remaining directories.
1054 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
1055
1056 // Collect generated headers
1057 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001058
1059 l.collectedSnapshotHeaders = ret
1060}
1061
1062// This returns all exported header files, both generated ones and headers from source tree.
1063// collectHeadersForSnapshot() must be called before calling this.
1064func (l *libraryDecorator) snapshotHeaders() android.Paths {
1065 if l.collectedSnapshotHeaders == nil {
1066 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
1067 }
1068 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -07001069}
1070
Chris Parsons3c27ca32020-11-20 12:42:07 -05001071// linkerProps returns the list of properties structs relevant for this library. (For example, if
1072// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -07001073func (library *libraryDecorator) linkerProps() []interface{} {
1074 var props []interface{}
1075 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001076 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001077 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -08001078 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001079 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -07001080 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001081
1082 if library.MutatedProperties.BuildShared {
1083 props = append(props, &library.SharedProperties)
1084 }
1085 if library.MutatedProperties.BuildStatic {
1086 props = append(props, &library.StaticProperties)
1087 }
1088
1089 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -07001090}
1091
Chris Parsons3c27ca32020-11-20 12:42:07 -05001092// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
1093// library, or that are implied by attributes of this library (such as whether this library is a
1094// shared library).
Colin Crossb916a382016-07-29 17:28:03 -07001095func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -07001096 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001097
Colin Crossb916a382016-07-29 17:28:03 -07001098 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
1099 // all code is position independent, and then those warnings get promoted to
1100 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -07001101 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001102 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -07001103 }
1104
1105 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001106 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001107 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001108 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -07001109 }
1110
Colin Crossa48ab5b2017-02-14 15:28:44 -08001111 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001112 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001113 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -07001114 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001115 f = append(f,
1116 "-nostdlib",
1117 "-Wl,--gc-sections",
1118 )
1119 }
1120
1121 if ctx.Darwin() {
1122 f = append(f,
1123 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -07001124 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
1125 )
Colin Cross7863cf52016-10-20 10:47:21 -07001126 if ctx.Arch().ArchType == android.X86 {
1127 f = append(f,
1128 "-read_only_relocs suppress",
1129 )
1130 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001131 } else {
Josh Gao75a50a22019-06-07 17:58:59 -07001132 f = append(f, "-shared")
1133 if !ctx.Windows() {
1134 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
1135 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001136 }
1137
Colin Cross4af21ed2019-11-04 09:37:55 -08001138 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001139 }
1140
1141 return flags
1142}
1143
Chris Parsons3c27ca32020-11-20 12:42:07 -05001144// compilerFlags takes a Flags and augments it to contain compile flags from global values,
1145// per-target values, module type values, per-module Blueprints properties, extra flags from
1146// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -08001147func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001148 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001149 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -07001150 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -08001151 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
1152 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001153 }
1154
Jiyong Park7ed9de32018-10-15 22:25:07 +09001155 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -08001156 if ctx.IsLlndk() {
1157 // LLNDK libraries ignore most of the properties on the cc_library and use the
1158 // LLNDK-specific properties instead.
1159 // Wipe all the module-local properties, leaving only the global properties.
1160 flags.Local = LocalOrGlobalFlags{}
1161 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001162 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +09001163 // Remove -include <file> when compiling stubs. Otherwise, the force included
1164 // headers might cause conflicting types error with the symbols in the
1165 // generated stubs source code. e.g.
1166 // double acos(double); // in header
1167 // void acos() {} // in the generated source code
1168 removeInclude := func(flags []string) []string {
1169 ret := flags[:0]
1170 for _, f := range flags {
1171 if strings.HasPrefix(f, "-include ") {
1172 continue
1173 }
1174 ret = append(ret, f)
1175 }
1176 return ret
1177 }
Colin Cross4af21ed2019-11-04 09:37:55 -08001178 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
1179 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +09001180
Jiyong Park7ed9de32018-10-15 22:25:07 +09001181 flags = addStubLibraryCompilerFlags(flags)
1182 }
1183 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -07001184}
1185
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001186func (library *libraryDecorator) getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties {
1187 m := ctx.Module().(*Module)
1188 variantProps := &library.Properties.Target.Platform.Header_abi_checker
1189 if m.InVendor() {
1190 variantProps = &library.Properties.Target.Vendor.Header_abi_checker
1191 } else if m.InProduct() {
1192 variantProps = &library.Properties.Target.Product.Header_abi_checker
1193 }
1194 props := library.Properties.Header_abi_checker
1195 err := proptools.AppendProperties(&props, variantProps, nil)
1196 if err != nil {
1197 ctx.ModuleErrorf("Cannot merge headerAbiCheckerProperties: %s", err.Error())
1198 }
1199 return props
Logan Chien41eabe62019-04-10 13:33:58 +08001200}
1201
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001202func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -08001203 if ctx.IsLlndk() {
1204 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
1205 vndkVer := ctx.Module().(*Module).VndkVersion()
1206 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
1207 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
1208 vndkVer = "current"
1209 }
1210 if library.stubsVersion() != "" {
1211 vndkVer = library.stubsVersion()
1212 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001213 nativeAbiResult := parseNativeAbiDefinition(ctx,
1214 String(library.Properties.Llndk.Symbol_file),
1215 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
1216 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -08001217 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001218 library.versionScriptPath = android.OptionalPathForPath(
1219 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -08001220 }
1221 return objs
1222 }
Colin Cross5271fea2021-04-27 13:06:04 -07001223 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -07001224 nativeAbiResult := parseNativeAbiDefinition(ctx,
1225 String(library.Properties.Vendor_public_library.Symbol_file),
1226 android.FutureApiLevel, "")
1227 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001228 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001229 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001230 }
1231 return objs
1232 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001233 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001234 symbolFile := String(library.Properties.Stubs.Symbol_file)
1235 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1236 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1237 return Objects{}
1238 }
Jiyong Park85cc35a2022-07-17 11:30:47 +09001239 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
1240 // systemapi, respectively. The former is for symbols defined in platform libraries
1241 // and the latter is for symbols defined in APEXes.
1242 var flag string
1243 if ctx.Module().(android.ApexModule).NotInPlatform() {
1244 flag = "--apex"
1245 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +09001246 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +09001247 }
Jiyong Parkaa27c082022-09-26 21:16:09 +09001248 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
1249 // the stub so that it is mandated that all symbols are explicitly marked with
1250 // either apex or systemapi.
1251 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
1252 flag = flag + " --no-ndk"
1253 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001254 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +09001255 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -07001256 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1257 library.versionScriptPath = android.OptionalPathForPath(
1258 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001259
1260 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001261 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001262 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1263 }
1264
Jiyong Park7ed9de32018-10-15 22:25:07 +09001265 return objs
1266 }
1267
Colin Cross5950f382016-12-13 12:50:57 -08001268 if !library.buildShared() && !library.buildStatic() {
1269 if len(library.baseCompiler.Properties.Srcs) > 0 {
1270 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1271 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001272 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001273 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1274 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001275 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001276 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1277 }
1278 return Objects{}
1279 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001280 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001281 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001282 var SourceAbiFlags []string
1283 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001284 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001285 }
Inseob Kim69378442019-06-03 19:10:47 +09001286 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1287 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001288 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001289 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001290 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001291 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001292 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001293 flags.SAbiDump = true
1294 }
1295 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001296 objs := library.baseCompiler.compile(ctx, flags, deps)
1297 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001298 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001299
Colin Cross4d9c2d12016-07-29 12:48:20 -07001300 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001301 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001302 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1303 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001304 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001305 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001306 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001307 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001308 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1309 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001310 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001311 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001312 }
1313
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001314 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001315}
1316
1317type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001318 versionedInterface
1319
Colin Crossb916a382016-07-29 17:28:03 -07001320 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001321 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001322 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001323 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001324 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001325
1326 // Returns true if the build options for the module have selected a static or shared build
1327 buildStatic() bool
1328 buildShared() bool
1329
1330 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001331 setStatic()
1332 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001333
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001334 // Gets the ABI properties for vendor, product, or platform variant
1335 getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001336
Logan Chien41eabe62019-04-10 13:33:58 +08001337 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1338 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001339
1340 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001341
1342 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001343
1344 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001345}
1346
Colin Crossc88c2722020-09-28 17:32:47 -07001347type versionedInterface interface {
1348 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001349 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001350 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +00001351 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001352 setStubsVersion(string)
1353 stubsVersion() string
1354
Colin Cross3572cf72020-10-01 15:58:11 -07001355 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001356 setAllStubsVersions([]string)
1357 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001358
1359 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001360 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001361 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001362 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001363}
1364
1365var _ libraryInterface = (*libraryDecorator)(nil)
1366var _ versionedInterface = (*libraryDecorator)(nil)
1367
Justin Yun6977e8a2020-10-29 18:24:11 +09001368func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001369 name := library.libName
1370 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001371 name = String(library.Properties.Stem)
1372 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001373 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001374 }
Colin Crossb916a382016-07-29 17:28:03 -07001375 }
1376
Colin Cross0fd6a412019-08-16 14:22:10 -07001377 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001378 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001379 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001380 } else if inProduct {
1381 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001382 }
1383 if suffix == "" {
1384 suffix = String(library.Properties.Suffix)
1385 }
1386
Jooyung Han0302a842019-10-30 18:43:49 +09001387 return name + suffix
1388}
1389
Chris Parsons3c27ca32020-11-20 12:42:07 -05001390// getLibName returns the actual canonical name of the library (the name which
1391// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001392func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001393 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001394
Ivan Lozanof9e21722020-12-02 09:00:51 -05001395 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001396 // vndk-ext lib should have the same name with original lib
1397 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1398 originalName := module.(*Module).outputFile.Path()
1399 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1400 })
Logan Chienf3511742017-10-31 18:04:35 +08001401 }
1402
Colin Crossb916a382016-07-29 17:28:03 -07001403 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1404 if !strings.HasSuffix(name, "-host") {
1405 name = name + "-host"
1406 }
1407 }
1408
Inseob Kim0ce291e2019-07-04 14:38:27 +09001409 return name
Colin Crossb916a382016-07-29 17:28:03 -07001410}
1411
Jiyong Parkda732bd2018-11-02 18:23:15 +09001412var versioningMacroNamesListMutex sync.Mutex
1413
Colin Crossb916a382016-07-29 17:28:03 -07001414func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1415 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001416 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001417 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001418 }
1419 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001420 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001421 // Let baseLinker know whether this variant is for stubs or not, so that
1422 // it can omit things that are not required for linking stubs.
1423 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001424
1425 if library.buildStubs() {
1426 macroNames := versioningMacroNamesList(ctx.Config())
1427 myName := versioningMacroName(ctx.ModuleName())
1428 versioningMacroNamesListMutex.Lock()
1429 defer versioningMacroNamesListMutex.Unlock()
1430 if (*macroNames)[myName] == "" {
1431 (*macroNames)[myName] = ctx.ModuleName()
1432 } else if (*macroNames)[myName] != ctx.ModuleName() {
1433 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1434 }
1435 }
Colin Crossb916a382016-07-29 17:28:03 -07001436}
1437
dimitry0345ad82018-12-05 16:28:14 +01001438func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001439 if ctx.IsLlndk() {
1440 // LLNDK libraries ignore most of the properties on the cc_library and use the
1441 // LLNDK-specific properties instead.
1442 return deps
1443 }
1444
dimitry0345ad82018-12-05 16:28:14 +01001445 deps = library.baseCompiler.compilerDeps(ctx, deps)
1446
dimitry0345ad82018-12-05 16:28:14 +01001447 return deps
1448}
1449
Colin Cross37047f12016-12-13 17:06:13 -08001450func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001451 if ctx.IsLlndk() {
1452 // LLNDK libraries ignore most of the properties on the cc_library and use the
1453 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001454 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1455 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001456 return deps
1457 }
Colin Cross5271fea2021-04-27 13:06:04 -07001458 if ctx.IsVendorPublicLibrary() {
1459 headers := library.Properties.Vendor_public_library.Export_public_headers
1460 deps.HeaderLibs = append([]string(nil), headers...)
1461 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1462 return deps
1463 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001464
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001465 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001466 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001467 if library.StaticProperties.Static.System_shared_libs != nil {
1468 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001469 }
1470 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001471 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001472 if library.SharedProperties.Shared.System_shared_libs != nil {
1473 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001474 }
1475 }
1476
Colin Crossb916a382016-07-29 17:28:03 -07001477 deps = library.baseLinker.linkerDeps(ctx, deps)
1478
1479 if library.static() {
1480 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001481 library.StaticProperties.Static.Whole_static_libs...)
1482 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1483 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001484
Colin Crosse1bb5d02019-09-24 14:55:04 -07001485 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1486 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001487 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001488 if !Bool(library.baseLinker.Properties.Nocrt) {
1489 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1490 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001491 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001492 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1493 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1494 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001495
Colin Crosse1bb5d02019-09-24 14:55:04 -07001496 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1497 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001498 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001499 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001500 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1501 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1502 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001503 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1504 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001505 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001506 if ctx.inProduct() {
1507 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1508 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1509 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1510 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1511 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1512 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001513 if ctx.inRecovery() {
1514 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1515 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1516 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001517 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1518 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001519 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001520 if ctx.inRamdisk() {
1521 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1522 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1523 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1524 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1525 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1526 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001527 if ctx.inVendorRamdisk() {
1528 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1529 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1530 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1531 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1532 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1533 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001534
Colin Cross4d9c2d12016-07-29 12:48:20 -07001535 return deps
1536}
1537
Paul Duffin13f02712020-03-06 12:30:43 +00001538func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1539 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1540 var properties StaticOrSharedProperties
1541 if library.static() {
1542 properties = library.StaticProperties.Static
1543 } else if library.shared() {
1544 properties = library.SharedProperties.Shared
1545 }
1546
1547 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001548
1549 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1550 // either input list doesn't come out as nil.
1551 if specifiedDeps.systemSharedLibs == nil {
1552 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1553 } else {
1554 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1555 }
Paul Duffin13f02712020-03-06 12:30:43 +00001556
1557 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001558 if len(specifiedDeps.systemSharedLibs) > 0 {
1559 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1560 // retained.
1561 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1562 }
Paul Duffin13f02712020-03-06 12:30:43 +00001563 return specifiedDeps
1564}
1565
Colin Crossb916a382016-07-29 17:28:03 -07001566func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001567 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001568
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001569 library.objects = deps.WholeStaticLibObjs.Copy()
1570 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001571 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001572
Inseob Kim0ce291e2019-07-04 14:38:27 +09001573 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001574 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001575 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001576
Dan Willemsen569edc52018-11-19 09:33:29 -08001577 if Bool(library.baseLinker.Properties.Use_version_lib) {
1578 if ctx.Host() {
1579 versionedOutputFile := outputFile
1580 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1581 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1582 } else {
1583 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001584 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001585 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1586 }
Colin Cross86803cf2018-02-15 14:12:26 -08001587 }
1588
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001589 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001590
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001591 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001592
Colin Cross4d9c2d12016-07-29 12:48:20 -07001593 ctx.CheckbuildFile(outputFile)
1594
Colin Cross649d8172020-12-10 12:30:21 -08001595 if library.static() {
1596 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001597 StaticLibrary: outputFile,
1598 ReuseObjects: library.reuseObjects,
1599 Objects: library.objects,
1600 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001601
Colin Cross649d8172020-12-10 12:30:21 -08001602 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1603 Direct(outputFile).
1604 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1605 Build(),
1606 })
1607 }
1608
1609 if library.header() {
1610 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1611 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001612
Colin Cross4d9c2d12016-07-29 12:48:20 -07001613 return outputFile
1614}
1615
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001616func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1617 if ctx.Module().(*Module).IsSdkVariant() {
1618 // The NDK sysroot timestamp file depends on all the NDK
1619 // sysroot header and shared library files.
1620 return android.Paths{getNdkBaseTimestampFile(ctx)}
1621 }
1622 return nil
1623}
1624
Colin Crossb916a382016-07-29 17:28:03 -07001625func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001626 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001627
1628 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001629 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001630 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001631
Colin Cross2383f3b2018-02-06 14:40:13 -08001632 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1633 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1634 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001635 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001636 if unexportedSymbols.Valid() {
1637 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1638 }
1639 if forceNotWeakSymbols.Valid() {
1640 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1641 }
1642 if forceWeakSymbols.Valid() {
1643 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1644 }
1645 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001646 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001647 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001648 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1649 }
1650 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001651 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001652 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1653 }
1654 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001655 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001656 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1657 }
1658 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001659 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001660 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001661 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001662 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001663 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001664
1665 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1666 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001667 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001668
Josh Gao75a50a22019-06-07 17:58:59 -07001669 var implicitOutputs android.WritablePaths
1670 if ctx.Windows() {
1671 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1672
Colin Cross4af21ed2019-11-04 09:37:55 -08001673 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001674 implicitOutputs = append(implicitOutputs, importLibraryPath)
1675 }
1676
Colin Cross4d9c2d12016-07-29 12:48:20 -07001677 builderFlags := flagsToBuilderFlags(flags)
1678
Dan Willemsen47450072021-10-19 20:24:49 -07001679 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1680 fatOutputFile := outputFile
1681 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1682 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1683 }
1684
Colin Crossb496cfd2018-09-10 16:50:05 -07001685 // Optimize out relinking against shared libraries whose interface hasn't changed by
1686 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001687 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001688 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001689 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001690
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001691 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001692 needsStrip := library.stripper.NeedsStrip(ctx)
1693 if library.buildStubs() {
1694 // No need to strip stubs libraries
1695 needsStrip = false
1696 }
1697 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001698 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001699 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001700 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001701 strippedOutputFile := outputFile
1702 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001703 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001704 }
Colin Crossb60190a2018-09-04 16:28:17 -07001705 library.unstrippedOutputFile = outputFile
1706
Colin Crossd7227f92019-09-05 14:26:33 -07001707 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001708
Dan Willemsen569edc52018-11-19 09:33:29 -08001709 if Bool(library.baseLinker.Properties.Use_version_lib) {
1710 if ctx.Host() {
1711 versionedOutputFile := outputFile
1712 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1713 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1714 } else {
1715 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001716 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001717
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001718 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001719 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001720 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001721 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001722 }
1723
1724 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1725 }
Colin Cross86803cf2018-02-15 14:12:26 -08001726 }
1727
Jiyong Park64a44f22019-01-18 14:37:08 +09001728 sharedLibs := deps.EarlySharedLibs
1729 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001730 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1731
Jiyong Park64a44f22019-01-18 14:37:08 +09001732 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001733 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1734 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001735 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001736 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001737 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001738
Dan Willemsen581341d2017-02-09 16:16:31 -08001739 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1740 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001741 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1742 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1743
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001744 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001745 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001746
Liz Kammeref6dfea2021-06-08 15:37:09 -04001747 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001748 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1749 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001750 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001751 }
1752
1753 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001754 TableOfContents: android.OptionalPathForPath(tocFile),
1755 SharedLibrary: unstrippedOutputFile,
1756 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1757 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001758 })
1759
1760 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1761 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001762 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001763 for _, stub := range stubs {
1764 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1765 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001766 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001767 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001768 SharedLibraryInfo: stubInfo,
1769 FlagExporterInfo: flagInfo,
1770 })
1771 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001772 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1773 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001774
Colin Cross127bb8b2020-12-16 16:46:01 -08001775 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001776 })
1777 }
1778
1779 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001780}
1781
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001782func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1783 return library.unstrippedOutputFile
1784}
1785
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001786func (library *libraryDecorator) disableStripping() {
1787 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1788}
1789
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001790func (library *libraryDecorator) nativeCoverage() bool {
1791 if library.header() || library.buildStubs() {
1792 return false
1793 }
1794 return true
1795}
1796
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001797func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1798 return library.coverageOutputFile
1799}
1800
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001801func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1802 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001803
1804 currentArchType := ctx.Arch().ArchType
1805 primaryArchType := ctx.Config().DevicePrimaryArchType()
1806 archName := currentArchType.String()
1807 if currentArchType != primaryArchType {
1808 archName += "_" + primaryArchType.String()
1809 }
1810
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001811 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001812 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001813}
1814
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001815func getRefAbiDumpDir(isNdk, isVndk bool) string {
1816 var dirName string
1817 if isNdk {
1818 dirName = "ndk"
1819 } else if isVndk {
1820 dirName = "vndk"
1821 } else {
1822 dirName = "platform"
1823 }
1824 return filepath.Join("prebuilts", "abi-dumps", dirName)
1825}
Logan Chien7eefdc42018-07-11 18:10:41 +08001826
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001827func prevRefAbiDumpVersion(ctx ModuleContext, dumpDir string) int {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001828 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
1829 sdkVersionStr := ctx.Config().PlatformSdkVersion().String()
1830
1831 if ctx.Config().PlatformSdkFinal() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001832 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001833 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001834 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1835 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1836 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001837 versionedDumpDir := android.ExistentPathForSource(ctx, dumpDir, sdkVersionStr)
1838 if versionedDumpDir.Valid() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001839 return sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001840 } else {
Mu-Le Lee13043932022-08-27 08:55:25 +00001841 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001842 }
1843 }
1844}
1845
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001846func currRefAbiDumpVersion(ctx ModuleContext, isVndk bool) string {
1847 if isVndk {
1848 // Each version of VNDK is independent, so follow the VNDK version which is the codename or PLATFORM_SDK_VERSION.
1849 return ctx.Module().(*Module).VndkVersion()
1850 } else if ctx.Config().PlatformSdkFinal() {
1851 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1852 // so choose PLATFORM_SDK_VERSION as the current version.
1853 return ctx.Config().PlatformSdkVersion().String()
1854 } else {
1855 return "current"
1856 }
1857}
1858
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001859// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
1860func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1861 baseName, nameExt string, isLlndkOrNdk, allowExtensions bool,
1862 sourceVersion, errorMessage string) {
1863
1864 sourceDump := library.sAbiOutputFile.Path()
1865
1866 extraFlags := []string{"-target-version", sourceVersion}
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001867 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
1868 if Bool(headerAbiChecker.Check_all_apis) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001869 extraFlags = append(extraFlags, "-check-all-apis")
1870 } else {
1871 extraFlags = append(extraFlags,
1872 "-allow-unreferenced-changes",
1873 "-allow-unreferenced-elf-symbol-changes")
1874 }
1875 if isLlndkOrNdk {
1876 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1877 }
1878 if allowExtensions {
1879 extraFlags = append(extraFlags, "-allow-extensions")
1880 }
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001881 extraFlags = append(extraFlags, headerAbiChecker.Diff_flags...)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001882
1883 library.sAbiDiff = append(
1884 library.sAbiDiff,
1885 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1886 baseName, nameExt, extraFlags, errorMessage))
1887}
1888
1889func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1890 baseName string, isLlndkOrNdk bool, sourceVersion, prevVersion string) {
1891
1892 errorMessage := "error: Please follow https://android.googlesource.com/platform/development/+/master/vndk/tools/header-checker/README.md#configure-cross_version-abi-check to resolve the ABI difference between your source code and version " + prevVersion + "."
1893
1894 library.sourceAbiDiff(ctx, referenceDump, baseName, prevVersion,
Sasha Smundak39a301c2022-12-29 17:11:49 -08001895 isLlndkOrNdk, true /* allowExtensions */, sourceVersion, errorMessage)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001896}
1897
1898func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1899 baseName string, isLlndkOrNdk, allowExtensions bool) {
1900
1901 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1902 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName
1903
Sasha Smundak39a301c2022-12-29 17:11:49 -08001904 library.sourceAbiDiff(ctx, referenceDump, baseName, "",
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001905 isLlndkOrNdk, allowExtensions, "current", errorMessage)
1906}
1907
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001908func (library *libraryDecorator) optInAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1909 baseName, nameExt string, isLlndkOrNdk bool, refDumpDir string) {
1910
1911 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1912 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName + " -ref-dump-dir $$ANDROID_BUILD_TOP/" + refDumpDir
1913
1914 library.sourceAbiDiff(ctx, referenceDump, baseName, nameExt,
Sasha Smundak39a301c2022-12-29 17:11:49 -08001915 isLlndkOrNdk, false /* allowExtensions */, "current", errorMessage)
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001916}
1917
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001918func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001919 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001920 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001921 var SourceAbiFlags []string
1922 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001923 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1924 }
Inseob Kim69378442019-06-03 19:10:47 +09001925 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1926 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001927 }
1928 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001929 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001930 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001931 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001932 headerAbiChecker.Exclude_symbol_versions,
1933 headerAbiChecker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001934
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001935 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001936
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001937 // The logic must be consistent with classifySourceAbiDump.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001938 isVndk := ctx.useVndk() && ctx.isVndk()
Hsin-Yi Chen7584bda2022-11-08 22:51:02 +08001939 isNdk := ctx.isNdk(ctx.Config())
1940 isLlndk := ctx.isImplementationForLLNDKPublic()
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001941 dumpDir := getRefAbiDumpDir(isNdk, isVndk)
1942 binderBitness := ctx.DeviceConfig().BinderBitness()
Mu-Le Lee13043932022-08-27 08:55:25 +00001943 // If NDK or PLATFORM library, check against previous version ABI.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001944 if !isVndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001945 prevVersionInt := prevRefAbiDumpVersion(ctx, dumpDir)
1946 prevVersion := strconv.Itoa(prevVersionInt)
1947 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1948 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001949 if prevDumpFile.Valid() {
1950 library.crossVersionAbiDiff(ctx, prevDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001951 fileName, isLlndk || isNdk,
1952 strconv.Itoa(prevVersionInt+1), prevVersion)
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001953 }
1954 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001955 // Check against the current version.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001956 currVersion := currRefAbiDumpVersion(ctx, isVndk)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001957 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1958 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001959 if currDumpFile.Valid() {
1960 library.sameVersionAbiDiff(ctx, currDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001961 fileName, isLlndk || isNdk, ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001962 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001963 // Check against the opt-in reference dumps.
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001964 for i, optInDumpDir := range headerAbiChecker.Ref_dump_dirs {
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001965 optInDumpDirPath := android.PathForModuleSrc(ctx, optInDumpDir)
1966 // Ref_dump_dirs are not versioned.
1967 // They do not contain subdir for binder bitness because 64-bit binder has been mandatory.
1968 optInDumpFile := getRefAbiDumpFile(ctx, optInDumpDirPath.String(), fileName)
1969 if !optInDumpFile.Valid() {
1970 continue
1971 }
1972 library.optInAbiDiff(ctx, optInDumpFile.Path(),
1973 fileName, "opt"+strconv.Itoa(i), isLlndk || isNdk,
1974 optInDumpDirPath.String())
1975 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001976 }
1977}
1978
Inseob Kimcc12d902021-05-14 20:15:55 +09001979func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001980 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1981 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1982
Colin Cross127bb8b2020-12-16 16:46:01 -08001983 for _, header := range srcFiles {
1984 headerDir := filepath.Dir(header.String())
1985 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1986 if err != nil {
1987 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1988 srcDir.String(), headerDir, err)
1989 continue
1990 }
1991
1992 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1993 }
1994
Inseob Kimcc12d902021-05-14 20:15:55 +09001995 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001996}
1997
Chris Parsons3c27ca32020-11-20 12:42:07 -05001998// link registers actions to link this library, and sets various fields
1999// on this library to reflect information that should be exported up the build
2000// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07002001func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002002 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002003
Colin Cross127bb8b2020-12-16 16:46:01 -08002004 if ctx.IsLlndk() {
2005 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
2006 // This is the vendor variant of an LLNDK library with preprocessed headers.
2007 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
2008
2009 var timestampFiles android.Paths
2010 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09002011 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
2012 timestampFiles = append(timestampFiles, timestampFile)
2013 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08002014 }
2015
2016 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2017 library.reexportSystemDirs(genHeaderOutDir)
2018 } else {
2019 library.reexportDirs(genHeaderOutDir)
2020 }
2021
2022 library.reexportDeps(timestampFiles...)
2023 }
2024
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002025 // override the module's export_include_dirs with llndk.override_export_include_dirs
2026 // if it is set.
2027 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
2028 library.flagExporter.Properties.Export_include_dirs = override
2029 }
2030
Colin Cross127bb8b2020-12-16 16:46:01 -08002031 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2032 library.flagExporter.Properties.Export_system_include_dirs = append(
2033 library.flagExporter.Properties.Export_system_include_dirs,
2034 library.flagExporter.Properties.Export_include_dirs...)
2035 library.flagExporter.Properties.Export_include_dirs = nil
2036 }
2037 }
2038
Colin Cross5271fea2021-04-27 13:06:04 -07002039 if ctx.IsVendorPublicLibrary() {
2040 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
2041 // if it is set.
2042 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
2043 library.flagExporter.Properties.Export_include_dirs = override
2044 }
2045 }
2046
Chris Parsons3c27ca32020-11-20 12:42:07 -05002047 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
2048 // of this library), together with `objs` (.o files created by compiling this
2049 // library).
Colin Crossad59e752017-11-16 14:29:11 -08002050 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002051 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08002052 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002053 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002054 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002055 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002056 }
2057
Chris Parsons3c27ca32020-11-20 12:42:07 -05002058 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09002059 library.exportIncludes(ctx)
2060 library.reexportDirs(deps.ReexportedDirs...)
2061 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
2062 library.reexportFlags(deps.ReexportedFlags...)
2063 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09002064 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002065
Chris Parsons3c27ca32020-11-20 12:42:07 -05002066 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002067 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002068 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09002069 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09002070 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09002071
Paul Duffin33056e82021-02-19 13:49:08 +00002072 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
2073 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07002074 }
2075 }
2076
Chris Parsons3c27ca32020-11-20 12:42:07 -05002077 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002078 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002079 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09002080 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07002081 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09002082 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07002083 }
Jiyong Park74955042019-10-22 20:19:51 +09002084 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09002085 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09002086
Paul Duffin33056e82021-02-19 13:49:08 +00002087 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
2088 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07002089 }
2090 }
2091
Inseob Kim07def122020-11-23 14:43:02 +09002092 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09002093 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09002094 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002095 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09002096 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
2097
Inseob Kim07def122020-11-23 14:43:02 +09002098 // If the owner is different from the user, expose public header. That is,
2099 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09002100 // 2) if the owner is platform and the client is vendor
2101 // We don't care Platform -> Vendor dependency as it's already forbidden.
2102 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09002103 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002104 }
2105 }
2106
Paul Duffin37e0de52021-02-19 17:05:39 +00002107 // Make sure to only export headers which are within the include directory.
2108 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
2109 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
2110 return isRel
2111 })
2112
Chris Parsons3c27ca32020-11-20 12:42:07 -05002113 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09002114 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00002115 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00002116 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09002117 }
2118
Chris Parsons3c27ca32020-11-20 12:42:07 -05002119 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09002120 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002121
Chris Parsons3c27ca32020-11-20 12:42:07 -05002122 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002123 library.flagExporter.setProvider(ctx)
2124
Colin Cross4d9c2d12016-07-29 12:48:20 -07002125 return out
2126}
2127
Jiyong Park892a98f2020-12-14 09:20:00 +09002128func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002129 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09002130 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09002131 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
2132 if err != nil {
2133 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
2134 }
2135 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09002136 }
2137}
2138
Chris Parsons3c27ca32020-11-20 12:42:07 -05002139// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07002140func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002141 return library.MutatedProperties.BuildStatic &&
2142 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002143}
2144
Chris Parsons3c27ca32020-11-20 12:42:07 -05002145// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07002146func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002147 return library.MutatedProperties.BuildShared &&
2148 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002149}
2150
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002151func (library *libraryDecorator) objs() Objects {
2152 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002153}
2154
Colin Cross0de8a1e2020-09-18 14:15:30 -07002155func (library *libraryDecorator) reuseObjs() Objects {
2156 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002157}
2158
Colin Cross26c34ed2016-09-30 17:10:16 -07002159func (library *libraryDecorator) toc() android.OptionalPath {
2160 return library.tocFile
2161}
2162
Jiyong Parkf1194352019-02-25 11:05:47 +09002163func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
2164 dir := library.baseInstaller.installDir(ctx)
2165 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
2166 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
2167 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002168 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09002169}
2170
Colin Crossb916a382016-07-29 17:28:03 -07002171func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07002172 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09002173 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09002174 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05002175 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002176 if ctx.isVndkSp() {
2177 library.baseInstaller.subDir = "vndk-sp"
2178 } else {
2179 library.baseInstaller.subDir = "vndk"
2180 }
2181 }
2182
Justin Yun31094b12020-12-24 16:11:23 +09002183 // In some cases we want to use core variant for VNDK-Core libs.
2184 // Skip product variant since VNDKs use only the vendor variant.
2185 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08002186 mayUseCoreVariant := true
2187
2188 if ctx.mustUseVendorVariant() {
2189 mayUseCoreVariant = false
2190 }
2191
Elvis Chien9c993542021-06-25 01:15:17 +08002192 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08002193 mayUseCoreVariant = false
2194 }
2195
2196 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08002197 library.checkSameCoreVariant = true
2198 if ctx.DeviceConfig().VndkUseCoreVariant() {
2199 library.useCoreVariant = true
2200 }
Vic Yangefd249e2018-11-12 20:19:56 -08002201 }
Justin Yun8fe12122017-12-07 17:18:15 +09002202 }
Logan Chienf3511742017-10-31 18:04:35 +08002203
Jooyung Han261e1582020-10-20 18:54:21 +09002204 // do not install vndk libs
2205 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05002206 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002207 return
Justin Yun8effde42017-06-23 19:24:43 +09002208 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002209 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09002210 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
2211 // The original path becomes a symlink to the corresponding file in the
2212 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07002213 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07002214 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002215 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01002216 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09002217 library.installSymlinkToRuntimeApex(ctx, file)
2218 }
Jiyong Park429660f2019-01-16 22:31:11 +09002219 library.baseInstaller.subDir = "bootstrap"
2220 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002221 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002222 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002223 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09002224 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002225
Colin Cross4d9c2d12016-07-29 12:48:20 -07002226 library.baseInstaller.install(ctx, file)
2227 }
Dan Albertf563d252017-10-13 00:29:00 -07002228
Dan Albert281f22b2017-12-13 15:03:47 -08002229 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002230 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09002231 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08002232 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07002233 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07002234 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07002235
2236 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
2237 Rule: android.Cp,
2238 Description: "install " + installPath.Base(),
2239 Output: installPath,
2240 Input: file,
2241 })
2242
Colin Cross0875c522017-11-28 17:34:01 -08002243 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07002244 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002245}
2246
Paul Duffin0cb37b92020-03-04 14:52:46 +00002247func (library *libraryDecorator) everInstallable() bool {
2248 // Only shared and static libraries are installed. Header libraries (which are
2249 // neither static or shared) are not installed.
2250 return library.shared() || library.static()
2251}
2252
Chris Parsons3c27ca32020-11-20 12:42:07 -05002253// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07002254func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002255 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07002256}
2257
Chris Parsons3c27ca32020-11-20 12:42:07 -05002258// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002259func (library *libraryDecorator) shared() bool {
2260 return library.MutatedProperties.VariantIsShared
2261}
2262
Chris Parsons3c27ca32020-11-20 12:42:07 -05002263// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002264func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002265 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002266 return !library.static() && !library.shared()
2267}
2268
Chris Parsons3c27ca32020-11-20 12:42:07 -05002269// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002270func (library *libraryDecorator) setStatic() {
2271 library.MutatedProperties.VariantIsStatic = true
2272 library.MutatedProperties.VariantIsShared = false
2273}
2274
Chris Parsons3c27ca32020-11-20 12:42:07 -05002275// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002276func (library *libraryDecorator) setShared() {
2277 library.MutatedProperties.VariantIsStatic = false
2278 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07002279}
2280
Chris Parsons3c27ca32020-11-20 12:42:07 -05002281// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08002282func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002283 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08002284}
2285
Chris Parsons3c27ca32020-11-20 12:42:07 -05002286// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08002287func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002288 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08002289}
2290
Chris Parsons3c27ca32020-11-20 12:42:07 -05002291// HeaderOnly disables building this library as a shared or static library;
2292// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08002293func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002294 library.MutatedProperties.BuildShared = false
2295 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08002296}
2297
Colin Cross127bb8b2020-12-16 16:46:01 -08002298// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
2299func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07002300 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002301}
2302
Colin Cross203b4212021-04-26 17:19:41 -07002303// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07002304func (library *libraryDecorator) hasLLNDKHeaders() bool {
2305 return Bool(library.Properties.Llndk.Llndk_headers)
2306}
2307
Colin Cross5271fea2021-04-27 13:06:04 -07002308// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
2309// vendor public library stubs.
2310func (library *libraryDecorator) hasVendorPublicLibrary() bool {
2311 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
2312}
2313
Colin Cross0477b422020-10-13 18:43:54 -07002314func (library *libraryDecorator) implementationModuleName(name string) string {
2315 return name
2316}
2317
Jiyong Park7ed9de32018-10-15 22:25:07 +09002318func (library *libraryDecorator) buildStubs() bool {
2319 return library.MutatedProperties.BuildStubs
2320}
2321
Jiyong Parka034b832019-08-27 14:02:19 +09002322func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08002323 if props := library.getHeaderAbiCheckerProperties(ctx); props.Symbol_file != nil {
2324 return props.Symbol_file
Jiyong Parka034b832019-08-27 14:02:19 +09002325 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002326 if ctx.Module().(*Module).IsLlndk() {
2327 return library.Properties.Llndk.Symbol_file
2328 }
Colin Cross31076b32020-10-23 17:22:06 -07002329 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09002330 return library.Properties.Stubs.Symbol_file
2331 }
2332 return nil
2333}
2334
Colin Crossc88c2722020-09-28 17:32:47 -07002335func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002336 // Just having stubs.symbol_file is enough to create a stub variant. In that case
2337 // the stub for the future API level is created.
2338 return library.Properties.Stubs.Symbol_file != nil ||
2339 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07002340}
2341
Alan Stokes73feba32022-11-14 12:21:24 +00002342func (library *libraryDecorator) isStubsImplementationRequired() bool {
2343 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
2344}
2345
Colin Cross3572cf72020-10-01 15:58:11 -07002346func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002347 if !library.hasStubsVariants() {
2348 return nil
2349 }
2350
Colin Crossc1b36442021-05-06 13:42:48 -07002351 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
2352 // LLNDK libraries only need a single stubs variant.
2353 return []string{android.FutureApiLevel.String()}
2354 }
2355
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002356 // Future API level is implicitly added if there isn't
2357 vers := library.Properties.Stubs.Versions
2358 if inList(android.FutureApiLevel.String(), vers) {
2359 return vers
2360 }
2361 // In some cases, people use the raw value "10000" in the versions property.
2362 // We shouldn't add the future API level in that case, otherwise there will
2363 // be two identical versions.
2364 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2365 return vers
2366 }
2367 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002368}
2369
2370func (library *libraryDecorator) setStubsVersion(version string) {
2371 library.MutatedProperties.StubsVersion = version
2372}
2373
Jiyong Park7ed9de32018-10-15 22:25:07 +09002374func (library *libraryDecorator) stubsVersion() string {
2375 return library.MutatedProperties.StubsVersion
2376}
2377
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002378func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002379 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002380 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002381}
2382
2383func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2384 library.MutatedProperties.AllStubsVersions = versions
2385}
2386
2387func (library *libraryDecorator) allStubsVersions() []string {
2388 return library.MutatedProperties.AllStubsVersions
2389}
2390
Jooyung Hanad4c1872020-02-27 17:56:44 +09002391func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002392 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002393}
2394
Jiyong Parka90ca002019-10-07 15:47:24 +09002395func (library *libraryDecorator) availableFor(what string) bool {
2396 var list []string
2397 if library.static() {
2398 list = library.StaticProperties.Static.Apex_available
2399 } else if library.shared() {
2400 list = library.SharedProperties.Shared.Apex_available
2401 }
2402 if len(list) == 0 {
2403 return false
2404 }
2405 return android.CheckAvailableForApex(what, list)
2406}
2407
Colin Cross1bc94122021-10-28 13:25:54 -07002408func (library *libraryDecorator) installable() *bool {
2409 if library.static() {
2410 return library.StaticProperties.Static.Installable
2411 } else if library.shared() {
2412 return library.SharedProperties.Shared.Installable
2413 }
2414 return nil
2415}
2416
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002417func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002418 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002419 // If we're asked to make a static library uninstallable we don't do
2420 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2421 // for these entries. This is done to still get the make targets for NOTICE
2422 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002423 return
2424 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002425 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002426}
2427
Jihoon Kangf78a8902022-09-01 22:47:07 +00002428func (library *libraryDecorator) getPartition() string {
2429 return library.path.Partition()
2430}
2431
Colin Crossceaa5322021-09-28 16:37:50 -07002432func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2433 return library.apiListCoverageXmlPath
2434}
2435
Inseob Kima1888ce2022-10-04 14:42:02 +09002436func (library *libraryDecorator) overriddenModules() []string {
2437 return library.Properties.Overrides
2438}
2439
2440var _ overridable = (*libraryDecorator)(nil)
2441
Colin Cross571cccf2019-02-04 11:22:08 -08002442var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2443
Chris Parsons3c27ca32020-11-20 12:42:07 -05002444// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2445// and values are the module name responsible for registering the version macro name.
2446//
2447// Version macros are used when building against stubs, to provide version information about
2448// the stub. Only stub libraries should have an entry in this list.
2449//
2450// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2451// that headers from libFoo can be conditionally compiled (this may hide APIs
2452// that are not available for the version).
2453//
2454// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002455func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002456 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002457 m := make(map[string]string)
2458 return &m
2459 }).(*map[string]string)
2460}
2461
2462// alphanumeric and _ characters are preserved.
2463// other characters are all converted to _
2464var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2465
Chris Parsons3c27ca32020-11-20 12:42:07 -05002466// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002467func versioningMacroName(moduleName string) string {
2468 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002469 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002470 return "__" + macroName + "_API__"
2471}
2472
Chris Parsons3c27ca32020-11-20 12:42:07 -05002473// NewLibrary builds and returns a new Module corresponding to a C++ library.
2474// Individual module implementations which comprise a C++ library (or something like
2475// a C++ library) should call this function, set some fields on the result, and
2476// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002477func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002478 module := newModule(hod, android.MultilibBoth)
2479
Colin Crossb916a382016-07-29 17:28:03 -07002480 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002481 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002482 BuildShared: true,
2483 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002484 },
Colin Crossb916a382016-07-29 17:28:03 -07002485 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002486 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002487 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002488 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002489 }
2490
Colin Crossb916a382016-07-29 17:28:03 -07002491 module.compiler = library
2492 module.linker = library
2493 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002494 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002495
2496 return module, library
2497}
2498
Colin Cross10d22312017-05-03 11:01:58 -07002499// connects a shared library to a static library in order to reuse its .o files to avoid
2500// compiling source files twice.
2501func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2502 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2503 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002504
2505 // Check libraries in addition to cflags, since libraries may be exporting different
2506 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002507 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2508 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2509 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2510 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2511 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2512 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2513 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2514 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002515 // Compare System_shared_libs properties with nil because empty lists are
2516 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002517 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2518 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002519
2520 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2521 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2522 sharedCompiler.baseCompiler.Properties.Srcs
2523 sharedCompiler.baseCompiler.Properties.Srcs = nil
2524 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2525 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002526
2527 // This dep is just to reference static variant from shared variant
2528 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002529 }
2530}
2531
Chris Parsons3c27ca32020-11-20 12:42:07 -05002532// LinkageMutator adds "static" or "shared" variants for modules depending
2533// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002534func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002535 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002536 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002537 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002538 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002539 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002540 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002541
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002542 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002543 buildStatic := library.buildStatic()
2544 buildShared := library.buildShared()
2545 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002546 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2547 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2548 // all the variants of the cc_library also exist on the prebuilt.
2549 modules := mctx.CreateLocalVariations("static", "shared")
2550 static := modules[0].(*Module)
2551 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002552
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002553 static.linker.(prebuiltLibraryInterface).setStatic()
2554 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002555
Colin Cross127bb8b2020-12-16 16:46:01 -08002556 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002557 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002558 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002559 mctx.AliasVariation("static")
2560 }
2561
Colin Cross127bb8b2020-12-16 16:46:01 -08002562 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002563 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2564 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002565 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002566 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2567 }
2568 } else {
2569 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002570 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002571
Ivan Lozano52767be2019-10-18 14:49:46 -07002572 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002573
Ivan Lozano2b262972019-11-21 12:30:50 -08002574 // Non-cc.Modules may need an empty variant for their mutators.
2575 variations := []string{}
2576 if library.NonCcVariants() {
2577 variations = append(variations, "")
2578 }
2579
Colin Cross127bb8b2020-12-16 16:46:01 -08002580 isLLNDK := false
2581 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002582 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002583 }
2584 buildStatic := library.BuildStaticVariant() && !isLLNDK
2585 buildShared := library.BuildSharedVariant()
2586 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002587 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002588
2589 modules := mctx.CreateLocalVariations(variations...)
2590 static := modules[0].(LinkableInterface)
2591 shared := modules[1].(LinkableInterface)
2592
2593 static.SetStatic()
2594 shared.SetShared()
2595
2596 if _, ok := library.(*Module); ok {
2597 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2598 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002599 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002600 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002601 variations := append([]string{"static"}, variations...)
2602
2603 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002604 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002605 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002606 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002607 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002608
Ivan Lozano2b262972019-11-21 12:30:50 -08002609 modules := mctx.CreateLocalVariations(variations...)
2610 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002611 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002612 } else if len(variations) > 0 {
2613 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002614 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002615 }
Colin Crossb916a382016-07-29 17:28:03 -07002616 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002617}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002618
Chris Parsons3c27ca32020-11-20 12:42:07 -05002619// normalizeVersions modifies `versions` in place, so that each raw version
2620// string becomes its normalized canonical form.
2621// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002622func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002623 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002624 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002625 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002626 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002627 ctx.PropertyErrorf("versions", "%s", err.Error())
2628 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002629 }
Dan Albertc8060532020-07-22 22:32:17 -07002630 if i > 0 && ver.LessThanOrEqualTo(previous) {
2631 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2632 }
2633 versions[i] = ver.String()
2634 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002635 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002636}
2637
Jooyung Han61b66e92020-03-21 14:21:46 +00002638func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002639 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2640 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002641 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002642
Colin Cross127bb8b2020-12-16 16:46:01 -08002643 m := mctx.Module().(*Module)
2644 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002645 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002646 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002647
Colin Crossd1f898e2020-08-18 18:35:15 -07002648 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002649 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002650
Kiyoung Kimee58c932022-10-25 22:59:41 +09002651 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002652 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002653 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002654 c.sanitize = nil
2655 c.stl = nil
2656 c.Properties.PreventInstall = true
2657 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002658 isLatest := i == (len(versions) - 1)
2659 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002660
2661 if variants[i] != "" {
2662 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2663 // implementation module to the stubs module.
2664 c.Properties.HideFromMake = true
2665 lib.setStubsVersion(variants[i])
2666 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2667 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002668 }
2669 }
Colin Cross094faa52020-08-06 17:38:25 -07002670 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002671 latestVersion := ""
2672 if len(versions) > 0 {
2673 latestVersion = versions[len(versions)-1]
2674 }
2675 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002676}
2677
Colin Crossbbc941b2020-09-30 12:27:01 -07002678func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2679 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2680 if err != nil {
2681 mctx.PropertyErrorf("min_sdk_version", err.Error())
2682 return
2683 }
2684
2685 versionStrs := ndkLibraryVersions(mctx, from)
2686 modules := mctx.CreateLocalVariations(versionStrs...)
2687
2688 for i, module := range modules {
2689 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002690 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002691 }
2692}
2693
Liz Kammer23942242022-04-08 15:41:00 -04002694func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002695 Host() bool
2696 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002697 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002698}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002699 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002700}
2701
Liz Kammer23942242022-04-08 15:41:00 -04002702func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002703 Host() bool
2704 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002705 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002706 CcLibraryInterface() bool
2707 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002708}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002709 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002710 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002711}
2712
Colin Cross127bb8b2020-12-16 16:46:01 -08002713func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002714 if m, ok := module.(*Module); ok {
2715 return m.library
2716 }
2717 return nil
2718}
2719
Liz Kammer23942242022-04-08 15:41:00 -04002720// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2721func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2722 if !library.buildShared() || !canBeVersionVariant(module) {
2723 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002724 }
Liz Kammer23942242022-04-08 15:41:00 -04002725 versions := library.stubsVersions(mctx)
2726 if len(versions) <= 0 {
2727 return
2728 }
2729 normalizeVersions(mctx, versions)
2730 if mctx.Failed() {
2731 return
2732 }
2733 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2734 // depend on the implementation library and haven't been mutated yet.
2735 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002736}
Jooyung Han61b66e92020-03-21 14:21:46 +00002737
Colin Crossd1f898e2020-08-18 18:35:15 -07002738// versionMutator splits a module into the mandatory non-stubs variant
2739// (which is unnamed) and zero or more stubs variants.
2740func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002741 if mctx.Os() != android.Android {
2742 return
2743 }
2744
2745 m, ok := mctx.Module().(*Module)
2746 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2747 setStubsVersions(mctx, library, m)
2748
Colin Cross31076b32020-10-23 17:22:06 -07002749 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002750 return
2751 }
2752
Liz Kammer23942242022-04-08 15:41:00 -04002753 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002754 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002755 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2756 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002757 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002758}
Colin Crossd7227f92019-09-05 14:26:33 -07002759
2760// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2761// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2762// that the linked output file should be written to.
2763// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2764func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2765 inject *bool, fileName string) android.ModuleOutPath {
2766 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2767 injectBoringSSLHash := Bool(inject)
2768 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002769 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002770 if cc, ok := dep.(*Module); ok {
2771 if library, ok := cc.linker.(*libraryDecorator); ok {
2772 if Bool(library.Properties.Inject_bssl_hash) {
2773 injectBoringSSLHash = true
2774 }
2775 }
2776 }
2777 }
2778 })
2779 if injectBoringSSLHash {
2780 hashedOutputfile := outputFile
2781 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2782
Colin Crossf1a035e2020-11-16 17:32:30 -08002783 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002784 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002785 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002786 FlagWithInput("-in-object ", outputFile).
2787 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002788 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002789 }
2790
2791 return outputFile
2792}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002793
Yu Liu56ccb1a2022-11-12 10:47:07 -08002794func bp2buildParseAbiCheckerProps(ctx android.TopDownMutatorContext, module *Module) bazelCcHeaderAbiCheckerAttributes {
2795 lib, ok := module.linker.(*libraryDecorator)
2796 if !ok {
2797 return bazelCcHeaderAbiCheckerAttributes{}
2798 }
2799
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08002800 abiChecker := lib.getHeaderAbiCheckerProperties(ctx)
Yu Liu56ccb1a2022-11-12 10:47:07 -08002801
2802 abiCheckerAttrs := bazelCcHeaderAbiCheckerAttributes{
2803 Abi_checker_enabled: abiChecker.Enabled,
2804 Abi_checker_exclude_symbol_versions: abiChecker.Exclude_symbol_versions,
2805 Abi_checker_exclude_symbol_tags: abiChecker.Exclude_symbol_tags,
2806 Abi_checker_check_all_apis: abiChecker.Check_all_apis,
2807 Abi_checker_diff_flags: abiChecker.Diff_flags,
2808 }
2809 if abiChecker.Symbol_file != nil {
2810 symbolFile := android.BazelLabelForModuleSrcSingle(ctx, *abiChecker.Symbol_file)
2811 abiCheckerAttrs.Abi_checker_symbol_file = &symbolFile
2812 }
2813
2814 return abiCheckerAttrs
2815}
2816
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002817func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002818 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2819 compilerAttrs := baseAttributes.compilerAttributes
2820 linkerAttrs := baseAttributes.linkerAttributes
2821
Liz Kammer54549442022-05-11 13:55:06 -04002822 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, &compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002823
2824 // Append shared/static{} stanza properties. These won't be specified on
2825 // cc_library_* itself, but may be specified in cc_defaults that this module
2826 // depends on.
2827 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2828
2829 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2830 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2831 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2832 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002833
2834 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2835 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002836 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002837 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002838 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2839
2840 asFlags := compilerAttrs.asFlags
2841 if compilerAttrs.asSrcs.IsEmpty() {
2842 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2843 asFlags = bazel.MakeStringListAttribute(nil)
2844 }
2845
Liz Kammer7a210ac2021-09-22 15:52:58 -04002846 commonAttrs := staticOrSharedAttributes{
2847 Srcs: compilerAttrs.srcs,
2848 Srcs_c: compilerAttrs.cSrcs,
2849 Srcs_as: compilerAttrs.asSrcs,
2850 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002851 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002852
Liz Kammer12615db2021-09-28 09:19:17 -04002853 Deps: linkerAttrs.deps,
2854 Implementation_deps: linkerAttrs.implementationDeps,
2855 Dynamic_deps: linkerAttrs.dynamicDeps,
2856 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2857 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2858 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2859 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Yu Liufc603162022-03-01 15:44:08 -08002860 sdkAttributes: bp2BuildParseSdkAttributes(module),
Cole Faust6b29f592022-08-09 09:50:56 -07002861 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liuf01a0f02022-12-07 15:45:30 -08002862 Native_coverage: baseAttributes.Native_coverage,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002863 }
2864
Sam Delmericoc9b8fbd2022-10-25 15:47:17 -04002865 module.convertTidyAttributes(ctx, &commonAttrs.tidyAttributes)
Sam Delmericofb3bb322022-10-21 10:42:24 -04002866
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002867 var attrs interface{}
2868 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002869 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002870 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002871 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002872
Liz Kammerbaced712022-09-16 09:01:29 -04002873 Use_libcrt: linkerAttrs.useLibcrt,
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002874
Liz Kammer1263d9b2021-12-10 14:28:20 -05002875 Rtti: compilerAttrs.rtti,
2876 Stl: compilerAttrs.stl,
2877 Cpp_std: compilerAttrs.cppStd,
2878 C_std: compilerAttrs.cStd,
2879
2880 Export_includes: exportedIncludes.Includes,
2881 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2882 Export_system_includes: exportedIncludes.SystemIncludes,
2883 Local_includes: compilerAttrs.localIncludes,
2884 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002885
2886 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002887 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002888 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002889
Cole Faust5fa4e962022-08-22 14:31:04 -07002890 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002891 }
2892 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002893 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2894
Wei Li81852ca2022-07-27 00:22:06 -07002895 sharedLibAttrs := &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002896 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002897
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002898 Cppflags: compilerAttrs.cppFlags,
2899 Conlyflags: compilerAttrs.conlyFlags,
2900 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002901
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002902 Linkopts: linkerAttrs.linkopts,
2903 Link_crt: linkerAttrs.linkCrt,
2904 Use_libcrt: linkerAttrs.useLibcrt,
2905 Use_version_lib: linkerAttrs.useVersionLib,
2906
2907 Rtti: compilerAttrs.rtti,
2908 Stl: compilerAttrs.stl,
2909 Cpp_std: compilerAttrs.cppStd,
2910 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002911
Liz Kammerd2871182021-10-04 13:54:37 -04002912 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002913 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002914 Export_system_includes: exportedIncludes.SystemIncludes,
2915 Local_includes: compilerAttrs.localIncludes,
2916 Absolute_includes: compilerAttrs.absoluteIncludes,
2917 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002918
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00002919 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
Liz Kammer0eae52e2021-10-06 10:32:26 -04002920
Cole Faust5fa4e962022-08-22 14:31:04 -07002921 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05002922
2923 Suffix: compilerAttrs.suffix,
Yu Liu56ccb1a2022-11-12 10:47:07 -08002924
2925 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, module),
Vinh Tran99270ea2022-11-28 11:15:23 -05002926
2927 Fdo_profile: compilerAttrs.fdoProfile,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002928 }
Wei Li81852ca2022-07-27 00:22:06 -07002929 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
Yu Liu56ccb1a2022-11-12 10:47:07 -08002930 sharedLibAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Wei Li81852ca2022-07-27 00:22:06 -07002931 }
2932 attrs = sharedLibAttrs
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002933 }
2934
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002935 var modType string
2936 if isStatic {
2937 modType = "cc_library_static"
2938 } else {
2939 modType = "cc_library_shared"
Trevor Radcliffef19d8a72022-09-20 23:04:39 +00002940 createStubsBazelTargetIfNeeded(ctx, module, compilerAttrs, exportedIncludes, baseAttributes)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002941 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002942 props := bazel.BazelTargetModuleProperties{
2943 Rule_class: modType,
Liz Kammer2b376bc2022-01-12 12:00:49 -05002944 Bzl_load_location: fmt.Sprintf("//build/bazel/rules/cc:%s.bzl", modType),
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002945 }
2946
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002947 tags := android.ApexAvailableTags(module)
Yu Liuf01a0f02022-12-07 15:45:30 -08002948
2949 // This lib needs some special handling in bazel, so add this tag to the build
2950 // file.
2951 if module.Name() == "libprofile-clang-extras" {
2952 tags.Append(bazel.MakeStringListAttribute([]string{"NO_EXPORTING"}))
2953 }
2954
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002955 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name(), Tags: tags}, attrs)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002956}
2957
2958// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002959type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002960 staticOrSharedAttributes
2961
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002962 Use_libcrt bazel.BoolAttribute
2963 Use_version_lib bazel.BoolAttribute
2964
2965 Rtti bazel.BoolAttribute
2966 Stl *string
2967 Cpp_std *string
2968 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002969
Liz Kammer1263d9b2021-12-10 14:28:20 -05002970 Export_includes bazel.StringListAttribute
2971 Export_absolute_includes bazel.StringListAttribute
2972 Export_system_includes bazel.StringListAttribute
2973 Local_includes bazel.StringListAttribute
2974 Absolute_includes bazel.StringListAttribute
2975 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002976
2977 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002978 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002979 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002980
2981 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002982}
2983
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002984// TODO(b/199902614): Can this be factored to share with the other Attributes?
2985type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002986 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002987
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002988 Linkopts bazel.StringListAttribute
2989 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
2990
2991 Use_libcrt bazel.BoolAttribute
2992 Use_version_lib bazel.BoolAttribute
2993
2994 Rtti bazel.BoolAttribute
2995 Stl *string
2996 Cpp_std *string
2997 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002998
Liz Kammer1263d9b2021-12-10 14:28:20 -05002999 Export_includes bazel.StringListAttribute
3000 Export_absolute_includes bazel.StringListAttribute
3001 Export_system_includes bazel.StringListAttribute
3002 Local_includes bazel.StringListAttribute
3003 Absolute_includes bazel.StringListAttribute
3004 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003005
Liz Kammerd2871182021-10-04 13:54:37 -04003006 Strip stripAttributes
3007 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04003008
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003009 Cppflags bazel.StringListAttribute
3010 Conlyflags bazel.StringListAttribute
3011 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04003012
3013 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00003014
Yu Liu56ccb1a2022-11-12 10:47:07 -08003015 Stubs_symbol_file *string
Wei Li81852ca2022-07-27 00:22:06 -07003016
3017 Inject_bssl_hash bazel.BoolAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05003018
3019 Suffix bazel.StringAttribute
Yu Liu56ccb1a2022-11-12 10:47:07 -08003020
3021 bazelCcHeaderAbiCheckerAttributes
Vinh Tran99270ea2022-11-28 11:15:23 -05003022
3023 Fdo_profile bazel.LabelAttribute
Wei Li81852ca2022-07-27 00:22:06 -07003024}
3025
3026type bazelCcStubSuiteAttributes struct {
3027 Symbol_file *string
3028 Versions bazel.StringListAttribute
3029 Export_includes bazel.StringListAttribute
3030 Source_library bazel.LabelAttribute
3031 Soname *string
3032 Deps bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003033}
Yu Liu56ccb1a2022-11-12 10:47:07 -08003034
3035type bazelCcHeaderAbiCheckerAttributes struct {
3036 Abi_checker_enabled *bool
3037 Abi_checker_symbol_file *bazel.Label
3038 Abi_checker_exclude_symbol_versions []string
3039 Abi_checker_exclude_symbol_tags []string
3040 Abi_checker_check_all_apis *bool
3041 Abi_checker_diff_flags []string
3042}