blob: aaaca7ad45a807e8d14a8f4ed8720dffc17d38d5 [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
Colin Crossb916a382016-07-29 17:28:03 -070017import (
Colin Cross72bf8e12021-07-13 16:23:23 -070018 "fmt"
19
Colin Crossb916a382016-07-29 17:28:03 -070020 "android/soong/android"
Yi Kong7df0f302018-10-08 22:10:12 +000021 "android/soong/cc/config"
Colin Cross4b963f82016-09-29 14:06:02 -070022
Colin Cross86803cf2018-02-15 14:12:26 -080023 "github.com/google/blueprint"
Colin Cross4b963f82016-09-29 14:06:02 -070024 "github.com/google/blueprint/proptools"
Colin Crossb916a382016-07-29 17:28:03 -070025)
26
Colin Cross4d9c2d12016-07-29 12:48:20 -070027// This file contains the basic functionality for linking against static libraries and shared
28// libraries. Final linking into libraries or executables is handled in library.go, binary.go, etc.
29
Liz Kammer0eae52e2021-10-06 10:32:26 -040030const (
31 packRelocationsDefault = true
32)
33
Colin Cross4d9c2d12016-07-29 12:48:20 -070034type BaseLinkerProperties struct {
35 // list of modules whose object files should be linked into this module
36 // in their entirety. For static library modules, all of the .o files from the intermediate
37 // directory of the dependency will be linked into this modules .a file. For a shared library,
38 // the dependency's .a file will be linked into this module using -Wl,--whole-archive.
39 Whole_static_libs []string `android:"arch_variant,variant_prepend"`
40
41 // list of modules that should be statically linked into this module.
42 Static_libs []string `android:"arch_variant,variant_prepend"`
43
44 // list of modules that should be dynamically linked into this module.
45 Shared_libs []string `android:"arch_variant"`
46
Colin Cross5950f382016-12-13 12:50:57 -080047 // list of modules that should only provide headers for this module.
48 Header_libs []string `android:"arch_variant,variant_prepend"`
49
Colin Cross4d9c2d12016-07-29 12:48:20 -070050 // list of module-specific flags that will be used for all link steps
51 Ldflags []string `android:"arch_variant"`
52
Colin Cross6b8f4252021-07-22 11:39:44 -070053 // list of system libraries that will be dynamically linked to
54 // shared library and executable modules. If unset, generally defaults to libc,
55 // libm, and libdl. Set to [] to prevent linking against the defaults.
Dan Willemsen3a26eef2018-12-03 15:25:46 -080056 System_shared_libs []string `android:"arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070057
58 // allow the module to contain undefined symbols. By default,
59 // modules cannot contain undefined symbols that are not satisified by their immediate
60 // dependencies. Set this flag to true to remove --no-undefined from the linker flags.
61 // This flag should only be necessary for compiling low-level libraries like libc.
Colin Crossbe360ae2016-12-08 09:45:21 -080062 Allow_undefined_symbols *bool `android:"arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070063
Yi Kong2c188be2018-10-10 13:43:02 -070064 // don't link in libclang_rt.builtins-*.a
Yi Kong410d8342019-02-15 10:07:18 -080065 No_libcrt *bool `android:"arch_variant"`
Yi Kong2c188be2018-10-10 13:43:02 -070066
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -070067 // Use clang lld instead of gnu ld.
Pirama Arumuga Nainar2b8959a2018-04-20 11:52:42 -070068 Use_clang_lld *bool `android:"arch_variant"`
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -070069
Colin Cross4d9c2d12016-07-29 12:48:20 -070070 // -l arguments to pass to linker for host-provided shared libraries
71 Host_ldlibs []string `android:"arch_variant"`
72
73 // list of shared libraries to re-export include directories from. Entries must be
74 // present in shared_libs.
75 Export_shared_lib_headers []string `android:"arch_variant"`
76
77 // list of static libraries to re-export include directories from. Entries must be
78 // present in static_libs.
79 Export_static_lib_headers []string `android:"arch_variant"`
80
Colin Cross5950f382016-12-13 12:50:57 -080081 // list of header libraries to re-export include directories from. Entries must be
82 // present in header_libs.
83 Export_header_lib_headers []string `android:"arch_variant"`
84
Dan Willemsenb3454ab2016-09-28 17:34:58 -070085 // list of generated headers to re-export include directories from. Entries must be
86 // present in generated_headers.
87 Export_generated_headers []string `android:"arch_variant"`
88
Colin Cross4d9c2d12016-07-29 12:48:20 -070089 // don't link in crt_begin and crt_end. This flag should only be necessary for
90 // compiling crt or libc.
91 Nocrt *bool `android:"arch_variant"`
Colin Cross18c0c5a2016-12-01 14:45:23 -080092
LaMont Jones5569d6e2021-08-30 22:52:19 +000093 // deprecated and ignored because lld makes it unnecessary. See b/189475744.
Colin Cross18c0c5a2016-12-01 14:45:23 -080094 Group_static_libs *bool `android:"arch_variant"`
Jiyong Park44cf1a72017-06-16 12:03:55 +090095
Logan Chien43d34c32017-12-20 01:17:32 +080096 // list of modules that should be installed with this module. This is similar to 'required'
97 // but '.vendor' suffix will be appended to the module names if the shared libraries have
98 // vendor variants and this module uses VNDK.
99 Runtime_libs []string `android:"arch_variant"`
100
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100101 // list of runtime libs that should not be installed along with this module.
102 Exclude_runtime_libs []string `android:"arch_variant"`
103
Jiyong Park44cf1a72017-06-16 12:03:55 +0900104 Target struct {
Justin Yun63e9ec72020-10-29 16:49:43 +0900105 Vendor, Product struct {
106 // list of shared libs that only should be used to build vendor or
107 // product variant of the C/C++ module.
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000108 Shared_libs []string
109
Justin Yun63e9ec72020-10-29 16:49:43 +0900110 // list of static libs that only should be used to build vendor or
111 // product variant of the C/C++ module.
Chong Zhanged5c1462020-02-20 15:04:35 -0800112 Static_libs []string
113
Jiyong Parka592b6f2021-07-16 16:05:50 +0900114 // list of ehader libs that only should be used to build vendor or product
115 // variant of the C/C++ module.
116 Header_libs []string
117
Justin Yun63e9ec72020-10-29 16:49:43 +0900118 // list of shared libs that should not be used to build vendor or
119 // product variant of the C/C++ module.
Jiyong Park44cf1a72017-06-16 12:03:55 +0900120 Exclude_shared_libs []string
Jiyong Park52d25bd2017-10-13 09:17:01 +0900121
Justin Yun63e9ec72020-10-29 16:49:43 +0900122 // list of static libs that should not be used to build vendor or
123 // product variant of the C/C++ module.
Jiyong Park52d25bd2017-10-13 09:17:01 +0900124 Exclude_static_libs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800125
Justin Yun63e9ec72020-10-29 16:49:43 +0900126 // list of header libs that should not be used to build vendor or
127 // product variant of the C/C++ module.
Jiwen 'Steve' Cai8dbc6532018-08-08 10:58:34 -0700128 Exclude_header_libs []string
129
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100130 // list of runtime libs that should not be installed along with the
131 // vendor or product variant of the C/C++ module.
Logan Chien43d34c32017-12-20 01:17:32 +0800132 Exclude_runtime_libs []string
Colin Crossc17727d2018-10-24 12:42:09 -0700133
Justin Yun63e9ec72020-10-29 16:49:43 +0900134 // version script for vendor or product variant
Colin Crossc17727d2018-10-24 12:42:09 -0700135 Version_script *string `android:"arch_variant"`
Pirama Arumuga Nainar250c5212021-06-15 09:51:00 -0700136 } `android:"arch_variant"`
Jiyong Parkf9332f12018-02-01 00:54:12 +0900137 Recovery struct {
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000138 // list of shared libs that only should be used to build the recovery
139 // variant of the C/C++ module.
140 Shared_libs []string
141
Yifan Honge7efbc82019-08-01 13:45:42 -0700142 // list of static libs that only should be used to build the recovery
143 // variant of the C/C++ module.
144 Static_libs []string
145
Jiyong Parkf9332f12018-02-01 00:54:12 +0900146 // list of shared libs that should not be used to build
147 // the recovery variant of the C/C++ module.
148 Exclude_shared_libs []string
149
150 // list of static libs that should not be used to build
151 // the recovery variant of the C/C++ module.
152 Exclude_static_libs []string
Hridya Valsaraju280febf2018-08-10 09:08:13 -0700153
154 // list of header libs that should not be used to build the recovery variant
155 // of the C/C++ module.
156 Exclude_header_libs []string
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100157
158 // list of runtime libs that should not be installed along with the
159 // recovery variant of the C/C++ module.
160 Exclude_runtime_libs []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900161 }
Yifan Hongcf4832c2020-01-21 17:04:13 -0800162 Ramdisk struct {
163 // list of static libs that only should be used to build the recovery
164 // variant of the C/C++ module.
165 Static_libs []string
166
167 // list of shared libs that should not be used to build
168 // the ramdisk variant of the C/C++ module.
169 Exclude_shared_libs []string
170
171 // list of static libs that should not be used to build
172 // the ramdisk variant of the C/C++ module.
173 Exclude_static_libs []string
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100174
175 // list of runtime libs that should not be installed along with the
176 // ramdisk variant of the C/C++ module.
177 Exclude_runtime_libs []string
Yifan Hongcf4832c2020-01-21 17:04:13 -0800178 }
Yifan Hong6da33c22020-10-27 15:01:21 -0700179 Vendor_ramdisk struct {
180 // list of shared libs that should not be used to build
181 // the recovery variant of the C/C++ module.
182 Exclude_shared_libs []string
183
184 // list of static libs that should not be used to build
185 // the vendor ramdisk variant of the C/C++ module.
186 Exclude_static_libs []string
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100187
188 // list of runtime libs that should not be installed along with the
189 // vendor ramdisk variant of the C/C++ module.
190 Exclude_runtime_libs []string
Yifan Hong6da33c22020-10-27 15:01:21 -0700191 }
Colin Crossc511bc52020-04-07 16:50:32 +0000192 Platform struct {
193 // list of shared libs that should be use to build the platform variant
194 // of a module that sets sdk_version. This should rarely be necessary,
195 // in most cases the same libraries are available for the SDK and platform
196 // variants.
197 Shared_libs []string
Jiyong Parka592b6f2021-07-16 16:05:50 +0900198
199 // list of ehader libs that only should be used to build platform variant of
200 // the C/C++ module.
201 Header_libs []string
202
203 // list of shared libs that should not be used to build the platform variant
204 // of the C/C++ module.
205 Exclude_shared_libs []string
Colin Crossc511bc52020-04-07 16:50:32 +0000206 }
Jiyong Parke3867542020-12-03 17:28:25 +0900207 Apex struct {
208 // list of shared libs that should not be used to build the apex variant of
209 // the C/C++ module.
210 Exclude_shared_libs []string
211
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100212 // list of static libs that should not be used to build the apex
Jiyong Parke3867542020-12-03 17:28:25 +0900213 // variant of the C/C++ module.
214 Exclude_static_libs []string
215 }
Pirama Arumuga Nainar250c5212021-06-15 09:51:00 -0700216 } `android:"arch_variant"`
Colin Cross86803cf2018-02-15 14:12:26 -0800217
218 // make android::build:GetBuildNumber() available containing the build ID.
219 Use_version_lib *bool `android:"arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -0700220
Chih-Hung Hsieh86814712018-05-23 18:30:46 -0700221 // Generate compact dynamic relocation table, default true.
222 Pack_relocations *bool `android:"arch_variant"`
Dan Albert61f32122018-07-26 14:00:24 -0700223
224 // local file name to pass to the linker as --version_script
Colin Cross27b922f2019-03-04 22:35:41 -0800225 Version_script *string `android:"path,arch_variant"`
Christopher Ferrisc71193a2019-12-16 09:55:10 -0800226
Colin Cross59422382021-07-22 16:35:24 -0700227 // local file name to pass to the linker as --dynamic-list
228 Dynamic_list *string `android:"path,arch_variant"`
229
Christopher Ferrisc71193a2019-12-16 09:55:10 -0800230 // list of static libs that should not be used to build this module
Colin Cross06210312020-06-10 15:47:34 -0700231 Exclude_static_libs []string `android:"arch_variant"`
232
233 // list of shared libs that should not be used to build this module
234 Exclude_shared_libs []string `android:"arch_variant"`
Chih-Hung Hsieh86814712018-05-23 18:30:46 -0700235}
236
Liz Kammerd366c902021-06-03 13:43:01 -0400237func invertBoolPtr(value *bool) *bool {
238 if value == nil {
239 return nil
240 }
241 ret := !(*value)
242 return &ret
243}
244
Jingwen Chen6ada5892021-09-17 11:38:09 +0000245func (blp *BaseLinkerProperties) crt() *bool {
246 val := invertBoolPtr(blp.Nocrt)
247 if val != nil && *val {
248 // == True
249 //
250 // Since crt is enabled for almost every module compiling against the Bionic runtime,
251 // use `nil` when it's enabled, and rely on the Starlark macro to set it to True by default.
252 // This keeps the BUILD files clean.
253 return nil
254 }
255 return val // can be False or nil
256}
257
Liz Kammerd366c902021-06-03 13:43:01 -0400258func (blp *BaseLinkerProperties) libCrt() *bool {
259 return invertBoolPtr(blp.No_libcrt)
260}
261
Dan Albert61f32122018-07-26 14:00:24 -0700262func NewBaseLinker(sanitize *sanitize) *baseLinker {
263 return &baseLinker{sanitize: sanitize}
Colin Crossb916a382016-07-29 17:28:03 -0700264}
265
Colin Cross4d9c2d12016-07-29 12:48:20 -0700266// baseLinker provides support for shared_libs, static_libs, and whole_static_libs properties
267type baseLinker struct {
268 Properties BaseLinkerProperties
269 dynamicProperties struct {
Jiyong Park7ed9de32018-10-15 22:25:07 +0900270 RunPaths []string `blueprint:"mutated"`
271 BuildStubs bool `blueprint:"mutated"`
Colin Cross4d9c2d12016-07-29 12:48:20 -0700272 }
Dan Albert61f32122018-07-26 14:00:24 -0700273
274 sanitize *sanitize
Colin Cross4d9c2d12016-07-29 12:48:20 -0700275}
276
277func (linker *baseLinker) appendLdflags(flags []string) {
278 linker.Properties.Ldflags = append(linker.Properties.Ldflags, flags...)
279}
280
Chris Parsonse0f2ab32020-11-20 17:27:25 -0500281// linkerInit initializes dynamic properties of the linker (such as runpath).
Colin Cross42742b82016-08-01 13:20:05 -0700282func (linker *baseLinker) linkerInit(ctx BaseModuleContext) {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700283 if ctx.toolchain().Is64Bit() {
Colin Crossb916a382016-07-29 17:28:03 -0700284 linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, "../lib64", "lib64")
Colin Cross4d9c2d12016-07-29 12:48:20 -0700285 } else {
Colin Crossb916a382016-07-29 17:28:03 -0700286 linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, "../lib", "lib")
Colin Cross4d9c2d12016-07-29 12:48:20 -0700287 }
288}
289
Colin Cross42742b82016-08-01 13:20:05 -0700290func (linker *baseLinker) linkerProps() []interface{} {
Colin Crossc17727d2018-10-24 12:42:09 -0700291 return []interface{}{&linker.Properties, &linker.dynamicProperties}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700292}
293
Dan Albert61f32122018-07-26 14:00:24 -0700294func (linker *baseLinker) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700295 deps.WholeStaticLibs = append(deps.WholeStaticLibs, linker.Properties.Whole_static_libs...)
Colin Cross5950f382016-12-13 12:50:57 -0800296 deps.HeaderLibs = append(deps.HeaderLibs, linker.Properties.Header_libs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700297 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Static_libs...)
298 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Shared_libs...)
Logan Chien43d34c32017-12-20 01:17:32 +0800299 deps.RuntimeLibs = append(deps.RuntimeLibs, linker.Properties.Runtime_libs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700300
Colin Cross5950f382016-12-13 12:50:57 -0800301 deps.ReexportHeaderLibHeaders = append(deps.ReexportHeaderLibHeaders, linker.Properties.Export_header_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700302 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, linker.Properties.Export_static_lib_headers...)
303 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, linker.Properties.Export_shared_lib_headers...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700304 deps.ReexportGeneratedHeaders = append(deps.ReexportGeneratedHeaders, linker.Properties.Export_generated_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700305
Colin Cross06210312020-06-10 15:47:34 -0700306 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Exclude_shared_libs)
307 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Exclude_static_libs)
Christopher Ferrisc71193a2019-12-16 09:55:10 -0800308 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Exclude_static_libs)
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100309 deps.RuntimeLibs = removeListFromList(deps.RuntimeLibs, linker.Properties.Exclude_runtime_libs)
Christopher Ferrisc71193a2019-12-16 09:55:10 -0800310
Jiyong Parke3867542020-12-03 17:28:25 +0900311 // Record the libraries that need to be excluded when building for APEX. Unlike other
312 // target.*.exclude_* properties, SharedLibs and StaticLibs are not modified here because
313 // this module hasn't yet passed the apexMutator. Therefore, we can't tell whether this is
314 // an apex variant of not. Record the exclude list in the deps struct for now. The info is
315 // used to mark the dependency tag when adding dependencies to the deps. Then inside
316 // GenerateAndroidBuildActions, the marked dependencies are ignored (i.e. not used) for APEX
317 // variants.
318 deps.ExcludeLibsForApex = append(deps.ExcludeLibsForApex, linker.Properties.Target.Apex.Exclude_shared_libs...)
319 deps.ExcludeLibsForApex = append(deps.ExcludeLibsForApex, linker.Properties.Target.Apex.Exclude_static_libs...)
320
Colin Cross86803cf2018-02-15 14:12:26 -0800321 if Bool(linker.Properties.Use_version_lib) {
322 deps.WholeStaticLibs = append(deps.WholeStaticLibs, "libbuildversion")
323 }
324
Justin Yun6977e8a2020-10-29 18:24:11 +0900325 if ctx.inVendor() {
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000326 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Target.Vendor.Shared_libs...)
Jiyong Park74472282017-08-10 00:48:06 +0900327 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Vendor.Exclude_shared_libs)
328 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Vendor.Exclude_shared_libs)
Chong Zhanged5c1462020-02-20 15:04:35 -0800329 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Target.Vendor.Static_libs...)
Jiyong Park52d25bd2017-10-13 09:17:01 +0900330 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Vendor.Exclude_static_libs)
Jiyong Parka592b6f2021-07-16 16:05:50 +0900331 deps.HeaderLibs = append(deps.HeaderLibs, linker.Properties.Target.Vendor.Header_libs...)
Jiwen 'Steve' Cai8dbc6532018-08-08 10:58:34 -0700332 deps.HeaderLibs = removeListFromList(deps.HeaderLibs, linker.Properties.Target.Vendor.Exclude_header_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +0900333 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Vendor.Exclude_static_libs)
334 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Vendor.Exclude_static_libs)
Logan Chien43d34c32017-12-20 01:17:32 +0800335 deps.RuntimeLibs = removeListFromList(deps.RuntimeLibs, linker.Properties.Target.Vendor.Exclude_runtime_libs)
Jiyong Park74472282017-08-10 00:48:06 +0900336 }
337
Justin Yun6977e8a2020-10-29 18:24:11 +0900338 if ctx.inProduct() {
339 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Target.Product.Shared_libs...)
340 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Product.Exclude_shared_libs)
341 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Product.Exclude_shared_libs)
342 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Target.Product.Static_libs...)
343 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Product.Exclude_static_libs)
344 deps.HeaderLibs = removeListFromList(deps.HeaderLibs, linker.Properties.Target.Product.Exclude_header_libs)
345 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Product.Exclude_static_libs)
346 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Product.Exclude_static_libs)
347 deps.RuntimeLibs = removeListFromList(deps.RuntimeLibs, linker.Properties.Target.Product.Exclude_runtime_libs)
348 }
349
Jiyong Parkf9332f12018-02-01 00:54:12 +0900350 if ctx.inRecovery() {
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000351 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Target.Recovery.Shared_libs...)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900352 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Recovery.Exclude_shared_libs)
353 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Recovery.Exclude_shared_libs)
Yifan Honge7efbc82019-08-01 13:45:42 -0700354 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Target.Recovery.Static_libs...)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900355 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Recovery.Exclude_static_libs)
Hridya Valsaraju280febf2018-08-10 09:08:13 -0700356 deps.HeaderLibs = removeListFromList(deps.HeaderLibs, linker.Properties.Target.Recovery.Exclude_header_libs)
357 deps.ReexportHeaderLibHeaders = removeListFromList(deps.ReexportHeaderLibHeaders, linker.Properties.Target.Recovery.Exclude_header_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900358 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Recovery.Exclude_static_libs)
359 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Recovery.Exclude_static_libs)
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100360 deps.RuntimeLibs = removeListFromList(deps.RuntimeLibs, linker.Properties.Target.Recovery.Exclude_runtime_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900361 }
362
Yifan Hongcf4832c2020-01-21 17:04:13 -0800363 if ctx.inRamdisk() {
Yifan Hongd2057fb2020-10-27 15:03:34 -0700364 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Ramdisk.Exclude_shared_libs)
365 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Ramdisk.Exclude_shared_libs)
366 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Target.Ramdisk.Static_libs...)
367 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Ramdisk.Exclude_static_libs)
368 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Ramdisk.Exclude_static_libs)
369 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Ramdisk.Exclude_static_libs)
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100370 deps.RuntimeLibs = removeListFromList(deps.RuntimeLibs, linker.Properties.Target.Ramdisk.Exclude_runtime_libs)
Yifan Hongcf4832c2020-01-21 17:04:13 -0800371 }
372
Yifan Hong6da33c22020-10-27 15:01:21 -0700373 if ctx.inVendorRamdisk() {
374 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
375 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Vendor_ramdisk.Exclude_shared_libs)
376 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
377 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
378 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Vendor_ramdisk.Exclude_static_libs)
Martin Stjernholm3aa95442021-08-26 17:00:09 +0100379 deps.RuntimeLibs = removeListFromList(deps.RuntimeLibs, linker.Properties.Target.Vendor_ramdisk.Exclude_runtime_libs)
Yifan Hong6da33c22020-10-27 15:01:21 -0700380 }
381
Colin Crossc511bc52020-04-07 16:50:32 +0000382 if !ctx.useSdk() {
383 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Target.Platform.Shared_libs...)
Jiyong Parka592b6f2021-07-16 16:05:50 +0900384 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Platform.Exclude_shared_libs)
385 deps.HeaderLibs = append(deps.HeaderLibs, linker.Properties.Target.Platform.Header_libs...)
Colin Crossc511bc52020-04-07 16:50:32 +0000386 }
387
Colin Cross6b8f4252021-07-22 11:39:44 -0700388 deps.SystemSharedLibs = linker.Properties.System_shared_libs
Colin Cross9ecb42d2021-06-22 13:20:01 -0700389 // In Bazel conversion mode, variations have not been specified, so SystemSharedLibs may
390 // inaccuarately appear unset, which can cause issues with circular dependencies.
391 if deps.SystemSharedLibs == nil && !ctx.BazelConversionMode() {
Colin Cross6b8f4252021-07-22 11:39:44 -0700392 // Provide a default system_shared_libs if it is unspecified. Note: If an
393 // empty list [] is specified, it implies that the module declines the
394 // default system_shared_libs.
Colin Cross9ecb42d2021-06-22 13:20:01 -0700395 deps.SystemSharedLibs = append(deps.SystemSharedLibs, ctx.toolchain().DefaultSharedLibraries()...)
396 }
397
Yi Kong6fb831b2018-10-05 19:46:01 +0000398 if ctx.toolchain().Bionic() {
Ryan Prichardc2018e22021-04-02 20:23:22 -0700399 // libclang_rt.builtins has to be last on the command line
Colin Crossbe763f72021-04-26 17:07:17 -0700400 if !Bool(linker.Properties.No_libcrt) && !ctx.header() {
Yi Kong19408a32019-02-12 09:41:18 -0800401 deps.LateStaticLibs = append(deps.LateStaticLibs, config.BuiltinsRuntimeLibrary(ctx.toolchain()))
Colin Cross4d9c2d12016-07-29 12:48:20 -0700402 }
403
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800404 if inList("libdl", deps.SharedLibs) {
405 // If system_shared_libs has libc but not libdl, make sure shared_libs does not
406 // have libdl to avoid loading libdl before libc.
Yo Chiang219968c2020-09-22 18:45:04 +0800407 if inList("libc", deps.SystemSharedLibs) {
408 if !inList("libdl", deps.SystemSharedLibs) {
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800409 ctx.PropertyErrorf("shared_libs",
410 "libdl must be in system_shared_libs, not shared_libs")
411 }
412 _, deps.SharedLibs = removeFromList("libdl", deps.SharedLibs)
413 }
414 }
415
416 // If libc and libdl are both in system_shared_libs make sure libdl comes after libc
417 // to avoid loading libdl before libc.
Yo Chiang219968c2020-09-22 18:45:04 +0800418 if inList("libdl", deps.SystemSharedLibs) && inList("libc", deps.SystemSharedLibs) &&
419 indexList("libdl", deps.SystemSharedLibs) < indexList("libc", deps.SystemSharedLibs) {
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800420 ctx.PropertyErrorf("system_shared_libs", "libdl must be after libc")
421 }
Colin Cross528d67e2021-07-23 22:23:07 +0000422 } else if ctx.toolchain().Musl() {
423 if !Bool(linker.Properties.No_libcrt) && !ctx.header() {
424 deps.LateStaticLibs = append(deps.LateStaticLibs, config.BuiltinsRuntimeLibrary(ctx.toolchain()))
425 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700426 }
427
Colin Crossc8544682021-06-21 17:31:50 -0700428 deps.LateSharedLibs = append(deps.LateSharedLibs, deps.SystemSharedLibs...)
429
Colin Cross3edeee12017-04-04 12:59:48 -0700430 if ctx.Windows() {
Josh Gao7bd4c5c2017-02-23 17:52:24 -0800431 deps.LateStaticLibs = append(deps.LateStaticLibs, "libwinpthread")
432 }
433
Colin Cross4d9c2d12016-07-29 12:48:20 -0700434 return deps
435}
436
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700437func (linker *baseLinker) useClangLld(ctx ModuleContext) bool {
Chih-Hung Hsiehe5ac6092018-04-24 16:00:01 -0700438 // Clang lld is not ready for for Darwin host executables yet.
439 // See https://lld.llvm.org/AtomLLD.html for status of lld for Mach-O.
440 if ctx.Darwin() {
441 return false
442 }
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700443 if linker.Properties.Use_clang_lld != nil {
444 return Bool(linker.Properties.Use_clang_lld)
445 }
Dan Willemsenfa2aee12018-10-21 19:47:01 -0700446 return true
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700447}
448
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800449// Check whether the SDK version is not older than the specific one
Elliott Hughes852edc12021-05-14 13:07:32 -0700450func CheckSdkVersionAtLeast(ctx ModuleContext, SdkVersion android.ApiLevel) bool {
451 if ctx.minSdkVersion() == "current" {
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800452 return true
453 }
Luke Huang088b5352021-05-19 16:44:53 +0800454 parsedSdkVersion, err := nativeApiLevelFromUser(ctx, ctx.minSdkVersion())
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800455 if err != nil {
Elliott Hughes852edc12021-05-14 13:07:32 -0700456 ctx.PropertyErrorf("min_sdk_version",
457 "Invalid min_sdk_version value (must be int or current): %q",
458 ctx.minSdkVersion())
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800459 }
Elliott Hughes852edc12021-05-14 13:07:32 -0700460 if parsedSdkVersion.LessThan(SdkVersion) {
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800461 return false
462 }
463 return true
464}
465
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700466// ModuleContext extends BaseModuleContext
467// BaseModuleContext should know if LLD is used?
Colin Cross42742b82016-08-01 13:20:05 -0700468func (linker *baseLinker) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700469 toolchain := ctx.toolchain()
470
Colin Cross324a4572017-11-02 23:09:41 -0700471 hod := "Host"
472 if ctx.Os().Class == android.Device {
473 hod = "Device"
474 }
475
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700476 if linker.useClangLld(ctx) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800477 flags.Global.LdFlags = append(flags.Global.LdFlags, fmt.Sprintf("${config.%sGlobalLldflags}", hod))
Liz Kammer0eae52e2021-10-06 10:32:26 -0400478 if !BoolDefault(linker.Properties.Pack_relocations, packRelocationsDefault) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800479 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--pack-dyn-relocs=none")
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800480 } else if ctx.Device() {
Elliott Hughes8df4b3d2021-04-12 13:20:58 -0700481 // SHT_RELR relocations are only supported at API level >= 30.
482 // ANDROID_RELR relocations were supported at API level >= 28.
483 // Relocation packer was supported at API level >= 23.
484 // Do the best we can...
Luke Huang088b5352021-05-19 16:44:53 +0800485 if (!ctx.useSdk() && ctx.minSdkVersion() == "") || CheckSdkVersionAtLeast(ctx, android.FirstShtRelrVersion) {
Elliott Hughes8df4b3d2021-04-12 13:20:58 -0700486 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--pack-dyn-relocs=android+relr")
Elliott Hughes852edc12021-05-14 13:07:32 -0700487 } else if CheckSdkVersionAtLeast(ctx, android.FirstAndroidRelrVersion) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800488 flags.Global.LdFlags = append(flags.Global.LdFlags,
489 "-Wl,--pack-dyn-relocs=android+relr",
490 "-Wl,--use-android-relr-tags")
Elliott Hughes852edc12021-05-14 13:07:32 -0700491 } else if CheckSdkVersionAtLeast(ctx, android.FirstPackedRelocationsVersion) {
Elliott Hughesda909fe2020-01-28 13:08:40 -0800492 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--pack-dyn-relocs=android")
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800493 }
Chih-Hung Hsieh86814712018-05-23 18:30:46 -0700494 }
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700495 } else {
Colin Cross4af21ed2019-11-04 09:37:55 -0800496 flags.Global.LdFlags = append(flags.Global.LdFlags, fmt.Sprintf("${config.%sGlobalLdflags}", hod))
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700497 }
Colin Cross87dd9632017-11-03 13:31:05 -0700498 if Bool(linker.Properties.Allow_undefined_symbols) {
499 if ctx.Darwin() {
500 // darwin defaults to treating undefined symbols as errors
Colin Cross4af21ed2019-11-04 09:37:55 -0800501 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,-undefined,dynamic_lookup")
Colin Cross4d9c2d12016-07-29 12:48:20 -0700502 }
Josh Gao75a50a22019-06-07 17:58:59 -0700503 } else if !ctx.Darwin() && !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800504 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--no-undefined")
Colin Cross87dd9632017-11-03 13:31:05 -0700505 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700506
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700507 if linker.useClangLld(ctx) {
Colin Cross33bac242021-07-14 17:03:16 -0700508 flags.Global.LdFlags = append(flags.Global.LdFlags, toolchain.Lldflags())
Colin Cross87dd9632017-11-03 13:31:05 -0700509 } else {
Colin Cross33bac242021-07-14 17:03:16 -0700510 flags.Global.LdFlags = append(flags.Global.LdFlags, toolchain.Ldflags())
Colin Cross87dd9632017-11-03 13:31:05 -0700511 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700512
Colin Cross528d67e2021-07-23 22:23:07 +0000513 if !ctx.toolchain().Bionic() && ctx.Os() != android.LinuxMusl {
Colin Cross87dd9632017-11-03 13:31:05 -0700514 CheckBadHostLdlibs(ctx, "host_ldlibs", linker.Properties.Host_ldlibs)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700515
Colin Cross4af21ed2019-11-04 09:37:55 -0800516 flags.Local.LdFlags = append(flags.Local.LdFlags, linker.Properties.Host_ldlibs...)
Colin Crossc5fdbb82017-09-08 12:45:18 -0700517
Colin Cross87dd9632017-11-03 13:31:05 -0700518 if !ctx.Windows() {
519 // Add -ldl, -lpthread, -lm and -lrt to host builds to match the default behavior of device
520 // builds
Colin Cross4af21ed2019-11-04 09:37:55 -0800521 flags.Global.LdFlags = append(flags.Global.LdFlags,
Colin Cross87dd9632017-11-03 13:31:05 -0700522 "-ldl",
523 "-lpthread",
524 "-lm",
525 )
526 if !ctx.Darwin() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800527 flags.Global.LdFlags = append(flags.Global.LdFlags, "-lrt")
Colin Crossc5fdbb82017-09-08 12:45:18 -0700528 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700529 }
530 }
531
Tom Cherrye4802322019-08-06 10:03:25 -0700532 if ctx.toolchain().LibclangRuntimeLibraryArch() != "" {
Colin Cross4af21ed2019-11-04 09:37:55 -0800533 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--exclude-libs="+config.BuiltinsRuntimeLibrary(ctx.toolchain())+".a")
Tom Cherrye4802322019-08-06 10:03:25 -0700534 }
535
Colin Cross4d9c2d12016-07-29 12:48:20 -0700536 CheckBadLinkerFlags(ctx, "ldflags", linker.Properties.Ldflags)
537
Colin Cross4af21ed2019-11-04 09:37:55 -0800538 flags.Local.LdFlags = append(flags.Local.LdFlags, proptools.NinjaAndShellEscapeList(linker.Properties.Ldflags)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700539
Josh Gao75a50a22019-06-07 17:58:59 -0700540 if ctx.Host() && !ctx.Windows() {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800541 rpathPrefix := `\$$ORIGIN/`
Colin Cross4d9c2d12016-07-29 12:48:20 -0700542 if ctx.Darwin() {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800543 rpathPrefix = "@loader_path/"
Colin Cross4d9c2d12016-07-29 12:48:20 -0700544 }
545
Dan Willemsen6f91fbf2017-09-18 22:45:15 -0700546 if !ctx.static() {
547 for _, rpath := range linker.dynamicProperties.RunPaths {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800548 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,-rpath,"+rpathPrefix+rpath)
Dan Willemsen6f91fbf2017-09-18 22:45:15 -0700549 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700550 }
551 }
552
Elliott Hughesda3a0712020-03-06 16:55:28 -0800553 if ctx.useSdk() {
Colin Cross6774e282017-08-11 13:23:57 -0700554 // The bionic linker now has support gnu style hashes (which are much faster!), but shipping
555 // to older devices requires the old style hash. Fortunately, we can build with both and
556 // it'll work anywhere.
Colin Cross4af21ed2019-11-04 09:37:55 -0800557 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--hash-style=both")
Colin Cross6774e282017-08-11 13:23:57 -0700558 }
559
Colin Cross33bac242021-07-14 17:03:16 -0700560 flags.Global.LdFlags = append(flags.Global.LdFlags, toolchain.ToolchainLdflags())
Colin Cross4d9c2d12016-07-29 12:48:20 -0700561
Jiyong Park7ed9de32018-10-15 22:25:07 +0900562 // Version_script is not needed when linking stubs lib where the version
563 // script is created from the symbol map file.
564 if !linker.dynamicProperties.BuildStubs {
565 versionScript := ctx.ExpandOptionalSource(
Colin Crossc17727d2018-10-24 12:42:09 -0700566 linker.Properties.Version_script, "version_script")
Dan Albert61f32122018-07-26 14:00:24 -0700567
Justin Yun6977e8a2020-10-29 18:24:11 +0900568 if ctx.inVendor() && linker.Properties.Target.Vendor.Version_script != nil {
Jiyong Park7ed9de32018-10-15 22:25:07 +0900569 versionScript = ctx.ExpandOptionalSource(
Colin Crossc17727d2018-10-24 12:42:09 -0700570 linker.Properties.Target.Vendor.Version_script,
Jiyong Park7ed9de32018-10-15 22:25:07 +0900571 "target.vendor.version_script")
Justin Yun6977e8a2020-10-29 18:24:11 +0900572 } else if ctx.inProduct() && linker.Properties.Target.Product.Version_script != nil {
573 versionScript = ctx.ExpandOptionalSource(
574 linker.Properties.Target.Product.Version_script,
575 "target.product.version_script")
Jiyong Park7ed9de32018-10-15 22:25:07 +0900576 }
Dan Albert61f32122018-07-26 14:00:24 -0700577
Jiyong Park7ed9de32018-10-15 22:25:07 +0900578 if versionScript.Valid() {
579 if ctx.Darwin() {
580 ctx.PropertyErrorf("version_script", "Not supported on Darwin")
581 } else {
Colin Cross4af21ed2019-11-04 09:37:55 -0800582 flags.Local.LdFlags = append(flags.Local.LdFlags,
Jiyong Park7ed9de32018-10-15 22:25:07 +0900583 "-Wl,--version-script,"+versionScript.String())
584 flags.LdFlagsDeps = append(flags.LdFlagsDeps, versionScript.Path())
585
586 if linker.sanitize.isSanitizerEnabled(cfi) {
587 cfiExportsMap := android.PathForSource(ctx, cfiExportsMapPath)
Colin Cross4af21ed2019-11-04 09:37:55 -0800588 flags.Local.LdFlags = append(flags.Local.LdFlags,
Jiyong Park7ed9de32018-10-15 22:25:07 +0900589 "-Wl,--version-script,"+cfiExportsMap.String())
590 flags.LdFlagsDeps = append(flags.LdFlagsDeps, cfiExportsMap)
591 }
Dan Albert61f32122018-07-26 14:00:24 -0700592 }
593 }
Colin Cross59422382021-07-22 16:35:24 -0700594
595 dynamicList := android.OptionalPathForModuleSrc(ctx, linker.Properties.Dynamic_list)
596 if dynamicList.Valid() {
597 if ctx.Darwin() {
598 ctx.PropertyErrorf("dynamic_list", "Not supported on Darwin")
599 } else {
600 flags.Local.LdFlags = append(flags.Local.LdFlags,
601 "-Wl,--dynamic-list,"+dynamicList.String())
602 flags.LdFlagsDeps = append(flags.LdFlagsDeps, dynamicList.Path())
603 }
604 }
Dan Albert61f32122018-07-26 14:00:24 -0700605 }
606
Colin Cross4d9c2d12016-07-29 12:48:20 -0700607 return flags
608}
609
Colin Crossb916a382016-07-29 17:28:03 -0700610func (linker *baseLinker) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700611 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Crossb916a382016-07-29 17:28:03 -0700612 panic(fmt.Errorf("baseLinker doesn't know how to link"))
Colin Cross4d9c2d12016-07-29 12:48:20 -0700613}
Colin Cross86803cf2018-02-15 14:12:26 -0800614
Paul Duffin13f02712020-03-06 12:30:43 +0000615func (linker *baseLinker) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
616 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, linker.Properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +0000617
618 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
619 // either input list doesn't come out as nil.
620 if specifiedDeps.systemSharedLibs == nil {
621 specifiedDeps.systemSharedLibs = linker.Properties.System_shared_libs
622 } else {
623 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, linker.Properties.System_shared_libs...)
624 }
625
Paul Duffin13f02712020-03-06 12:30:43 +0000626 return specifiedDeps
627}
628
Colin Cross86803cf2018-02-15 14:12:26 -0800629// Injecting version symbols
630// Some host modules want a version number, but we don't want to rebuild it every time. Optionally add a step
631// after linking that injects a constant placeholder with the current version number.
632
633func init() {
634 pctx.HostBinToolVariable("symbolInjectCmd", "symbol_inject")
635}
636
637var injectVersionSymbol = pctx.AndroidStaticRule("injectVersionSymbol",
638 blueprint.RuleParams{
639 Command: "$symbolInjectCmd -i $in -o $out -s soong_build_number " +
Colin Cross2a2e0db2020-02-21 16:55:46 -0800640 "-from 'SOONG BUILD NUMBER PLACEHOLDER' -v $$(cat $buildNumberFile)",
Colin Cross86803cf2018-02-15 14:12:26 -0800641 CommandDeps: []string{"$symbolInjectCmd"},
642 },
Colin Cross2a2e0db2020-02-21 16:55:46 -0800643 "buildNumberFile")
Colin Cross86803cf2018-02-15 14:12:26 -0800644
645func (linker *baseLinker) injectVersionSymbol(ctx ModuleContext, in android.Path, out android.WritablePath) {
Colin Cross2a2e0db2020-02-21 16:55:46 -0800646 buildNumberFile := ctx.Config().BuildNumberFile(ctx)
Colin Cross86803cf2018-02-15 14:12:26 -0800647 ctx.Build(pctx, android.BuildParams{
648 Rule: injectVersionSymbol,
649 Description: "inject version symbol",
650 Input: in,
651 Output: out,
Colin Cross2a2e0db2020-02-21 16:55:46 -0800652 OrderOnly: android.Paths{buildNumberFile},
Colin Cross86803cf2018-02-15 14:12:26 -0800653 Args: map[string]string{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800654 "buildNumberFile": buildNumberFile.String(),
Colin Cross86803cf2018-02-15 14:12:26 -0800655 },
656 })
657}