blob: c9cbd9bafbe69339d52566dbbd1ab462084d26a0 [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 (
18 "android/soong/android"
Yi Kong7df0f302018-10-08 22:10:12 +000019 "android/soong/cc/config"
Colin Crossb916a382016-07-29 17:28:03 -070020 "fmt"
Zhizhou Yang9100b1d2018-11-30 14:00:04 -080021 "strconv"
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
30type BaseLinkerProperties struct {
31 // list of modules whose object files should be linked into this module
32 // in their entirety. For static library modules, all of the .o files from the intermediate
33 // directory of the dependency will be linked into this modules .a file. For a shared library,
34 // the dependency's .a file will be linked into this module using -Wl,--whole-archive.
35 Whole_static_libs []string `android:"arch_variant,variant_prepend"`
36
37 // list of modules that should be statically linked into this module.
38 Static_libs []string `android:"arch_variant,variant_prepend"`
39
40 // list of modules that should be dynamically linked into this module.
41 Shared_libs []string `android:"arch_variant"`
42
Colin Cross5950f382016-12-13 12:50:57 -080043 // list of modules that should only provide headers for this module.
44 Header_libs []string `android:"arch_variant,variant_prepend"`
45
Colin Cross4d9c2d12016-07-29 12:48:20 -070046 // list of module-specific flags that will be used for all link steps
47 Ldflags []string `android:"arch_variant"`
48
Colin Cross4d9c2d12016-07-29 12:48:20 -070049 // list of system libraries that will be dynamically linked to
Colin Crossef88ae22017-08-18 16:52:25 -070050 // shared library and executable modules. If unset, generally defaults to libc,
51 // libm, and libdl. Set to [] to prevent linking against the defaults.
Dan Willemsen3a26eef2018-12-03 15:25:46 -080052 System_shared_libs []string `android:"arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070053
54 // allow the module to contain undefined symbols. By default,
55 // modules cannot contain undefined symbols that are not satisified by their immediate
56 // dependencies. Set this flag to true to remove --no-undefined from the linker flags.
57 // This flag should only be necessary for compiling low-level libraries like libc.
Colin Crossbe360ae2016-12-08 09:45:21 -080058 Allow_undefined_symbols *bool `android:"arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -070059
Yi Kong2c188be2018-10-10 13:43:02 -070060 // don't link in libclang_rt.builtins-*.a
Yi Kong410d8342019-02-15 10:07:18 -080061 No_libcrt *bool `android:"arch_variant"`
Yi Kong2c188be2018-10-10 13:43:02 -070062
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -070063 // Use clang lld instead of gnu ld.
Pirama Arumuga Nainar2b8959a2018-04-20 11:52:42 -070064 Use_clang_lld *bool `android:"arch_variant"`
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -070065
Colin Cross4d9c2d12016-07-29 12:48:20 -070066 // -l arguments to pass to linker for host-provided shared libraries
67 Host_ldlibs []string `android:"arch_variant"`
68
69 // list of shared libraries to re-export include directories from. Entries must be
70 // present in shared_libs.
71 Export_shared_lib_headers []string `android:"arch_variant"`
72
73 // list of static libraries to re-export include directories from. Entries must be
74 // present in static_libs.
75 Export_static_lib_headers []string `android:"arch_variant"`
76
Colin Cross5950f382016-12-13 12:50:57 -080077 // list of header libraries to re-export include directories from. Entries must be
78 // present in header_libs.
79 Export_header_lib_headers []string `android:"arch_variant"`
80
Dan Willemsenb3454ab2016-09-28 17:34:58 -070081 // list of generated headers to re-export include directories from. Entries must be
82 // present in generated_headers.
83 Export_generated_headers []string `android:"arch_variant"`
84
Colin Cross4d9c2d12016-07-29 12:48:20 -070085 // don't link in crt_begin and crt_end. This flag should only be necessary for
86 // compiling crt or libc.
87 Nocrt *bool `android:"arch_variant"`
Colin Cross18c0c5a2016-12-01 14:45:23 -080088
89 // group static libraries. This can resolve missing symbols issues with interdependencies
90 // between static libraries, but it is generally better to order them correctly instead.
91 Group_static_libs *bool `android:"arch_variant"`
Jiyong Park44cf1a72017-06-16 12:03:55 +090092
Logan Chien43d34c32017-12-20 01:17:32 +080093 // list of modules that should be installed with this module. This is similar to 'required'
94 // but '.vendor' suffix will be appended to the module names if the shared libraries have
95 // vendor variants and this module uses VNDK.
96 Runtime_libs []string `android:"arch_variant"`
97
Jiyong Park44cf1a72017-06-16 12:03:55 +090098 Target struct {
99 Vendor struct {
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000100 // list of shared libs that only should be used to build the vendor
101 // variant of the C/C++ module.
102 Shared_libs []string
103
Chong Zhanged5c1462020-02-20 15:04:35 -0800104 // list of static libs that only should be used to build the vendor
105 // variant of the C/C++ module.
106 Static_libs []string
107
Logan Chien43d34c32017-12-20 01:17:32 +0800108 // list of shared libs that should not be used to build the vendor variant
109 // of the C/C++ module.
Jiyong Park44cf1a72017-06-16 12:03:55 +0900110 Exclude_shared_libs []string
Jiyong Park52d25bd2017-10-13 09:17:01 +0900111
Logan Chien43d34c32017-12-20 01:17:32 +0800112 // list of static libs that should not be used to build the vendor variant
113 // of the C/C++ module.
Jiyong Park52d25bd2017-10-13 09:17:01 +0900114 Exclude_static_libs []string
Logan Chien43d34c32017-12-20 01:17:32 +0800115
Jiwen 'Steve' Cai8dbc6532018-08-08 10:58:34 -0700116 // list of header libs that should not be used to build the vendor variant
117 // of the C/C++ module.
118 Exclude_header_libs []string
119
Logan Chien43d34c32017-12-20 01:17:32 +0800120 // list of runtime libs that should not be installed along with the vendor
121 // variant of the C/C++ module.
122 Exclude_runtime_libs []string
Colin Crossc17727d2018-10-24 12:42:09 -0700123
124 // version script for this vendor variant
125 Version_script *string `android:"arch_variant"`
Jiyong Park44cf1a72017-06-16 12:03:55 +0900126 }
Jiyong Parkf9332f12018-02-01 00:54:12 +0900127 Recovery struct {
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000128 // list of shared libs that only should be used to build the recovery
129 // variant of the C/C++ module.
130 Shared_libs []string
131
Yifan Honge7efbc82019-08-01 13:45:42 -0700132 // list of static libs that only should be used to build the recovery
133 // variant of the C/C++ module.
134 Static_libs []string
135
Jiyong Parkf9332f12018-02-01 00:54:12 +0900136 // list of shared libs that should not be used to build
137 // the recovery variant of the C/C++ module.
138 Exclude_shared_libs []string
139
140 // list of static libs that should not be used to build
141 // the recovery variant of the C/C++ module.
142 Exclude_static_libs []string
Hridya Valsaraju280febf2018-08-10 09:08:13 -0700143
144 // list of header libs that should not be used to build the recovery variant
145 // of the C/C++ module.
146 Exclude_header_libs []string
Jiyong Parkf9332f12018-02-01 00:54:12 +0900147 }
Yifan Hongcf4832c2020-01-21 17:04:13 -0800148 Ramdisk struct {
149 // list of static libs that only should be used to build the recovery
150 // variant of the C/C++ module.
151 Static_libs []string
152
153 // list of shared libs that should not be used to build
154 // the ramdisk variant of the C/C++ module.
155 Exclude_shared_libs []string
156
157 // list of static libs that should not be used to build
158 // the ramdisk variant of the C/C++ module.
159 Exclude_static_libs []string
160 }
Colin Crossc511bc52020-04-07 16:50:32 +0000161 Platform struct {
162 // list of shared libs that should be use to build the platform variant
163 // of a module that sets sdk_version. This should rarely be necessary,
164 // in most cases the same libraries are available for the SDK and platform
165 // variants.
166 Shared_libs []string
167 }
Jiyong Park44cf1a72017-06-16 12:03:55 +0900168 }
Colin Cross86803cf2018-02-15 14:12:26 -0800169
170 // make android::build:GetBuildNumber() available containing the build ID.
171 Use_version_lib *bool `android:"arch_variant"`
Colin Cross4d9c2d12016-07-29 12:48:20 -0700172
Chih-Hung Hsieh86814712018-05-23 18:30:46 -0700173 // Generate compact dynamic relocation table, default true.
174 Pack_relocations *bool `android:"arch_variant"`
Dan Albert61f32122018-07-26 14:00:24 -0700175
176 // local file name to pass to the linker as --version_script
Colin Cross27b922f2019-03-04 22:35:41 -0800177 Version_script *string `android:"path,arch_variant"`
Christopher Ferrisc71193a2019-12-16 09:55:10 -0800178
179 // list of static libs that should not be used to build this module
Colin Cross06210312020-06-10 15:47:34 -0700180 Exclude_static_libs []string `android:"arch_variant"`
181
182 // list of shared libs that should not be used to build this module
183 Exclude_shared_libs []string `android:"arch_variant"`
Chih-Hung Hsieh86814712018-05-23 18:30:46 -0700184}
185
Dan Albert61f32122018-07-26 14:00:24 -0700186func NewBaseLinker(sanitize *sanitize) *baseLinker {
187 return &baseLinker{sanitize: sanitize}
Colin Crossb916a382016-07-29 17:28:03 -0700188}
189
Colin Cross4d9c2d12016-07-29 12:48:20 -0700190// baseLinker provides support for shared_libs, static_libs, and whole_static_libs properties
191type baseLinker struct {
192 Properties BaseLinkerProperties
193 dynamicProperties struct {
Jiyong Park7ed9de32018-10-15 22:25:07 +0900194 RunPaths []string `blueprint:"mutated"`
195 BuildStubs bool `blueprint:"mutated"`
Colin Cross4d9c2d12016-07-29 12:48:20 -0700196 }
Dan Albert61f32122018-07-26 14:00:24 -0700197
198 sanitize *sanitize
Colin Cross4d9c2d12016-07-29 12:48:20 -0700199}
200
201func (linker *baseLinker) appendLdflags(flags []string) {
202 linker.Properties.Ldflags = append(linker.Properties.Ldflags, flags...)
203}
204
Colin Cross42742b82016-08-01 13:20:05 -0700205func (linker *baseLinker) linkerInit(ctx BaseModuleContext) {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700206 if ctx.toolchain().Is64Bit() {
Colin Crossb916a382016-07-29 17:28:03 -0700207 linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, "../lib64", "lib64")
Colin Cross4d9c2d12016-07-29 12:48:20 -0700208 } else {
Colin Crossb916a382016-07-29 17:28:03 -0700209 linker.dynamicProperties.RunPaths = append(linker.dynamicProperties.RunPaths, "../lib", "lib")
Colin Cross4d9c2d12016-07-29 12:48:20 -0700210 }
211}
212
Colin Cross42742b82016-08-01 13:20:05 -0700213func (linker *baseLinker) linkerProps() []interface{} {
Colin Crossc17727d2018-10-24 12:42:09 -0700214 return []interface{}{&linker.Properties, &linker.dynamicProperties}
Colin Cross4d9c2d12016-07-29 12:48:20 -0700215}
216
Dan Albert61f32122018-07-26 14:00:24 -0700217func (linker *baseLinker) linkerDeps(ctx DepsContext, deps Deps) Deps {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700218 deps.WholeStaticLibs = append(deps.WholeStaticLibs, linker.Properties.Whole_static_libs...)
Colin Cross5950f382016-12-13 12:50:57 -0800219 deps.HeaderLibs = append(deps.HeaderLibs, linker.Properties.Header_libs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700220 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Static_libs...)
221 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Shared_libs...)
Logan Chien43d34c32017-12-20 01:17:32 +0800222 deps.RuntimeLibs = append(deps.RuntimeLibs, linker.Properties.Runtime_libs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700223
Colin Cross5950f382016-12-13 12:50:57 -0800224 deps.ReexportHeaderLibHeaders = append(deps.ReexportHeaderLibHeaders, linker.Properties.Export_header_lib_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700225 deps.ReexportStaticLibHeaders = append(deps.ReexportStaticLibHeaders, linker.Properties.Export_static_lib_headers...)
226 deps.ReexportSharedLibHeaders = append(deps.ReexportSharedLibHeaders, linker.Properties.Export_shared_lib_headers...)
Dan Willemsenb3454ab2016-09-28 17:34:58 -0700227 deps.ReexportGeneratedHeaders = append(deps.ReexportGeneratedHeaders, linker.Properties.Export_generated_headers...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700228
Colin Cross06210312020-06-10 15:47:34 -0700229 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Exclude_shared_libs)
230 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Exclude_static_libs)
Christopher Ferrisc71193a2019-12-16 09:55:10 -0800231 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Exclude_static_libs)
232
Colin Cross86803cf2018-02-15 14:12:26 -0800233 if Bool(linker.Properties.Use_version_lib) {
234 deps.WholeStaticLibs = append(deps.WholeStaticLibs, "libbuildversion")
235 }
236
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700237 if ctx.useVndk() {
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000238 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Target.Vendor.Shared_libs...)
Jiyong Park74472282017-08-10 00:48:06 +0900239 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Vendor.Exclude_shared_libs)
240 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Vendor.Exclude_shared_libs)
Chong Zhanged5c1462020-02-20 15:04:35 -0800241 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Target.Vendor.Static_libs...)
Jiyong Park52d25bd2017-10-13 09:17:01 +0900242 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Vendor.Exclude_static_libs)
Jiwen 'Steve' Cai8dbc6532018-08-08 10:58:34 -0700243 deps.HeaderLibs = removeListFromList(deps.HeaderLibs, linker.Properties.Target.Vendor.Exclude_header_libs)
Jiyong Park52d25bd2017-10-13 09:17:01 +0900244 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Vendor.Exclude_static_libs)
245 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Vendor.Exclude_static_libs)
Logan Chien43d34c32017-12-20 01:17:32 +0800246 deps.RuntimeLibs = removeListFromList(deps.RuntimeLibs, linker.Properties.Target.Vendor.Exclude_runtime_libs)
Jiyong Park74472282017-08-10 00:48:06 +0900247 }
248
Jiyong Parkf9332f12018-02-01 00:54:12 +0900249 if ctx.inRecovery() {
Martin Stjernholmef449fe2018-11-06 16:12:13 +0000250 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Target.Recovery.Shared_libs...)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900251 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Recovery.Exclude_shared_libs)
252 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Recovery.Exclude_shared_libs)
Yifan Honge7efbc82019-08-01 13:45:42 -0700253 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Target.Recovery.Static_libs...)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900254 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Recovery.Exclude_static_libs)
Hridya Valsaraju280febf2018-08-10 09:08:13 -0700255 deps.HeaderLibs = removeListFromList(deps.HeaderLibs, linker.Properties.Target.Recovery.Exclude_header_libs)
256 deps.ReexportHeaderLibHeaders = removeListFromList(deps.ReexportHeaderLibHeaders, linker.Properties.Target.Recovery.Exclude_header_libs)
Jiyong Parkf9332f12018-02-01 00:54:12 +0900257 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Recovery.Exclude_static_libs)
258 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Recovery.Exclude_static_libs)
259 }
260
Yifan Hongcf4832c2020-01-21 17:04:13 -0800261 if ctx.inRamdisk() {
262 deps.SharedLibs = removeListFromList(deps.SharedLibs, linker.Properties.Target.Recovery.Exclude_shared_libs)
263 deps.ReexportSharedLibHeaders = removeListFromList(deps.ReexportSharedLibHeaders, linker.Properties.Target.Recovery.Exclude_shared_libs)
264 deps.StaticLibs = append(deps.StaticLibs, linker.Properties.Target.Recovery.Static_libs...)
265 deps.StaticLibs = removeListFromList(deps.StaticLibs, linker.Properties.Target.Recovery.Exclude_static_libs)
266 deps.ReexportStaticLibHeaders = removeListFromList(deps.ReexportStaticLibHeaders, linker.Properties.Target.Recovery.Exclude_static_libs)
267 deps.WholeStaticLibs = removeListFromList(deps.WholeStaticLibs, linker.Properties.Target.Recovery.Exclude_static_libs)
268 }
269
Colin Crossc511bc52020-04-07 16:50:32 +0000270 if !ctx.useSdk() {
271 deps.SharedLibs = append(deps.SharedLibs, linker.Properties.Target.Platform.Shared_libs...)
272 }
273
Yi Kong6fb831b2018-10-05 19:46:01 +0000274 if ctx.toolchain().Bionic() {
Peter Collingbournee5ba2862019-12-10 18:37:45 -0800275 // libclang_rt.builtins and libatomic have to be last on the command line
Yi Kong2c188be2018-10-10 13:43:02 -0700276 if !Bool(linker.Properties.No_libcrt) {
Yi Kong19408a32019-02-12 09:41:18 -0800277 deps.LateStaticLibs = append(deps.LateStaticLibs, config.BuiltinsRuntimeLibrary(ctx.toolchain()))
Yi Kongacee27c2019-03-29 20:05:14 -0700278 deps.LateStaticLibs = append(deps.LateStaticLibs, "libatomic")
Colin Cross4d9c2d12016-07-29 12:48:20 -0700279 }
280
Logan Chien14bd0db2019-01-15 21:12:43 +0800281 systemSharedLibs := linker.Properties.System_shared_libs
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800282 if systemSharedLibs == nil {
Logan Chien14bd0db2019-01-15 21:12:43 +0800283 // Provide a default system_shared_libs if it is unspecified. Note: If an
284 // empty list [] is specified, it implies that the module declines the
285 // default system_shared_libs.
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800286 systemSharedLibs = []string{"libc", "libm", "libdl"}
287 }
288
289 if inList("libdl", deps.SharedLibs) {
290 // If system_shared_libs has libc but not libdl, make sure shared_libs does not
291 // have libdl to avoid loading libdl before libc.
292 if inList("libc", systemSharedLibs) {
293 if !inList("libdl", systemSharedLibs) {
294 ctx.PropertyErrorf("shared_libs",
295 "libdl must be in system_shared_libs, not shared_libs")
296 }
297 _, deps.SharedLibs = removeFromList("libdl", deps.SharedLibs)
298 }
299 }
300
Christopher Ferris134f8f62019-04-01 16:30:21 -0700301 if inList("libc_scudo", deps.SharedLibs) {
302 // libc_scudo is an alternate implementation of all
303 // allocation functions (malloc, free), that uses
304 // the scudo allocator instead of the default native
305 // allocator. If this library is in the list, make
306 // sure it's first so it properly overrides the
307 // allocation functions of all other shared libraries.
308 _, deps.SharedLibs = removeFromList("libc_scudo", deps.SharedLibs)
309 deps.SharedLibs = append([]string{"libc_scudo"}, deps.SharedLibs...)
310 }
311
Dan Willemsen3a26eef2018-12-03 15:25:46 -0800312 // If libc and libdl are both in system_shared_libs make sure libdl comes after libc
313 // to avoid loading libdl before libc.
314 if inList("libdl", systemSharedLibs) && inList("libc", systemSharedLibs) &&
315 indexList("libdl", systemSharedLibs) < indexList("libc", systemSharedLibs) {
316 ctx.PropertyErrorf("system_shared_libs", "libdl must be after libc")
317 }
318
319 deps.LateSharedLibs = append(deps.LateSharedLibs, systemSharedLibs...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700320 }
321
Doug Hornc32c6b02019-01-17 14:44:05 -0800322 if ctx.Fuchsia() {
323 if ctx.ModuleName() != "libbioniccompat" &&
324 ctx.ModuleName() != "libcompiler_rt-extras" &&
325 ctx.ModuleName() != "libcompiler_rt" {
326 deps.StaticLibs = append(deps.StaticLibs, "libbioniccompat")
327 }
328 if ctx.ModuleName() != "libcompiler_rt" && ctx.ModuleName() != "libcompiler_rt-extras" {
329 deps.LateStaticLibs = append(deps.LateStaticLibs, "libcompiler_rt")
330 }
331
332 }
333
Colin Cross3edeee12017-04-04 12:59:48 -0700334 if ctx.Windows() {
Josh Gao7bd4c5c2017-02-23 17:52:24 -0800335 deps.LateStaticLibs = append(deps.LateStaticLibs, "libwinpthread")
336 }
337
Colin Cross4d9c2d12016-07-29 12:48:20 -0700338 return deps
339}
340
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700341func (linker *baseLinker) useClangLld(ctx ModuleContext) bool {
Chih-Hung Hsiehe5ac6092018-04-24 16:00:01 -0700342 // Clang lld is not ready for for Darwin host executables yet.
343 // See https://lld.llvm.org/AtomLLD.html for status of lld for Mach-O.
344 if ctx.Darwin() {
345 return false
346 }
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700347 if linker.Properties.Use_clang_lld != nil {
348 return Bool(linker.Properties.Use_clang_lld)
349 }
Dan Willemsenfa2aee12018-10-21 19:47:01 -0700350 return true
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700351}
352
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800353// Check whether the SDK version is not older than the specific one
354func CheckSdkVersionAtLeast(ctx ModuleContext, SdkVersion int) bool {
355 if ctx.sdkVersion() == "current" {
356 return true
357 }
358 parsedSdkVersion, err := strconv.Atoi(ctx.sdkVersion())
359 if err != nil {
360 ctx.PropertyErrorf("sdk_version",
361 "Invalid sdk_version value (must be int or current): %q",
362 ctx.sdkVersion())
363 }
364 if parsedSdkVersion < SdkVersion {
365 return false
366 }
367 return true
368}
369
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700370// ModuleContext extends BaseModuleContext
371// BaseModuleContext should know if LLD is used?
Colin Cross42742b82016-08-01 13:20:05 -0700372func (linker *baseLinker) linkerFlags(ctx ModuleContext, flags Flags) Flags {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700373 toolchain := ctx.toolchain()
374
Colin Cross324a4572017-11-02 23:09:41 -0700375 hod := "Host"
376 if ctx.Os().Class == android.Device {
377 hod = "Device"
378 }
379
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700380 if linker.useClangLld(ctx) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800381 flags.Global.LdFlags = append(flags.Global.LdFlags, fmt.Sprintf("${config.%sGlobalLldflags}", hod))
Colin Crossc17727d2018-10-24 12:42:09 -0700382 if !BoolDefault(linker.Properties.Pack_relocations, true) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800383 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--pack-dyn-relocs=none")
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800384 } else if ctx.Device() {
385 // The SHT_RELR relocations is only supported by API level >= 28.
386 // Do not turn this on if older version NDK is used.
387 if !ctx.useSdk() || CheckSdkVersionAtLeast(ctx, 28) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800388 flags.Global.LdFlags = append(flags.Global.LdFlags,
389 "-Wl,--pack-dyn-relocs=android+relr",
390 "-Wl,--use-android-relr-tags")
Elliott Hughesda909fe2020-01-28 13:08:40 -0800391 } else if CheckSdkVersionAtLeast(ctx, 23) {
392 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--pack-dyn-relocs=android")
Zhizhou Yang9100b1d2018-11-30 14:00:04 -0800393 }
Chih-Hung Hsieh86814712018-05-23 18:30:46 -0700394 }
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700395 } else {
Colin Cross4af21ed2019-11-04 09:37:55 -0800396 flags.Global.LdFlags = append(flags.Global.LdFlags, fmt.Sprintf("${config.%sGlobalLdflags}", hod))
Chih-Hung Hsieh02b4da52018-04-03 11:33:34 -0700397 }
Colin Cross87dd9632017-11-03 13:31:05 -0700398 if Bool(linker.Properties.Allow_undefined_symbols) {
399 if ctx.Darwin() {
400 // darwin defaults to treating undefined symbols as errors
Colin Cross4af21ed2019-11-04 09:37:55 -0800401 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,-undefined,dynamic_lookup")
Colin Cross4d9c2d12016-07-29 12:48:20 -0700402 }
Josh Gao75a50a22019-06-07 17:58:59 -0700403 } else if !ctx.Darwin() && !ctx.Windows() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800404 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--no-undefined")
Colin Cross87dd9632017-11-03 13:31:05 -0700405 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700406
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700407 if linker.useClangLld(ctx) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800408 flags.Global.LdFlags = append(flags.Global.LdFlags, toolchain.ClangLldflags())
Colin Cross87dd9632017-11-03 13:31:05 -0700409 } else {
Colin Cross4af21ed2019-11-04 09:37:55 -0800410 flags.Global.LdFlags = append(flags.Global.LdFlags, toolchain.ClangLdflags())
Colin Cross87dd9632017-11-03 13:31:05 -0700411 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700412
Doug Hornc32c6b02019-01-17 14:44:05 -0800413 if !ctx.toolchain().Bionic() && !ctx.Fuchsia() {
Colin Cross87dd9632017-11-03 13:31:05 -0700414 CheckBadHostLdlibs(ctx, "host_ldlibs", linker.Properties.Host_ldlibs)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700415
Colin Cross4af21ed2019-11-04 09:37:55 -0800416 flags.Local.LdFlags = append(flags.Local.LdFlags, linker.Properties.Host_ldlibs...)
Colin Crossc5fdbb82017-09-08 12:45:18 -0700417
Colin Cross87dd9632017-11-03 13:31:05 -0700418 if !ctx.Windows() {
419 // Add -ldl, -lpthread, -lm and -lrt to host builds to match the default behavior of device
420 // builds
Colin Cross4af21ed2019-11-04 09:37:55 -0800421 flags.Global.LdFlags = append(flags.Global.LdFlags,
Colin Cross87dd9632017-11-03 13:31:05 -0700422 "-ldl",
423 "-lpthread",
424 "-lm",
425 )
426 if !ctx.Darwin() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800427 flags.Global.LdFlags = append(flags.Global.LdFlags, "-lrt")
Colin Crossc5fdbb82017-09-08 12:45:18 -0700428 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700429 }
430 }
431
Doug Hornc32c6b02019-01-17 14:44:05 -0800432 if ctx.Fuchsia() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800433 flags.Global.LdFlags = append(flags.Global.LdFlags, "-lfdio", "-lzircon")
Doug Hornc32c6b02019-01-17 14:44:05 -0800434 }
435
Tom Cherrye4802322019-08-06 10:03:25 -0700436 if ctx.toolchain().LibclangRuntimeLibraryArch() != "" {
Colin Cross4af21ed2019-11-04 09:37:55 -0800437 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--exclude-libs="+config.BuiltinsRuntimeLibrary(ctx.toolchain())+".a")
Tom Cherrye4802322019-08-06 10:03:25 -0700438 }
439
Colin Cross4d9c2d12016-07-29 12:48:20 -0700440 CheckBadLinkerFlags(ctx, "ldflags", linker.Properties.Ldflags)
441
Colin Cross4af21ed2019-11-04 09:37:55 -0800442 flags.Local.LdFlags = append(flags.Local.LdFlags, proptools.NinjaAndShellEscapeList(linker.Properties.Ldflags)...)
Colin Cross4d9c2d12016-07-29 12:48:20 -0700443
Josh Gao75a50a22019-06-07 17:58:59 -0700444 if ctx.Host() && !ctx.Windows() {
Colin Cross4d9c2d12016-07-29 12:48:20 -0700445 rpath_prefix := `\$$ORIGIN/`
446 if ctx.Darwin() {
447 rpath_prefix = "@loader_path/"
448 }
449
Dan Willemsen6f91fbf2017-09-18 22:45:15 -0700450 if !ctx.static() {
451 for _, rpath := range linker.dynamicProperties.RunPaths {
Colin Cross4af21ed2019-11-04 09:37:55 -0800452 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,-rpath,"+rpath_prefix+rpath)
Dan Willemsen6f91fbf2017-09-18 22:45:15 -0700453 }
Colin Cross4d9c2d12016-07-29 12:48:20 -0700454 }
455 }
456
Elliott Hughesda3a0712020-03-06 16:55:28 -0800457 if ctx.useSdk() {
Colin Cross6774e282017-08-11 13:23:57 -0700458 // The bionic linker now has support gnu style hashes (which are much faster!), but shipping
459 // to older devices requires the old style hash. Fortunately, we can build with both and
460 // it'll work anywhere.
Colin Cross4af21ed2019-11-04 09:37:55 -0800461 flags.Global.LdFlags = append(flags.Global.LdFlags, "-Wl,--hash-style=both")
Colin Cross6774e282017-08-11 13:23:57 -0700462 }
463
Colin Cross4af21ed2019-11-04 09:37:55 -0800464 flags.Global.LdFlags = append(flags.Global.LdFlags, toolchain.ToolchainClangLdflags())
Colin Cross4d9c2d12016-07-29 12:48:20 -0700465
Colin Cross18c0c5a2016-12-01 14:45:23 -0800466 if Bool(linker.Properties.Group_static_libs) {
467 flags.GroupStaticLibs = true
468 }
469
Jiyong Park7ed9de32018-10-15 22:25:07 +0900470 // Version_script is not needed when linking stubs lib where the version
471 // script is created from the symbol map file.
472 if !linker.dynamicProperties.BuildStubs {
473 versionScript := ctx.ExpandOptionalSource(
Colin Crossc17727d2018-10-24 12:42:09 -0700474 linker.Properties.Version_script, "version_script")
Dan Albert61f32122018-07-26 14:00:24 -0700475
Colin Crossc17727d2018-10-24 12:42:09 -0700476 if ctx.useVndk() && linker.Properties.Target.Vendor.Version_script != nil {
Jiyong Park7ed9de32018-10-15 22:25:07 +0900477 versionScript = ctx.ExpandOptionalSource(
Colin Crossc17727d2018-10-24 12:42:09 -0700478 linker.Properties.Target.Vendor.Version_script,
Jiyong Park7ed9de32018-10-15 22:25:07 +0900479 "target.vendor.version_script")
480 }
Dan Albert61f32122018-07-26 14:00:24 -0700481
Jiyong Park7ed9de32018-10-15 22:25:07 +0900482 if versionScript.Valid() {
483 if ctx.Darwin() {
484 ctx.PropertyErrorf("version_script", "Not supported on Darwin")
485 } else {
Colin Cross4af21ed2019-11-04 09:37:55 -0800486 flags.Local.LdFlags = append(flags.Local.LdFlags,
Jiyong Park7ed9de32018-10-15 22:25:07 +0900487 "-Wl,--version-script,"+versionScript.String())
488 flags.LdFlagsDeps = append(flags.LdFlagsDeps, versionScript.Path())
489
490 if linker.sanitize.isSanitizerEnabled(cfi) {
491 cfiExportsMap := android.PathForSource(ctx, cfiExportsMapPath)
Colin Cross4af21ed2019-11-04 09:37:55 -0800492 flags.Local.LdFlags = append(flags.Local.LdFlags,
Jiyong Park7ed9de32018-10-15 22:25:07 +0900493 "-Wl,--version-script,"+cfiExportsMap.String())
494 flags.LdFlagsDeps = append(flags.LdFlagsDeps, cfiExportsMap)
495 }
Dan Albert61f32122018-07-26 14:00:24 -0700496 }
497 }
498 }
499
Colin Cross4d9c2d12016-07-29 12:48:20 -0700500 return flags
501}
502
Colin Crossb916a382016-07-29 17:28:03 -0700503func (linker *baseLinker) link(ctx ModuleContext,
Dan Willemsen5cb580f2016-09-26 17:33:01 -0700504 flags Flags, deps PathDeps, objs Objects) android.Path {
Colin Crossb916a382016-07-29 17:28:03 -0700505 panic(fmt.Errorf("baseLinker doesn't know how to link"))
Colin Cross4d9c2d12016-07-29 12:48:20 -0700506}
Colin Cross86803cf2018-02-15 14:12:26 -0800507
Paul Duffin13f02712020-03-06 12:30:43 +0000508func (linker *baseLinker) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps {
509 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, linker.Properties.Shared_libs...)
Martin Stjernholm10566a02020-03-24 01:19:52 +0000510
511 // Must distinguish nil and [] in system_shared_libs - ensure that [] in
512 // either input list doesn't come out as nil.
513 if specifiedDeps.systemSharedLibs == nil {
514 specifiedDeps.systemSharedLibs = linker.Properties.System_shared_libs
515 } else {
516 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, linker.Properties.System_shared_libs...)
517 }
518
Paul Duffin13f02712020-03-06 12:30:43 +0000519 return specifiedDeps
520}
521
Colin Cross86803cf2018-02-15 14:12:26 -0800522// Injecting version symbols
523// Some host modules want a version number, but we don't want to rebuild it every time. Optionally add a step
524// after linking that injects a constant placeholder with the current version number.
525
526func init() {
527 pctx.HostBinToolVariable("symbolInjectCmd", "symbol_inject")
528}
529
530var injectVersionSymbol = pctx.AndroidStaticRule("injectVersionSymbol",
531 blueprint.RuleParams{
532 Command: "$symbolInjectCmd -i $in -o $out -s soong_build_number " +
Colin Cross2a2e0db2020-02-21 16:55:46 -0800533 "-from 'SOONG BUILD NUMBER PLACEHOLDER' -v $$(cat $buildNumberFile)",
Colin Cross86803cf2018-02-15 14:12:26 -0800534 CommandDeps: []string{"$symbolInjectCmd"},
535 },
Colin Cross2a2e0db2020-02-21 16:55:46 -0800536 "buildNumberFile")
Colin Cross86803cf2018-02-15 14:12:26 -0800537
538func (linker *baseLinker) injectVersionSymbol(ctx ModuleContext, in android.Path, out android.WritablePath) {
Colin Cross2a2e0db2020-02-21 16:55:46 -0800539 buildNumberFile := ctx.Config().BuildNumberFile(ctx)
Colin Cross86803cf2018-02-15 14:12:26 -0800540 ctx.Build(pctx, android.BuildParams{
541 Rule: injectVersionSymbol,
542 Description: "inject version symbol",
543 Input: in,
544 Output: out,
Colin Cross2a2e0db2020-02-21 16:55:46 -0800545 OrderOnly: android.Paths{buildNumberFile},
Colin Cross86803cf2018-02-15 14:12:26 -0800546 Args: map[string]string{
Colin Cross2a2e0db2020-02-21 16:55:46 -0800547 "buildNumberFile": buildNumberFile.String(),
Colin Cross86803cf2018-02-15 14:12:26 -0800548 },
549 })
550}
Vic Yang6cd1be82019-06-24 16:08:48 -0700551
552// Rule to generate .bss symbol ordering file.
553
554var (
555 _ = pctx.SourcePathVariable("genSortedBssSymbolsPath", "build/soong/scripts/gen_sorted_bss_symbols.sh")
556 gen_sorted_bss_symbols = pctx.AndroidStaticRule("gen_sorted_bss_symbols",
557 blueprint.RuleParams{
558 Command: "CROSS_COMPILE=$crossCompile $genSortedBssSymbolsPath ${in} ${out}",
Dan Willemsen724ab5d2019-09-19 10:50:18 -0700559 CommandDeps: []string{"$genSortedBssSymbolsPath", "${crossCompile}nm"},
Vic Yang6cd1be82019-06-24 16:08:48 -0700560 },
561 "crossCompile")
562)
563
564func (linker *baseLinker) sortBssSymbolsBySize(ctx ModuleContext, in android.Path, symbolOrderingFile android.ModuleOutPath, flags builderFlags) string {
565 crossCompile := gccCmd(flags.toolchain, "")
566 ctx.Build(pctx, android.BuildParams{
567 Rule: gen_sorted_bss_symbols,
568 Description: "generate bss symbol order " + symbolOrderingFile.Base(),
569 Output: symbolOrderingFile,
570 Input: in,
571 Args: map[string]string{
572 "crossCompile": crossCompile,
573 },
574 })
575 return "-Wl,--symbol-ordering-file," + symbolOrderingFile.String()
576}