blob: 3556d94d5492dc8df2d1306a2525d1a909cfc549 [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//
32// vndk_prebuilt_shared {
33// name: "libfoo",
Inseob Kimeec88e12020-01-22 11:11:29 +090034// version: "27",
35// target_arch: "arm64",
Justin Yun71549282017-11-17 12:10:28 +090036// vendor_available: true,
37// vndk: {
38// enabled: true,
39// },
40// export_include_dirs: ["include/external/libfoo/vndk_include"],
41// arch: {
42// arm64: {
43// srcs: ["arm/lib64/libfoo.so"],
44// },
45// arm: {
46// srcs: ["arm/lib/libfoo.so"],
47// },
48// },
49// }
50//
51type vndkPrebuiltProperties struct {
Jae Shin43ef2642017-12-29 16:20:21 +090052 // VNDK snapshot version.
53 Version *string
54
55 // Target arch name of the snapshot (e.g. 'arm64' for variant 'aosp_arm64_ab')
56 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 {
Justin Yun3e2323d2018-06-08 15:08:40 +090084 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
94func (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
Justin Yun71549282017-11-17 12:10:28 +0900109func (p *vndkPrebuiltLibraryDecorator) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Jae Shin43ef2642017-12-29 16:20:21 +0900110 p.libraryDecorator.libName = strings.TrimSuffix(ctx.ModuleName(), p.NameSuffix())
Justin Yun71549282017-11-17 12:10:28 +0900111 return p.libraryDecorator.linkerFlags(ctx, flags)
112}
113
114func (p *vndkPrebuiltLibraryDecorator) singleSourcePath(ctx ModuleContext) android.Path {
115 if len(p.properties.Srcs) == 0 {
116 ctx.PropertyErrorf("srcs", "missing prebuilt source file")
117 return nil
118 }
119
120 if len(p.properties.Srcs) > 1 {
121 ctx.PropertyErrorf("srcs", "multiple prebuilt source files")
122 return nil
123 }
124
125 return android.PathForModuleSrc(ctx, p.properties.Srcs[0])
126}
127
128func (p *vndkPrebuiltLibraryDecorator) link(ctx ModuleContext,
129 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Crossff6c33d2019-10-02 16:01:35 -0700130
Jooyung Han31c470b2019-10-18 16:26:59 +0900131 if !p.matchesWithDevice(ctx.DeviceConfig()) {
Colin Crossff6c33d2019-10-02 16:01:35 -0700132 ctx.Module().SkipInstall()
133 return nil
134 }
135
Justin Yun71549282017-11-17 12:10:28 +0900136 if len(p.properties.Srcs) > 0 && p.shared() {
Inseob Kimae553032019-05-14 18:52:49 +0900137 p.libraryDecorator.exportIncludes(ctx)
Inseob Kimae553032019-05-14 18:52:49 +0900138 p.libraryDecorator.reexportFlags(p.properties.Export_flags...)
Justin Yun71549282017-11-17 12:10:28 +0900139 // current VNDK prebuilts are only shared libs.
Inseob Kimeec88e12020-01-22 11:11:29 +0900140
141 in := p.singleSourcePath(ctx)
142 builderFlags := flagsToBuilderFlags(flags)
143 p.unstrippedOutputFile = in
144 libName := in.Base()
Thiébaud Weksteend4587452020-08-19 14:53:01 +0200145 if p.stripper.NeedsStrip(ctx) {
146 stripFlags := flagsToStripFlags(flags)
Inseob Kimeec88e12020-01-22 11:11:29 +0900147 stripped := android.PathForModuleOut(ctx, "stripped", libName)
Thiébaud Weksteend4587452020-08-19 14:53:01 +0200148 p.stripper.StripExecutableOrSharedLib(ctx, in, stripped, stripFlags)
Inseob Kimeec88e12020-01-22 11:11:29 +0900149 in = stripped
150 }
151
152 // Optimize out relinking against shared libraries whose interface hasn't changed by
153 // depending on a table of contents file instead of the library itself.
154 tocFile := android.PathForModuleOut(ctx, libName+".toc")
155 p.tocFile = android.OptionalPathForPath(tocFile)
156 TransformSharedObjectToToc(ctx, in, tocFile, builderFlags)
157
Inseob Kim2b96bf52020-02-17 18:00:39 +0900158 p.androidMkSuffix = p.NameSuffix()
159
160 vndkVersion := ctx.DeviceConfig().VndkVersion()
161 if vndkVersion == p.version() {
162 p.androidMkSuffix = ""
163 }
164
Colin Cross0de8a1e2020-09-18 14:15:30 -0700165 ctx.SetProvider(SharedLibraryInfoProvider, SharedLibraryInfo{
166 SharedLibrary: in,
167 UnstrippedSharedLibrary: p.unstrippedOutputFile,
168
169 TableOfContents: p.tocFile,
170 })
171
Inseob Kim70cb3b62020-10-16 16:23:05 +0900172 p.libraryDecorator.flagExporter.setProvider(ctx)
173
Inseob Kimeec88e12020-01-22 11:11:29 +0900174 return in
Justin Yun71549282017-11-17 12:10:28 +0900175 }
Colin Crossff6c33d2019-10-02 16:01:35 -0700176
177 ctx.Module().SkipInstall()
Justin Yun71549282017-11-17 12:10:28 +0900178 return nil
179}
180
Jooyung Han31c470b2019-10-18 16:26:59 +0900181func (p *vndkPrebuiltLibraryDecorator) matchesWithDevice(config android.DeviceConfig) bool {
182 arches := config.Arches()
183 if len(arches) == 0 || arches[0].ArchType.String() != p.arch() {
184 return false
185 }
186 if config.BinderBitness() != p.binderBit() {
187 return false
188 }
189 if len(p.properties.Srcs) == 0 {
190 return false
191 }
192 return true
193}
194
Inseob Kimc9fa4a32019-09-09 10:49:03 +0900195func (p *vndkPrebuiltLibraryDecorator) nativeCoverage() bool {
196 return false
197}
198
Inseob Kim1042d292020-06-01 23:23:05 +0900199func (p *vndkPrebuiltLibraryDecorator) isSnapshotPrebuilt() bool {
200 return true
201}
202
Justin Yun71549282017-11-17 12:10:28 +0900203func (p *vndkPrebuiltLibraryDecorator) install(ctx ModuleContext, file android.Path) {
Justin Yun312ccb92018-01-23 12:07:46 +0900204 arches := ctx.DeviceConfig().Arches()
205 if len(arches) == 0 || arches[0].ArchType.String() != p.arch() {
206 return
207 }
Justin Yun3e2323d2018-06-08 15:08:40 +0900208 if ctx.DeviceConfig().BinderBitness() != p.binderBit() {
209 return
210 }
Justin Yun71549282017-11-17 12:10:28 +0900211 if p.shared() {
Justin Yun3e15b962018-01-10 18:28:48 +0900212 if ctx.isVndkSp() {
213 p.baseInstaller.subDir = "vndk-sp-" + p.version()
214 } else if ctx.isVndk() {
215 p.baseInstaller.subDir = "vndk-" + p.version()
Justin Yun71549282017-11-17 12:10:28 +0900216 }
217 p.baseInstaller.install(ctx, file)
218 }
219}
220
221func vndkPrebuiltSharedLibrary() *Module {
222 module, library := NewLibrary(android.DeviceSupported)
223 library.BuildOnlyShared()
224 module.stl = nil
225 module.sanitize = nil
Thiébaud Weksteend4587452020-08-19 14:53:01 +0200226 library.disableStripping()
Justin Yun71549282017-11-17 12:10:28 +0900227
228 prebuilt := &vndkPrebuiltLibraryDecorator{
229 libraryDecorator: library,
230 }
231
Logan Chien4fcea3d2018-11-20 11:59:08 +0800232 prebuilt.properties.Check_elf_files = BoolPtr(false)
Inseob Kim64c43952019-08-26 16:52:35 +0900233 prebuilt.baseLinker.Properties.No_libcrt = BoolPtr(true)
234 prebuilt.baseLinker.Properties.Nocrt = BoolPtr(true)
235
236 // Prevent default system libs (libc, libm, and libdl) from being linked
237 if prebuilt.baseLinker.Properties.System_shared_libs == nil {
238 prebuilt.baseLinker.Properties.System_shared_libs = []string{}
239 }
Logan Chien4fcea3d2018-11-20 11:59:08 +0800240
Justin Yun71549282017-11-17 12:10:28 +0900241 module.compiler = nil
242 module.linker = prebuilt
243 module.installer = prebuilt
244
245 module.AddProperties(
246 &prebuilt.properties,
247 )
248
249 return module
250}
251
Patrice Arrudaad031502019-04-01 10:56:49 -0700252// vndk_prebuilt_shared installs Vendor Native Development kit (VNDK) snapshot
253// shared libraries for system build. Example:
254//
255// vndk_prebuilt_shared {
256// name: "libfoo",
Inseob Kimeec88e12020-01-22 11:11:29 +0900257// version: "27",
258// target_arch: "arm64",
Patrice Arrudaad031502019-04-01 10:56:49 -0700259// vendor_available: true,
260// vndk: {
261// enabled: true,
262// },
263// export_include_dirs: ["include/external/libfoo/vndk_include"],
264// arch: {
265// arm64: {
266// srcs: ["arm/lib64/libfoo.so"],
267// },
268// arm: {
269// srcs: ["arm/lib/libfoo.so"],
270// },
271// },
272// }
Jooyung Han344d5432019-08-23 11:17:39 +0900273func VndkPrebuiltSharedFactory() android.Module {
Justin Yun71549282017-11-17 12:10:28 +0900274 module := vndkPrebuiltSharedLibrary()
275 return module.Init()
276}
277
278func init() {
Jooyung Han344d5432019-08-23 11:17:39 +0900279 android.RegisterModuleType("vndk_prebuilt_shared", VndkPrebuiltSharedFactory)
Colin Cross7a6fcbe2017-12-06 13:08:00 -0800280}