blob: 160828a5cc1a5aa065c7df022cff161cca6aba90 [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 Chen179856a2021-05-03 09:15:48 +0000295 // For some cc_library modules, their static variants are ready to be
296 // converted, but not their shared variants. For these modules, delegate to
297 // the cc_library_static bp2build converter temporarily instead.
Chris Parsonsad876012022-08-20 14:48:32 -0400298 if android.GetBp2BuildAllowList().GenerateCcLibraryStaticOnly(ctx.Module().Name()) {
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400299 sharedOrStaticLibraryBp2Build(ctx, m, true)
Jingwen Chen179856a2021-05-03 09:15:48 +0000300 return
301 }
302
Jingwen Chen53681ef2021-04-29 08:15:13 +0000303 sharedAttrs := bp2BuildParseSharedProps(ctx, m)
304 staticAttrs := bp2BuildParseStaticProps(ctx, m)
Liz Kammere6583482021-10-19 13:56:10 -0400305 baseAttributes := bp2BuildParseBaseProps(ctx, m)
306 compilerAttrs := baseAttributes.compilerAttributes
307 linkerAttrs := baseAttributes.linkerAttributes
Liz Kammer54549442022-05-11 13:55:06 -0400308 exportedIncludes := bp2BuildParseExportedIncludes(ctx, m, &compilerAttrs.includes)
Jingwen Chen63930982021-03-24 10:04:33 -0400309
Liz Kammer9abd62d2021-05-21 08:37:59 -0400310 srcs := compilerAttrs.srcs
Jingwen Chen53681ef2021-04-29 08:15:13 +0000311
Liz Kammer12615db2021-09-28 09:19:17 -0400312 sharedAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
313 staticAttrs.Deps.Add(baseAttributes.protoDependency)
314
Chris Parsons69fa9f92021-07-13 11:47:44 -0400315 asFlags := compilerAttrs.asFlags
316 if compilerAttrs.asSrcs.IsEmpty() && sharedAttrs.Srcs_as.IsEmpty() && staticAttrs.Srcs_as.IsEmpty() {
317 // Skip asflags for BUILD file simplicity if there are no assembly sources.
318 asFlags = bazel.MakeStringListAttribute(nil)
319 }
320
Chris Parsons77acf2e2021-12-03 17:27:16 -0500321 staticCommonAttrs := staticOrSharedAttributes{
322 Srcs: *srcs.Clone().Append(staticAttrs.Srcs),
323 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(staticAttrs.Srcs_c),
324 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(staticAttrs.Srcs_as),
325 Copts: *compilerAttrs.copts.Clone().Append(staticAttrs.Copts),
326 Hdrs: *compilerAttrs.hdrs.Clone().Append(staticAttrs.Hdrs),
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000327
Chris Parsons77acf2e2021-12-03 17:27:16 -0500328 Deps: *linkerAttrs.deps.Clone().Append(staticAttrs.Deps),
329 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(staticAttrs.Implementation_deps),
330 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(staticAttrs.Dynamic_deps),
331 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(staticAttrs.Implementation_dynamic_deps),
332 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
333 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(staticAttrs.Whole_archive_deps),
334 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(staticAttrs.System_dynamic_deps),
Cole Faust6b29f592022-08-09 09:50:56 -0700335 Runtime_deps: linkerAttrs.runtimeDeps,
Yu Liufc603162022-03-01 15:44:08 -0800336 sdkAttributes: bp2BuildParseSdkAttributes(m),
Chris Parsons77acf2e2021-12-03 17:27:16 -0500337 }
338
339 sharedCommonAttrs := staticOrSharedAttributes{
340 Srcs: *srcs.Clone().Append(sharedAttrs.Srcs),
341 Srcs_c: *compilerAttrs.cSrcs.Clone().Append(sharedAttrs.Srcs_c),
342 Srcs_as: *compilerAttrs.asSrcs.Clone().Append(sharedAttrs.Srcs_as),
343 Copts: *compilerAttrs.copts.Clone().Append(sharedAttrs.Copts),
344 Hdrs: *compilerAttrs.hdrs.Clone().Append(sharedAttrs.Hdrs),
345
Liz Kammer84b0ecb2022-09-14 10:49:13 -0400346 Deps: *linkerAttrs.deps.Clone().Append(sharedAttrs.Deps),
347 Implementation_deps: *linkerAttrs.implementationDeps.Clone().Append(sharedAttrs.Implementation_deps),
348 Dynamic_deps: *linkerAttrs.dynamicDeps.Clone().Append(sharedAttrs.Dynamic_deps),
349 Implementation_dynamic_deps: *linkerAttrs.implementationDynamicDeps.Clone().Append(sharedAttrs.Implementation_dynamic_deps),
350 Whole_archive_deps: *linkerAttrs.wholeArchiveDeps.Clone().Append(sharedAttrs.Whole_archive_deps),
351 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
352 System_dynamic_deps: *linkerAttrs.systemDynamicDeps.Clone().Append(sharedAttrs.System_dynamic_deps),
353 Runtime_deps: linkerAttrs.runtimeDeps,
354 sdkAttributes: bp2BuildParseSdkAttributes(m),
Chris Parsons77acf2e2021-12-03 17:27:16 -0500355 }
356
357 staticTargetAttrs := &bazelCcLibraryStaticAttributes{
358 staticOrSharedAttributes: staticCommonAttrs,
359
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000360 Cppflags: compilerAttrs.cppFlags,
361 Conlyflags: compilerAttrs.conlyFlags,
Chris Parsons69fa9f92021-07-13 11:47:44 -0400362 Asflags: asFlags,
Jingwen Chen14a8bda2021-06-02 11:10:02 +0000363
Liz Kammer1263d9b2021-12-10 14:28:20 -0500364 Export_includes: exportedIncludes.Includes,
365 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
366 Export_system_includes: exportedIncludes.SystemIncludes,
367 Local_includes: compilerAttrs.localIncludes,
368 Absolute_includes: compilerAttrs.absoluteIncludes,
369 Use_libcrt: linkerAttrs.useLibcrt,
370 Rtti: compilerAttrs.rtti,
371 Stl: compilerAttrs.stl,
372 Cpp_std: compilerAttrs.cppStd,
373 C_std: compilerAttrs.cStd,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500374
Cole Faust5fa4e962022-08-22 14:31:04 -0700375 Features: baseAttributes.features,
Chris Parsons77acf2e2021-12-03 17:27:16 -0500376 }
377
378 sharedTargetAttrs := &bazelCcLibrarySharedAttributes{
379 staticOrSharedAttributes: sharedCommonAttrs,
380 Cppflags: compilerAttrs.cppFlags,
381 Conlyflags: compilerAttrs.conlyFlags,
382 Asflags: asFlags,
383
Liz Kammer1263d9b2021-12-10 14:28:20 -0500384 Export_includes: exportedIncludes.Includes,
385 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
386 Export_system_includes: exportedIncludes.SystemIncludes,
387 Local_includes: compilerAttrs.localIncludes,
388 Absolute_includes: compilerAttrs.absoluteIncludes,
389 Linkopts: linkerAttrs.linkopts,
390 Link_crt: linkerAttrs.linkCrt,
391 Use_libcrt: linkerAttrs.useLibcrt,
392 Rtti: compilerAttrs.rtti,
393 Stl: compilerAttrs.stl,
394 Cpp_std: compilerAttrs.cppStd,
395 C_std: compilerAttrs.cStd,
Yu Liua79c9462022-03-22 16:35:22 -0700396 Use_version_lib: linkerAttrs.useVersionLib,
Chris Parsons990c4f42021-05-25 12:10:58 -0400397
Liz Kammerd2871182021-10-04 13:54:37 -0400398 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Jingwen Chenc4dc9b42021-06-11 12:51:48 +0000399
Yu Liu56ccb1a2022-11-12 10:47:07 -0800400 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
401 Features: baseAttributes.features,
402 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, m),
Vinh Tran99270ea2022-11-28 11:15:23 -0500403
404 Fdo_profile: compilerAttrs.fdoProfile,
Wei Li81852ca2022-07-27 00:22:06 -0700405 }
Jingwen Chen0ee88a62022-01-07 14:55:29 +0000406
Wei Li81852ca2022-07-27 00:22:06 -0700407 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
408 hasStubs := true
409 sharedTargetAttrs.Has_stubs.SetValue(&hasStubs)
Yu Liu56ccb1a2022-11-12 10:47:07 -0800410 sharedTargetAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Jingwen Chen63930982021-03-24 10:04:33 -0400411 }
412
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -0500413 sharedTargetAttrs.Suffix = compilerAttrs.suffix
414
Yu Liu75be7b92022-02-01 09:54:09 -0800415 for axis, configToProps := range m.GetArchVariantProperties(ctx, &LibraryProperties{}) {
416 for config, props := range configToProps {
417 if props, ok := props.(*LibraryProperties); ok {
418 if props.Inject_bssl_hash != nil {
419 // This is an edge case applies only to libcrypto
Sam Delmericofae47f92022-08-08 13:35:08 -0400420 if m.Name() == "libcrypto" || m.Name() == "libcrypto_for_testing" {
Yu Liu75be7b92022-02-01 09:54:09 -0800421 sharedTargetAttrs.Inject_bssl_hash.SetSelectValue(axis, config, props.Inject_bssl_hash)
422 } else {
423 ctx.PropertyErrorf("inject_bssl_hash", "only applies to libcrypto")
424 }
425 }
426 }
427 }
428 }
429
Chris Parsons77acf2e2021-12-03 17:27:16 -0500430 staticProps := bazel.BazelTargetModuleProperties{
431 Rule_class: "cc_library_static",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500432 Bzl_load_location: "//build/bazel/rules/cc:cc_library_static.bzl",
Chris Parsons77acf2e2021-12-03 17:27:16 -0500433 }
434 sharedProps := bazel.BazelTargetModuleProperties{
435 Rule_class: "cc_library_shared",
Liz Kammer2b376bc2022-01-12 12:00:49 -0500436 Bzl_load_location: "//build/bazel/rules/cc:cc_library_shared.bzl",
Jingwen Chen63930982021-03-24 10:04:33 -0400437 }
438
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000439 tags := android.ApexAvailableTags(m)
Chris Parsons58852a02021-12-09 18:10:18 -0500440 ctx.CreateBazelTargetModuleWithRestrictions(staticProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000441 android.CommonAttributes{
442 Name: m.Name() + "_bp2build_cc_library_static",
443 Tags: tags,
444 },
Chris Parsons58852a02021-12-09 18:10:18 -0500445 staticTargetAttrs, staticAttrs.Enabled)
446 ctx.CreateBazelTargetModuleWithRestrictions(sharedProps,
Jingwen Chenc4c34e12022-11-29 12:07:45 +0000447 android.CommonAttributes{
448 Name: m.Name(),
449 Tags: tags,
450 },
Chris Parsons58852a02021-12-09 18:10:18 -0500451 sharedTargetAttrs, sharedAttrs.Enabled)
Wei Li81852ca2022-07-27 00:22:06 -0700452
Trevor Radcliffe087af542022-09-16 15:36:10 +0000453 createStubsBazelTargetIfNeeded(ctx, m, compilerAttrs, exportedIncludes, baseAttributes)
454}
455
456func createStubsBazelTargetIfNeeded(ctx android.TopDownMutatorContext, m *Module, compilerAttrs compilerAttributes, exportedIncludes BazelIncludes, baseAttributes baseAttributes) {
Wei Li81852ca2022-07-27 00:22:06 -0700457 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
458 stubSuitesProps := bazel.BazelTargetModuleProperties{
459 Rule_class: "cc_stub_suite",
460 Bzl_load_location: "//build/bazel/rules/cc:cc_stub_library.bzl",
461 }
462 soname := m.Name() + ".so"
463 stubSuitesAttrs := &bazelCcStubSuiteAttributes{
464 Symbol_file: compilerAttrs.stubsSymbolFile,
465 Versions: compilerAttrs.stubsVersions,
466 Export_includes: exportedIncludes.Includes,
467 Soname: &soname,
468 Source_library: *bazel.MakeLabelAttribute(":" + m.Name()),
469 Deps: baseAttributes.deps,
470 }
471 ctx.CreateBazelTargetModule(stubSuitesProps,
472 android.CommonAttributes{Name: m.Name() + "_stub_libs"},
473 stubSuitesAttrs)
474 }
Jingwen Chen63930982021-03-24 10:04:33 -0400475}
476
Spandan Das4238c652022-09-09 01:38:47 +0000477func apiContributionBp2Build(ctx android.TopDownMutatorContext, module *Module) {
478 apiSurfaces := make([]string, 0)
479 apiHeaders := make([]string, 0)
480 // systemapi (non-null `stubs` property)
481 if module.HasStubsVariants() {
482 apiSurfaces = append(apiSurfaces, android.SystemApi.String())
483 apiIncludes := getSystemApiIncludes(ctx, module)
484 if !apiIncludes.isEmpty() {
485 createApiHeaderTarget(ctx, apiIncludes)
486 apiHeaders = append(apiHeaders, apiIncludes.name)
487 }
488 }
489 // vendorapi (non-null `llndk` property)
490 if module.HasLlndkStubs() {
491 apiSurfaces = append(apiSurfaces, android.VendorApi.String())
492 apiIncludes := getVendorApiIncludes(ctx, module)
493 if !apiIncludes.isEmpty() {
494 createApiHeaderTarget(ctx, apiIncludes)
495 apiHeaders = append(apiHeaders, apiIncludes.name)
496 }
497 }
498 // create a target only if this module contributes to an api surface
499 // TODO: Currently this does not distinguish systemapi-only headers and vendrorapi-only headers
500 // TODO: Update so that systemapi-only headers do not get exported to vendorapi (and vice-versa)
501 if len(apiSurfaces) > 0 {
502 props := bazel.BazelTargetModuleProperties{
503 Rule_class: "cc_api_contribution",
504 Bzl_load_location: "//build/bazel/rules/apis:cc_api_contribution.bzl",
505 }
506 attrs := &bazelCcApiContributionAttributes{
507 Library_name: module.Name(),
508 Api_surfaces: bazel.MakeStringListAttribute(apiSurfaces),
509 Api: apiLabelAttribute(ctx, module),
510 Hdrs: bazel.MakeLabelListAttribute(
511 bazel.MakeLabelListFromTargetNames(apiHeaders),
512 ),
513 }
514 ctx.CreateBazelTargetModule(
515 props,
516 android.CommonAttributes{
517 Name: android.ApiContributionTargetName(module.Name()),
518 SkipData: proptools.BoolPtr(true),
519 },
520 attrs,
521 )
522 }
523}
524
525// Native apis are versioned in a single .map.txt for all api surfaces
526// Pick any one of the .map.txt files
527func apiLabelAttribute(ctx android.TopDownMutatorContext, module *Module) bazel.LabelAttribute {
528 var apiFile *string
529 linker := module.linker.(*libraryDecorator)
530 if llndkApi := linker.Properties.Llndk.Symbol_file; llndkApi != nil {
531 apiFile = llndkApi
532 } else if systemApi := linker.Properties.Stubs.Symbol_file; systemApi != nil {
533 apiFile = systemApi
534 } else {
535 ctx.ModuleErrorf("API surface library does not have any API file")
536 }
537 apiLabel := android.BazelLabelForModuleSrcSingle(ctx, proptools.String(apiFile)).Label
538 return *bazel.MakeLabelAttribute(apiLabel)
539}
540
541// wrapper struct to flatten the arch and os specific export_include_dirs
542// flattening is necessary since we want to export apis of all arches even when we build for x86 (e.g.)
543type bazelCcApiLibraryHeadersAttributes struct {
544 bazelCcLibraryHeadersAttributes
545
546 Arch *string
547}
548
549func (a *bazelCcApiLibraryHeadersAttributes) isEmpty() bool {
550 return a.Export_includes.IsEmpty() &&
551 a.Export_system_includes.IsEmpty() &&
552 a.Deps.IsEmpty()
553}
554
555type apiIncludes struct {
556 name string // name of the Bazel target in the generated bp2build workspace
557 attrs bazelCcApiLibraryHeadersAttributes
558}
559
560func (includes *apiIncludes) isEmpty() bool {
561 return includes.attrs.isEmpty()
562}
563
564func (includes *apiIncludes) addDep(name string) {
565 l := bazel.Label{Label: ":" + name}
566 ll := bazel.MakeLabelList([]bazel.Label{l})
567 lla := bazel.MakeLabelListAttribute(ll)
568 includes.attrs.Deps.Append(lla)
569}
570
571func getSystemApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
572 flagProps := c.library.(*libraryDecorator).flagExporter.Properties
573 linkProps := c.library.(*libraryDecorator).baseLinker.Properties
574 includes := android.FirstUniqueStrings(flagProps.Export_include_dirs)
575 systemIncludes := android.FirstUniqueStrings(flagProps.Export_system_include_dirs)
576 headerLibs := android.FirstUniqueStrings(linkProps.Export_header_lib_headers)
577 attrs := bazelCcLibraryHeadersAttributes{
578 Export_includes: bazel.MakeStringListAttribute(includes),
579 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
580 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, headerLibs)),
581 }
582
583 return apiIncludes{
584 name: c.Name() + ".systemapi.headers",
585 attrs: bazelCcApiLibraryHeadersAttributes{
586 bazelCcLibraryHeadersAttributes: attrs,
587 },
588 }
589}
590
591func getVendorApiIncludes(ctx android.TopDownMutatorContext, c *Module) apiIncludes {
592 baseProps := c.library.(*libraryDecorator).flagExporter.Properties
593 llndkProps := c.library.(*libraryDecorator).Properties.Llndk
594 includes := baseProps.Export_include_dirs
595 systemIncludes := baseProps.Export_system_include_dirs
596 // LLNDK can override the base includes
597 if llndkIncludes := llndkProps.Override_export_include_dirs; llndkIncludes != nil {
598 includes = llndkIncludes
599 }
600 if proptools.Bool(llndkProps.Export_headers_as_system) {
601 systemIncludes = append(systemIncludes, includes...)
602 includes = nil
603 }
604
605 attrs := bazelCcLibraryHeadersAttributes{
606 Export_includes: bazel.MakeStringListAttribute(includes),
607 Export_system_includes: bazel.MakeStringListAttribute(systemIncludes),
608 Deps: bazel.MakeLabelListAttribute(apiHeaderLabels(ctx, llndkProps.Export_llndk_headers)),
609 }
610 return apiIncludes{
611 name: c.Name() + ".vendorapi.headers",
612 attrs: bazelCcApiLibraryHeadersAttributes{
613 bazelCcLibraryHeadersAttributes: attrs,
614 },
615 }
616}
617
Patrice Arruda83c89e02019-03-25 15:32:39 -0700618// cc_library creates both static and/or shared libraries for a device and/or
619// host. By default, a cc_library has a single variant that targets the device.
620// Specifying `host_supported: true` also creates a library that targets the
621// host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700622func LibraryFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800623 module, _ := NewLibrary(android.HostAndDeviceSupported)
Paul Duffina0843f62019-12-13 19:50:38 +0000624 // Can be used as both a static and a shared library.
625 module.sdkMemberTypes = []android.SdkMemberType{
626 sharedLibrarySdkMemberType,
627 staticLibrarySdkMemberType,
Paul Duffin9b76c0b2020-03-12 10:24:35 +0000628 staticAndSharedLibrarySdkMemberType,
Paul Duffina0843f62019-12-13 19:50:38 +0000629 }
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400630 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400631 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700632 return module.Init()
633}
634
Patrice Arruda83c89e02019-03-25 15:32:39 -0700635// cc_library_static creates a static library for a device and/or host binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700636func LibraryStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800637 module, library := NewLibrary(android.HostAndDeviceSupported)
638 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000639 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400640 module.bazelable = true
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400641 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700642 return module.Init()
643}
644
Patrice Arruda83c89e02019-03-25 15:32:39 -0700645// cc_library_shared creates a shared library for a device and/or host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700646func LibrarySharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800647 module, library := NewLibrary(android.HostAndDeviceSupported)
648 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000649 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Liz Kammerbe46fcc2021-11-01 15:32:43 -0400650 module.bazelable = true
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxbc4e7342021-09-14 20:58:25 +0000651 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700652 return module.Init()
653}
654
Patrice Arruda83c89e02019-03-25 15:32:39 -0700655// cc_library_host_static creates a static library that is linkable to a host
656// binary.
Steven Morelandf9e62162017-11-02 17:00:50 -0700657func LibraryHostStaticFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800658 module, library := NewLibrary(android.HostSupported)
659 library.BuildOnlyStatic()
Paul Duffina0843f62019-12-13 19:50:38 +0000660 module.sdkMemberTypes = []android.SdkMemberType{staticLibrarySdkMemberType}
Liz Kammer3d3b35c2022-01-11 16:02:50 +0000661 module.bazelable = true
662 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700663 return module.Init()
664}
665
Patrice Arruda83c89e02019-03-25 15:32:39 -0700666// cc_library_host_shared creates a shared library that is usable on a host.
Steven Morelandf9e62162017-11-02 17:00:50 -0700667func LibraryHostSharedFactory() android.Module {
Colin Crossab3b7322016-12-09 14:46:15 -0800668 module, library := NewLibrary(android.HostSupported)
669 library.BuildOnlyShared()
Paul Duffina0843f62019-12-13 19:50:38 +0000670 module.sdkMemberTypes = []android.SdkMemberType{sharedLibrarySdkMemberType}
Wei Libafb6d62021-12-10 03:14:59 -0800671 module.bazelable = true
672 module.bazelHandler = &ccLibraryBazelHandler{module: module}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700673 return module.Init()
674}
675
Chris Parsons3c27ca32020-11-20 12:42:07 -0500676// flagExporter is a separated portion of libraryDecorator pertaining to exported
677// include paths and flags. Keeping this dependency-related information separate
678// from the rest of library information is helpful in keeping data more structured
679// and explicit.
Colin Cross4d9c2d12016-07-29 12:48:20 -0700680type flagExporter struct {
681 Properties FlagExporterProperties
682
Chris Parsons3c27ca32020-11-20 12:42:07 -0500683 dirs android.Paths // Include directories to be included with -I
684 systemDirs android.Paths // System include directories to be included with -isystem
685 flags []string // Exported raw flags.
Inseob Kim69378442019-06-03 19:10:47 +0900686 deps android.Paths
Inseob Kimd110f872019-12-06 13:15:38 +0900687 headers android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700688}
689
Chris Parsons3c27ca32020-11-20 12:42:07 -0500690// exportedIncludes returns the effective include paths for this module and
691// any module that links against this module. This is obtained from
692// the export_include_dirs property in the appropriate target stanza.
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700693func (f *flagExporter) exportedIncludes(ctx ModuleContext) android.Paths {
Justin Yun6977e8a2020-10-29 18:24:11 +0900694 if ctx.inVendor() && f.Properties.Target.Vendor.Override_export_include_dirs != nil {
Steven Morelandb21df8f2018-01-05 14:42:54 -0800695 return android.PathsForModuleSrc(ctx, f.Properties.Target.Vendor.Override_export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700696 }
Justin Yun6977e8a2020-10-29 18:24:11 +0900697 if ctx.inProduct() && f.Properties.Target.Product.Override_export_include_dirs != nil {
698 return android.PathsForModuleSrc(ctx, f.Properties.Target.Product.Override_export_include_dirs)
699 }
700 return android.PathsForModuleSrc(ctx, f.Properties.Export_include_dirs)
Dan Willemsen4416e5d2017-04-06 12:43:22 -0700701}
702
Chris Parsons3c27ca32020-11-20 12:42:07 -0500703// exportIncludes registers the include directories and system include directories to be exported
704// transitively to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900705func (f *flagExporter) exportIncludes(ctx ModuleContext) {
Jiyong Park74955042019-10-22 20:19:51 +0900706 f.dirs = append(f.dirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900707 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700708}
709
Chris Parsons3c27ca32020-11-20 12:42:07 -0500710// exportIncludesAsSystem registers the include directories and system include directories to be
711// exported transitively both as system include directories to modules depending on this module.
Inseob Kim69378442019-06-03 19:10:47 +0900712func (f *flagExporter) exportIncludesAsSystem(ctx ModuleContext) {
Jiyong Park73c54ee2019-10-22 20:31:18 +0900713 // all dirs are force exported as system
Jiyong Park74955042019-10-22 20:19:51 +0900714 f.systemDirs = append(f.systemDirs, f.exportedIncludes(ctx)...)
Jiyong Park73c54ee2019-10-22 20:31:18 +0900715 f.systemDirs = append(f.systemDirs, android.PathsForModuleSrc(ctx, f.Properties.Export_system_include_dirs)...)
Inseob Kim69378442019-06-03 19:10:47 +0900716}
717
Chris Parsons3c27ca32020-11-20 12:42:07 -0500718// reexportDirs registers the given directories as include directories to be exported transitively
719// to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900720func (f *flagExporter) reexportDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900721 f.dirs = append(f.dirs, dirs...)
722}
723
Chris Parsons3c27ca32020-11-20 12:42:07 -0500724// reexportSystemDirs registers the given directories as system include directories
725// to be exported transitively to modules depending on this module.
Jiyong Park74955042019-10-22 20:19:51 +0900726func (f *flagExporter) reexportSystemDirs(dirs ...android.Path) {
Inseob Kim69378442019-06-03 19:10:47 +0900727 f.systemDirs = append(f.systemDirs, dirs...)
728}
729
Chris Parsons3c27ca32020-11-20 12:42:07 -0500730// reexportFlags registers the flags to be exported transitively to modules depending on this
731// module.
Inseob Kim69378442019-06-03 19:10:47 +0900732func (f *flagExporter) reexportFlags(flags ...string) {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800733 if android.PrefixInList(flags, "-I") || android.PrefixInList(flags, "-isystem") {
734 panic(fmt.Errorf("Exporting invalid flag %q: "+
735 "use reexportDirs or reexportSystemDirs to export directories", flag))
Inseob Kim69378442019-06-03 19:10:47 +0900736 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700737 f.flags = append(f.flags, flags...)
738}
739
Inseob Kim69378442019-06-03 19:10:47 +0900740func (f *flagExporter) reexportDeps(deps ...android.Path) {
741 f.deps = append(f.deps, deps...)
742}
743
Inseob Kimd110f872019-12-06 13:15:38 +0900744// addExportedGeneratedHeaders does nothing but collects generated header files.
745// This can be differ to exportedDeps which may contain phony files to minimize ninja.
746func (f *flagExporter) addExportedGeneratedHeaders(headers ...android.Path) {
747 f.headers = append(f.headers, headers...)
748}
749
Colin Cross0de8a1e2020-09-18 14:15:30 -0700750func (f *flagExporter) setProvider(ctx android.ModuleContext) {
751 ctx.SetProvider(FlagExporterInfoProvider, FlagExporterInfo{
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400752 // Comes from Export_include_dirs property, and those of exported transitive deps
753 IncludeDirs: android.FirstUniquePaths(f.dirs),
754 // Comes from Export_system_include_dirs property, and those of exported transitive deps
Colin Crossc82e6e22021-04-20 18:21:50 -0700755 SystemIncludeDirs: android.FirstUniquePaths(f.systemDirs),
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400756 // Used in very few places as a one-off way of adding extra defines.
757 Flags: f.flags,
758 // Used sparingly, for extra files that need to be explicitly exported to dependers,
759 // or for phony files to minimize ninja.
760 Deps: f.deps,
761 // For exported generated headers, such as exported aidl headers, proto headers, or
762 // sysprop headers.
763 GeneratedHeaders: f.headers,
Colin Cross0de8a1e2020-09-18 14:15:30 -0700764 })
Inseob Kim69378442019-06-03 19:10:47 +0900765}
766
Colin Crossb916a382016-07-29 17:28:03 -0700767// libraryDecorator wraps baseCompiler, baseLinker and baseInstaller to provide library-specific
768// functionality: static vs. shared linkage, reusing object files for shared libraries
769type libraryDecorator struct {
Colin Crossa48ab5b2017-02-14 15:28:44 -0800770 Properties LibraryProperties
Colin Crosse1bb5d02019-09-24 14:55:04 -0700771 StaticProperties StaticProperties
772 SharedProperties SharedProperties
Colin Crossa48ab5b2017-02-14 15:28:44 -0800773 MutatedProperties LibraryMutatedProperties
Colin Cross4d9c2d12016-07-29 12:48:20 -0700774
775 // For reusing static library objects for shared library
Inseob Kim69378442019-06-03 19:10:47 +0900776 reuseObjects Objects
Colin Cross10d22312017-05-03 11:01:58 -0700777
Colin Cross26c34ed2016-09-30 17:10:16 -0700778 // table-of-contents file to optimize out relinking when possible
779 tocFile android.OptionalPath
Colin Cross4d9c2d12016-07-29 12:48:20 -0700780
Colin Cross4d9c2d12016-07-29 12:48:20 -0700781 flagExporter
Liz Kammerb6a55bf2021-04-12 15:42:51 -0400782 flagExporterInfo *FlagExporterInfo
783 stripper Stripper
Colin Cross4d9c2d12016-07-29 12:48:20 -0700784
Colin Cross4d9c2d12016-07-29 12:48:20 -0700785 // For whole_static_libs
Colin Crossa2bcf2c2022-02-11 13:11:55 -0800786 objects Objects
787 wholeStaticLibsFromPrebuilts android.Paths
Colin Cross4d9c2d12016-07-29 12:48:20 -0700788
789 // Uses the module's name if empty, but can be overridden. Does not include
790 // shlib suffix.
791 libName string
Colin Crossb916a382016-07-29 17:28:03 -0700792
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800793 sabi *sabi
794
Dan Willemsen581341d2017-02-09 16:16:31 -0800795 // Output archive of gcno coverage information files
796 coverageOutputFile android.OptionalPath
797
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -0800798 // linked Source Abi Dump
799 sAbiOutputFile android.OptionalPath
800
801 // Source Abi Diff
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +0800802 sAbiDiff android.Paths
Mu-Le Lee0a9005e2022-07-05 09:49:50 +0000803
Colin Cross0875c522017-11-28 17:34:01 -0800804 // Location of the static library in the sysroot. Empty if the library is
805 // not included in the NDK.
806 ndkSysrootPath android.Path
807
Colin Crossb60190a2018-09-04 16:28:17 -0700808 // Location of the linked, unstripped library for shared libraries
809 unstrippedOutputFile android.Path
810
Dan Willemsen569edc52018-11-19 09:33:29 -0800811 // Location of the file that should be copied to dist dir when requested
Jingwen Chen40fd90a2020-06-15 05:24:19 +0000812 distFile android.Path
Dan Willemsen569edc52018-11-19 09:33:29 -0800813
Colin Cross8e21aa52020-09-28 18:28:02 -0700814 versionScriptPath android.OptionalPath
Jiyong Park7ed9de32018-10-15 22:25:07 +0900815
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800816 postInstallCmds []string
Jiyong Parkf1194352019-02-25 11:05:47 +0900817
Vic Yangefd249e2018-11-12 20:19:56 -0800818 // If useCoreVariant is true, the vendor variant of a VNDK library is
819 // not installed.
Vic Yangd92090f2020-01-08 14:32:28 -0800820 useCoreVariant bool
821 checkSameCoreVariant bool
Vic Yangefd249e2018-11-12 20:19:56 -0800822
Colin Cross5ec407b2020-09-30 11:41:33 -0700823 skipAPIDefine bool
824
Martin Stjernholmc5dd4f72020-04-01 20:38:01 +0100825 // Decorated interfaces
Colin Crossb916a382016-07-29 17:28:03 -0700826 *baseCompiler
827 *baseLinker
828 *baseInstaller
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900829
830 collectedSnapshotHeaders android.Paths
sophiez4c4f8032021-08-16 22:54:00 -0700831
832 apiListCoverageXmlPath android.ModuleOutPath
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900833}
834
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400835type ccLibraryBazelHandler struct {
Chris Parsons808d84c2021-03-09 20:43:32 -0500836 module *Module
837}
838
Chris Parsons6ce2cf92022-05-20 10:54:17 -0400839var _ BazelHandler = (*ccLibraryBazelHandler)(nil)
840
Chris Parsons94a0bba2021-06-04 15:03:47 -0400841// generateStaticBazelBuildActions constructs the StaticLibraryInfo Soong
842// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400843func (handler *ccLibraryBazelHandler) generateStaticBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400844 rootStaticArchives := ccInfo.RootStaticArchives
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400845 if len(rootStaticArchives) != 1 {
846 ctx.ModuleErrorf("expected exactly one root archive file for '%s', but got %s", label, rootStaticArchives)
Chris Parsonsf874e462022-05-10 13:50:12 -0400847 return
Chris Parsons944e7d02021-03-11 11:08:46 -0500848 }
Chris Parsonsbcc9b882021-06-03 11:16:27 -0400849 outputFilePath := android.PathForBazelOut(ctx, rootStaticArchives[0])
Chris Parsons944e7d02021-03-11 11:08:46 -0500850 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
851
Chris Parsons94a0bba2021-06-04 15:03:47 -0400852 objPaths := ccInfo.CcObjectFiles
Chris Parsons944e7d02021-03-11 11:08:46 -0500853 objFiles := make(android.Paths, len(objPaths))
854 for i, objPath := range objPaths {
855 objFiles[i] = android.PathForBazelOut(ctx, objPath)
856 }
857 objects := Objects{
858 objFiles: objFiles,
859 }
860
861 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
862 StaticLibrary: outputFilePath,
863 ReuseObjects: objects,
864 Objects: objects,
865
Chris Parsons94a0bba2021-06-04 15:03:47 -0400866 // TODO(b/190524881): Include transitive static libraries in this provider to support
Chris Parsons944e7d02021-03-11 11:08:46 -0500867 // static libraries with deps.
868 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
869 Direct(outputFilePath).
870 Build(),
871 })
Chris Parsonsf60ecf02021-04-27 14:48:30 -0400872
Chris Parsonsf874e462022-05-10 13:50:12 -0400873 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400874}
875
876// generateSharedBazelBuildActions constructs the SharedLibraryInfo Soong
877// provider from a Bazel shared library's CcInfo provider.
Chris Parsonsf874e462022-05-10 13:50:12 -0400878func (handler *ccLibraryBazelHandler) generateSharedBazelBuildActions(ctx android.ModuleContext, label string, ccInfo cquery.CcInfo) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400879 rootDynamicLibraries := ccInfo.RootDynamicLibraries
880
881 if len(rootDynamicLibraries) != 1 {
882 ctx.ModuleErrorf("expected exactly one root dynamic library file for '%s', but got %s", label, rootDynamicLibraries)
Chris Parsonsf874e462022-05-10 13:50:12 -0400883 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400884 }
885 outputFilePath := android.PathForBazelOut(ctx, rootDynamicLibraries[0])
886 handler.module.outputFile = android.OptionalPathForPath(outputFilePath)
887
Sasha Smundakedd16662022-10-07 14:44:50 -0700888 handler.module.linker.(*libraryDecorator).unstrippedOutputFile = android.PathForBazelOut(ctx, ccInfo.UnstrippedOutput)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400889
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux62585e82021-09-14 21:19:31 +0000890 var tocFile android.OptionalPath
891 if len(ccInfo.TocFile) > 0 {
892 tocFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, ccInfo.TocFile))
893 }
Chris Parsons94a0bba2021-06-04 15:03:47 -0400894 handler.module.linker.(*libraryDecorator).tocFile = tocFile
895
Yu Liu24214aa2022-11-22 12:30:59 -0800896 if len(ccInfo.AbiDiffFiles) > 0 {
897 handler.module.linker.(*libraryDecorator).sAbiDiff = android.PathsForBazelOut(ctx, ccInfo.AbiDiffFiles)
898 }
899
Chris Parsons94a0bba2021-06-04 15:03:47 -0400900 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
901 TableOfContents: tocFile,
902 SharedLibrary: outputFilePath,
Jingwen Chen702963e2021-06-15 23:44:13 +0000903 Target: ctx.Target(),
Chris Parsons94a0bba2021-06-04 15:03:47 -0400904 // TODO(b/190524881): Include transitive static libraries in this provider to support
Jingwen Chen702963e2021-06-15 23:44:13 +0000905 // static libraries with deps. The provider key for this is TransitiveStaticLibrariesForOrdering.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400906 })
Chris Parsons94a0bba2021-06-04 15:03:47 -0400907}
908
Chris Parsonsf874e462022-05-10 13:50:12 -0400909func (handler *ccLibraryBazelHandler) QueueBazelCall(ctx android.BaseModuleContext, label string) {
Chris Parsons94a0bba2021-06-04 15:03:47 -0400910 bazelCtx := ctx.Config().BazelContext
Chris Parsonsf874e462022-05-10 13:50:12 -0400911 bazelCtx.QueueBazelRequest(label, cquery.GetCcInfo, android.GetConfigKey(ctx))
912}
913
914func (handler *ccLibraryBazelHandler) ProcessBazelQueryResponse(ctx android.ModuleContext, label string) {
915 bazelCtx := ctx.Config().BazelContext
916 ccInfo, err := bazelCtx.GetCcInfo(label, android.GetConfigKey(ctx))
Chris Parsons94a0bba2021-06-04 15:03:47 -0400917 if err != nil {
918 ctx.ModuleErrorf("Error getting Bazel CcInfo: %s", err)
Chris Parsonsf874e462022-05-10 13:50:12 -0400919 return
Chris Parsons94a0bba2021-06-04 15:03:47 -0400920 }
921
922 if handler.module.static() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400923 handler.generateStaticBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400924 } else if handler.module.Shared() {
Chris Parsonsf874e462022-05-10 13:50:12 -0400925 handler.generateSharedBazelBuildActions(ctx, label, ccInfo)
Chris Parsons94a0bba2021-06-04 15:03:47 -0400926 } else {
Chris Parsonsf874e462022-05-10 13:50:12 -0400927 ctx.ModuleErrorf("Unhandled bazel case for %s (neither shared nor static!)", ctx.ModuleName())
Chris Parsons94a0bba2021-06-04 15:03:47 -0400928 }
929
930 handler.module.linker.(*libraryDecorator).setFlagExporterInfoFromCcInfo(ctx, ccInfo)
931 handler.module.maybeUnhideFromMake()
932
Chris Parsonseefc9e62021-04-02 17:36:47 -0400933 if i, ok := handler.module.linker.(snapshotLibraryInterface); ok {
934 // Dependencies on this library will expect collectedSnapshotHeaders to
935 // be set, otherwise validation will fail. For now, set this to an empty
936 // list.
Chris Parsons94a0bba2021-06-04 15:03:47 -0400937 // TODO(b/190533363): More closely mirror the collectHeadersForSnapshot
Chris Parsonseefc9e62021-04-02 17:36:47 -0400938 // implementation.
939 i.(*libraryDecorator).collectedSnapshotHeaders = android.Paths{}
940 }
Chris Parsons808d84c2021-03-09 20:43:32 -0500941}
942
Chris Parsons94a0bba2021-06-04 15:03:47 -0400943func (library *libraryDecorator) setFlagExporterInfoFromCcInfo(ctx android.ModuleContext, ccInfo cquery.CcInfo) {
944 flagExporterInfo := flagExporterInfoFromCcInfo(ctx, ccInfo)
945 // flag exporters consolidates properties like includes, flags, dependencies that should be
946 // exported from this module to other modules
947 ctx.SetProvider(FlagExporterInfoProvider, flagExporterInfo)
948 // Store flag info to be passed along to androidmk
949 // TODO(b/184387147): Androidmk should be done in Bazel, not Soong.
950 library.flagExporterInfo = &flagExporterInfo
951}
952
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400953func GlobHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900954 ret := android.Paths{}
955
956 // Headers in the source tree should be globbed. On the contrast, generated headers
957 // can't be globbed, and they should be manually collected.
958 // So, we first filter out intermediate directories (which contains generated headers)
959 // from exported directories, and then glob headers under remaining directories.
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400960 for _, path := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900961 dir := path.String()
962 // Skip if dir is for generated headers
Spandan Das925cb2a2022-11-03 16:34:12 +0000963 if strings.HasPrefix(dir, ctx.Config().OutDir()) {
Inseob Kimeda2e9c2020-03-03 22:06:32 +0900964 continue
965 }
Yu Liu1175c052022-08-15 10:21:31 -0700966
967 // Filter out the generated headers from bazel.
968 if strings.HasPrefix(dir, android.PathForBazelOut(ctx, "bazel-out").String()) {
969 continue
970 }
971
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900972 // libeigen wrongly exports the root directory "external/eigen". But only two
973 // subdirectories "Eigen" and "unsupported" contain exported header files. Even worse
974 // some of them have no extension. So we need special treatment for libeigen in order
975 // to glob correctly.
976 if dir == "external/eigen" {
977 // Only these two directories contains exported headers.
978 for _, subdir := range []string{"Eigen", "unsupported/Eigen"} {
Liz Kammer0ea79982022-02-07 08:51:47 -0500979 globDir := "external/eigen/" + subdir + "/**/*"
980 glob, err := ctx.GlobWithDeps(globDir, nil)
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900981 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -0500982 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -0400983 return nil
Inseob Kim04f2d6a2020-05-29 22:30:58 +0900984 }
985 for _, header := range glob {
986 if strings.HasSuffix(header, "/") {
987 continue
988 }
989 ext := filepath.Ext(header)
990 if ext != "" && ext != ".h" {
991 continue
992 }
993 ret = append(ret, android.PathForSource(ctx, header))
994 }
995 }
996 continue
997 }
Liz Kammer0ea79982022-02-07 08:51:47 -0500998 globDir := dir + "/**/*"
999 glob, err := ctx.GlobWithDeps(globDir, nil)
Colin Crossec118d02021-01-22 18:05:59 +00001000 if err != nil {
Liz Kammer0ea79982022-02-07 08:51:47 -05001001 ctx.ModuleErrorf("glob of %q failed: %s", globDir, err)
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001002 return nil
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001003 }
Colin Crossec118d02021-01-22 18:05:59 +00001004 isLibcxx := strings.HasPrefix(dir, "external/libcxx/include")
Jose Galmes0d736912021-03-30 11:00:06 -07001005 for _, header := range glob {
Colin Crossec118d02021-01-22 18:05:59 +00001006 if isLibcxx {
1007 // Glob all files under this special directory, because of C++ headers with no
1008 // extension.
Jose Galmes0d736912021-03-30 11:00:06 -07001009 if strings.HasSuffix(header, "/") {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001010 continue
1011 }
Colin Crossec118d02021-01-22 18:05:59 +00001012 } else {
1013 // Filter out only the files with extensions that are headers.
1014 found := false
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001015 for _, ext := range HeaderExts {
Colin Crossec118d02021-01-22 18:05:59 +00001016 if strings.HasSuffix(header, ext) {
1017 found = true
1018 break
1019 }
1020 }
1021 if !found {
1022 continue
1023 }
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001024 }
Jose Galmes0d736912021-03-30 11:00:06 -07001025 ret = append(ret, android.PathForSource(ctx, header))
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001026 }
1027 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001028 return ret
1029}
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001030
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001031func GlobGeneratedHeadersForSnapshot(ctx android.ModuleContext, paths android.Paths) android.Paths {
1032 ret := android.Paths{}
1033 for _, header := range paths {
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001034 // TODO(b/148123511): remove exportedDeps after cleaning up genrule
1035 if strings.HasSuffix(header.Base(), "-phony") {
1036 continue
1037 }
1038 ret = append(ret, header)
1039 }
Ivan Lozanod67a6b02021-05-20 13:01:32 -04001040 return ret
1041}
1042
1043// collectHeadersForSnapshot collects all exported headers from library.
1044// It globs header files in the source tree for exported include directories,
1045// and tracks generated header files separately.
1046//
1047// This is to be called from GenerateAndroidBuildActions, and then collected
1048// header files can be retrieved by snapshotHeaders().
1049func (l *libraryDecorator) collectHeadersForSnapshot(ctx android.ModuleContext) {
1050 ret := android.Paths{}
1051
1052 // Headers in the source tree should be globbed. On the contrast, generated headers
1053 // can't be globbed, and they should be manually collected.
1054 // So, we first filter out intermediate directories (which contains generated headers)
1055 // from exported directories, and then glob headers under remaining directories.
1056 ret = append(ret, GlobHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.dirs), l.flagExporter.systemDirs...))...)
1057
1058 // Collect generated headers
1059 ret = append(ret, GlobGeneratedHeadersForSnapshot(ctx, append(android.CopyOfPaths(l.flagExporter.headers), l.flagExporter.deps...))...)
Inseob Kimeda2e9c2020-03-03 22:06:32 +09001060
1061 l.collectedSnapshotHeaders = ret
1062}
1063
1064// This returns all exported header files, both generated ones and headers from source tree.
1065// collectHeadersForSnapshot() must be called before calling this.
1066func (l *libraryDecorator) snapshotHeaders() android.Paths {
1067 if l.collectedSnapshotHeaders == nil {
1068 panic("snapshotHeaders() must be called after collectHeadersForSnapshot()")
1069 }
1070 return l.collectedSnapshotHeaders
Colin Cross4d9c2d12016-07-29 12:48:20 -07001071}
1072
Chris Parsons3c27ca32020-11-20 12:42:07 -05001073// linkerProps returns the list of properties structs relevant for this library. (For example, if
1074// the library is cc_shared_library, then static-library properties are omitted.)
Colin Crossb916a382016-07-29 17:28:03 -07001075func (library *libraryDecorator) linkerProps() []interface{} {
1076 var props []interface{}
1077 props = append(props, library.baseLinker.linkerProps()...)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001078 props = append(props,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001079 &library.Properties,
Colin Crossa48ab5b2017-02-14 15:28:44 -08001080 &library.MutatedProperties,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001081 &library.flagExporter.Properties,
Colin Cross22f37952018-09-05 10:43:13 -07001082 &library.stripper.StripProperties)
Colin Crosse1bb5d02019-09-24 14:55:04 -07001083
1084 if library.MutatedProperties.BuildShared {
1085 props = append(props, &library.SharedProperties)
1086 }
1087 if library.MutatedProperties.BuildStatic {
1088 props = append(props, &library.StaticProperties)
1089 }
1090
1091 return props
Colin Cross4d9c2d12016-07-29 12:48:20 -07001092}
1093
Chris Parsons3c27ca32020-11-20 12:42:07 -05001094// linkerFlags takes a Flags struct and augments it to contain linker flags that are defined by this
1095// library, or that are implied by attributes of this library (such as whether this library is a
1096// shared library).
Colin Crossb916a382016-07-29 17:28:03 -07001097func (library *libraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross42742b82016-08-01 13:20:05 -07001098 flags = library.baseLinker.linkerFlags(ctx, flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001099
Colin Crossb916a382016-07-29 17:28:03 -07001100 // MinGW spits out warnings about -fPIC even for -fpie?!) being ignored because
1101 // all code is position independent, and then those warnings get promoted to
1102 // errors.
Colin Cross3edeee12017-04-04 12:59:48 -07001103 if !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001104 flags.Global.CFlags = append(flags.Global.CFlags, "-fPIC")
Colin Crossb916a382016-07-29 17:28:03 -07001105 }
1106
1107 if library.static() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001108 flags.Local.CFlags = append(flags.Local.CFlags, library.StaticProperties.Static.Cflags...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001109 } else if library.shared() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001110 flags.Local.CFlags = append(flags.Local.CFlags, library.SharedProperties.Shared.Cflags...)
Colin Crossb916a382016-07-29 17:28:03 -07001111 }
1112
Colin Crossa48ab5b2017-02-14 15:28:44 -08001113 if library.shared() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001114 libName := library.getLibName(ctx)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001115 var f []string
Dan Willemsen01a405a2016-06-13 17:19:03 -07001116 if ctx.toolchain().Bionic() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001117 f = append(f,
1118 "-nostdlib",
1119 "-Wl,--gc-sections",
1120 )
1121 }
1122
1123 if ctx.Darwin() {
1124 f = append(f,
1125 "-dynamiclib",
Colin Cross4d9c2d12016-07-29 12:48:20 -07001126 "-install_name @rpath/"+libName+flags.Toolchain.ShlibSuffix(),
1127 )
Colin Cross7863cf52016-10-20 10:47:21 -07001128 if ctx.Arch().ArchType == android.X86 {
1129 f = append(f,
1130 "-read_only_relocs suppress",
1131 )
1132 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001133 } else {
Josh Gao75a50a22019-06-07 17:58:59 -07001134 f = append(f, "-shared")
1135 if !ctx.Windows() {
1136 f = append(f, "-Wl,-soname,"+libName+flags.Toolchain.ShlibSuffix())
1137 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001138 }
1139
Colin Cross4af21ed2019-11-04 09:37:55 -08001140 flags.Global.LdFlags = append(flags.Global.LdFlags, f...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001141 }
1142
1143 return flags
1144}
1145
Chris Parsons3c27ca32020-11-20 12:42:07 -05001146// compilerFlags takes a Flags and augments it to contain compile flags from global values,
1147// per-target values, module type values, per-module Blueprints properties, extra flags from
1148// `flags`, and generated sources from `deps`.
Colin Crossf18e1102017-11-16 14:33:08 -08001149func (library *libraryDecorator) compilerFlags(ctx ModuleContext, flags Flags, deps PathDeps) Flags {
Dan Willemsen4416e5d2017-04-06 12:43:22 -07001150 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001151 if len(exportIncludeDirs) > 0 {
Colin Crossdad8c952017-04-26 14:55:27 -07001152 f := includeDirsToFlags(exportIncludeDirs)
Colin Cross4af21ed2019-11-04 09:37:55 -08001153 flags.Local.CommonFlags = append(flags.Local.CommonFlags, f)
1154 flags.Local.YasmFlags = append(flags.Local.YasmFlags, f)
Dan Willemsen273af7f2016-11-03 15:53:42 -07001155 }
1156
Jiyong Park7ed9de32018-10-15 22:25:07 +09001157 flags = library.baseCompiler.compilerFlags(ctx, flags, deps)
Colin Cross127bb8b2020-12-16 16:46:01 -08001158 if ctx.IsLlndk() {
1159 // LLNDK libraries ignore most of the properties on the cc_library and use the
1160 // LLNDK-specific properties instead.
1161 // Wipe all the module-local properties, leaving only the global properties.
1162 flags.Local = LocalOrGlobalFlags{}
1163 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001164 if library.buildStubs() {
Jiyong Park64379952018-12-13 18:37:29 +09001165 // Remove -include <file> when compiling stubs. Otherwise, the force included
1166 // headers might cause conflicting types error with the symbols in the
1167 // generated stubs source code. e.g.
1168 // double acos(double); // in header
1169 // void acos() {} // in the generated source code
1170 removeInclude := func(flags []string) []string {
1171 ret := flags[:0]
1172 for _, f := range flags {
1173 if strings.HasPrefix(f, "-include ") {
1174 continue
1175 }
1176 ret = append(ret, f)
1177 }
1178 return ret
1179 }
Colin Cross4af21ed2019-11-04 09:37:55 -08001180 flags.Local.CommonFlags = removeInclude(flags.Local.CommonFlags)
1181 flags.Local.CFlags = removeInclude(flags.Local.CFlags)
Jiyong Park64379952018-12-13 18:37:29 +09001182
Jiyong Park7ed9de32018-10-15 22:25:07 +09001183 flags = addStubLibraryCompilerFlags(flags)
1184 }
1185 return flags
Dan Willemsen273af7f2016-11-03 15:53:42 -07001186}
1187
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001188func (library *libraryDecorator) getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties {
1189 m := ctx.Module().(*Module)
1190 variantProps := &library.Properties.Target.Platform.Header_abi_checker
1191 if m.InVendor() {
1192 variantProps = &library.Properties.Target.Vendor.Header_abi_checker
1193 } else if m.InProduct() {
1194 variantProps = &library.Properties.Target.Product.Header_abi_checker
1195 }
1196 props := library.Properties.Header_abi_checker
1197 err := proptools.AppendProperties(&props, variantProps, nil)
1198 if err != nil {
1199 ctx.ModuleErrorf("Cannot merge headerAbiCheckerProperties: %s", err.Error())
1200 }
1201 return props
Logan Chien41eabe62019-04-10 13:33:58 +08001202}
1203
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001204func (library *libraryDecorator) compile(ctx ModuleContext, flags Flags, deps PathDeps) Objects {
Colin Cross127bb8b2020-12-16 16:46:01 -08001205 if ctx.IsLlndk() {
1206 // This is the vendor variant of an LLNDK library, build the LLNDK stubs.
1207 vndkVer := ctx.Module().(*Module).VndkVersion()
1208 if !inList(vndkVer, ctx.Config().PlatformVersionActiveCodenames()) || vndkVer == "" {
1209 // For non-enforcing devices, vndkVer is empty. Use "current" in that case, too.
1210 vndkVer = "current"
1211 }
1212 if library.stubsVersion() != "" {
1213 vndkVer = library.stubsVersion()
1214 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001215 nativeAbiResult := parseNativeAbiDefinition(ctx,
1216 String(library.Properties.Llndk.Symbol_file),
1217 android.ApiLevelOrPanic(ctx, vndkVer), "--llndk")
1218 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross127bb8b2020-12-16 16:46:01 -08001219 if !Bool(library.Properties.Llndk.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001220 library.versionScriptPath = android.OptionalPathForPath(
1221 nativeAbiResult.versionScript)
Colin Cross127bb8b2020-12-16 16:46:01 -08001222 }
1223 return objs
1224 }
Colin Cross5271fea2021-04-27 13:06:04 -07001225 if ctx.IsVendorPublicLibrary() {
Dan Albertf1d14c72020-07-30 14:32:55 -07001226 nativeAbiResult := parseNativeAbiDefinition(ctx,
1227 String(library.Properties.Vendor_public_library.Symbol_file),
1228 android.FutureApiLevel, "")
1229 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
Colin Cross5271fea2021-04-27 13:06:04 -07001230 if !Bool(library.Properties.Vendor_public_library.Unversioned) {
Dan Albertf1d14c72020-07-30 14:32:55 -07001231 library.versionScriptPath = android.OptionalPathForPath(nativeAbiResult.versionScript)
Colin Cross5271fea2021-04-27 13:06:04 -07001232 }
1233 return objs
1234 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09001235 if library.buildStubs() {
Jiyong Parka4175572021-02-04 21:05:47 +09001236 symbolFile := String(library.Properties.Stubs.Symbol_file)
1237 if symbolFile != "" && !strings.HasSuffix(symbolFile, ".map.txt") {
1238 ctx.PropertyErrorf("symbol_file", "%q doesn't have .map.txt suffix", symbolFile)
1239 return Objects{}
1240 }
Jiyong Park85cc35a2022-07-17 11:30:47 +09001241 // b/239274367 --apex and --systemapi filters symbols tagged with # apex and #
1242 // systemapi, respectively. The former is for symbols defined in platform libraries
1243 // and the latter is for symbols defined in APEXes.
1244 var flag string
1245 if ctx.Module().(android.ApexModule).NotInPlatform() {
1246 flag = "--apex"
1247 } else {
Jiyong Parkffea9b32022-07-17 17:32:56 +09001248 flag = "--systemapi"
Jiyong Park85cc35a2022-07-17 11:30:47 +09001249 }
Jiyong Parkaa27c082022-09-26 21:16:09 +09001250 // b/184712170, unless the lib is an NDK library, exclude all public symbols from
1251 // the stub so that it is mandated that all symbols are explicitly marked with
1252 // either apex or systemapi.
1253 if !ctx.Module().(*Module).IsNdk(ctx.Config()) {
1254 flag = flag + " --no-ndk"
1255 }
Dan Albertf1d14c72020-07-30 14:32:55 -07001256 nativeAbiResult := parseNativeAbiDefinition(ctx, symbolFile,
Jiyong Park85cc35a2022-07-17 11:30:47 +09001257 android.ApiLevelOrPanic(ctx, library.MutatedProperties.StubsVersion), flag)
Dan Albertf1d14c72020-07-30 14:32:55 -07001258 objs := compileStubLibrary(ctx, flags, nativeAbiResult.stubSrc)
1259 library.versionScriptPath = android.OptionalPathForPath(
1260 nativeAbiResult.versionScript)
sophiez4c4f8032021-08-16 22:54:00 -07001261
1262 // Parse symbol file to get API list for coverage
Colin Crossceaa5322021-09-28 16:37:50 -07001263 if library.stubsVersion() == "current" && ctx.PrimaryArch() && !ctx.inRecovery() && !ctx.inProduct() && !ctx.inVendor() {
sophiez4c4f8032021-08-16 22:54:00 -07001264 library.apiListCoverageXmlPath = parseSymbolFileForAPICoverage(ctx, symbolFile)
1265 }
1266
Jiyong Park7ed9de32018-10-15 22:25:07 +09001267 return objs
1268 }
1269
Colin Cross5950f382016-12-13 12:50:57 -08001270 if !library.buildShared() && !library.buildStatic() {
1271 if len(library.baseCompiler.Properties.Srcs) > 0 {
1272 ctx.PropertyErrorf("srcs", "cc_library_headers must not have any srcs")
1273 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001274 if len(library.StaticProperties.Static.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001275 ctx.PropertyErrorf("static.srcs", "cc_library_headers must not have any srcs")
1276 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001277 if len(library.SharedProperties.Shared.Srcs) > 0 {
Colin Cross5950f382016-12-13 12:50:57 -08001278 ctx.PropertyErrorf("shared.srcs", "cc_library_headers must not have any srcs")
1279 }
1280 return Objects{}
1281 }
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001282 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001283 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001284 var SourceAbiFlags []string
1285 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001286 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001287 }
Inseob Kim69378442019-06-03 19:10:47 +09001288 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1289 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001290 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001291 flags.SAbiFlags = SourceAbiFlags
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001292 totalLength := len(library.baseCompiler.Properties.Srcs) + len(deps.GeneratedSources) +
Colin Crosse1bb5d02019-09-24 14:55:04 -07001293 len(library.SharedProperties.Shared.Srcs) + len(library.StaticProperties.Static.Srcs)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001294 if totalLength > 0 {
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001295 flags.SAbiDump = true
1296 }
1297 }
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001298 objs := library.baseCompiler.compile(ctx, flags, deps)
1299 library.reuseObjects = objs
Colin Cross2f336352016-10-26 10:03:47 -07001300 buildFlags := flagsToBuilderFlags(flags)
Colin Crossb916a382016-07-29 17:28:03 -07001301
Colin Cross4d9c2d12016-07-29 12:48:20 -07001302 if library.static() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001303 srcs := android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001304 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceStaticLibrary, srcs,
1305 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001306 android.PathsForModuleSrc(ctx, library.StaticProperties.Static.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001307 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossa48ab5b2017-02-14 15:28:44 -08001308 } else if library.shared() {
Colin Crosse1bb5d02019-09-24 14:55:04 -07001309 srcs := android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Srcs)
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001310 objs = objs.Append(compileObjs(ctx, buildFlags, android.DeviceSharedLibrary, srcs,
1311 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_disabled_srcs),
Chih-Hung Hsieh9db8a0c2022-02-17 12:54:45 -08001312 android.PathsForModuleSrc(ctx, library.SharedProperties.Shared.Tidy_timeout_srcs),
Chih-Hung Hsieh769a51c2021-09-17 17:18:39 -07001313 library.baseCompiler.pathDeps, library.baseCompiler.cFlagsDeps))
Colin Crossb916a382016-07-29 17:28:03 -07001314 }
1315
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001316 return objs
Colin Crossb916a382016-07-29 17:28:03 -07001317}
1318
1319type libraryInterface interface {
Colin Cross3572cf72020-10-01 15:58:11 -07001320 versionedInterface
1321
Colin Crossb916a382016-07-29 17:28:03 -07001322 static() bool
Inseob Kimae553032019-05-14 18:52:49 +09001323 shared() bool
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001324 objs() Objects
Colin Cross0de8a1e2020-09-18 14:15:30 -07001325 reuseObjs() Objects
Colin Cross26c34ed2016-09-30 17:10:16 -07001326 toc() android.OptionalPath
Colin Crossb916a382016-07-29 17:28:03 -07001327
1328 // Returns true if the build options for the module have selected a static or shared build
1329 buildStatic() bool
1330 buildShared() bool
1331
1332 // Sets whether a specific variant is static or shared
Colin Crossa48ab5b2017-02-14 15:28:44 -08001333 setStatic()
1334 setShared()
Logan Chien41eabe62019-04-10 13:33:58 +08001335
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001336 // Gets the ABI properties for vendor, product, or platform variant
1337 getHeaderAbiCheckerProperties(ctx android.BaseModuleContext) headerAbiCheckerProperties
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001338
Logan Chien41eabe62019-04-10 13:33:58 +08001339 // Write LOCAL_ADDITIONAL_DEPENDENCIES for ABI diff
1340 androidMkWriteAdditionalDependenciesForSourceAbiDiff(w io.Writer)
Jiyong Parka90ca002019-10-07 15:47:24 +09001341
1342 availableFor(string) bool
Colin Crossceaa5322021-09-28 16:37:50 -07001343
1344 getAPIListCoverageXMLPath() android.ModuleOutPath
Colin Cross1bc94122021-10-28 13:25:54 -07001345
1346 installable() *bool
Colin Crossb916a382016-07-29 17:28:03 -07001347}
1348
Colin Crossc88c2722020-09-28 17:32:47 -07001349type versionedInterface interface {
1350 buildStubs() bool
Jiyong Parkd4a3a132021-03-17 20:21:35 +09001351 setBuildStubs(isLatest bool)
Colin Crossc88c2722020-09-28 17:32:47 -07001352 hasStubsVariants() bool
Alan Stokes73feba32022-11-14 12:21:24 +00001353 isStubsImplementationRequired() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001354 setStubsVersion(string)
1355 stubsVersion() string
1356
Colin Cross3572cf72020-10-01 15:58:11 -07001357 stubsVersions(ctx android.BaseMutatorContext) []string
Colin Crossc88c2722020-09-28 17:32:47 -07001358 setAllStubsVersions([]string)
1359 allStubsVersions() []string
Colin Cross0477b422020-10-13 18:43:54 -07001360
1361 implementationModuleName(name string) string
Colin Cross127bb8b2020-12-16 16:46:01 -08001362 hasLLNDKStubs() bool
Colin Cross1f3f1302021-04-26 18:37:44 -07001363 hasLLNDKHeaders() bool
Colin Cross5271fea2021-04-27 13:06:04 -07001364 hasVendorPublicLibrary() bool
Colin Crossc88c2722020-09-28 17:32:47 -07001365}
1366
1367var _ libraryInterface = (*libraryDecorator)(nil)
1368var _ versionedInterface = (*libraryDecorator)(nil)
1369
Justin Yun6977e8a2020-10-29 18:24:11 +09001370func (library *libraryDecorator) getLibNameHelper(baseModuleName string, inVendor bool, inProduct bool) string {
Colin Crossb916a382016-07-29 17:28:03 -07001371 name := library.libName
1372 if name == "" {
dimitryd95964a2018-11-07 13:43:34 +01001373 name = String(library.Properties.Stem)
1374 if name == "" {
Jooyung Han0302a842019-10-30 18:43:49 +09001375 name = baseModuleName
dimitryd95964a2018-11-07 13:43:34 +01001376 }
Colin Crossb916a382016-07-29 17:28:03 -07001377 }
1378
Colin Cross0fd6a412019-08-16 14:22:10 -07001379 suffix := ""
Justin Yun6977e8a2020-10-29 18:24:11 +09001380 if inVendor {
Colin Cross0fd6a412019-08-16 14:22:10 -07001381 suffix = String(library.Properties.Target.Vendor.Suffix)
Justin Yun6977e8a2020-10-29 18:24:11 +09001382 } else if inProduct {
1383 suffix = String(library.Properties.Target.Product.Suffix)
Colin Cross0fd6a412019-08-16 14:22:10 -07001384 }
1385 if suffix == "" {
1386 suffix = String(library.Properties.Suffix)
1387 }
1388
Jooyung Han0302a842019-10-30 18:43:49 +09001389 return name + suffix
1390}
1391
Chris Parsons3c27ca32020-11-20 12:42:07 -05001392// getLibName returns the actual canonical name of the library (the name which
1393// should be passed to the linker via linker flags).
Jooyung Han0302a842019-10-30 18:43:49 +09001394func (library *libraryDecorator) getLibName(ctx BaseModuleContext) string {
Justin Yun6977e8a2020-10-29 18:24:11 +09001395 name := library.getLibNameHelper(ctx.baseModuleName(), ctx.inVendor(), ctx.inProduct())
Colin Cross0fd6a412019-08-16 14:22:10 -07001396
Ivan Lozanof9e21722020-12-02 09:00:51 -05001397 if ctx.IsVndkExt() {
Jooyung Han4c2b9422019-10-22 19:53:47 +09001398 // vndk-ext lib should have the same name with original lib
1399 ctx.VisitDirectDepsWithTag(vndkExtDepTag, func(module android.Module) {
1400 originalName := module.(*Module).outputFile.Path()
1401 name = strings.TrimSuffix(originalName.Base(), originalName.Ext())
1402 })
Logan Chienf3511742017-10-31 18:04:35 +08001403 }
1404
Colin Crossb916a382016-07-29 17:28:03 -07001405 if ctx.Host() && Bool(library.Properties.Unique_host_soname) {
1406 if !strings.HasSuffix(name, "-host") {
1407 name = name + "-host"
1408 }
1409 }
1410
Inseob Kim0ce291e2019-07-04 14:38:27 +09001411 return name
Colin Crossb916a382016-07-29 17:28:03 -07001412}
1413
Jiyong Parkda732bd2018-11-02 18:23:15 +09001414var versioningMacroNamesListMutex sync.Mutex
1415
Colin Crossb916a382016-07-29 17:28:03 -07001416func (library *libraryDecorator) linkerInit(ctx BaseModuleContext) {
1417 location := InstallInSystem
Dan Albert61f32122018-07-26 14:00:24 -07001418 if library.baseLinker.sanitize.inSanitizerDir() {
Vishwath Mohan1dd88392017-03-29 22:00:18 -07001419 location = InstallInSanitizerDir
Colin Crossb916a382016-07-29 17:28:03 -07001420 }
1421 library.baseInstaller.location = location
Colin Crossb916a382016-07-29 17:28:03 -07001422 library.baseLinker.linkerInit(ctx)
Jiyong Park7ed9de32018-10-15 22:25:07 +09001423 // Let baseLinker know whether this variant is for stubs or not, so that
1424 // it can omit things that are not required for linking stubs.
1425 library.baseLinker.dynamicProperties.BuildStubs = library.buildStubs()
Jiyong Parkda732bd2018-11-02 18:23:15 +09001426
1427 if library.buildStubs() {
1428 macroNames := versioningMacroNamesList(ctx.Config())
1429 myName := versioningMacroName(ctx.ModuleName())
1430 versioningMacroNamesListMutex.Lock()
1431 defer versioningMacroNamesListMutex.Unlock()
1432 if (*macroNames)[myName] == "" {
1433 (*macroNames)[myName] = ctx.ModuleName()
1434 } else if (*macroNames)[myName] != ctx.ModuleName() {
1435 ctx.ModuleErrorf("Macro name %q for versioning conflicts with macro name from module %q ", myName, (*macroNames)[myName])
1436 }
1437 }
Colin Crossb916a382016-07-29 17:28:03 -07001438}
1439
dimitry0345ad82018-12-05 16:28:14 +01001440func (library *libraryDecorator) compilerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001441 if ctx.IsLlndk() {
1442 // LLNDK libraries ignore most of the properties on the cc_library and use the
1443 // LLNDK-specific properties instead.
1444 return deps
1445 }
1446
dimitry0345ad82018-12-05 16:28:14 +01001447 deps = library.baseCompiler.compilerDeps(ctx, deps)
1448
dimitry0345ad82018-12-05 16:28:14 +01001449 return deps
1450}
1451
Colin Cross37047f12016-12-13 17:06:13 -08001452func (library *libraryDecorator) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross127bb8b2020-12-16 16:46:01 -08001453 if ctx.IsLlndk() {
1454 // LLNDK libraries ignore most of the properties on the cc_library and use the
1455 // LLNDK-specific properties instead.
Colin Cross0fb7fcd2021-03-02 11:00:07 -08001456 deps.HeaderLibs = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
1457 deps.ReexportHeaderLibHeaders = append([]string(nil), library.Properties.Llndk.Export_llndk_headers...)
Colin Cross127bb8b2020-12-16 16:46:01 -08001458 return deps
1459 }
Colin Cross5271fea2021-04-27 13:06:04 -07001460 if ctx.IsVendorPublicLibrary() {
1461 headers := library.Properties.Vendor_public_library.Export_public_headers
1462 deps.HeaderLibs = append([]string(nil), headers...)
1463 deps.ReexportHeaderLibHeaders = append([]string(nil), headers...)
1464 return deps
1465 }
Colin Cross127bb8b2020-12-16 16:46:01 -08001466
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001467 if library.static() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001468 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001469 if library.StaticProperties.Static.System_shared_libs != nil {
1470 library.baseLinker.Properties.System_shared_libs = library.StaticProperties.Static.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001471 }
1472 } else if library.shared() {
Martin Stjernholm10566a02020-03-24 01:19:52 +00001473 // Compare with nil because an empty list needs to be propagated.
Colin Crosse1bb5d02019-09-24 14:55:04 -07001474 if library.SharedProperties.Shared.System_shared_libs != nil {
1475 library.baseLinker.Properties.System_shared_libs = library.SharedProperties.Shared.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -08001476 }
1477 }
1478
Colin Crossb916a382016-07-29 17:28:03 -07001479 deps = library.baseLinker.linkerDeps(ctx, deps)
1480
1481 if library.static() {
1482 deps.WholeStaticLibs = append(deps.WholeStaticLibs,
Colin Crosse1bb5d02019-09-24 14:55:04 -07001483 library.StaticProperties.Static.Whole_static_libs...)
1484 deps.StaticLibs = append(deps.StaticLibs, library.StaticProperties.Static.Static_libs...)
1485 deps.SharedLibs = append(deps.SharedLibs, library.StaticProperties.Static.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001486
Colin Crosse1bb5d02019-09-24 14:55:04 -07001487 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.StaticProperties.Static.Export_shared_lib_headers...)
1488 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.StaticProperties.Static.Export_static_lib_headers...)
Colin Crossa48ab5b2017-02-14 15:28:44 -08001489 } else if library.shared() {
Colin Crossd1a28132021-06-21 17:34:47 -07001490 if !Bool(library.baseLinker.Properties.Nocrt) {
1491 deps.CrtBegin = append(deps.CrtBegin, ctx.toolchain().CrtBeginSharedLibrary()...)
1492 deps.CrtEnd = append(deps.CrtEnd, ctx.toolchain().CrtEndSharedLibrary()...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001493 }
Colin Crosse1bb5d02019-09-24 14:55:04 -07001494 deps.WholeStaticLibs = append(deps.WholeStaticLibs, library.SharedProperties.Shared.Whole_static_libs...)
1495 deps.StaticLibs = append(deps.StaticLibs, library.SharedProperties.Shared.Static_libs...)
1496 deps.SharedLibs = append(deps.SharedLibs, library.SharedProperties.Shared.Shared_libs...)
Colin Crosseefe9a32019-01-22 14:41:08 -08001497
Colin Crosse1bb5d02019-09-24 14:55:04 -07001498 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, library.SharedProperties.Shared.Export_shared_lib_headers...)
1499 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, library.SharedProperties.Shared.Export_static_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001500 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001501 if ctx.inVendor() {
Jiyong Park52d25bd2017-10-13 09:17:01 +09001502 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
1503 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1504 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001505 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_shared_libs)
1506 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +09001507 }
Justin Yun6977e8a2020-10-29 18:24:11 +09001508 if ctx.inProduct() {
1509 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1510 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1511 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1512 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_shared_libs)
1513 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Product.Exclude_static_libs)
1514 }
Jiyong Parkf9332f12018-02-01 00:54:12 +09001515 if ctx.inRecovery() {
1516 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
1517 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1518 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Victor Chang51271c12019-01-30 16:02:22 +00001519 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_shared_libs)
1520 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Recovery.Exclude_static_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +09001521 }
Yifan Hongcf4832c2020-01-21 17:04:13 -08001522 if ctx.inRamdisk() {
1523 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1524 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1525 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1526 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_shared_libs)
1527 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Ramdisk.Exclude_static_libs)
1528 }
Yifan Hong6da33c22020-10-27 15:01:21 -07001529 if ctx.inVendorRamdisk() {
1530 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1531 deps.SharedLibs = removeListFromList(deps.SharedLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1532 deps.StaticLibs = removeListFromList(deps.StaticLibs, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1533 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
1534 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, library.baseLinker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
1535 }
Colin Cross2383f3b2018-02-06 14:40:13 -08001536
Colin Cross4d9c2d12016-07-29 12:48:20 -07001537 return deps
1538}
1539
Paul Duffin13f02712020-03-06 12:30:43 +00001540func (library *libraryDecorator) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
1541 specifiedDeps = library.baseLinker.linkerSpecifiedDeps(specifiedDeps)
1542 var properties StaticOrSharedProperties
1543 if library.static() {
1544 properties = library.StaticProperties.Static
1545 } else if library.shared() {
1546 properties = library.SharedProperties.Shared
1547 }
1548
1549 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001550
1551 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
1552 // either input list doesn't come out as nil.
1553 if specifiedDeps.systemSharedLibs == nil {
1554 specifiedDeps.systemSharedLibs = properties.System_shared_libs
1555 } else {
1556 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, properties.System_shared_libs...)
1557 }
Paul Duffin13f02712020-03-06 12:30:43 +00001558
1559 specifiedDeps.sharedLibs = android.FirstUniqueStrings(specifiedDeps.sharedLibs)
Martin Stjernholm10566a02020-03-24 01:19:52 +00001560 if len(specifiedDeps.systemSharedLibs) > 0 {
1561 // Skip this if systemSharedLibs is either nil or [], to ensure they are
1562 // retained.
1563 specifiedDeps.systemSharedLibs = android.FirstUniqueStrings(specifiedDeps.systemSharedLibs)
1564 }
Paul Duffin13f02712020-03-06 12:30:43 +00001565 return specifiedDeps
1566}
1567
Colin Crossb916a382016-07-29 17:28:03 -07001568func (library *libraryDecorator) linkStatic(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001569 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001570
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001571 library.objects = deps.WholeStaticLibObjs.Copy()
1572 library.objects = library.objects.Append(objs)
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001573 library.wholeStaticLibsFromPrebuilts = android.CopyOfPaths(deps.WholeStaticLibsFromPrebuilts)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001574
Inseob Kim0ce291e2019-07-04 14:38:27 +09001575 fileName := ctx.ModuleName() + staticLibraryExtension
Colin Cross86803cf2018-02-15 14:12:26 -08001576 outputFile := android.PathForModuleOut(ctx, fileName)
Dan Willemsen581341d2017-02-09 16:16:31 -08001577 builderFlags := flagsToBuilderFlags(flags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001578
Dan Willemsen569edc52018-11-19 09:33:29 -08001579 if Bool(library.baseLinker.Properties.Use_version_lib) {
1580 if ctx.Host() {
1581 versionedOutputFile := outputFile
1582 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1583 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1584 } else {
1585 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001586 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001587 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1588 }
Colin Cross86803cf2018-02-15 14:12:26 -08001589 }
1590
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001591 transformObjToStaticLib(ctx, library.objects.objFiles, deps.WholeStaticLibsFromPrebuilts, builderFlags, outputFile, nil, objs.tidyDepFiles)
Dan Willemsen581341d2017-02-09 16:16:31 -08001592
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001593 library.coverageOutputFile = transformCoverageFilesToZip(ctx, library.objects, ctx.ModuleName())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001594
Colin Cross4d9c2d12016-07-29 12:48:20 -07001595 ctx.CheckbuildFile(outputFile)
1596
Colin Cross649d8172020-12-10 12:30:21 -08001597 if library.static() {
1598 ctx.SetProvider(StaticLibraryInfoProvider, StaticLibraryInfo{
Colin Crossa2bcf2c2022-02-11 13:11:55 -08001599 StaticLibrary: outputFile,
1600 ReuseObjects: library.reuseObjects,
1601 Objects: library.objects,
1602 WholeStaticLibsFromPrebuilts: library.wholeStaticLibsFromPrebuilts,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001603
Colin Cross649d8172020-12-10 12:30:21 -08001604 TransitiveStaticLibrariesForOrdering: android.NewDepSetBuilder(android.TOPOLOGICAL).
1605 Direct(outputFile).
1606 Transitive(deps.TranstiveStaticLibrariesForOrdering).
1607 Build(),
1608 })
1609 }
1610
1611 if library.header() {
1612 ctx.SetProvider(HeaderLibraryInfoProvider, HeaderLibraryInfo{})
1613 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07001614
Colin Cross4d9c2d12016-07-29 12:48:20 -07001615 return outputFile
1616}
1617
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001618func ndkSharedLibDeps(ctx ModuleContext) android.Paths {
1619 if ctx.Module().(*Module).IsSdkVariant() {
1620 // The NDK sysroot timestamp file depends on all the NDK
1621 // sysroot header and shared library files.
1622 return android.Paths{getNdkBaseTimestampFile(ctx)}
1623 }
1624 return nil
1625}
1626
Colin Crossb916a382016-07-29 17:28:03 -07001627func (library *libraryDecorator) linkShared(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07001628 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001629
1630 var linkerDeps android.Paths
Pirama Arumuga Nainarada83ec2017-08-31 23:38:27 -07001631 linkerDeps = append(linkerDeps, flags.LdFlagsDeps...)
Chih-Hung Hsiehf6ca1b92021-12-05 18:02:50 -08001632 linkerDeps = append(linkerDeps, ndkSharedLibDeps(ctx)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001633
Colin Cross2383f3b2018-02-06 14:40:13 -08001634 unexportedSymbols := ctx.ExpandOptionalSource(library.Properties.Unexported_symbols_list, "unexported_symbols_list")
1635 forceNotWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_not_weak_list, "force_symbols_not_weak_list")
1636 forceWeakSymbols := ctx.ExpandOptionalSource(library.Properties.Force_symbols_weak_list, "force_symbols_weak_list")
Colin Cross4d9c2d12016-07-29 12:48:20 -07001637 if !ctx.Darwin() {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001638 if unexportedSymbols.Valid() {
1639 ctx.PropertyErrorf("unexported_symbols_list", "Only supported on Darwin")
1640 }
1641 if forceNotWeakSymbols.Valid() {
1642 ctx.PropertyErrorf("force_symbols_not_weak_list", "Only supported on Darwin")
1643 }
1644 if forceWeakSymbols.Valid() {
1645 ctx.PropertyErrorf("force_symbols_weak_list", "Only supported on Darwin")
1646 }
1647 } else {
Colin Cross4d9c2d12016-07-29 12:48:20 -07001648 if unexportedSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001649 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-unexported_symbols_list,"+unexportedSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001650 linkerDeps = append(linkerDeps, unexportedSymbols.Path())
1651 }
1652 if forceNotWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001653 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_not_weak_list,"+forceNotWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001654 linkerDeps = append(linkerDeps, forceNotWeakSymbols.Path())
1655 }
1656 if forceWeakSymbols.Valid() {
Colin Cross4af21ed2019-11-04 09:37:55 -08001657 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-force_symbols_weak_list,"+forceWeakSymbols.String())
Colin Cross4d9c2d12016-07-29 12:48:20 -07001658 linkerDeps = append(linkerDeps, forceWeakSymbols.Path())
1659 }
1660 }
Colin Cross8e21aa52020-09-28 18:28:02 -07001661 if library.versionScriptPath.Valid() {
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001662 linkerScriptFlags := "-Wl,--version-script," + library.versionScriptPath.String()
Colin Cross4af21ed2019-11-04 09:37:55 -08001663 flags.Local.LdFlags = append(flags.Local.LdFlags, linkerScriptFlags)
Colin Cross8e21aa52020-09-28 18:28:02 -07001664 linkerDeps = append(linkerDeps, library.versionScriptPath.Path())
Jiyong Parkc1e7f482019-01-12 13:39:10 +09001665 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001666
1667 fileName := library.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
1668 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Cross0de8a1e2020-09-18 14:15:30 -07001669 unstrippedOutputFile := outputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001670
Josh Gao75a50a22019-06-07 17:58:59 -07001671 var implicitOutputs android.WritablePaths
1672 if ctx.Windows() {
1673 importLibraryPath := android.PathForModuleOut(ctx, pathtools.ReplaceExtension(fileName, "lib"))
1674
Colin Cross4af21ed2019-11-04 09:37:55 -08001675 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--out-implib="+importLibraryPath.String())
Josh Gao75a50a22019-06-07 17:58:59 -07001676 implicitOutputs = append(implicitOutputs, importLibraryPath)
1677 }
1678
Colin Cross4d9c2d12016-07-29 12:48:20 -07001679 builderFlags := flagsToBuilderFlags(flags)
1680
Dan Willemsen47450072021-10-19 20:24:49 -07001681 if ctx.Darwin() && deps.DarwinSecondArchOutput.Valid() {
1682 fatOutputFile := outputFile
1683 outputFile = android.PathForModuleOut(ctx, "pre-fat", fileName)
1684 transformDarwinUniversalBinary(ctx, fatOutputFile, outputFile, deps.DarwinSecondArchOutput.Path())
1685 }
1686
Colin Crossb496cfd2018-09-10 16:50:05 -07001687 // Optimize out relinking against shared libraries whose interface hasn't changed by
1688 // depending on a table of contents file instead of the library itself.
Colin Cross70dda7e2019-10-01 22:05:35 -07001689 tocFile := outputFile.ReplaceExtension(ctx, flags.Toolchain.ShlibSuffix()[1:]+".toc")
Colin Crossb496cfd2018-09-10 16:50:05 -07001690 library.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -04001691 TransformSharedObjectToToc(ctx, outputFile, tocFile)
Colin Cross89562dc2016-10-03 17:47:19 -07001692
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001693 stripFlags := flagsToStripFlags(flags)
Colin Crossadc81a02020-12-14 17:01:55 -08001694 needsStrip := library.stripper.NeedsStrip(ctx)
1695 if library.buildStubs() {
1696 // No need to strip stubs libraries
1697 needsStrip = false
1698 }
1699 if needsStrip {
Yi Kongb5c34d72018-11-07 16:28:49 -08001700 if ctx.Darwin() {
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001701 stripFlags.StripUseGnuStrip = true
Yi Kongb5c34d72018-11-07 16:28:49 -08001702 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07001703 strippedOutputFile := outputFile
1704 outputFile = android.PathForModuleOut(ctx, "unstripped", fileName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001705 library.stripper.StripExecutableOrSharedLib(ctx, outputFile, strippedOutputFile, stripFlags)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001706 }
Colin Crossb60190a2018-09-04 16:28:17 -07001707 library.unstrippedOutputFile = outputFile
1708
Colin Crossd7227f92019-09-05 14:26:33 -07001709 outputFile = maybeInjectBoringSSLHash(ctx, outputFile, library.Properties.Inject_bssl_hash, fileName)
Pete Bentley803e1612019-08-06 22:19:59 +01001710
Dan Willemsen569edc52018-11-19 09:33:29 -08001711 if Bool(library.baseLinker.Properties.Use_version_lib) {
1712 if ctx.Host() {
1713 versionedOutputFile := outputFile
1714 outputFile = android.PathForModuleOut(ctx, "unversioned", fileName)
1715 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1716 } else {
1717 versionedOutputFile := android.PathForModuleOut(ctx, "versioned", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001718 library.distFile = versionedOutputFile
Dan Willemsen569edc52018-11-19 09:33:29 -08001719
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001720 if library.stripper.NeedsStrip(ctx) {
Dan Willemsen569edc52018-11-19 09:33:29 -08001721 out := android.PathForModuleOut(ctx, "versioned-stripped", fileName)
Jingwen Chen40fd90a2020-06-15 05:24:19 +00001722 library.distFile = out
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001723 library.stripper.StripExecutableOrSharedLib(ctx, versionedOutputFile, out, stripFlags)
Dan Willemsen569edc52018-11-19 09:33:29 -08001724 }
1725
1726 library.injectVersionSymbol(ctx, outputFile, versionedOutputFile)
1727 }
Colin Cross86803cf2018-02-15 14:12:26 -08001728 }
1729
Jiyong Park64a44f22019-01-18 14:37:08 +09001730 sharedLibs := deps.EarlySharedLibs
1731 sharedLibs = append(sharedLibs, deps.SharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001732 sharedLibs = append(sharedLibs, deps.LateSharedLibs...)
1733
Jiyong Park64a44f22019-01-18 14:37:08 +09001734 linkerDeps = append(linkerDeps, deps.EarlySharedLibsDeps...)
Colin Cross26c34ed2016-09-30 17:10:16 -07001735 linkerDeps = append(linkerDeps, deps.SharedLibsDeps...)
1736 linkerDeps = append(linkerDeps, deps.LateSharedLibsDeps...)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001737 transformObjToDynamicBinary(ctx, objs.objFiles, sharedLibs,
Colin Cross4d9c2d12016-07-29 12:48:20 -07001738 deps.StaticLibs, deps.LateStaticLibs, deps.WholeStaticLibs,
Chih-Hung Hsieh7540a782022-01-08 19:56:09 -08001739 linkerDeps, deps.CrtBegin, deps.CrtEnd, false, builderFlags, outputFile, implicitOutputs, objs.tidyDepFiles)
Colin Cross4d9c2d12016-07-29 12:48:20 -07001740
Dan Willemsen581341d2017-02-09 16:16:31 -08001741 objs.coverageFiles = append(objs.coverageFiles, deps.StaticLibObjs.coverageFiles...)
1742 objs.coverageFiles = append(objs.coverageFiles, deps.WholeStaticLibObjs.coverageFiles...)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001743 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.StaticLibObjs.sAbiDumpFiles...)
1744 objs.sAbiDumpFiles = append(objs.sAbiDumpFiles, deps.WholeStaticLibObjs.sAbiDumpFiles...)
1745
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001746 library.coverageOutputFile = transformCoverageFilesToZip(ctx, objs, library.getLibName(ctx))
Colin Cross0de8a1e2020-09-18 14:15:30 -07001747 library.linkSAbiDumpFiles(ctx, objs, fileName, unstrippedOutputFile)
Dan Willemsen581341d2017-02-09 16:16:31 -08001748
Liz Kammeref6dfea2021-06-08 15:37:09 -04001749 var transitiveStaticLibrariesForOrdering *android.DepSet
Colin Cross0de8a1e2020-09-18 14:15:30 -07001750 if static := ctx.GetDirectDepsWithTag(staticVariantTag); len(static) > 0 {
1751 s := ctx.OtherModuleProvider(static[0], StaticLibraryInfoProvider).(StaticLibraryInfo)
Liz Kammeref6dfea2021-06-08 15:37:09 -04001752 transitiveStaticLibrariesForOrdering = s.TransitiveStaticLibrariesForOrdering
Colin Cross0de8a1e2020-09-18 14:15:30 -07001753 }
1754
1755 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -04001756 TableOfContents: android.OptionalPathForPath(tocFile),
1757 SharedLibrary: unstrippedOutputFile,
1758 TransitiveStaticLibrariesForOrdering: transitiveStaticLibrariesForOrdering,
1759 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001760 })
1761
1762 stubs := ctx.GetDirectDepsWithTag(stubImplDepTag)
1763 if len(stubs) > 0 {
Chris Parsons3c27ca32020-11-20 12:42:07 -05001764 var stubsInfo []SharedStubLibrary
Colin Cross0de8a1e2020-09-18 14:15:30 -07001765 for _, stub := range stubs {
1766 stubInfo := ctx.OtherModuleProvider(stub, SharedLibraryInfoProvider).(SharedLibraryInfo)
1767 flagInfo := ctx.OtherModuleProvider(stub, FlagExporterInfoProvider).(FlagExporterInfo)
Chris Parsons3c27ca32020-11-20 12:42:07 -05001768 stubsInfo = append(stubsInfo, SharedStubLibrary{
Colin Cross31076b32020-10-23 17:22:06 -07001769 Version: moduleLibraryInterface(stub).stubsVersion(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001770 SharedLibraryInfo: stubInfo,
1771 FlagExporterInfo: flagInfo,
1772 })
1773 }
Chris Parsons3c27ca32020-11-20 12:42:07 -05001774 ctx.SetProvider(SharedLibraryStubsProvider, SharedLibraryStubsInfo{
1775 SharedStubLibraries: stubsInfo,
Colin Cross0de8a1e2020-09-18 14:15:30 -07001776
Colin Cross127bb8b2020-12-16 16:46:01 -08001777 IsLLNDK: ctx.IsLlndk(),
Colin Cross0de8a1e2020-09-18 14:15:30 -07001778 })
1779 }
1780
1781 return unstrippedOutputFile
Colin Cross4d9c2d12016-07-29 12:48:20 -07001782}
1783
Jiyong Parkaf6d8952019-01-31 12:21:23 +09001784func (library *libraryDecorator) unstrippedOutputFilePath() android.Path {
1785 return library.unstrippedOutputFile
1786}
1787
Thiébaud Weksteend4587452020-08-19 14:53:01 +02001788func (library *libraryDecorator) disableStripping() {
1789 library.stripper.StripProperties.Strip.None = BoolPtr(true)
1790}
1791
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -07001792func (library *libraryDecorator) nativeCoverage() bool {
1793 if library.header() || library.buildStubs() {
1794 return false
1795 }
1796 return true
1797}
1798
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001799func (library *libraryDecorator) coverageOutputFilePath() android.OptionalPath {
1800 return library.coverageOutputFile
1801}
1802
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001803func getRefAbiDumpFile(ctx android.ModuleInstallPathContext,
1804 versionedDumpDir, fileName string) android.OptionalPath {
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001805
1806 currentArchType := ctx.Arch().ArchType
1807 primaryArchType := ctx.Config().DevicePrimaryArchType()
1808 archName := currentArchType.String()
1809 if currentArchType != primaryArchType {
1810 archName += "_" + primaryArchType.String()
1811 }
1812
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001813 return android.ExistentPathForSource(ctx, versionedDumpDir, archName, "source-based",
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001814 fileName+".lsdump")
Mu-Le Leef5ed30b2022-08-30 10:37:21 +00001815}
1816
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001817func getRefAbiDumpDir(isNdk, isVndk bool) string {
1818 var dirName string
1819 if isNdk {
1820 dirName = "ndk"
1821 } else if isVndk {
1822 dirName = "vndk"
1823 } else {
1824 dirName = "platform"
1825 }
1826 return filepath.Join("prebuilts", "abi-dumps", dirName)
1827}
Logan Chien7eefdc42018-07-11 18:10:41 +08001828
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001829func prevRefAbiDumpVersion(ctx ModuleContext, dumpDir string) int {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001830 sdkVersionInt := ctx.Config().PlatformSdkVersion().FinalInt()
1831 sdkVersionStr := ctx.Config().PlatformSdkVersion().String()
1832
1833 if ctx.Config().PlatformSdkFinal() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001834 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001835 } else {
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001836 // The platform SDK version can be upgraded before finalization while the corresponding abi dumps hasn't
1837 // been generated. Thus the Cross-Version Check chooses PLATFORM_SDK_VERION - 1 as previous version.
1838 // This situation could be identified by checking the existence of the PLATFORM_SDK_VERION dump directory.
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001839 versionedDumpDir := android.ExistentPathForSource(ctx, dumpDir, sdkVersionStr)
1840 if versionedDumpDir.Valid() {
Mu-Le Lee13043932022-08-27 08:55:25 +00001841 return sdkVersionInt
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001842 } else {
Mu-Le Lee13043932022-08-27 08:55:25 +00001843 return sdkVersionInt - 1
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001844 }
1845 }
1846}
1847
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001848func currRefAbiDumpVersion(ctx ModuleContext, isVndk bool) string {
1849 if isVndk {
1850 // Each version of VNDK is independent, so follow the VNDK version which is the codename or PLATFORM_SDK_VERSION.
1851 return ctx.Module().(*Module).VndkVersion()
1852 } else if ctx.Config().PlatformSdkFinal() {
1853 // After sdk finalization, the ABI of the latest API level must be consistent with the source code,
1854 // so choose PLATFORM_SDK_VERSION as the current version.
1855 return ctx.Config().PlatformSdkVersion().String()
1856 } else {
1857 return "current"
1858 }
1859}
1860
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001861// sourceAbiDiff registers a build statement to compare linked sAbi dump files (.lsdump).
1862func (library *libraryDecorator) sourceAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1863 baseName, nameExt string, isLlndkOrNdk, allowExtensions bool,
1864 sourceVersion, errorMessage string) {
1865
1866 sourceDump := library.sAbiOutputFile.Path()
1867
1868 extraFlags := []string{"-target-version", sourceVersion}
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001869 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
1870 if Bool(headerAbiChecker.Check_all_apis) {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001871 extraFlags = append(extraFlags, "-check-all-apis")
1872 } else {
1873 extraFlags = append(extraFlags,
1874 "-allow-unreferenced-changes",
1875 "-allow-unreferenced-elf-symbol-changes")
1876 }
1877 if isLlndkOrNdk {
1878 extraFlags = append(extraFlags, "-consider-opaque-types-different")
1879 }
1880 if allowExtensions {
1881 extraFlags = append(extraFlags, "-allow-extensions")
1882 }
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001883 extraFlags = append(extraFlags, headerAbiChecker.Diff_flags...)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001884
1885 library.sAbiDiff = append(
1886 library.sAbiDiff,
1887 transformAbiDumpToAbiDiff(ctx, sourceDump, referenceDump,
1888 baseName, nameExt, extraFlags, errorMessage))
1889}
1890
1891func (library *libraryDecorator) crossVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1892 baseName string, isLlndkOrNdk bool, sourceVersion, prevVersion string) {
1893
1894 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 + "."
1895
1896 library.sourceAbiDiff(ctx, referenceDump, baseName, prevVersion,
1897 isLlndkOrNdk, /* allowExtensions */ true, sourceVersion, errorMessage)
1898}
1899
1900func (library *libraryDecorator) sameVersionAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1901 baseName string, isLlndkOrNdk, allowExtensions bool) {
1902
1903 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1904 errorMessage := "error: Please update ABI references with: $$ANDROID_BUILD_TOP/development/vndk/tools/header-checker/utils/create_reference_dumps.py -l " + libName
1905
1906 library.sourceAbiDiff(ctx, referenceDump, baseName, /* nameExt */ "",
1907 isLlndkOrNdk, allowExtensions, "current", errorMessage)
1908}
1909
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001910func (library *libraryDecorator) optInAbiDiff(ctx android.ModuleContext, referenceDump android.Path,
1911 baseName, nameExt string, isLlndkOrNdk bool, refDumpDir string) {
1912
1913 libName := strings.TrimSuffix(baseName, filepath.Ext(baseName))
1914 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
1915
1916 library.sourceAbiDiff(ctx, referenceDump, baseName, nameExt,
1917 isLlndkOrNdk, /* allowExtensions */ false, "current", errorMessage)
1918}
1919
Jayant Chowdhary6ab3d842017-06-26 12:52:58 -07001920func (library *libraryDecorator) linkSAbiDumpFiles(ctx ModuleContext, objs Objects, fileName string, soFile android.Path) {
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001921 if library.sabi.shouldCreateSourceAbiDump() {
Jayant Chowdharya4fce192017-09-06 13:10:03 -07001922 exportIncludeDirs := library.flagExporter.exportedIncludes(ctx)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001923 var SourceAbiFlags []string
1924 for _, dir := range exportIncludeDirs.Strings() {
Jayant Chowdhary715cac32017-04-20 06:53:59 -07001925 SourceAbiFlags = append(SourceAbiFlags, "-I"+dir)
1926 }
Inseob Kim69378442019-06-03 19:10:47 +09001927 for _, reexportedInclude := range library.sabi.Properties.ReexportedIncludes {
1928 SourceAbiFlags = append(SourceAbiFlags, "-I"+reexportedInclude)
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001929 }
1930 exportedHeaderFlags := strings.Join(SourceAbiFlags, " ")
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001931 headerAbiChecker := library.getHeaderAbiCheckerProperties(ctx)
Chris Parsonsbf4f55f2020-11-23 17:02:44 -05001932 library.sAbiOutputFile = transformDumpToLinkedDump(ctx, objs.sAbiDumpFiles, soFile, fileName, exportedHeaderFlags,
Jiyong Parka034b832019-08-27 14:02:19 +09001933 android.OptionalPathForModuleSrc(ctx, library.symbolFileForAbiCheck(ctx)),
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001934 headerAbiChecker.Exclude_symbol_versions,
1935 headerAbiChecker.Exclude_symbol_tags)
Logan Chien2f2b8902018-07-10 15:01:19 +08001936
Yo Chiang2bbadfa2020-12-14 11:42:16 +08001937 addLsdumpPath(classifySourceAbiDump(ctx) + ":" + library.sAbiOutputFile.String())
Hsin-Yi Chen53489642019-07-31 17:10:45 +08001938
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001939 // The logic must be consistent with classifySourceAbiDump.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001940 isVndk := ctx.useVndk() && ctx.isVndk()
Hsin-Yi Chen7584bda2022-11-08 22:51:02 +08001941 isNdk := ctx.isNdk(ctx.Config())
1942 isLlndk := ctx.isImplementationForLLNDKPublic()
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001943 dumpDir := getRefAbiDumpDir(isNdk, isVndk)
1944 binderBitness := ctx.DeviceConfig().BinderBitness()
Mu-Le Lee13043932022-08-27 08:55:25 +00001945 // If NDK or PLATFORM library, check against previous version ABI.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001946 if !isVndk {
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001947 prevVersionInt := prevRefAbiDumpVersion(ctx, dumpDir)
1948 prevVersion := strconv.Itoa(prevVersionInt)
1949 prevDumpDir := filepath.Join(dumpDir, prevVersion, binderBitness)
1950 prevDumpFile := getRefAbiDumpFile(ctx, prevDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001951 if prevDumpFile.Valid() {
1952 library.crossVersionAbiDiff(ctx, prevDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001953 fileName, isLlndk || isNdk,
1954 strconv.Itoa(prevVersionInt+1), prevVersion)
Mu-Le Lee0a9005e2022-07-05 09:49:50 +00001955 }
1956 }
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001957 // Check against the current version.
Hsin-Yi Chena90bd382022-11-10 16:56:27 +08001958 currVersion := currRefAbiDumpVersion(ctx, isVndk)
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001959 currDumpDir := filepath.Join(dumpDir, currVersion, binderBitness)
1960 currDumpFile := getRefAbiDumpFile(ctx, currDumpDir, fileName)
Hsin-Yi Chen0af4e672022-11-23 14:39:46 +08001961 if currDumpFile.Valid() {
1962 library.sameVersionAbiDiff(ctx, currDumpFile.Path(),
Hsin-Yi Chena6ddb142022-10-27 14:55:42 +08001963 fileName, isLlndk || isNdk, ctx.IsVndkExt())
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001964 }
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001965 // Check against the opt-in reference dumps.
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08001966 for i, optInDumpDir := range headerAbiChecker.Ref_dump_dirs {
Hsin-Yi Chenf3630122022-11-17 14:29:43 +08001967 optInDumpDirPath := android.PathForModuleSrc(ctx, optInDumpDir)
1968 // Ref_dump_dirs are not versioned.
1969 // They do not contain subdir for binder bitness because 64-bit binder has been mandatory.
1970 optInDumpFile := getRefAbiDumpFile(ctx, optInDumpDirPath.String(), fileName)
1971 if !optInDumpFile.Valid() {
1972 continue
1973 }
1974 library.optInAbiDiff(ctx, optInDumpFile.Path(),
1975 fileName, "opt"+strconv.Itoa(i), isLlndk || isNdk,
1976 optInDumpDirPath.String())
1977 }
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08001978 }
1979}
1980
Inseob Kimcc12d902021-05-14 20:15:55 +09001981func processLLNDKHeaders(ctx ModuleContext, srcHeaderDir string, outDir android.ModuleGenPath) (timestamp android.Path, installPaths android.WritablePaths) {
Colin Cross127bb8b2020-12-16 16:46:01 -08001982 srcDir := android.PathForModuleSrc(ctx, srcHeaderDir)
1983 srcFiles := ctx.GlobFiles(filepath.Join(srcDir.String(), "**/*.h"), nil)
1984
Colin Cross127bb8b2020-12-16 16:46:01 -08001985 for _, header := range srcFiles {
1986 headerDir := filepath.Dir(header.String())
1987 relHeaderDir, err := filepath.Rel(srcDir.String(), headerDir)
1988 if err != nil {
1989 ctx.ModuleErrorf("filepath.Rel(%q, %q) failed: %s",
1990 srcDir.String(), headerDir, err)
1991 continue
1992 }
1993
1994 installPaths = append(installPaths, outDir.Join(ctx, relHeaderDir, header.Base()))
1995 }
1996
Inseob Kimcc12d902021-05-14 20:15:55 +09001997 return processHeadersWithVersioner(ctx, srcDir, outDir, srcFiles, installPaths), installPaths
Colin Cross127bb8b2020-12-16 16:46:01 -08001998}
1999
Chris Parsons3c27ca32020-11-20 12:42:07 -05002000// link registers actions to link this library, and sets various fields
2001// on this library to reflect information that should be exported up the build
2002// tree (for example, exported flags and include paths).
Colin Crossb916a382016-07-29 17:28:03 -07002003func (library *libraryDecorator) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002004 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002005
Colin Cross127bb8b2020-12-16 16:46:01 -08002006 if ctx.IsLlndk() {
2007 if len(library.Properties.Llndk.Export_preprocessed_headers) > 0 {
2008 // This is the vendor variant of an LLNDK library with preprocessed headers.
2009 genHeaderOutDir := android.PathForModuleGen(ctx, "include")
2010
2011 var timestampFiles android.Paths
2012 for _, dir := range library.Properties.Llndk.Export_preprocessed_headers {
Inseob Kimcc12d902021-05-14 20:15:55 +09002013 timestampFile, installPaths := processLLNDKHeaders(ctx, dir, genHeaderOutDir)
2014 timestampFiles = append(timestampFiles, timestampFile)
2015 library.addExportedGeneratedHeaders(installPaths.Paths()...)
Colin Cross127bb8b2020-12-16 16:46:01 -08002016 }
2017
2018 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2019 library.reexportSystemDirs(genHeaderOutDir)
2020 } else {
2021 library.reexportDirs(genHeaderOutDir)
2022 }
2023
2024 library.reexportDeps(timestampFiles...)
2025 }
2026
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002027 // override the module's export_include_dirs with llndk.override_export_include_dirs
2028 // if it is set.
2029 if override := library.Properties.Llndk.Override_export_include_dirs; override != nil {
2030 library.flagExporter.Properties.Export_include_dirs = override
2031 }
2032
Colin Cross127bb8b2020-12-16 16:46:01 -08002033 if Bool(library.Properties.Llndk.Export_headers_as_system) {
2034 library.flagExporter.Properties.Export_system_include_dirs = append(
2035 library.flagExporter.Properties.Export_system_include_dirs,
2036 library.flagExporter.Properties.Export_include_dirs...)
2037 library.flagExporter.Properties.Export_include_dirs = nil
2038 }
2039 }
2040
Colin Cross5271fea2021-04-27 13:06:04 -07002041 if ctx.IsVendorPublicLibrary() {
2042 // override the module's export_include_dirs with vendor_public_library.override_export_include_dirs
2043 // if it is set.
2044 if override := library.Properties.Vendor_public_library.Override_export_include_dirs; override != nil {
2045 library.flagExporter.Properties.Export_include_dirs = override
2046 }
2047 }
2048
Chris Parsons3c27ca32020-11-20 12:42:07 -05002049 // Linking this library consists of linking `deps.Objs` (.o files in dependencies
2050 // of this library), together with `objs` (.o files created by compiling this
2051 // library).
Colin Crossad59e752017-11-16 14:29:11 -08002052 objs = deps.Objs.Copy().Append(objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002053 var out android.Path
Colin Crossa48ab5b2017-02-14 15:28:44 -08002054 if library.static() || library.header() {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002055 out = library.linkStatic(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002056 } else {
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002057 out = library.linkShared(ctx, flags, deps, objs)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002058 }
2059
Chris Parsons3c27ca32020-11-20 12:42:07 -05002060 // Export include paths and flags to be propagated up the tree.
Inseob Kim69378442019-06-03 19:10:47 +09002061 library.exportIncludes(ctx)
2062 library.reexportDirs(deps.ReexportedDirs...)
2063 library.reexportSystemDirs(deps.ReexportedSystemDirs...)
2064 library.reexportFlags(deps.ReexportedFlags...)
2065 library.reexportDeps(deps.ReexportedDeps...)
Inseob Kimd110f872019-12-06 13:15:38 +09002066 library.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002067
Chris Parsons3c27ca32020-11-20 12:42:07 -05002068 // Optionally export aidl headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002069 if Bool(library.Properties.Aidl.Export_aidl_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002070 if library.baseCompiler.hasSrcExt(".aidl") {
Jiyong Park74955042019-10-22 20:19:51 +09002071 dir := android.PathForModuleGen(ctx, "aidl")
Inseob Kim69378442019-06-03 19:10:47 +09002072 library.reexportDirs(dir)
Inseob Kimd110f872019-12-06 13:15:38 +09002073
Paul Duffin33056e82021-02-19 13:49:08 +00002074 library.reexportDeps(library.baseCompiler.aidlOrderOnlyDeps...)
2075 library.addExportedGeneratedHeaders(library.baseCompiler.aidlHeaders...)
Dan Willemsene1240db2016-11-03 14:28:51 -07002076 }
2077 }
2078
Chris Parsons3c27ca32020-11-20 12:42:07 -05002079 // Optionally export proto headers.
Nan Zhang0007d812017-11-07 10:57:05 -08002080 if Bool(library.Properties.Proto.Export_proto_headers) {
Dan Willemsene1240db2016-11-03 14:28:51 -07002081 if library.baseCompiler.hasSrcExt(".proto") {
Jiyong Park74955042019-10-22 20:19:51 +09002082 var includes android.Paths
Colin Cross19878da2019-03-28 14:45:07 -07002083 if flags.proto.CanonicalPathFromRoot {
Jiyong Park74955042019-10-22 20:19:51 +09002084 includes = append(includes, flags.proto.SubDir)
Colin Cross10d22312017-05-03 11:01:58 -07002085 }
Jiyong Park74955042019-10-22 20:19:51 +09002086 includes = append(includes, flags.proto.Dir)
Inseob Kim69378442019-06-03 19:10:47 +09002087 library.reexportDirs(includes...)
Inseob Kimd110f872019-12-06 13:15:38 +09002088
Paul Duffin33056e82021-02-19 13:49:08 +00002089 library.reexportDeps(library.baseCompiler.protoOrderOnlyDeps...)
2090 library.addExportedGeneratedHeaders(library.baseCompiler.protoHeaders...)
Colin Cross0c461f12016-10-20 16:11:43 -07002091 }
2092 }
2093
Inseob Kim07def122020-11-23 14:43:02 +09002094 // If the library is sysprop_library, expose either public or internal header selectively.
Inseob Kim21f26902018-09-06 00:55:20 +09002095 if library.baseCompiler.hasSrcExt(".sysprop") {
Jiyong Park74955042019-10-22 20:19:51 +09002096 dir := android.PathForModuleGen(ctx, "sysprop", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002097 if library.Properties.Sysprop.Platform != nil {
Inseob Kimc0907f12019-02-08 21:00:45 +09002098 isOwnerPlatform := Bool(library.Properties.Sysprop.Platform)
2099
Inseob Kim07def122020-11-23 14:43:02 +09002100 // If the owner is different from the user, expose public header. That is,
2101 // 1) if the user is product (as owner can only be platform / vendor)
Inseob Kim06410042021-01-18 15:23:28 +09002102 // 2) if the owner is platform and the client is vendor
2103 // We don't care Platform -> Vendor dependency as it's already forbidden.
2104 if ctx.Device() && (ctx.ProductSpecific() || (isOwnerPlatform && ctx.inVendor())) {
Jiyong Park74955042019-10-22 20:19:51 +09002105 dir = android.PathForModuleGen(ctx, "sysprop/public", "include")
Inseob Kimc0907f12019-02-08 21:00:45 +09002106 }
2107 }
2108
Paul Duffin37e0de52021-02-19 17:05:39 +00002109 // Make sure to only export headers which are within the include directory.
2110 _, headers := android.FilterPathListPredicate(library.baseCompiler.syspropHeaders, func(path android.Path) bool {
2111 _, isRel := android.MaybeRel(ctx, dir.String(), path.String())
2112 return isRel
2113 })
2114
Chris Parsons3c27ca32020-11-20 12:42:07 -05002115 // Add sysprop-related directories to the exported directories of this library.
Inseob Kim69378442019-06-03 19:10:47 +09002116 library.reexportDirs(dir)
Paul Duffin33056e82021-02-19 13:49:08 +00002117 library.reexportDeps(library.baseCompiler.syspropOrderOnlyDeps...)
Paul Duffin37e0de52021-02-19 17:05:39 +00002118 library.addExportedGeneratedHeaders(headers...)
Inseob Kim21f26902018-09-06 00:55:20 +09002119 }
2120
Chris Parsons3c27ca32020-11-20 12:42:07 -05002121 // Add stub-related flags if this library is a stub library.
Jiyong Park892a98f2020-12-14 09:20:00 +09002122 library.exportVersioningMacroIfNeeded(ctx)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002123
Chris Parsons3c27ca32020-11-20 12:42:07 -05002124 // Propagate a Provider containing information about exported flags, deps, and include paths.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002125 library.flagExporter.setProvider(ctx)
2126
Colin Cross4d9c2d12016-07-29 12:48:20 -07002127 return out
2128}
2129
Jiyong Park892a98f2020-12-14 09:20:00 +09002130func (library *libraryDecorator) exportVersioningMacroIfNeeded(ctx android.BaseModuleContext) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002131 if library.buildStubs() && library.stubsVersion() != "" && !library.skipAPIDefine {
Jiyong Park892a98f2020-12-14 09:20:00 +09002132 name := versioningMacroName(ctx.Module().(*Module).ImplementationModuleName(ctx))
Jooyung Han11b0fbd2021-02-05 02:28:22 +09002133 apiLevel, err := android.ApiLevelFromUser(ctx, library.stubsVersion())
2134 if err != nil {
2135 ctx.ModuleErrorf("Can't export version macro: %s", err.Error())
2136 }
2137 library.reexportFlags("-D" + name + "=" + strconv.Itoa(apiLevel.FinalOrPreviewInt()))
Jiyong Park892a98f2020-12-14 09:20:00 +09002138 }
2139}
2140
Chris Parsons3c27ca32020-11-20 12:42:07 -05002141// buildStatic returns true if this library should be built as a static library.
Colin Crossb916a382016-07-29 17:28:03 -07002142func (library *libraryDecorator) buildStatic() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002143 return library.MutatedProperties.BuildStatic &&
2144 BoolDefault(library.StaticProperties.Static.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002145}
2146
Chris Parsons3c27ca32020-11-20 12:42:07 -05002147// buildShared returns true if this library should be built as a shared library.
Colin Crossb916a382016-07-29 17:28:03 -07002148func (library *libraryDecorator) buildShared() bool {
Colin Crosse1bb5d02019-09-24 14:55:04 -07002149 return library.MutatedProperties.BuildShared &&
2150 BoolDefault(library.SharedProperties.Shared.Enabled, true)
Colin Cross4d9c2d12016-07-29 12:48:20 -07002151}
2152
Dan Willemsen5cb580f2016-09-26 17:33:01 -07002153func (library *libraryDecorator) objs() Objects {
2154 return library.objects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002155}
2156
Colin Cross0de8a1e2020-09-18 14:15:30 -07002157func (library *libraryDecorator) reuseObjs() Objects {
2158 return library.reuseObjects
Colin Cross4d9c2d12016-07-29 12:48:20 -07002159}
2160
Colin Cross26c34ed2016-09-30 17:10:16 -07002161func (library *libraryDecorator) toc() android.OptionalPath {
2162 return library.tocFile
2163}
2164
Jiyong Parkf1194352019-02-25 11:05:47 +09002165func (library *libraryDecorator) installSymlinkToRuntimeApex(ctx ModuleContext, file android.Path) {
2166 dir := library.baseInstaller.installDir(ctx)
2167 dirOnDevice := android.InstallPathToOnDevicePath(ctx, dir)
2168 target := "/" + filepath.Join("apex", "com.android.runtime", dir.Base(), "bionic", file.Base())
2169 ctx.InstallAbsoluteSymlink(dir, file.Base(), target)
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002170 library.postInstallCmds = append(library.postInstallCmds, makeSymlinkCmd(dirOnDevice, file.Base(), target))
Jiyong Parkf1194352019-02-25 11:05:47 +09002171}
2172
Colin Crossb916a382016-07-29 17:28:03 -07002173func (library *libraryDecorator) install(ctx ModuleContext, file android.Path) {
Colin Crossc43ae772017-04-14 15:42:53 -07002174 if library.shared() {
Justin Yun8fe12122017-12-07 17:18:15 +09002175 if ctx.Device() && ctx.useVndk() {
Jooyung Han261e1582020-10-20 18:54:21 +09002176 // set subDir for VNDK extensions
Ivan Lozanof9e21722020-12-02 09:00:51 -05002177 if ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002178 if ctx.isVndkSp() {
2179 library.baseInstaller.subDir = "vndk-sp"
2180 } else {
2181 library.baseInstaller.subDir = "vndk"
2182 }
2183 }
2184
Justin Yun31094b12020-12-24 16:11:23 +09002185 // In some cases we want to use core variant for VNDK-Core libs.
2186 // Skip product variant since VNDKs use only the vendor variant.
2187 if ctx.isVndk() && !ctx.isVndkSp() && !ctx.IsVndkExt() && !ctx.inProduct() {
Vic Yang1a5812a2020-01-31 10:38:40 -08002188 mayUseCoreVariant := true
2189
2190 if ctx.mustUseVendorVariant() {
2191 mayUseCoreVariant = false
2192 }
2193
Elvis Chien9c993542021-06-25 01:15:17 +08002194 if ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) {
Vic Yang1a5812a2020-01-31 10:38:40 -08002195 mayUseCoreVariant = false
2196 }
2197
2198 if mayUseCoreVariant {
Vic Yangd92090f2020-01-08 14:32:28 -08002199 library.checkSameCoreVariant = true
2200 if ctx.DeviceConfig().VndkUseCoreVariant() {
2201 library.useCoreVariant = true
2202 }
Vic Yangefd249e2018-11-12 20:19:56 -08002203 }
Justin Yun8fe12122017-12-07 17:18:15 +09002204 }
Logan Chienf3511742017-10-31 18:04:35 +08002205
Jooyung Han261e1582020-10-20 18:54:21 +09002206 // do not install vndk libs
2207 // vndk libs are packaged into VNDK APEX
Ivan Lozanof9e21722020-12-02 09:00:51 -05002208 if ctx.isVndk() && !ctx.IsVndkExt() {
Jooyung Han261e1582020-10-20 18:54:21 +09002209 return
Justin Yun8effde42017-06-23 19:24:43 +09002210 }
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002211 } else if library.hasStubsVariants() && !ctx.Host() && ctx.directlyInAnyApex() {
Jiyong Parkf1194352019-02-25 11:05:47 +09002212 // Bionic libraries (e.g. libc.so) is installed to the bootstrap subdirectory.
2213 // The original path becomes a symlink to the corresponding file in the
2214 // runtime APEX.
Colin Cross3b19f5d2019-09-17 14:45:31 -07002215 translatedArch := ctx.Target().NativeBridge == android.NativeBridgeEnabled
Colin Cross56a83212020-09-15 18:30:11 -07002216 if InstallToBootstrap(ctx.baseModuleName(), ctx.Config()) && !library.buildStubs() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002217 !translatedArch && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() {
Martin Stjernholm279de572019-09-10 23:18:20 +01002218 if ctx.Device() {
Jiyong Parkc3e2c862019-03-16 01:10:08 +09002219 library.installSymlinkToRuntimeApex(ctx, file)
2220 }
Jiyong Park429660f2019-01-16 22:31:11 +09002221 library.baseInstaller.subDir = "bootstrap"
2222 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002223 } else if ctx.directlyInAnyApex() && ctx.IsLlndk() && !isBionic(ctx.baseModuleName()) {
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002224 // Skip installing LLNDK (non-bionic) libraries moved to APEX.
Colin Crossa9c8c9f2020-12-16 10:20:23 -08002225 ctx.Module().HideFromMake()
Justin Yun8effde42017-06-23 19:24:43 +09002226 }
Przemyslaw Szczepaniake6fc5072019-07-12 14:06:23 +01002227
Colin Cross4d9c2d12016-07-29 12:48:20 -07002228 library.baseInstaller.install(ctx, file)
2229 }
Dan Albertf563d252017-10-13 00:29:00 -07002230
Dan Albert281f22b2017-12-13 15:03:47 -08002231 if Bool(library.Properties.Static_ndk_lib) && library.static() &&
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002232 !ctx.useVndk() && !ctx.inRamdisk() && !ctx.inVendorRamdisk() && !ctx.inRecovery() && ctx.Device() &&
Jiyong Park7ed9de32018-10-15 22:25:07 +09002233 library.baseLinker.sanitize.isUnsanitizedVariant() &&
Colin Cross95b07f22020-12-16 11:06:50 -08002234 ctx.isForPlatform() && !ctx.isPreventInstall() {
Dan Albertf563d252017-10-13 00:29:00 -07002235 installPath := getNdkSysrootBase(ctx).Join(
Dan Albertea4b7b92018-04-25 16:05:30 -07002236 ctx, "usr/lib", config.NDKTriple(ctx.toolchain()), file.Base())
Dan Albertf563d252017-10-13 00:29:00 -07002237
2238 ctx.ModuleBuild(pctx, android.ModuleBuildParams{
2239 Rule: android.Cp,
2240 Description: "install " + installPath.Base(),
2241 Output: installPath,
2242 Input: file,
2243 })
2244
Colin Cross0875c522017-11-28 17:34:01 -08002245 library.ndkSysrootPath = installPath
Dan Albertf563d252017-10-13 00:29:00 -07002246 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002247}
2248
Paul Duffin0cb37b92020-03-04 14:52:46 +00002249func (library *libraryDecorator) everInstallable() bool {
2250 // Only shared and static libraries are installed. Header libraries (which are
2251 // neither static or shared) are not installed.
2252 return library.shared() || library.static()
2253}
2254
Chris Parsons3c27ca32020-11-20 12:42:07 -05002255// static returns true if this library is for a "static' variant.
Colin Crossb916a382016-07-29 17:28:03 -07002256func (library *libraryDecorator) static() bool {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002257 return library.MutatedProperties.VariantIsStatic
Colin Cross4d9c2d12016-07-29 12:48:20 -07002258}
2259
Chris Parsons3c27ca32020-11-20 12:42:07 -05002260// shared returns true if this library is for a "shared' variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002261func (library *libraryDecorator) shared() bool {
2262 return library.MutatedProperties.VariantIsShared
2263}
2264
Chris Parsons3c27ca32020-11-20 12:42:07 -05002265// header returns true if this library is for a header-only variant.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002266func (library *libraryDecorator) header() bool {
Chris Parsons3c27ca32020-11-20 12:42:07 -05002267 // Neither "static" nor "shared" implies this library is header-only.
Colin Crossa48ab5b2017-02-14 15:28:44 -08002268 return !library.static() && !library.shared()
2269}
2270
Chris Parsons3c27ca32020-11-20 12:42:07 -05002271// setStatic marks the library variant as "static".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002272func (library *libraryDecorator) setStatic() {
2273 library.MutatedProperties.VariantIsStatic = true
2274 library.MutatedProperties.VariantIsShared = false
2275}
2276
Chris Parsons3c27ca32020-11-20 12:42:07 -05002277// setShared marks the library variant as "shared".
Colin Crossa48ab5b2017-02-14 15:28:44 -08002278func (library *libraryDecorator) setShared() {
2279 library.MutatedProperties.VariantIsStatic = false
2280 library.MutatedProperties.VariantIsShared = true
Colin Crossb916a382016-07-29 17:28:03 -07002281}
2282
Chris Parsons3c27ca32020-11-20 12:42:07 -05002283// BuildOnlyStatic disables building this library as a shared library.
Colin Crossab3b7322016-12-09 14:46:15 -08002284func (library *libraryDecorator) BuildOnlyStatic() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002285 library.MutatedProperties.BuildShared = false
Colin Crossab3b7322016-12-09 14:46:15 -08002286}
2287
Chris Parsons3c27ca32020-11-20 12:42:07 -05002288// BuildOnlyShared disables building this library as a static library.
Colin Crossab3b7322016-12-09 14:46:15 -08002289func (library *libraryDecorator) BuildOnlyShared() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002290 library.MutatedProperties.BuildStatic = false
Colin Crossab3b7322016-12-09 14:46:15 -08002291}
2292
Chris Parsons3c27ca32020-11-20 12:42:07 -05002293// HeaderOnly disables building this library as a shared or static library;
2294// the library only exists to propagate header file dependencies up the build graph.
Colin Cross5950f382016-12-13 12:50:57 -08002295func (library *libraryDecorator) HeaderOnly() {
Colin Crossa48ab5b2017-02-14 15:28:44 -08002296 library.MutatedProperties.BuildShared = false
2297 library.MutatedProperties.BuildStatic = false
Colin Cross5950f382016-12-13 12:50:57 -08002298}
2299
Colin Cross127bb8b2020-12-16 16:46:01 -08002300// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
2301func (library *libraryDecorator) hasLLNDKStubs() bool {
Colin Cross203b4212021-04-26 17:19:41 -07002302 return String(library.Properties.Llndk.Symbol_file) != ""
Colin Cross0fb7fcd2021-03-02 11:00:07 -08002303}
2304
Colin Cross203b4212021-04-26 17:19:41 -07002305// hasLLNDKStubs returns true if this cc_library module has a variant that will build LLNDK stubs.
Colin Cross1f3f1302021-04-26 18:37:44 -07002306func (library *libraryDecorator) hasLLNDKHeaders() bool {
2307 return Bool(library.Properties.Llndk.Llndk_headers)
2308}
2309
Colin Cross5271fea2021-04-27 13:06:04 -07002310// hasVendorPublicLibrary returns true if this cc_library module has a variant that will build
2311// vendor public library stubs.
2312func (library *libraryDecorator) hasVendorPublicLibrary() bool {
2313 return String(library.Properties.Vendor_public_library.Symbol_file) != ""
2314}
2315
Colin Cross0477b422020-10-13 18:43:54 -07002316func (library *libraryDecorator) implementationModuleName(name string) string {
2317 return name
2318}
2319
Jiyong Park7ed9de32018-10-15 22:25:07 +09002320func (library *libraryDecorator) buildStubs() bool {
2321 return library.MutatedProperties.BuildStubs
2322}
2323
Jiyong Parka034b832019-08-27 14:02:19 +09002324func (library *libraryDecorator) symbolFileForAbiCheck(ctx ModuleContext) *string {
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08002325 if props := library.getHeaderAbiCheckerProperties(ctx); props.Symbol_file != nil {
2326 return props.Symbol_file
Jiyong Parka034b832019-08-27 14:02:19 +09002327 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002328 if ctx.Module().(*Module).IsLlndk() {
2329 return library.Properties.Llndk.Symbol_file
2330 }
Colin Cross31076b32020-10-23 17:22:06 -07002331 if library.hasStubsVariants() && library.Properties.Stubs.Symbol_file != nil {
Jiyong Parka034b832019-08-27 14:02:19 +09002332 return library.Properties.Stubs.Symbol_file
2333 }
2334 return nil
2335}
2336
Colin Crossc88c2722020-09-28 17:32:47 -07002337func (library *libraryDecorator) hasStubsVariants() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002338 // Just having stubs.symbol_file is enough to create a stub variant. In that case
2339 // the stub for the future API level is created.
2340 return library.Properties.Stubs.Symbol_file != nil ||
2341 len(library.Properties.Stubs.Versions) > 0
Colin Crossc88c2722020-09-28 17:32:47 -07002342}
2343
Alan Stokes73feba32022-11-14 12:21:24 +00002344func (library *libraryDecorator) isStubsImplementationRequired() bool {
2345 return BoolDefault(library.Properties.Stubs.Implementation_installable, true)
2346}
2347
Colin Cross3572cf72020-10-01 15:58:11 -07002348func (library *libraryDecorator) stubsVersions(ctx android.BaseMutatorContext) []string {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002349 if !library.hasStubsVariants() {
2350 return nil
2351 }
2352
Colin Crossc1b36442021-05-06 13:42:48 -07002353 if library.hasLLNDKStubs() && ctx.Module().(*Module).UseVndk() {
2354 // LLNDK libraries only need a single stubs variant.
2355 return []string{android.FutureApiLevel.String()}
2356 }
2357
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002358 // Future API level is implicitly added if there isn't
2359 vers := library.Properties.Stubs.Versions
2360 if inList(android.FutureApiLevel.String(), vers) {
2361 return vers
2362 }
2363 // In some cases, people use the raw value "10000" in the versions property.
2364 // We shouldn't add the future API level in that case, otherwise there will
2365 // be two identical versions.
2366 if inList(strconv.Itoa(android.FutureApiLevel.FinalOrFutureInt()), vers) {
2367 return vers
2368 }
2369 return append(vers, android.FutureApiLevel.String())
Colin Crossc88c2722020-09-28 17:32:47 -07002370}
2371
2372func (library *libraryDecorator) setStubsVersion(version string) {
2373 library.MutatedProperties.StubsVersion = version
2374}
2375
Jiyong Park7ed9de32018-10-15 22:25:07 +09002376func (library *libraryDecorator) stubsVersion() string {
2377 return library.MutatedProperties.StubsVersion
2378}
2379
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002380func (library *libraryDecorator) setBuildStubs(isLatest bool) {
Colin Crossc88c2722020-09-28 17:32:47 -07002381 library.MutatedProperties.BuildStubs = true
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002382 library.MutatedProperties.IsLatestVersion = isLatest
Colin Crossc88c2722020-09-28 17:32:47 -07002383}
2384
2385func (library *libraryDecorator) setAllStubsVersions(versions []string) {
2386 library.MutatedProperties.AllStubsVersions = versions
2387}
2388
2389func (library *libraryDecorator) allStubsVersions() []string {
2390 return library.MutatedProperties.AllStubsVersions
2391}
2392
Jooyung Hanad4c1872020-02-27 17:56:44 +09002393func (library *libraryDecorator) isLatestStubVersion() bool {
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002394 return library.MutatedProperties.IsLatestVersion
Jooyung Hanad4c1872020-02-27 17:56:44 +09002395}
2396
Jiyong Parka90ca002019-10-07 15:47:24 +09002397func (library *libraryDecorator) availableFor(what string) bool {
2398 var list []string
2399 if library.static() {
2400 list = library.StaticProperties.Static.Apex_available
2401 } else if library.shared() {
2402 list = library.SharedProperties.Shared.Apex_available
2403 }
2404 if len(list) == 0 {
2405 return false
2406 }
2407 return android.CheckAvailableForApex(what, list)
2408}
2409
Colin Cross1bc94122021-10-28 13:25:54 -07002410func (library *libraryDecorator) installable() *bool {
2411 if library.static() {
2412 return library.StaticProperties.Static.Installable
2413 } else if library.shared() {
2414 return library.SharedProperties.Shared.Installable
2415 }
2416 return nil
2417}
2418
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002419func (library *libraryDecorator) makeUninstallable(mod *Module) {
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002420 if library.static() && library.buildStatic() && !library.buildStubs() {
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002421 // If we're asked to make a static library uninstallable we don't do
2422 // anything since AndroidMkEntries always sets LOCAL_UNINSTALLABLE_MODULE
2423 // for these entries. This is done to still get the make targets for NOTICE
2424 // files from notice_files.mk, which other libraries might depend on.
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002425 return
2426 }
Martin Stjernholm9e9bb7f2020-08-06 22:34:42 +01002427 mod.ModuleBase.MakeUninstallable()
Martin Stjernholmbf37d162020-03-31 16:05:34 +01002428}
2429
Jihoon Kangf78a8902022-09-01 22:47:07 +00002430func (library *libraryDecorator) getPartition() string {
2431 return library.path.Partition()
2432}
2433
Colin Crossceaa5322021-09-28 16:37:50 -07002434func (library *libraryDecorator) getAPIListCoverageXMLPath() android.ModuleOutPath {
2435 return library.apiListCoverageXmlPath
2436}
2437
Inseob Kima1888ce2022-10-04 14:42:02 +09002438func (library *libraryDecorator) overriddenModules() []string {
2439 return library.Properties.Overrides
2440}
2441
2442var _ overridable = (*libraryDecorator)(nil)
2443
Colin Cross571cccf2019-02-04 11:22:08 -08002444var versioningMacroNamesListKey = android.NewOnceKey("versioningMacroNamesList")
2445
Chris Parsons3c27ca32020-11-20 12:42:07 -05002446// versioningMacroNamesList returns a singleton map, where keys are "version macro names",
2447// and values are the module name responsible for registering the version macro name.
2448//
2449// Version macros are used when building against stubs, to provide version information about
2450// the stub. Only stub libraries should have an entry in this list.
2451//
2452// For example, when building against libFoo#ver, __LIBFOO_API__ macro is set to ver so
2453// that headers from libFoo can be conditionally compiled (this may hide APIs
2454// that are not available for the version).
2455//
2456// This map is used to ensure that there aren't conflicts between these version macro names.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002457func versioningMacroNamesList(config android.Config) *map[string]string {
Colin Cross571cccf2019-02-04 11:22:08 -08002458 return config.Once(versioningMacroNamesListKey, func() interface{} {
Jiyong Parkda732bd2018-11-02 18:23:15 +09002459 m := make(map[string]string)
2460 return &m
2461 }).(*map[string]string)
2462}
2463
2464// alphanumeric and _ characters are preserved.
2465// other characters are all converted to _
2466var charsNotForMacro = regexp.MustCompile("[^a-zA-Z0-9_]+")
2467
Chris Parsons3c27ca32020-11-20 12:42:07 -05002468// versioningMacroName returns the canonical version macro name for the given module.
Jiyong Parkda732bd2018-11-02 18:23:15 +09002469func versioningMacroName(moduleName string) string {
2470 macroName := charsNotForMacro.ReplaceAllString(moduleName, "_")
Jooyung Hanb04a4992020-03-13 18:57:35 +09002471 macroName = strings.ToUpper(macroName)
Jiyong Parkda732bd2018-11-02 18:23:15 +09002472 return "__" + macroName + "_API__"
2473}
2474
Chris Parsons3c27ca32020-11-20 12:42:07 -05002475// NewLibrary builds and returns a new Module corresponding to a C++ library.
2476// Individual module implementations which comprise a C++ library (or something like
2477// a C++ library) should call this function, set some fields on the result, and
2478// then call the Init function.
Colin Crossab3b7322016-12-09 14:46:15 -08002479func NewLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Colin Cross4d9c2d12016-07-29 12:48:20 -07002480 module := newModule(hod, android.MultilibBoth)
2481
Colin Crossb916a382016-07-29 17:28:03 -07002482 library := &libraryDecorator{
Colin Crossa48ab5b2017-02-14 15:28:44 -08002483 MutatedProperties: LibraryMutatedProperties{
Colin Crossab3b7322016-12-09 14:46:15 -08002484 BuildShared: true,
2485 BuildStatic: true,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002486 },
Colin Crossb916a382016-07-29 17:28:03 -07002487 baseCompiler: NewBaseCompiler(),
Dan Albert61f32122018-07-26 14:00:24 -07002488 baseLinker: NewBaseLinker(module.sanitize),
Colin Crossb916a382016-07-29 17:28:03 -07002489 baseInstaller: NewBaseInstaller("lib", "lib64", InstallInSystem),
Jayant Chowdhary3e231fd2017-02-08 13:45:53 -08002490 sabi: module.sabi,
Colin Cross4d9c2d12016-07-29 12:48:20 -07002491 }
2492
Colin Crossb916a382016-07-29 17:28:03 -07002493 module.compiler = library
2494 module.linker = library
2495 module.installer = library
Colin Cross31076b32020-10-23 17:22:06 -07002496 module.library = library
Colin Crossb916a382016-07-29 17:28:03 -07002497
2498 return module, library
2499}
2500
Colin Cross10d22312017-05-03 11:01:58 -07002501// connects a shared library to a static library in order to reuse its .o files to avoid
2502// compiling source files twice.
2503func reuseStaticLibrary(mctx android.BottomUpMutatorContext, static, shared *Module) {
2504 if staticCompiler, ok := static.compiler.(*libraryDecorator); ok {
2505 sharedCompiler := shared.compiler.(*libraryDecorator)
Dan Willemsen3a26eef2018-12-03 15:25:46 -08002506
2507 // Check libraries in addition to cflags, since libraries may be exporting different
2508 // include directories.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002509 if len(staticCompiler.StaticProperties.Static.Cflags) == 0 &&
2510 len(sharedCompiler.SharedProperties.Shared.Cflags) == 0 &&
2511 len(staticCompiler.StaticProperties.Static.Whole_static_libs) == 0 &&
2512 len(sharedCompiler.SharedProperties.Shared.Whole_static_libs) == 0 &&
2513 len(staticCompiler.StaticProperties.Static.Static_libs) == 0 &&
2514 len(sharedCompiler.SharedProperties.Shared.Static_libs) == 0 &&
2515 len(staticCompiler.StaticProperties.Static.Shared_libs) == 0 &&
2516 len(sharedCompiler.SharedProperties.Shared.Shared_libs) == 0 &&
Martin Stjernholm10566a02020-03-24 01:19:52 +00002517 // Compare System_shared_libs properties with nil because empty lists are
2518 // semantically significant for them.
Colin Crosse1bb5d02019-09-24 14:55:04 -07002519 staticCompiler.StaticProperties.Static.System_shared_libs == nil &&
2520 sharedCompiler.SharedProperties.Shared.System_shared_libs == nil {
Colin Cross10d22312017-05-03 11:01:58 -07002521
2522 mctx.AddInterVariantDependency(reuseObjTag, shared, static)
2523 sharedCompiler.baseCompiler.Properties.OriginalSrcs =
2524 sharedCompiler.baseCompiler.Properties.Srcs
2525 sharedCompiler.baseCompiler.Properties.Srcs = nil
2526 sharedCompiler.baseCompiler.Properties.Generated_sources = nil
2527 }
Colin Cross0de8a1e2020-09-18 14:15:30 -07002528
2529 // This dep is just to reference static variant from shared variant
2530 mctx.AddInterVariantDependency(staticVariantTag, shared, static)
Colin Cross10d22312017-05-03 11:01:58 -07002531 }
2532}
2533
Chris Parsons3c27ca32020-11-20 12:42:07 -05002534// LinkageMutator adds "static" or "shared" variants for modules depending
2535// on whether the module can be built as a static library or a shared library.
Colin Crosse40b4ea2018-10-02 22:25:58 -07002536func LinkageMutator(mctx android.BottomUpMutatorContext) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002537 ccPrebuilt := false
Colin Crossb916a382016-07-29 17:28:03 -07002538 if m, ok := mctx.Module().(*Module); ok && m.linker != nil {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002539 _, ccPrebuilt = m.linker.(prebuiltLibraryInterface)
Ivan Lozano52767be2019-10-18 14:49:46 -07002540 }
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002541 if ccPrebuilt {
Ivan Lozano52767be2019-10-18 14:49:46 -07002542 library := mctx.Module().(*Module).linker.(prebuiltLibraryInterface)
Colin Cross33b2fb72019-05-14 14:07:01 -07002543
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002544 // Differentiate between header only and building an actual static/shared library
Colin Cross127bb8b2020-12-16 16:46:01 -08002545 buildStatic := library.buildStatic()
2546 buildShared := library.buildShared()
2547 if buildStatic || buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002548 // Always create both the static and shared variants for prebuilt libraries, and then disable the one
2549 // that is not being used. This allows them to share the name of a cc_library module, which requires that
2550 // all the variants of the cc_library also exist on the prebuilt.
2551 modules := mctx.CreateLocalVariations("static", "shared")
2552 static := modules[0].(*Module)
2553 shared := modules[1].(*Module)
Colin Cross33b2fb72019-05-14 14:07:01 -07002554
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002555 static.linker.(prebuiltLibraryInterface).setStatic()
2556 shared.linker.(prebuiltLibraryInterface).setShared()
Colin Cross33b2fb72019-05-14 14:07:01 -07002557
Colin Cross127bb8b2020-12-16 16:46:01 -08002558 if buildShared {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002559 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002560 } else if buildStatic {
Colin Cross81ca6cd2020-08-06 17:46:48 -07002561 mctx.AliasVariation("static")
2562 }
2563
Colin Cross127bb8b2020-12-16 16:46:01 -08002564 if !buildStatic {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002565 static.linker.(prebuiltLibraryInterface).disablePrebuilt()
2566 }
Colin Cross127bb8b2020-12-16 16:46:01 -08002567 if !buildShared {
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002568 shared.linker.(prebuiltLibraryInterface).disablePrebuilt()
2569 }
2570 } else {
2571 // Header only
Colin Crossb916a382016-07-29 17:28:03 -07002572 }
Paul Duffinf5ea9e12020-02-21 10:57:00 +00002573
Ivan Lozano52767be2019-10-18 14:49:46 -07002574 } else if library, ok := mctx.Module().(LinkableInterface); ok && library.CcLibraryInterface() {
Ivan Lozano52767be2019-10-18 14:49:46 -07002575
Ivan Lozano2b262972019-11-21 12:30:50 -08002576 // Non-cc.Modules may need an empty variant for their mutators.
2577 variations := []string{}
2578 if library.NonCcVariants() {
2579 variations = append(variations, "")
2580 }
2581
Colin Cross127bb8b2020-12-16 16:46:01 -08002582 isLLNDK := false
2583 if m, ok := mctx.Module().(*Module); ok {
Colin Cross203b4212021-04-26 17:19:41 -07002584 isLLNDK = m.IsLlndk()
Colin Cross127bb8b2020-12-16 16:46:01 -08002585 }
2586 buildStatic := library.BuildStaticVariant() && !isLLNDK
2587 buildShared := library.BuildSharedVariant()
2588 if buildStatic && buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002589 variations := append([]string{"static", "shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002590
2591 modules := mctx.CreateLocalVariations(variations...)
2592 static := modules[0].(LinkableInterface)
2593 shared := modules[1].(LinkableInterface)
2594
2595 static.SetStatic()
2596 shared.SetShared()
2597
2598 if _, ok := library.(*Module); ok {
2599 reuseStaticLibrary(mctx, static.(*Module), shared.(*Module))
2600 }
Colin Cross81ca6cd2020-08-06 17:46:48 -07002601 mctx.AliasVariation("shared")
Colin Cross127bb8b2020-12-16 16:46:01 -08002602 } else if buildStatic {
Ivan Lozano2b262972019-11-21 12:30:50 -08002603 variations := append([]string{"static"}, variations...)
2604
2605 modules := mctx.CreateLocalVariations(variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002606 modules[0].(LinkableInterface).SetStatic()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002607 mctx.AliasVariation("static")
Colin Cross127bb8b2020-12-16 16:46:01 -08002608 } else if buildShared {
Ivan Lozano2b262972019-11-21 12:30:50 -08002609 variations := append([]string{"shared"}, variations...)
Ivan Lozano52767be2019-10-18 14:49:46 -07002610
Ivan Lozano2b262972019-11-21 12:30:50 -08002611 modules := mctx.CreateLocalVariations(variations...)
2612 modules[0].(LinkableInterface).SetShared()
Colin Cross81ca6cd2020-08-06 17:46:48 -07002613 mctx.AliasVariation("shared")
Ivan Lozano2b262972019-11-21 12:30:50 -08002614 } else if len(variations) > 0 {
2615 mctx.CreateLocalVariations(variations...)
Colin Cross81ca6cd2020-08-06 17:46:48 -07002616 mctx.AliasVariation(variations[0])
Ivan Lozano2b262972019-11-21 12:30:50 -08002617 }
Colin Crossb916a382016-07-29 17:28:03 -07002618 }
Colin Cross4d9c2d12016-07-29 12:48:20 -07002619}
Jiyong Park7ed9de32018-10-15 22:25:07 +09002620
Chris Parsons3c27ca32020-11-20 12:42:07 -05002621// normalizeVersions modifies `versions` in place, so that each raw version
2622// string becomes its normalized canonical form.
2623// Validates that the versions in `versions` are specified in least to greatest order.
Jooyung Hanaed150d2020-04-02 01:41:41 +09002624func normalizeVersions(ctx android.BaseModuleContext, versions []string) {
Dan Albertc8060532020-07-22 22:32:17 -07002625 var previous android.ApiLevel
Jooyung Hanad4c1872020-02-27 17:56:44 +09002626 for i, v := range versions {
Dan Albertc8060532020-07-22 22:32:17 -07002627 ver, err := android.ApiLevelFromUser(ctx, v)
Jooyung Hanad4c1872020-02-27 17:56:44 +09002628 if err != nil {
Jooyung Hanaed150d2020-04-02 01:41:41 +09002629 ctx.PropertyErrorf("versions", "%s", err.Error())
2630 return
Jooyung Hanad4c1872020-02-27 17:56:44 +09002631 }
Dan Albertc8060532020-07-22 22:32:17 -07002632 if i > 0 && ver.LessThanOrEqualTo(previous) {
2633 ctx.PropertyErrorf("versions", "not sorted: %v", versions)
2634 }
2635 versions[i] = ver.String()
2636 previous = ver
Jooyung Hanaed150d2020-04-02 01:41:41 +09002637 }
Jooyung Hanad4c1872020-02-27 17:56:44 +09002638}
2639
Jooyung Han61b66e92020-03-21 14:21:46 +00002640func createVersionVariations(mctx android.BottomUpMutatorContext, versions []string) {
Colin Cross127bb8b2020-12-16 16:46:01 -08002641 // "" is for the non-stubs (implementation) variant for system modules, or the LLNDK variant
2642 // for LLNDK modules.
Colin Cross0de8a1e2020-09-18 14:15:30 -07002643 variants := append(android.CopyOf(versions), "")
Jooyung Han61b66e92020-03-21 14:21:46 +00002644
Colin Cross127bb8b2020-12-16 16:46:01 -08002645 m := mctx.Module().(*Module)
2646 isLLNDK := m.IsLlndk()
Colin Cross5271fea2021-04-27 13:06:04 -07002647 isVendorPublicLibrary := m.IsVendorPublicLibrary()
Kiyoung Kimee58c932022-10-25 22:59:41 +09002648 isImportedApiLibrary := m.isImportedApiLibrary()
Colin Cross127bb8b2020-12-16 16:46:01 -08002649
Colin Crossd1f898e2020-08-18 18:35:15 -07002650 modules := mctx.CreateLocalVariations(variants...)
Jooyung Han61b66e92020-03-21 14:21:46 +00002651 for i, m := range modules {
Colin Cross127bb8b2020-12-16 16:46:01 -08002652
Kiyoung Kimee58c932022-10-25 22:59:41 +09002653 if variants[i] != "" || isLLNDK || isVendorPublicLibrary || isImportedApiLibrary {
Colin Cross127bb8b2020-12-16 16:46:01 -08002654 // A stubs or LLNDK stubs variant.
Colin Cross31076b32020-10-23 17:22:06 -07002655 c := m.(*Module)
Colin Cross31076b32020-10-23 17:22:06 -07002656 c.sanitize = nil
2657 c.stl = nil
2658 c.Properties.PreventInstall = true
2659 lib := moduleLibraryInterface(m)
Jiyong Parkd4a3a132021-03-17 20:21:35 +09002660 isLatest := i == (len(versions) - 1)
2661 lib.setBuildStubs(isLatest)
Colin Cross127bb8b2020-12-16 16:46:01 -08002662
2663 if variants[i] != "" {
2664 // A non-LLNDK stubs module is hidden from make and has a dependency from the
2665 // implementation module to the stubs module.
2666 c.Properties.HideFromMake = true
2667 lib.setStubsVersion(variants[i])
2668 mctx.AddInterVariantDependency(stubImplDepTag, modules[len(modules)-1], modules[i])
2669 }
Jooyung Han61b66e92020-03-21 14:21:46 +00002670 }
2671 }
Colin Cross094faa52020-08-06 17:38:25 -07002672 mctx.AliasVariation("")
Colin Crossd1f898e2020-08-18 18:35:15 -07002673 latestVersion := ""
2674 if len(versions) > 0 {
2675 latestVersion = versions[len(versions)-1]
2676 }
2677 mctx.CreateAliasVariation("latest", latestVersion)
Jooyung Han61b66e92020-03-21 14:21:46 +00002678}
2679
Colin Crossbbc941b2020-09-30 12:27:01 -07002680func createPerApiVersionVariations(mctx android.BottomUpMutatorContext, minSdkVersion string) {
2681 from, err := nativeApiLevelFromUser(mctx, minSdkVersion)
2682 if err != nil {
2683 mctx.PropertyErrorf("min_sdk_version", err.Error())
2684 return
2685 }
2686
2687 versionStrs := ndkLibraryVersions(mctx, from)
2688 modules := mctx.CreateLocalVariations(versionStrs...)
2689
2690 for i, module := range modules {
2691 module.(*Module).Properties.Sdk_version = StringPtr(versionStrs[i])
Jiyong Parkfdaa5f72021-03-19 22:18:04 +09002692 module.(*Module).Properties.Min_sdk_version = StringPtr(versionStrs[i])
Colin Crossbbc941b2020-09-30 12:27:01 -07002693 }
2694}
2695
Liz Kammer23942242022-04-08 15:41:00 -04002696func canBeOrLinkAgainstVersionVariants(module interface {
Jooyung Han624d35c2020-04-10 12:57:24 +09002697 Host() bool
2698 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002699 InVendorRamdisk() bool
Jooyung Han624d35c2020-04-10 12:57:24 +09002700}) bool {
Jose Galmes6f843bc2020-12-11 13:36:29 -08002701 return !module.Host() && !module.InRamdisk() && !module.InVendorRamdisk()
Jooyung Han624d35c2020-04-10 12:57:24 +09002702}
2703
Liz Kammer23942242022-04-08 15:41:00 -04002704func canBeVersionVariant(module interface {
Colin Cross3146c5c2020-09-30 15:34:40 -07002705 Host() bool
2706 InRamdisk() bool
Yifan Hong60e0cfb2020-10-21 15:17:56 -07002707 InVendorRamdisk() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002708 CcLibraryInterface() bool
2709 Shared() bool
Colin Cross3146c5c2020-09-30 15:34:40 -07002710}) bool {
Liz Kammer23942242022-04-08 15:41:00 -04002711 return canBeOrLinkAgainstVersionVariants(module) &&
Colin Crossa717db72020-10-23 14:53:06 -07002712 module.CcLibraryInterface() && module.Shared()
Colin Cross3146c5c2020-09-30 15:34:40 -07002713}
2714
Colin Cross127bb8b2020-12-16 16:46:01 -08002715func moduleLibraryInterface(module blueprint.Module) libraryInterface {
Colin Cross31076b32020-10-23 17:22:06 -07002716 if m, ok := module.(*Module); ok {
2717 return m.library
2718 }
2719 return nil
2720}
2721
Liz Kammer23942242022-04-08 15:41:00 -04002722// setStubsVersions normalizes the versions in the Stubs.Versions property into MutatedProperties.AllStubsVersions.
2723func setStubsVersions(mctx android.BottomUpMutatorContext, library libraryInterface, module *Module) {
2724 if !library.buildShared() || !canBeVersionVariant(module) {
2725 return
Colin Crossd1f898e2020-08-18 18:35:15 -07002726 }
Liz Kammer23942242022-04-08 15:41:00 -04002727 versions := library.stubsVersions(mctx)
2728 if len(versions) <= 0 {
2729 return
2730 }
2731 normalizeVersions(mctx, versions)
2732 if mctx.Failed() {
2733 return
2734 }
2735 // Set the versions on the pre-mutated module so they can be read by any llndk modules that
2736 // depend on the implementation library and haven't been mutated yet.
2737 library.setAllStubsVersions(versions)
Colin Crossd1f898e2020-08-18 18:35:15 -07002738}
Jooyung Han61b66e92020-03-21 14:21:46 +00002739
Colin Crossd1f898e2020-08-18 18:35:15 -07002740// versionMutator splits a module into the mandatory non-stubs variant
2741// (which is unnamed) and zero or more stubs variants.
2742func versionMutator(mctx android.BottomUpMutatorContext) {
Liz Kammer23942242022-04-08 15:41:00 -04002743 if mctx.Os() != android.Android {
2744 return
2745 }
2746
2747 m, ok := mctx.Module().(*Module)
2748 if library := moduleLibraryInterface(mctx.Module()); library != nil && canBeVersionVariant(m) {
2749 setStubsVersions(mctx, library, m)
2750
Colin Cross31076b32020-10-23 17:22:06 -07002751 createVersionVariations(mctx, library.allStubsVersions())
Colin Crossbbc941b2020-09-30 12:27:01 -07002752 return
2753 }
2754
Liz Kammer23942242022-04-08 15:41:00 -04002755 if ok {
Colin Crossbbc941b2020-09-30 12:27:01 -07002756 if m.SplitPerApiLevel() && m.IsSdkVariant() {
Colin Crossbbc941b2020-09-30 12:27:01 -07002757 createPerApiVersionVariations(mctx, m.MinSdkVersion())
2758 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002759 }
Jiyong Park7ed9de32018-10-15 22:25:07 +09002760}
Colin Crossd7227f92019-09-05 14:26:33 -07002761
2762// maybeInjectBoringSSLHash adds a rule to run bssl_inject_hash on the output file if the module has the
2763// inject_bssl_hash or if any static library dependencies have inject_bssl_hash set. It returns the output path
2764// that the linked output file should be written to.
2765// TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2766func maybeInjectBoringSSLHash(ctx android.ModuleContext, outputFile android.ModuleOutPath,
2767 inject *bool, fileName string) android.ModuleOutPath {
2768 // TODO(b/137267623): Remove this in favor of a cc_genrule when they support operating on shared libraries.
2769 injectBoringSSLHash := Bool(inject)
2770 ctx.VisitDirectDeps(func(dep android.Module) {
Colin Cross6e511a92020-07-27 21:26:48 -07002771 if tag, ok := ctx.OtherModuleDependencyTag(dep).(libraryDependencyTag); ok && tag.static() {
Colin Crossd7227f92019-09-05 14:26:33 -07002772 if cc, ok := dep.(*Module); ok {
2773 if library, ok := cc.linker.(*libraryDecorator); ok {
2774 if Bool(library.Properties.Inject_bssl_hash) {
2775 injectBoringSSLHash = true
2776 }
2777 }
2778 }
2779 }
2780 })
2781 if injectBoringSSLHash {
2782 hashedOutputfile := outputFile
2783 outputFile = android.PathForModuleOut(ctx, "unhashed", fileName)
2784
Colin Crossf1a035e2020-11-16 17:32:30 -08002785 rule := android.NewRuleBuilder(pctx, ctx)
Colin Crossd7227f92019-09-05 14:26:33 -07002786 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08002787 BuiltTool("bssl_inject_hash").
Colin Crossd7227f92019-09-05 14:26:33 -07002788 FlagWithInput("-in-object ", outputFile).
2789 FlagWithOutput("-o ", hashedOutputfile)
Colin Crossf1a035e2020-11-16 17:32:30 -08002790 rule.Build("injectCryptoHash", "inject crypto hash")
Colin Crossd7227f92019-09-05 14:26:33 -07002791 }
2792
2793 return outputFile
2794}
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002795
Yu Liu56ccb1a2022-11-12 10:47:07 -08002796func bp2buildParseAbiCheckerProps(ctx android.TopDownMutatorContext, module *Module) bazelCcHeaderAbiCheckerAttributes {
2797 lib, ok := module.linker.(*libraryDecorator)
2798 if !ok {
2799 return bazelCcHeaderAbiCheckerAttributes{}
2800 }
2801
Hsin-Yi Chen8feb4132022-12-26 15:54:36 +08002802 abiChecker := lib.getHeaderAbiCheckerProperties(ctx)
Yu Liu56ccb1a2022-11-12 10:47:07 -08002803
2804 abiCheckerAttrs := bazelCcHeaderAbiCheckerAttributes{
2805 Abi_checker_enabled: abiChecker.Enabled,
2806 Abi_checker_exclude_symbol_versions: abiChecker.Exclude_symbol_versions,
2807 Abi_checker_exclude_symbol_tags: abiChecker.Exclude_symbol_tags,
2808 Abi_checker_check_all_apis: abiChecker.Check_all_apis,
2809 Abi_checker_diff_flags: abiChecker.Diff_flags,
2810 }
2811 if abiChecker.Symbol_file != nil {
2812 symbolFile := android.BazelLabelForModuleSrcSingle(ctx, *abiChecker.Symbol_file)
2813 abiCheckerAttrs.Abi_checker_symbol_file = &symbolFile
2814 }
2815
2816 return abiCheckerAttrs
2817}
2818
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002819func sharedOrStaticLibraryBp2Build(ctx android.TopDownMutatorContext, module *Module, isStatic bool) {
Liz Kammere6583482021-10-19 13:56:10 -04002820 baseAttributes := bp2BuildParseBaseProps(ctx, module)
2821 compilerAttrs := baseAttributes.compilerAttributes
2822 linkerAttrs := baseAttributes.linkerAttributes
2823
Liz Kammer54549442022-05-11 13:55:06 -04002824 exportedIncludes := bp2BuildParseExportedIncludes(ctx, module, &compilerAttrs.includes)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002825
2826 // Append shared/static{} stanza properties. These won't be specified on
2827 // cc_library_* itself, but may be specified in cc_defaults that this module
2828 // depends on.
2829 libSharedOrStaticAttrs := bp2BuildParseLibProps(ctx, module, isStatic)
2830
2831 compilerAttrs.srcs.Append(libSharedOrStaticAttrs.Srcs)
2832 compilerAttrs.cSrcs.Append(libSharedOrStaticAttrs.Srcs_c)
2833 compilerAttrs.asSrcs.Append(libSharedOrStaticAttrs.Srcs_as)
2834 compilerAttrs.copts.Append(libSharedOrStaticAttrs.Copts)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002835
2836 linkerAttrs.deps.Append(libSharedOrStaticAttrs.Deps)
2837 linkerAttrs.implementationDeps.Append(libSharedOrStaticAttrs.Implementation_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002838 linkerAttrs.dynamicDeps.Append(libSharedOrStaticAttrs.Dynamic_deps)
Liz Kammer7a210ac2021-09-22 15:52:58 -04002839 linkerAttrs.implementationDynamicDeps.Append(libSharedOrStaticAttrs.Implementation_dynamic_deps)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002840 linkerAttrs.systemDynamicDeps.Append(libSharedOrStaticAttrs.System_dynamic_deps)
2841
2842 asFlags := compilerAttrs.asFlags
2843 if compilerAttrs.asSrcs.IsEmpty() {
2844 // Skip asflags for BUILD file simplicity if there are no assembly sources.
2845 asFlags = bazel.MakeStringListAttribute(nil)
2846 }
2847
Liz Kammer7a210ac2021-09-22 15:52:58 -04002848 commonAttrs := staticOrSharedAttributes{
2849 Srcs: compilerAttrs.srcs,
2850 Srcs_c: compilerAttrs.cSrcs,
2851 Srcs_as: compilerAttrs.asSrcs,
2852 Copts: compilerAttrs.copts,
Liz Kammere6583482021-10-19 13:56:10 -04002853 Hdrs: compilerAttrs.hdrs,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002854
Liz Kammer12615db2021-09-28 09:19:17 -04002855 Deps: linkerAttrs.deps,
2856 Implementation_deps: linkerAttrs.implementationDeps,
2857 Dynamic_deps: linkerAttrs.dynamicDeps,
2858 Implementation_dynamic_deps: linkerAttrs.implementationDynamicDeps,
2859 Whole_archive_deps: linkerAttrs.wholeArchiveDeps,
2860 Implementation_whole_archive_deps: linkerAttrs.implementationWholeArchiveDeps,
2861 System_dynamic_deps: linkerAttrs.systemDynamicDeps,
Yu Liufc603162022-03-01 15:44:08 -08002862 sdkAttributes: bp2BuildParseSdkAttributes(module),
Cole Faust6b29f592022-08-09 09:50:56 -07002863 Runtime_deps: linkerAttrs.runtimeDeps,
Liz Kammer7a210ac2021-09-22 15:52:58 -04002864 }
2865
Sam Delmericoc9b8fbd2022-10-25 15:47:17 -04002866 module.convertTidyAttributes(ctx, &commonAttrs.tidyAttributes)
Sam Delmericofb3bb322022-10-21 10:42:24 -04002867
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002868 var attrs interface{}
2869 if isStatic {
Liz Kammer12615db2021-09-28 09:19:17 -04002870 commonAttrs.Deps.Add(baseAttributes.protoDependency)
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002871 attrs = &bazelCcLibraryStaticAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002872 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002873
Liz Kammerbaced712022-09-16 09:01:29 -04002874 Use_libcrt: linkerAttrs.useLibcrt,
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002875
Liz Kammer1263d9b2021-12-10 14:28:20 -05002876 Rtti: compilerAttrs.rtti,
2877 Stl: compilerAttrs.stl,
2878 Cpp_std: compilerAttrs.cppStd,
2879 C_std: compilerAttrs.cStd,
2880
2881 Export_includes: exportedIncludes.Includes,
2882 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
2883 Export_system_includes: exportedIncludes.SystemIncludes,
2884 Local_includes: compilerAttrs.localIncludes,
2885 Absolute_includes: compilerAttrs.absoluteIncludes,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002886
2887 Cppflags: compilerAttrs.cppFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002888 Conlyflags: compilerAttrs.conlyFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002889 Asflags: asFlags,
Liz Kammer0eae52e2021-10-06 10:32:26 -04002890
Cole Faust5fa4e962022-08-22 14:31:04 -07002891 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002892 }
2893 } else {
Liz Kammer12615db2021-09-28 09:19:17 -04002894 commonAttrs.Dynamic_deps.Add(baseAttributes.protoDependency)
2895
Wei Li81852ca2022-07-27 00:22:06 -07002896 sharedLibAttrs := &bazelCcLibrarySharedAttributes{
Liz Kammer7a210ac2021-09-22 15:52:58 -04002897 staticOrSharedAttributes: commonAttrs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002898
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002899 Cppflags: compilerAttrs.cppFlags,
2900 Conlyflags: compilerAttrs.conlyFlags,
2901 Asflags: asFlags,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002902
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002903 Linkopts: linkerAttrs.linkopts,
2904 Link_crt: linkerAttrs.linkCrt,
2905 Use_libcrt: linkerAttrs.useLibcrt,
2906 Use_version_lib: linkerAttrs.useVersionLib,
2907
2908 Rtti: compilerAttrs.rtti,
2909 Stl: compilerAttrs.stl,
2910 Cpp_std: compilerAttrs.cppStd,
2911 C_std: compilerAttrs.cStd,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002912
Liz Kammerd2871182021-10-04 13:54:37 -04002913 Export_includes: exportedIncludes.Includes,
Liz Kammer1263d9b2021-12-10 14:28:20 -05002914 Export_absolute_includes: exportedIncludes.AbsoluteIncludes,
Liz Kammerd2871182021-10-04 13:54:37 -04002915 Export_system_includes: exportedIncludes.SystemIncludes,
2916 Local_includes: compilerAttrs.localIncludes,
2917 Absolute_includes: compilerAttrs.absoluteIncludes,
2918 Additional_linker_inputs: linkerAttrs.additionalLinkerInputs,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002919
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxb12ff592022-09-01 15:04:04 +00002920 Strip: stripAttrsFromLinkerAttrs(&linkerAttrs),
Liz Kammer0eae52e2021-10-06 10:32:26 -04002921
Cole Faust5fa4e962022-08-22 14:31:04 -07002922 Features: baseAttributes.features,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05002923
2924 Suffix: compilerAttrs.suffix,
Yu Liu56ccb1a2022-11-12 10:47:07 -08002925
2926 bazelCcHeaderAbiCheckerAttributes: bp2buildParseAbiCheckerProps(ctx, module),
Vinh Tran99270ea2022-11-28 11:15:23 -05002927
2928 Fdo_profile: compilerAttrs.fdoProfile,
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002929 }
Wei Li81852ca2022-07-27 00:22:06 -07002930 if compilerAttrs.stubsSymbolFile != nil && len(compilerAttrs.stubsVersions.Value) > 0 {
2931 hasStubs := true
2932 sharedLibAttrs.Has_stubs.SetValue(&hasStubs)
Yu Liu56ccb1a2022-11-12 10:47:07 -08002933 sharedLibAttrs.Stubs_symbol_file = compilerAttrs.stubsSymbolFile
Wei Li81852ca2022-07-27 00:22:06 -07002934 }
2935 attrs = sharedLibAttrs
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002936 }
2937
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002938 var modType string
2939 if isStatic {
2940 modType = "cc_library_static"
2941 } else {
2942 modType = "cc_library_shared"
Trevor Radcliffef19d8a72022-09-20 23:04:39 +00002943 createStubsBazelTargetIfNeeded(ctx, module, compilerAttrs, exportedIncludes, baseAttributes)
Liz Kammerbe46fcc2021-11-01 15:32:43 -04002944 }
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002945 props := bazel.BazelTargetModuleProperties{
2946 Rule_class: modType,
Liz Kammer2b376bc2022-01-12 12:00:49 -05002947 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 +00002948 }
2949
Jingwen Chenc4c34e12022-11-29 12:07:45 +00002950 tags := android.ApexAvailableTags(module)
2951 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 +00002952}
2953
2954// TODO(b/199902614): Can this be factored to share with the other Attributes?
Rupert Shuttleworth095081c2021-03-25 09:06:03 +00002955type bazelCcLibraryStaticAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002956 staticOrSharedAttributes
2957
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002958 Use_libcrt bazel.BoolAttribute
2959 Use_version_lib bazel.BoolAttribute
2960
2961 Rtti bazel.BoolAttribute
2962 Stl *string
2963 Cpp_std *string
2964 C_std *string
Liz Kammer7a210ac2021-09-22 15:52:58 -04002965
Liz Kammer1263d9b2021-12-10 14:28:20 -05002966 Export_includes bazel.StringListAttribute
2967 Export_absolute_includes bazel.StringListAttribute
2968 Export_system_includes bazel.StringListAttribute
2969 Local_includes bazel.StringListAttribute
2970 Absolute_includes bazel.StringListAttribute
2971 Hdrs bazel.LabelListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002972
2973 Cppflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002974 Conlyflags bazel.StringListAttribute
Chris Parsons990c4f42021-05-25 12:10:58 -04002975 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04002976
2977 Features bazel.StringListAttribute
Jingwen Chen179856a2021-05-03 09:15:48 +00002978}
2979
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002980// TODO(b/199902614): Can this be factored to share with the other Attributes?
2981type bazelCcLibrarySharedAttributes struct {
Liz Kammer7a210ac2021-09-22 15:52:58 -04002982 staticOrSharedAttributes
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002983
Rupert Shuttleworth484aa252021-12-10 07:22:53 -05002984 Linkopts bazel.StringListAttribute
2985 Link_crt bazel.BoolAttribute // Only for linking shared library (and cc_binary)
2986
2987 Use_libcrt bazel.BoolAttribute
2988 Use_version_lib bazel.BoolAttribute
2989
2990 Rtti bazel.BoolAttribute
2991 Stl *string
2992 Cpp_std *string
2993 C_std *string
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00002994
Liz Kammer1263d9b2021-12-10 14:28:20 -05002995 Export_includes bazel.StringListAttribute
2996 Export_absolute_includes bazel.StringListAttribute
2997 Export_system_includes bazel.StringListAttribute
2998 Local_includes bazel.StringListAttribute
2999 Absolute_includes bazel.StringListAttribute
3000 Hdrs bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003001
Liz Kammerd2871182021-10-04 13:54:37 -04003002 Strip stripAttributes
3003 Additional_linker_inputs bazel.LabelListAttribute
Liz Kammer7a210ac2021-09-22 15:52:58 -04003004
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003005 Cppflags bazel.StringListAttribute
3006 Conlyflags bazel.StringListAttribute
3007 Asflags bazel.StringListAttribute
Liz Kammer0eae52e2021-10-06 10:32:26 -04003008
3009 Features bazel.StringListAttribute
Jingwen Chen0ee88a62022-01-07 14:55:29 +00003010
Yu Liu56ccb1a2022-11-12 10:47:07 -08003011 Has_stubs bazel.BoolAttribute
3012 Stubs_symbol_file *string
Wei Li81852ca2022-07-27 00:22:06 -07003013
3014 Inject_bssl_hash bazel.BoolAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxa56e9702022-02-23 18:39:59 -05003015
3016 Suffix bazel.StringAttribute
Yu Liu56ccb1a2022-11-12 10:47:07 -08003017
3018 bazelCcHeaderAbiCheckerAttributes
Vinh Tran99270ea2022-11-28 11:15:23 -05003019
3020 Fdo_profile bazel.LabelAttribute
Wei Li81852ca2022-07-27 00:22:06 -07003021}
3022
3023type bazelCcStubSuiteAttributes struct {
3024 Symbol_file *string
3025 Versions bazel.StringListAttribute
3026 Export_includes bazel.StringListAttribute
3027 Source_library bazel.LabelAttribute
3028 Soname *string
3029 Deps bazel.LabelListAttribute
Alex Márquez Pérez Muñíz Díaz Púras Thaureauxac5097f2021-09-01 21:22:09 +00003030}
Yu Liu56ccb1a2022-11-12 10:47:07 -08003031
3032type bazelCcHeaderAbiCheckerAttributes struct {
3033 Abi_checker_enabled *bool
3034 Abi_checker_symbol_file *bazel.Label
3035 Abi_checker_exclude_symbol_versions []string
3036 Abi_checker_exclude_symbol_tags []string
3037 Abi_checker_check_all_apis *bool
3038 Abi_checker_diff_flags []string
3039}