blob: 653b43ef07027956ec372a49136622623ed548f0 [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() {
Paul Duffin59986b22019-12-19 14:38:36 +000022 RegisterPrebuiltBuildComponents(android.InitRegistrationContext)
23}
24
25func RegisterPrebuiltBuildComponents(ctx android.RegistrationContext) {
Paul Duffinbce90da2020-03-12 20:17:14 +000026 ctx.RegisterModuleType("cc_prebuilt_library", PrebuiltLibraryFactory)
Paul Duffin59986b22019-12-19 14:38:36 +000027 ctx.RegisterModuleType("cc_prebuilt_library_shared", PrebuiltSharedLibraryFactory)
28 ctx.RegisterModuleType("cc_prebuilt_library_static", PrebuiltStaticLibraryFactory)
Chris Parsons1f6d90f2020-06-17 16:10:42 -040029 ctx.RegisterModuleType("cc_prebuilt_test_library_shared", PrebuiltSharedTestLibraryFactory)
Martin Stjernholm0b92ac82020-03-11 21:45:49 +000030 ctx.RegisterModuleType("cc_prebuilt_object", prebuiltObjectFactory)
Paul Duffin59986b22019-12-19 14:38:36 +000031 ctx.RegisterModuleType("cc_prebuilt_binary", prebuiltBinaryFactory)
Colin Crossce75d2c2016-10-06 16:12:58 -070032}
33
34type prebuiltLinkerInterface interface {
35 Name(string) string
36 prebuilt() *android.Prebuilt
37}
38
Patrice Arruda3554a982019-03-27 19:09:10 -070039type prebuiltLinkerProperties struct {
40
41 // a prebuilt library or binary. Can reference a genrule module that generates an executable file.
42 Srcs []string `android:"path,arch_variant"`
43
44 // Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
45 // symbols, etc), default true.
46 Check_elf_files *bool
Yo Chianga3ad9b22020-03-18 14:19:07 +080047
48 // Optionally provide an import library if this is a Windows PE DLL prebuilt.
49 // This is needed only if this library is linked by other modules in build time.
50 // Only makes sense for the Windows target.
51 Windows_import_lib *string `android:"path,arch_variant"`
Patrice Arruda3554a982019-03-27 19:09:10 -070052}
53
Colin Crossde89fb82017-03-17 13:28:06 -070054type prebuiltLinker struct {
Colin Crossce75d2c2016-10-06 16:12:58 -070055 android.Prebuilt
Logan Chien4fcea3d2018-11-20 11:59:08 +080056
Patrice Arruda3554a982019-03-27 19:09:10 -070057 properties prebuiltLinkerProperties
Colin Crossce75d2c2016-10-06 16:12:58 -070058}
59
Colin Crossde89fb82017-03-17 13:28:06 -070060func (p *prebuiltLinker) prebuilt() *android.Prebuilt {
Colin Crossce75d2c2016-10-06 16:12:58 -070061 return &p.Prebuilt
62}
63
Colin Cross74d73e22017-08-02 11:05:49 -070064func (p *prebuiltLinker) PrebuiltSrcs() []string {
65 return p.properties.Srcs
66}
67
Colin Cross33b2fb72019-05-14 14:07:01 -070068type prebuiltLibraryInterface interface {
69 libraryInterface
70 prebuiltLinkerInterface
71 disablePrebuilt()
72}
73
Colin Crossde89fb82017-03-17 13:28:06 -070074type prebuiltLibraryLinker struct {
75 *libraryDecorator
76 prebuiltLinker
77}
78
79var _ prebuiltLinkerInterface = (*prebuiltLibraryLinker)(nil)
Colin Cross33b2fb72019-05-14 14:07:01 -070080var _ prebuiltLibraryInterface = (*prebuiltLibraryLinker)(nil)
Colin Crossde89fb82017-03-17 13:28:06 -070081
Yi Kong00981662018-08-13 16:02:49 -070082func (p *prebuiltLibraryLinker) linkerInit(ctx BaseModuleContext) {}
83
84func (p *prebuiltLibraryLinker) linkerDeps(ctx DepsContext, deps Deps) Deps {
Logan Chienc7f797e2019-01-14 15:35:08 +080085 return p.libraryDecorator.linkerDeps(ctx, deps)
Yi Kong00981662018-08-13 16:02:49 -070086}
87
88func (p *prebuiltLibraryLinker) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross1ab10a72018-09-04 11:02:37 -070089 return flags
Yi Kong00981662018-08-13 16:02:49 -070090}
91
92func (p *prebuiltLibraryLinker) linkerProps() []interface{} {
93 return p.libraryDecorator.linkerProps()
94}
95
Colin Crossce75d2c2016-10-06 16:12:58 -070096func (p *prebuiltLibraryLinker) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -070097 flags Flags, deps PathDeps, objs Objects) android.Path {
Paul Duffinf5ea9e12020-02-21 10:57:00 +000098
99 p.libraryDecorator.exportIncludes(ctx)
100 p.libraryDecorator.reexportDirs(deps.ReexportedDirs...)
101 p.libraryDecorator.reexportSystemDirs(deps.ReexportedSystemDirs...)
102 p.libraryDecorator.reexportFlags(deps.ReexportedFlags...)
103 p.libraryDecorator.reexportDeps(deps.ReexportedDeps...)
104 p.libraryDecorator.addExportedGeneratedHeaders(deps.ReexportedGeneratedHeaders...)
105
Colin Crossce75d2c2016-10-06 16:12:58 -0700106 // TODO(ccross): verify shared library dependencies
Paul Duffinbce90da2020-03-12 20:17:14 +0000107 srcs := p.prebuiltSrcs()
108 if len(srcs) > 0 {
Colin Cross88f6fef2018-09-05 14:20:03 -0700109 builderFlags := flagsToBuilderFlags(flags)
110
Paul Duffinbce90da2020-03-12 20:17:14 +0000111 if len(srcs) > 1 {
112 ctx.PropertyErrorf("srcs", "multiple prebuilt source files")
113 return nil
114 }
115
116 in := android.PathForModuleSrc(ctx, srcs[0])
Colin Cross88f6fef2018-09-05 14:20:03 -0700117
Yo Chianga3ad9b22020-03-18 14:19:07 +0800118 if p.static() {
119 return in
120 }
121
Colin Cross88f6fef2018-09-05 14:20:03 -0700122 if p.shared() {
Colin Crossb60190a2018-09-04 16:28:17 -0700123 p.unstrippedOutputFile = in
Colin Cross0fd6a412019-08-16 14:22:10 -0700124 libName := p.libraryDecorator.getLibName(ctx) + flags.Toolchain.ShlibSuffix()
Yo Chianga3ad9b22020-03-18 14:19:07 +0800125 outputFile := android.PathForModuleOut(ctx, libName)
126 var implicits android.Paths
127
Colin Cross88f6fef2018-09-05 14:20:03 -0700128 if p.needsStrip(ctx) {
129 stripped := android.PathForModuleOut(ctx, "stripped", libName)
Ryan Prichardf979d732019-05-30 20:53:29 -0700130 p.stripExecutableOrSharedLib(ctx, in, stripped, builderFlags)
Colin Cross88f6fef2018-09-05 14:20:03 -0700131 in = stripped
132 }
133
Colin Crossb60190a2018-09-04 16:28:17 -0700134 // Optimize out relinking against shared libraries whose interface hasn't changed by
135 // depending on a table of contents file instead of the library itself.
136 tocFile := android.PathForModuleOut(ctx, libName+".toc")
137 p.tocFile = android.OptionalPathForPath(tocFile)
Yo Chianga3ad9b22020-03-18 14:19:07 +0800138 TransformSharedObjectToToc(ctx, outputFile, tocFile, builderFlags)
Colin Cross88f6fef2018-09-05 14:20:03 -0700139
Yo Chianga3ad9b22020-03-18 14:19:07 +0800140 if ctx.Windows() && p.properties.Windows_import_lib != nil {
141 // Consumers of this library actually links to the import library in build
142 // time and dynamically links to the DLL in run time. i.e.
143 // a.exe <-- static link --> foo.lib <-- dynamic link --> foo.dll
144 importLibSrc := android.PathForModuleSrc(ctx, String(p.properties.Windows_import_lib))
145 importLibName := p.libraryDecorator.getLibName(ctx) + ".lib"
146 importLibOutputFile := android.PathForModuleOut(ctx, importLibName)
147 implicits = append(implicits, importLibOutputFile)
148
149 ctx.Build(pctx, android.BuildParams{
150 Rule: android.Cp,
151 Description: "prebuilt import library",
152 Input: importLibSrc,
153 Output: importLibOutputFile,
154 Args: map[string]string{
155 "cpFlags": "-L",
156 },
157 })
158 }
159
160 ctx.Build(pctx, android.BuildParams{
161 Rule: android.Cp,
162 Description: "prebuilt shared library",
163 Implicits: implicits,
164 Input: in,
165 Output: outputFile,
166 Args: map[string]string{
167 "cpFlags": "-L",
168 },
169 })
170
171 return outputFile
172 }
Colin Crossce75d2c2016-10-06 16:12:58 -0700173 }
174
175 return nil
176}
177
Paul Duffinbce90da2020-03-12 20:17:14 +0000178func (p *prebuiltLibraryLinker) prebuiltSrcs() []string {
179 srcs := p.properties.Srcs
180 if p.static() {
181 srcs = append(srcs, p.libraryDecorator.StaticProperties.Static.Srcs...)
182 }
183 if p.shared() {
184 srcs = append(srcs, p.libraryDecorator.SharedProperties.Shared.Srcs...)
185 }
186
187 return srcs
188}
189
Jiyong Park379de2f2018-12-19 02:47:14 +0900190func (p *prebuiltLibraryLinker) shared() bool {
191 return p.libraryDecorator.shared()
192}
193
Pirama Arumuga Nainar65c95ff2019-03-25 10:21:31 -0700194func (p *prebuiltLibraryLinker) nativeCoverage() bool {
195 return false
196}
197
Colin Cross33b2fb72019-05-14 14:07:01 -0700198func (p *prebuiltLibraryLinker) disablePrebuilt() {
199 p.properties.Srcs = nil
200}
201
Martin Stjernholmbf37d162020-03-31 16:05:34 +0100202func (p *prebuiltLibraryLinker) skipInstall(mod *Module) {
203 mod.ModuleBase.SkipInstall()
204}
205
Paul Duffinac6e6082019-12-11 15:22:32 +0000206func NewPrebuiltLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Leo Li74f7b972017-05-17 11:30:45 -0700207 module, library := NewLibrary(hod)
Colin Crossce75d2c2016-10-06 16:12:58 -0700208 module.compiler = nil
209
210 prebuilt := &prebuiltLibraryLinker{
211 libraryDecorator: library,
212 }
213 module.linker = prebuilt
Martin Stjernholmbf37d162020-03-31 16:05:34 +0100214 module.installer = prebuilt
Colin Crossde89fb82017-03-17 13:28:06 -0700215
Colin Cross74d73e22017-08-02 11:05:49 -0700216 module.AddProperties(&prebuilt.properties)
217
Paul Duffinbce90da2020-03-12 20:17:14 +0000218 srcsSupplier := func() []string {
219 return prebuilt.prebuiltSrcs()
220 }
221
222 android.InitPrebuiltModuleWithSrcSupplier(module, srcsSupplier, "srcs")
Jiyong Park379de2f2018-12-19 02:47:14 +0900223
Paul Duffinac6e6082019-12-11 15:22:32 +0000224 // Prebuilt libraries can be used in SDKs.
Jiyong Parkd1063c12019-07-17 20:08:41 +0900225 android.InitSdkAwareModule(module)
Paul Duffinac6e6082019-12-11 15:22:32 +0000226 return module, library
227}
228
Paul Duffinbce90da2020-03-12 20:17:14 +0000229// cc_prebuilt_library installs a precompiled shared library that are
230// listed in the srcs property in the device's directory.
231func PrebuiltLibraryFactory() android.Module {
232 module, _ := NewPrebuiltLibrary(android.HostAndDeviceSupported)
233
234 // Prebuilt shared libraries can be included in APEXes
235 android.InitApexModule(module)
236
237 return module.Init()
238}
239
Paul Duffinac6e6082019-12-11 15:22:32 +0000240// cc_prebuilt_library_shared installs a precompiled shared library that are
241// listed in the srcs property in the device's directory.
242func PrebuiltSharedLibraryFactory() android.Module {
243 module, _ := NewPrebuiltSharedLibrary(android.HostAndDeviceSupported)
244 return module.Init()
245}
246
Chris Parsons1f6d90f2020-06-17 16:10:42 -0400247// cc_prebuilt_test_library_shared installs a precompiled shared library
248// to be used as a data dependency of a test-related module (such as cc_test, or
249// cc_test_library).
250func PrebuiltSharedTestLibraryFactory() android.Module {
251 module, library := NewPrebuiltLibrary(android.HostAndDeviceSupported)
252 library.BuildOnlyShared()
253 library.baseInstaller = NewTestInstaller()
254 return module.Init()
255}
256
Paul Duffinac6e6082019-12-11 15:22:32 +0000257func NewPrebuiltSharedLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
258 module, library := NewPrebuiltLibrary(hod)
259 library.BuildOnlyShared()
260
261 // Prebuilt shared libraries can be included in APEXes
262 android.InitApexModule(module)
Jiyong Park379de2f2018-12-19 02:47:14 +0900263
Leo Li74f7b972017-05-17 11:30:45 -0700264 return module, library
Colin Crossde89fb82017-03-17 13:28:06 -0700265}
266
Patrice Arruda3554a982019-03-27 19:09:10 -0700267// cc_prebuilt_library_static installs a precompiled static library that are
268// listed in the srcs property in the device's directory.
Jooyung Han344d5432019-08-23 11:17:39 +0900269func PrebuiltStaticLibraryFactory() android.Module {
Leo Li74f7b972017-05-17 11:30:45 -0700270 module, _ := NewPrebuiltStaticLibrary(android.HostAndDeviceSupported)
271 return module.Init()
272}
273
274func NewPrebuiltStaticLibrary(hod android.HostOrDeviceSupported) (*Module, *libraryDecorator) {
Paul Duffinac6e6082019-12-11 15:22:32 +0000275 module, library := NewPrebuiltLibrary(hod)
Colin Crossde89fb82017-03-17 13:28:06 -0700276 library.BuildOnlyStatic()
Leo Li74f7b972017-05-17 11:30:45 -0700277 return module, library
Colin Crossde89fb82017-03-17 13:28:06 -0700278}
279
Martin Stjernholm0b92ac82020-03-11 21:45:49 +0000280type prebuiltObjectProperties struct {
281 Srcs []string `android:"path,arch_variant"`
282}
283
284type prebuiltObjectLinker struct {
285 android.Prebuilt
286 objectLinker
287
288 properties prebuiltObjectProperties
289}
290
291func (p *prebuiltObjectLinker) prebuilt() *android.Prebuilt {
292 return &p.Prebuilt
293}
294
295var _ prebuiltLinkerInterface = (*prebuiltObjectLinker)(nil)
296
297func (p *prebuiltObjectLinker) link(ctx ModuleContext,
298 flags Flags, deps PathDeps, objs Objects) android.Path {
299 if len(p.properties.Srcs) > 0 {
300 return p.Prebuilt.SingleSourcePath(ctx)
301 }
302 return nil
303}
304
Inseob Kim1042d292020-06-01 23:23:05 +0900305func (p *prebuiltObjectLinker) object() bool {
306 return true
307}
308
Martin Stjernholm0b92ac82020-03-11 21:45:49 +0000309func newPrebuiltObject() *Module {
310 module := newObject()
311 prebuilt := &prebuiltObjectLinker{
312 objectLinker: objectLinker{
313 baseLinker: NewBaseLinker(nil),
314 },
315 }
316 module.linker = prebuilt
317 module.AddProperties(&prebuilt.properties)
318 android.InitPrebuiltModule(module, &prebuilt.properties.Srcs)
319 android.InitSdkAwareModule(module)
320 return module
321}
322
323func prebuiltObjectFactory() android.Module {
324 module := newPrebuiltObject()
325 return module.Init()
326}
327
Colin Crossde89fb82017-03-17 13:28:06 -0700328type prebuiltBinaryLinker struct {
329 *binaryDecorator
330 prebuiltLinker
331}
332
333var _ prebuiltLinkerInterface = (*prebuiltBinaryLinker)(nil)
334
Colin Crossde89fb82017-03-17 13:28:06 -0700335func (p *prebuiltBinaryLinker) link(ctx ModuleContext,
336 flags Flags, deps PathDeps, objs Objects) android.Path {
337 // TODO(ccross): verify shared library dependencies
Colin Cross74d73e22017-08-02 11:05:49 -0700338 if len(p.properties.Srcs) > 0 {
Colin Cross88f6fef2018-09-05 14:20:03 -0700339 builderFlags := flagsToBuilderFlags(flags)
340
341 fileName := p.getStem(ctx) + flags.Toolchain.ExecutableSuffix()
342 in := p.Prebuilt.SingleSourcePath(ctx)
343
Colin Crossb60190a2018-09-04 16:28:17 -0700344 p.unstrippedOutputFile = in
345
Colin Cross88f6fef2018-09-05 14:20:03 -0700346 if p.needsStrip(ctx) {
347 stripped := android.PathForModuleOut(ctx, "stripped", fileName)
Ryan Prichardf979d732019-05-30 20:53:29 -0700348 p.stripExecutableOrSharedLib(ctx, in, stripped, builderFlags)
Colin Cross88f6fef2018-09-05 14:20:03 -0700349 in = stripped
350 }
Colin Cross94921e72017-08-08 16:20:15 -0700351
352 // Copy binaries to a name matching the final installed name
Colin Cross94921e72017-08-08 16:20:15 -0700353 outputFile := android.PathForModuleOut(ctx, fileName)
Colin Crossae887032017-10-23 17:16:14 -0700354 ctx.Build(pctx, android.BuildParams{
Colin Cross5c517922017-08-31 12:29:17 -0700355 Rule: android.CpExecutable,
Colin Cross94921e72017-08-08 16:20:15 -0700356 Description: "prebuilt",
357 Output: outputFile,
Colin Cross88f6fef2018-09-05 14:20:03 -0700358 Input: in,
Colin Cross94921e72017-08-08 16:20:15 -0700359 })
360
361 return outputFile
Colin Crossde89fb82017-03-17 13:28:06 -0700362 }
363
364 return nil
365}
366
Inseob Kim7f283f42020-06-01 21:53:49 +0900367func (p *prebuiltBinaryLinker) binary() bool {
368 return true
369}
370
Patrice Arruda3554a982019-03-27 19:09:10 -0700371// cc_prebuilt_binary installs a precompiled executable in srcs property in the
372// device's directory.
Colin Cross36242852017-06-23 15:06:31 -0700373func prebuiltBinaryFactory() android.Module {
Leo Li74f7b972017-05-17 11:30:45 -0700374 module, _ := NewPrebuiltBinary(android.HostAndDeviceSupported)
375 return module.Init()
376}
377
378func NewPrebuiltBinary(hod android.HostOrDeviceSupported) (*Module, *binaryDecorator) {
379 module, binary := NewBinary(hod)
Colin Crossde89fb82017-03-17 13:28:06 -0700380 module.compiler = nil
381
382 prebuilt := &prebuiltBinaryLinker{
383 binaryDecorator: binary,
384 }
385 module.linker = prebuilt
Colin Crossce75d2c2016-10-06 16:12:58 -0700386
Colin Cross74d73e22017-08-02 11:05:49 -0700387 module.AddProperties(&prebuilt.properties)
388
389 android.InitPrebuiltModule(module, &prebuilt.properties.Srcs)
Leo Li74f7b972017-05-17 11:30:45 -0700390 return module, binary
Colin Crossce75d2c2016-10-06 16:12:58 -0700391}