blob: 48e466715a17be7f7f17a360e639f653bd46574c [file] [log] [blame]
Colin Crossce75d2c2016-10-06 16:12:58 -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 (
18 "android/soong/android"
Colin Crossce75d2c2016-10-06 16:12:58 -070019)
20
21func init() {
Colin Crossdfee1bc2017-03-17 14:03:18 -070022 android.RegisterModuleType("cc_prebuilt_library_shared", prebuiltSharedLibraryFactory)
Colin Crossde89fb82017-03-17 13:28:06 -070023 android.RegisterModuleType("cc_prebuilt_library_static", prebuiltStaticLibraryFactory)
24 android.RegisterModuleType("cc_prebuilt_binary", prebuiltBinaryFactory)
Colin Crossce75d2c2016-10-06 16:12:58 -070025}
26
27type prebuiltLinkerInterface interface {
28 Name(string) string
29 prebuilt() *android.Prebuilt
30}
31
Patrice Arruda3554a982019-03-27 19:09:10 -070032type prebuiltLinkerProperties struct {
33
34 // a prebuilt library or binary. Can reference a genrule module that generates an executable file.
35 Srcs []string `android:"path,arch_variant"`
36
37 // Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
38 // symbols, etc), default true.
39 Check_elf_files *bool
40}
41
Colin Crossde89fb82017-03-17 13:28:06 -070042type prebuiltLinker struct {
Colin Crossce75d2c2016-10-06 16:12:58 -070043 android.Prebuilt
Logan Chien4fcea3d2018-11-20 11:59:08 +080044
Patrice Arruda3554a982019-03-27 19:09:10 -070045 properties prebuiltLinkerProperties
Colin Crossce75d2c2016-10-06 16:12:58 -070046}
47
Colin Crossde89fb82017-03-17 13:28:06 -070048func (p *prebuiltLinker) prebuilt() *android.Prebuilt {
Colin Crossce75d2c2016-10-06 16:12:58 -070049 return &p.Prebuilt
50}
51
Colin Cross74d73e22017-08-02 11:05:49 -070052func (p *prebuiltLinker) PrebuiltSrcs() []string {
53 return p.properties.Srcs
54}
55
Colin Cross33b2fb72019-05-14 14:07:01 -070056type prebuiltLibraryInterface interface {
57 libraryInterface
58 prebuiltLinkerInterface
59 disablePrebuilt()
60}
61
Colin Crossde89fb82017-03-17 13:28:06 -070062type prebuiltLibraryLinker struct {
63 *libraryDecorator
64 prebuiltLinker
65}
66
67var _ prebuiltLinkerInterface = (*prebuiltLibraryLinker)(nil)
Colin Cross33b2fb72019-05-14 14:07:01 -070068var _ prebuiltLibraryInterface = (*prebuiltLibraryLinker)(nil)
Colin Crossde89fb82017-03-17 13:28:06 -070069
Yi Kong00981662018-08-13 16:02:49 -070070func (p *prebuiltLibraryLinker) linkerInit(ctx BaseModuleContext) {}
71
72func (p *prebuiltLibraryLinker) linkerDeps(ctx DepsContext, deps Deps) Deps {
Logan Chienc7f797e2019-01-14 15:35:08 +080073 return p.libraryDecorator.linkerDeps(ctx, deps)
Yi Kong00981662018-08-13 16:02:49 -070074}
75
76func (p *prebuiltLibraryLinker) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross1ab10a72018-09-04 11:02:37 -070077 return flags
Yi Kong00981662018-08-13 16:02:49 -070078}
79
80func (p *prebuiltLibraryLinker) linkerProps() []interface{} {
81 return p.libraryDecorator.linkerProps()
82}
83
Colin Crossce75d2c2016-10-06 16:12:58 -070084func (p *prebuiltLibraryLinker) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -070085 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Crossce75d2c2016-10-06 16:12:58 -070086 // TODO(ccross): verify shared library dependencies
Colin Cross74d73e22017-08-02 11:05:49 -070087 if len(p.properties.Srcs) > 0 {
Colin Crossce75d2c2016-10-06 16:12:58 -070088 p.libraryDecorator.exportIncludes(ctx, "-I")
89 p.libraryDecorator.reexportFlags(deps.ReexportedFlags)
90 p.libraryDecorator.reexportDeps(deps.ReexportedFlagsDeps)
Colin Cross88f6fef2018-09-05 14:20:03 -070091
92 builderFlags := flagsToBuilderFlags(flags)
93
94 in := p.Prebuilt.SingleSourcePath(ctx)
95
96 if p.shared() {
Colin Crossb60190a2018-09-04 16:28:17 -070097 p.unstrippedOutputFile = in
Colin Cross88f6fef2018-09-05 14:20:03 -070098 libName := ctx.baseModuleName() + flags.Toolchain.ShlibSuffix()
99 if p.needsStrip(ctx) {
100 stripped := android.PathForModuleOut(ctx, "stripped", libName)
101 p.strip(ctx, in, stripped, builderFlags)
102 in = stripped
103 }
104
Colin Crossb60190a2018-09-04 16:28:17 -0700105 // Optimize out relinking against shared libraries whose interface hasn't changed by
106 // depending on a table of contents file instead of the library itself.
107 tocFile := android.PathForModuleOut(ctx, libName+".toc")
108 p.tocFile = android.OptionalPathForPath(tocFile)
109 TransformSharedObjectToToc(ctx, in, tocFile, builderFlags)
Colin Cross88f6fef2018-09-05 14:20:03 -0700110 }
111
112 return in
Colin Crossce75d2c2016-10-06 16:12:58 -0700113 }
114
115 return nil
116}
117
Jiyong Park379de2f2018-12-19 02:47:14 +0900118func (p *prebuiltLibraryLinker) shared() bool {
119 return p.libraryDecorator.shared()
120}
121
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700122func (p *prebuiltLibraryLinker) nativeCoverage() bool {
123 return false
124}
125
Colin Cross33b2fb72019-05-14 14:07:01 -0700126func (p *prebuiltLibraryLinker) disablePrebuilt() {
127 p.properties.Srcs = nil
128}
129
Patrice Arruda3554a982019-03-27 19:09:10 -0700130// cc_prebuilt_library_shared installs a precompiled shared library that are
131// listed in the srcs property in the device's directory.
Colin Cross36242852017-06-23 15:06:31 -0700132func prebuiltSharedLibraryFactory() android.Module {
Leo Li74f7b972017-05-17 11:30:45 -0700133 module, _ := NewPrebuiltSharedLibrary(android.HostAndDeviceSupported)
134 return module.Init()
135}
136
137func NewPrebuiltSharedLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
138 module, library := NewLibrary(hod)
Colin Crossde89fb82017-03-17 13:28:06 -0700139 library.BuildOnlyShared()
Colin Crossce75d2c2016-10-06 16:12:58 -0700140 module.compiler = nil
141
142 prebuilt := &prebuiltLibraryLinker{
143 libraryDecorator: library,
144 }
145 module.linker = prebuilt
Colin Crossde89fb82017-03-17 13:28:06 -0700146
Colin Cross74d73e22017-08-02 11:05:49 -0700147 module.AddProperties(&prebuilt.properties)
148
149 android.InitPrebuiltModule(module, &prebuilt.properties.Srcs)
Jiyong Park379de2f2018-12-19 02:47:14 +0900150
151 // Prebuilt libraries can be included in APEXes
152 android.InitApexModule(module)
153
Leo Li74f7b972017-05-17 11:30:45 -0700154 return module, library
Colin Crossde89fb82017-03-17 13:28:06 -0700155}
156
Patrice Arruda3554a982019-03-27 19:09:10 -0700157// cc_prebuilt_library_static installs a precompiled static library that are
158// listed in the srcs property in the device's directory.
Colin Cross36242852017-06-23 15:06:31 -0700159func prebuiltStaticLibraryFactory() android.Module {
Leo Li74f7b972017-05-17 11:30:45 -0700160 module, _ := NewPrebuiltStaticLibrary(android.HostAndDeviceSupported)
161 return module.Init()
162}
163
164func NewPrebuiltStaticLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
165 module, library := NewLibrary(hod)
Colin Crossde89fb82017-03-17 13:28:06 -0700166 library.BuildOnlyStatic()
167 module.compiler = nil
168
169 prebuilt := &prebuiltLibraryLinker{
170 libraryDecorator: library,
171 }
172 module.linker = prebuilt
173
Colin Cross74d73e22017-08-02 11:05:49 -0700174 module.AddProperties(&prebuilt.properties)
175
176 android.InitPrebuiltModule(module, &prebuilt.properties.Srcs)
Leo Li74f7b972017-05-17 11:30:45 -0700177 return module, library
Colin Crossde89fb82017-03-17 13:28:06 -0700178}
179
180type prebuiltBinaryLinker struct {
181 *binaryDecorator
182 prebuiltLinker
183}
184
185var _ prebuiltLinkerInterface = (*prebuiltBinaryLinker)(nil)
186
Colin Crossde89fb82017-03-17 13:28:06 -0700187func (p *prebuiltBinaryLinker) link(ctx ModuleContext,
188 flags Flags, deps PathDeps, objs Objects) android.Path {
189 // TODO(ccross): verify shared library dependencies
Colin Cross74d73e22017-08-02 11:05:49 -0700190 if len(p.properties.Srcs) > 0 {
Colin Cross88f6fef2018-09-05 14:20:03 -0700191 builderFlags := flagsToBuilderFlags(flags)
192
193 fileName := p.getStem(ctx) + flags.Toolchain.ExecutableSuffix()
194 in := p.Prebuilt.SingleSourcePath(ctx)
195
Colin Crossb60190a2018-09-04 16:28:17 -0700196 p.unstrippedOutputFile = in
197
Colin Cross88f6fef2018-09-05 14:20:03 -0700198 if p.needsStrip(ctx) {
199 stripped := android.PathForModuleOut(ctx, "stripped", fileName)
200 p.strip(ctx, in, stripped, builderFlags)
201 in = stripped
202 }
Colin Cross94921e72017-08-08 16:20:15 -0700203
204 // Copy binaries to a name matching the final installed name
Colin Cross94921e72017-08-08 16:20:15 -0700205 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Crossae887032017-10-23 17:16:14 -0700206 ctx.Build(pctx, android.BuildParams{
Colin Cross5c517922017-08-31 12:29:17 -0700207 Rule: android.CpExecutable,
Colin Cross94921e72017-08-08 16:20:15 -0700208 Description: "prebuilt",
209 Output: outputFile,
Colin Cross88f6fef2018-09-05 14:20:03 -0700210 Input: in,
Colin Cross94921e72017-08-08 16:20:15 -0700211 })
212
213 return outputFile
Colin Crossde89fb82017-03-17 13:28:06 -0700214 }
215
216 return nil
217}
218
Patrice Arruda3554a982019-03-27 19:09:10 -0700219// cc_prebuilt_binary installs a precompiled executable in srcs property in the
220// device's directory.
Colin Cross36242852017-06-23 15:06:31 -0700221func prebuiltBinaryFactory() android.Module {
Leo Li74f7b972017-05-17 11:30:45 -0700222 module, _ := NewPrebuiltBinary(android.HostAndDeviceSupported)
223 return module.Init()
224}
225
226func NewPrebuiltBinary(hod android.HostOrDeviceSupported) (*Module, *binaryDecorator) {
227 module, binary := NewBinary(hod)
Colin Crossde89fb82017-03-17 13:28:06 -0700228 module.compiler = nil
229
230 prebuilt := &prebuiltBinaryLinker{
231 binaryDecorator: binary,
232 }
233 module.linker = prebuilt
Colin Crossce75d2c2016-10-06 16:12:58 -0700234
Colin Cross74d73e22017-08-02 11:05:49 -0700235 module.AddProperties(&prebuilt.properties)
236
237 android.InitPrebuiltModule(module, &prebuilt.properties.Srcs)
Leo Li74f7b972017-05-17 11:30:45 -0700238 return module, binary
Colin Crossce75d2c2016-10-06 16:12:58 -0700239}