blob: 37819a4be63fdf35990a4e22c2eeece08584fcc9 [file] [log] [blame]
Justin Yun71549282017-11-17 12:10:28 +09001// Copyright 2017 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 (
18 "strings"
19
20 "android/soong/android"
21)
22
23var (
Justin Yun3e2323d2018-06-08 15:08:40 +090024 vndkSuffix = ".vndk."
25 binder32Suffix = ".binder32"
Justin Yun71549282017-11-17 12:10:28 +090026)
27
28// Creates vndk prebuilts that include the VNDK version.
29//
30// Example:
31//
Colin Crossd079e0b2022-08-16 10:27:33 -070032// vndk_prebuilt_shared {
33// name: "libfoo",
34// version: "27",
35// target_arch: "arm64",
36// vendor_available: true,
37// product_available: true,
38// vndk: {
39// enabled: true,
40// },
41// export_include_dirs: ["include/external/libfoo/vndk_include"],
42// arch: {
43// arm64: {
44// srcs: ["arm/lib64/libfoo.so"],
45// },
46// arm: {
47// srcs: ["arm/lib/libfoo.so"],
48// },
49// },
50// }
Justin Yun71549282017-11-17 12:10:28 +090051type vndkPrebuiltProperties struct {
Jae Shin43ef2642017-12-29 16:20:21 +090052 // VNDK snapshot version.
53 Version *string
54
SzuWei Lin31c4dfc2020-11-03 18:27:32 +080055 // Target arch name of the snapshot (e.g. 'arm64' for variant 'aosp_arm64')
Jae Shin43ef2642017-12-29 16:20:21 +090056 Target_arch *string
Justin Yun71549282017-11-17 12:10:28 +090057
Justin Yun3e2323d2018-06-08 15:08:40 +090058 // If the prebuilt snapshot lib is built with 32 bit binder, this must be set to true.
59 // The lib with 64 bit binder does not need to set this property.
60 Binder32bit *bool
61
Justin Yun71549282017-11-17 12:10:28 +090062 // Prebuilt files for each arch.
63 Srcs []string `android:"arch_variant"`
Logan Chien4fcea3d2018-11-20 11:59:08 +080064
Inseob Kimae553032019-05-14 18:52:49 +090065 // list of flags that will be used for any module that links against this module.
66 Export_flags []string `android:"arch_variant"`
67
Logan Chien4fcea3d2018-11-20 11:59:08 +080068 // Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined symbols,
69 // etc).
70 Check_elf_files *bool
Justin Yun71549282017-11-17 12:10:28 +090071}
72
73type vndkPrebuiltLibraryDecorator struct {
74 *libraryDecorator
Inseob Kim2b96bf52020-02-17 18:00:39 +090075 properties vndkPrebuiltProperties
76 androidMkSuffix string
Justin Yun71549282017-11-17 12:10:28 +090077}
78
79func (p *vndkPrebuiltLibraryDecorator) Name(name string) string {
Jae Shin43ef2642017-12-29 16:20:21 +090080 return name + p.NameSuffix()
81}
82
83func (p *vndkPrebuiltLibraryDecorator) NameSuffix() string {
Ivan Lozanod1dec542021-05-26 15:33:11 -040084 suffix := p.Version()
Jae Shin43ef2642017-12-29 16:20:21 +090085 if p.arch() != "" {
Justin Yun3e2323d2018-06-08 15:08:40 +090086 suffix += "." + p.arch()
Jae Shin43ef2642017-12-29 16:20:21 +090087 }
Justin Yun3e2323d2018-06-08 15:08:40 +090088 if Bool(p.properties.Binder32bit) {
89 suffix += binder32Suffix
90 }
91 return vndkSuffix + suffix
Justin Yun71549282017-11-17 12:10:28 +090092}
93
Ivan Lozanod1dec542021-05-26 15:33:11 -040094func (p *vndkPrebuiltLibraryDecorator) Version() string {
Jae Shin43ef2642017-12-29 16:20:21 +090095 return String(p.properties.Version)
96}
97
98func (p *vndkPrebuiltLibraryDecorator) arch() string {
99 return String(p.properties.Target_arch)
Justin Yun71549282017-11-17 12:10:28 +0900100}
101
Justin Yun3e2323d2018-06-08 15:08:40 +0900102func (p *vndkPrebuiltLibraryDecorator) binderBit() string {
103 if Bool(p.properties.Binder32bit) {
104 return "32"
105 }
106 return "64"
107}
108
Ivan Lozanod1dec542021-05-26 15:33:11 -0400109func (p *vndkPrebuiltLibraryDecorator) SnapshotAndroidMkSuffix() string {
Colin Crossa8890802021-01-22 14:06:33 -0800110 return ".vendor"
111}
112
Justin Yun71549282017-11-17 12:10:28 +0900113func (p *vndkPrebuiltLibraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Jae Shin43ef2642017-12-29 16:20:21 +0900114 p.libraryDecorator.libName = strings.TrimSuffix(ctx.ModuleName(), p.NameSuffix())
Justin Yun71549282017-11-17 12:10:28 +0900115 return p.libraryDecorator.linkerFlags(ctx, flags)
116}
117
118func (p *vndkPrebuiltLibraryDecorator) singleSourcePath(ctx ModuleContext) android.Path {
119 if len(p.properties.Srcs) == 0 {
120 ctx.PropertyErrorf("srcs", "missing prebuilt source file")
121 return nil
122 }
123
124 if len(p.properties.Srcs) > 1 {
125 ctx.PropertyErrorf("srcs", "multiple prebuilt source files")
126 return nil
127 }
128
129 return android.PathForModuleSrc(ctx, p.properties.Srcs[0])
130}
131
132func (p *vndkPrebuiltLibraryDecorator) link(ctx ModuleContext,
133 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Crossff6c33d2019-10-02 16:01:35 -0700134
Ivan Lozanod1dec542021-05-26 15:33:11 -0400135 if !p.MatchesWithDevice(ctx.DeviceConfig()) {
Colin Crossa9c8c9f2020-12-16 10:20:23 -0800136 ctx.Module().HideFromMake()
Colin Crossff6c33d2019-10-02 16:01:35 -0700137 return nil
138 }
139
Justin Yun71549282017-11-17 12:10:28 +0900140 if len(p.properties.Srcs) > 0 && p.shared() {
Inseob Kimae553032019-05-14 18:52:49 +0900141 p.libraryDecorator.exportIncludes(ctx)
Inseob Kimae553032019-05-14 18:52:49 +0900142 p.libraryDecorator.reexportFlags(p.properties.Export_flags...)
Justin Yun71549282017-11-17 12:10:28 +0900143 // current VNDK prebuilts are only shared libs.
Inseob Kimeec88e12020-01-22 11:11:29 +0900144
145 in := p.singleSourcePath(ctx)
Inseob Kimeec88e12020-01-22 11:11:29 +0900146 p.unstrippedOutputFile = in
147 libName := in.Base()
Thiébaud Weksteend4587452020-08-19 14:53:01 +0200148 if p.stripper.NeedsStrip(ctx) {
149 stripFlags := flagsToStripFlags(flags)
Inseob Kimeec88e12020-01-22 11:11:29 +0900150 stripped := android.PathForModuleOut(ctx, "stripped", libName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +0200151 p.stripper.StripExecutableOrSharedLib(ctx, in, stripped, stripFlags)
Inseob Kimeec88e12020-01-22 11:11:29 +0900152 in = stripped
153 }
154
155 // Optimize out relinking against shared libraries whose interface hasn't changed by
156 // depending on a table of contents file instead of the library itself.
157 tocFile := android.PathForModuleOut(ctx, libName+".toc")
158 p.tocFile = android.OptionalPathForPath(tocFile)
Ivan Lozano7b0781d2021-11-03 15:30:18 -0400159 TransformSharedObjectToToc(ctx, in, tocFile)
Inseob Kimeec88e12020-01-22 11:11:29 +0900160
Inseob Kim2b96bf52020-02-17 18:00:39 +0900161 p.androidMkSuffix = p.NameSuffix()
162
163 vndkVersion := ctx.DeviceConfig().VndkVersion()
Ivan Lozanod1dec542021-05-26 15:33:11 -0400164 if vndkVersion == p.Version() {
Inseob Kim2b96bf52020-02-17 18:00:39 +0900165 p.androidMkSuffix = ""
166 }
167
Colin Cross0de8a1e2020-09-18 14:15:30 -0700168 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
Liz Kammeref6dfea2021-06-08 15:37:09 -0400169 SharedLibrary: in,
170 Target: ctx.Target(),
Colin Cross0de8a1e2020-09-18 14:15:30 -0700171
172 TableOfContents: p.tocFile,
173 })
174
Inseob Kim70cb3b62020-10-16 16:23:05 +0900175 p.libraryDecorator.flagExporter.setProvider(ctx)
176
Inseob Kimeec88e12020-01-22 11:11:29 +0900177 return in
Justin Yun71549282017-11-17 12:10:28 +0900178 }
Colin Crossff6c33d2019-10-02 16:01:35 -0700179
Colin Crossa9c8c9f2020-12-16 10:20:23 -0800180 ctx.Module().HideFromMake()
Justin Yun71549282017-11-17 12:10:28 +0900181 return nil
182}
183
Ivan Lozanod1dec542021-05-26 15:33:11 -0400184func (p *vndkPrebuiltLibraryDecorator) MatchesWithDevice(config android.DeviceConfig) bool {
Jooyung Han31c470b2019-10-18 16:26:59 +0900185 arches := config.Arches()
186 if len(arches) == 0 || arches[0].ArchType.String() != p.arch() {
187 return false
188 }
189 if config.BinderBitness() != p.binderBit() {
190 return false
191 }
192 if len(p.properties.Srcs) == 0 {
193 return false
194 }
195 return true
196}
197
Inseob Kimc9fa4a32019-09-09 10:49:03 +0900198func (p *vndkPrebuiltLibraryDecorator) nativeCoverage() bool {
199 return false
200}
201
Ivan Lozanod1dec542021-05-26 15:33:11 -0400202func (p *vndkPrebuiltLibraryDecorator) IsSnapshotPrebuilt() bool {
Inseob Kim1042d292020-06-01 23:23:05 +0900203 return true
204}
205
Justin Yun71549282017-11-17 12:10:28 +0900206func (p *vndkPrebuiltLibraryDecorator) install(ctx ModuleContext, file android.Path) {
Jooyung Han261e1582020-10-20 18:54:21 +0900207 // do not install vndk libs
Justin Yun71549282017-11-17 12:10:28 +0900208}
209
210func vndkPrebuiltSharedLibrary() *Module {
211 module, library := NewLibrary(android.DeviceSupported)
212 library.BuildOnlyShared()
213 module.stl = nil
214 module.sanitize = nil
Thiébaud Weksteend4587452020-08-19 14:53:01 +0200215 library.disableStripping()
Justin Yun71549282017-11-17 12:10:28 +0900216
217 prebuilt := &vndkPrebuiltLibraryDecorator{
218 libraryDecorator: library,
219 }
220
Logan Chien4fcea3d2018-11-20 11:59:08 +0800221 prebuilt.properties.Check_elf_files = BoolPtr(false)
Inseob Kim64c43952019-08-26 16:52:35 +0900222 prebuilt.baseLinker.Properties.No_libcrt = BoolPtr(true)
223 prebuilt.baseLinker.Properties.Nocrt = BoolPtr(true)
224
225 // Prevent default system libs (libc, libm, and libdl) from being linked
226 if prebuilt.baseLinker.Properties.System_shared_libs == nil {
227 prebuilt.baseLinker.Properties.System_shared_libs = []string{}
228 }
Logan Chien4fcea3d2018-11-20 11:59:08 +0800229
Justin Yun71549282017-11-17 12:10:28 +0900230 module.compiler = nil
231 module.linker = prebuilt
232 module.installer = prebuilt
233
234 module.AddProperties(
235 &prebuilt.properties,
236 )
237
Inseob Kim81235ff2020-10-23 14:36:11 +0900238 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
239 // empty BOARD_VNDK_VERSION implies that the device won't support
240 // system only OTA. In this case, VNDK snapshots aren't needed.
241 if ctx.DeviceConfig().VndkVersion() == "" {
242 ctx.Module().Disable()
243 }
244 })
245
Justin Yun71549282017-11-17 12:10:28 +0900246 return module
247}
248
Patrice Arrudaad031502019-04-01 10:56:49 -0700249// vndk_prebuilt_shared installs Vendor Native Development kit (VNDK) snapshot
250// shared libraries for system build. Example:
251//
Colin Crossd079e0b2022-08-16 10:27:33 -0700252// vndk_prebuilt_shared {
253// name: "libfoo",
254// version: "27",
255// target_arch: "arm64",
256// vendor_available: true,
257// product_available: true,
258// vndk: {
259// enabled: true,
260// },
261// export_include_dirs: ["include/external/libfoo/vndk_include"],
262// arch: {
263// arm64: {
264// srcs: ["arm/lib64/libfoo.so"],
265// },
266// arm: {
267// srcs: ["arm/lib/libfoo.so"],
268// },
269// },
270// }
Jooyung Han344d5432019-08-23 11:17:39 +0900271func VndkPrebuiltSharedFactory() android.Module {
Justin Yun71549282017-11-17 12:10:28 +0900272 module := vndkPrebuiltSharedLibrary()
273 return module.Init()
274}
275
276func init() {
Jooyung Han344d5432019-08-23 11:17:39 +0900277 android.RegisterModuleType("vndk_prebuilt_shared", VndkPrebuiltSharedFactory)
Colin Cross7a6fcbe2017-12-06 13:08:00 -0800278}