blob: 8c3e97af31d7f71cff6fd3197ba18bba27a84fb1 [file] [log] [blame]
Colin Cross16b23492016-01-06 14:41:07 -08001// 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 "fmt"
Jeff Gaston72765392017-11-28 16:37:53 -080019 "sort"
Colin Cross16b23492016-01-06 14:41:07 -080020 "strings"
Vishwath Mohane7128792017-11-17 11:08:10 -080021 "sync"
Colin Cross16b23492016-01-06 14:41:07 -080022
Colin Cross6b753602018-06-21 13:03:07 -070023 "github.com/google/blueprint"
24
Colin Cross635c3b02016-05-18 15:37:25 -070025 "android/soong/android"
Evgenii Stepanovaf36db12016-08-15 14:18:24 -070026 "android/soong/cc/config"
Colin Cross16b23492016-01-06 14:41:07 -080027)
28
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -070029var (
30 // Any C flags added by sanitizer which libTooling tools may not
31 // understand also need to be added to ClangLibToolingUnknownCflags in
32 // cc/config/clang.go
Vishwath Mohanf3918d32017-02-14 07:59:33 -080033
Yi Kong20233a42019-08-21 01:38:40 -070034 asanCflags = []string{
35 "-fno-omit-frame-pointer",
36 "-fno-experimental-new-pass-manager",
37 }
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -070038 asanLdflags = []string{"-Wl,-u,__asan_preinit"}
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -070039
Peter Collingbourne967511a2019-03-19 21:39:54 -070040 hwasanCflags = []string{"-fno-omit-frame-pointer", "-Wno-frame-larger-than=",
Evgenii Stepanov96fa3dd2020-03-27 19:38:42 +000041 "-fsanitize-hwaddress-abi=platform",
42 "-fno-experimental-new-pass-manager",
Evgenii Stepanov64bee4d2019-11-22 18:37:10 -080043 // The following improves debug location information
44 // availability at the cost of its accuracy. It increases
45 // the likelihood of a stack variable's frame offset
46 // to be recorded in the debug info, which is important
47 // for the quality of hwasan reports. The downside is a
48 // higher number of "optimized out" stack variables.
49 // b/112437883.
50 "-mllvm", "-instcombine-lower-dbg-declare=0",
Mitch Phillipsb1c574f2020-06-22 13:28:23 -070051 // TODO(b/159343917): HWASan and GlobalISel don't play nicely, and
52 // GlobalISel is the default at -O0 on aarch64.
53 "-mllvm", "--aarch64-enable-global-isel-at-O=-1",
54 "-mllvm", "-fast-isel=false",
Evgenii Stepanov64bee4d2019-11-22 18:37:10 -080055 }
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070056
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000057 cfiCflags = []string{"-flto", "-fsanitize-cfi-cross-dso",
Pirama Arumuga Nainareb8d4032020-07-27 11:22:35 -070058 "-fsanitize-blacklist=external/compiler-rt/lib/cfi/cfi_blocklist.txt"}
Evgenii Stepanovdbf1d4f2018-08-31 12:54:33 -070059 // -flto and -fvisibility are required by clang when -fsanitize=cfi is
60 // used, but have no effect on assembly files
61 cfiAsflags = []string{"-flto", "-fvisibility=default"}
Jayant Chowdhary9677e8c2017-06-15 14:45:18 -070062 cfiLdflags = []string{"-flto", "-fsanitize-cfi-cross-dso", "-fsanitize=cfi",
Pirama Arumuga Nainarbdb17f02017-08-28 21:50:17 -070063 "-Wl,-plugin-opt,O1"}
Inseob Kim74d25562020-08-04 00:41:38 +090064 cfiExportsMapPath = "build/soong/cc/config/cfi_exports.map"
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -070065
Pirama Arumuga Nainareb8d4032020-07-27 11:22:35 -070066 intOverflowCflags = []string{"-fsanitize-blacklist=build/soong/cc/config/integer_overflow_blocklist.txt"}
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080067
Peter Collingbournebd19db02019-03-06 10:38:48 -080068 minimalRuntimeFlags = []string{"-fsanitize-minimal-runtime", "-fno-sanitize-trap=integer,undefined",
Ivan Lozanoae6ae1d2018-10-08 09:29:39 -070069 "-fno-sanitize-recover=integer,undefined"}
Evgenii Stepanov2c6484e2019-05-15 12:49:54 -070070 hwasanGlobalOptions = []string{"heap_history_size=1023", "stack_history_size=512",
71 "export_memory_stats=0", "max_malloc_fill_size=0"}
Dan Willemsencbceaab2016-10-13 16:44:07 -070072)
73
Colin Cross16b23492016-01-06 14:41:07 -080074type sanitizerType int
75
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -070076func boolPtr(v bool) *bool {
77 if v {
78 return &v
79 } else {
80 return nil
81 }
82}
83
Colin Cross16b23492016-01-06 14:41:07 -080084const (
85 asan sanitizerType = iota + 1
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070086 hwasan
Colin Cross16b23492016-01-06 14:41:07 -080087 tsan
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -070088 intOverflow
Vishwath Mohanb743e9c2017-11-01 09:20:21 +000089 cfi
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -080090 scs
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -070091 fuzzer
Colin Cross16b23492016-01-06 14:41:07 -080092)
93
Jiyong Park82226632019-02-01 10:50:50 +090094// Name of the sanitizer variation for this sanitizer type
95func (t sanitizerType) variationName() string {
Colin Cross16b23492016-01-06 14:41:07 -080096 switch t {
97 case asan:
98 return "asan"
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -070099 case hwasan:
100 return "hwasan"
Colin Cross16b23492016-01-06 14:41:07 -0800101 case tsan:
102 return "tsan"
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700103 case intOverflow:
104 return "intOverflow"
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000105 case cfi:
106 return "cfi"
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800107 case scs:
108 return "scs"
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700109 case fuzzer:
110 return "fuzzer"
Colin Cross16b23492016-01-06 14:41:07 -0800111 default:
112 panic(fmt.Errorf("unknown sanitizerType %d", t))
113 }
114}
115
Jiyong Park82226632019-02-01 10:50:50 +0900116// This is the sanitizer names in SANITIZE_[TARGET|HOST]
117func (t sanitizerType) name() string {
118 switch t {
119 case asan:
120 return "address"
121 case hwasan:
122 return "hwaddress"
123 case tsan:
124 return "thread"
125 case intOverflow:
126 return "integer_overflow"
127 case cfi:
128 return "cfi"
129 case scs:
130 return "shadow-call-stack"
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700131 case fuzzer:
132 return "fuzzer"
Jiyong Park82226632019-02-01 10:50:50 +0900133 default:
134 panic(fmt.Errorf("unknown sanitizerType %d", t))
135 }
136}
137
Jiyong Park1d1119f2019-07-29 21:27:18 +0900138func (t sanitizerType) incompatibleWithCfi() bool {
139 return t == asan || t == fuzzer || t == hwasan
140}
141
Martin Stjernholmb0249572020-09-15 02:32:35 +0100142type SanitizeUserProps struct {
143 Never *bool `android:"arch_variant"`
Colin Cross16b23492016-01-06 14:41:07 -0800144
Martin Stjernholmb0249572020-09-15 02:32:35 +0100145 // main sanitizers
146 Address *bool `android:"arch_variant"`
147 Thread *bool `android:"arch_variant"`
148 Hwaddress *bool `android:"arch_variant"`
Colin Cross16b23492016-01-06 14:41:07 -0800149
Martin Stjernholmb0249572020-09-15 02:32:35 +0100150 // local sanitizers
151 Undefined *bool `android:"arch_variant"`
152 All_undefined *bool `android:"arch_variant"`
153 Misc_undefined []string `android:"arch_variant"`
154 Fuzzer *bool `android:"arch_variant"`
155 Safestack *bool `android:"arch_variant"`
156 Cfi *bool `android:"arch_variant"`
157 Integer_overflow *bool `android:"arch_variant"`
158 Scudo *bool `android:"arch_variant"`
159 Scs *bool `android:"arch_variant"`
160
161 // A modifier for ASAN and HWASAN for write only instrumentation
162 Writeonly *bool `android:"arch_variant"`
163
164 // Sanitizers to run in the diagnostic mode (as opposed to the release mode).
165 // Replaces abort() on error with a human-readable error message.
166 // Address and Thread sanitizers always run in diagnostic mode.
167 Diag struct {
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700168 Undefined *bool `android:"arch_variant"`
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700169 Cfi *bool `android:"arch_variant"`
170 Integer_overflow *bool `android:"arch_variant"`
Martin Stjernholmb0249572020-09-15 02:32:35 +0100171 Misc_undefined []string `android:"arch_variant"`
172 No_recover []string
173 }
Colin Cross16b23492016-01-06 14:41:07 -0800174
Martin Stjernholmb0249572020-09-15 02:32:35 +0100175 // value to pass to -fsanitize-recover=
176 Recover []string
Jasraj Bedibb4511d2020-07-23 22:58:17 +0000177
Martin Stjernholmb0249572020-09-15 02:32:35 +0100178 // value to pass to -fsanitize-blacklist
179 Blocklist *string
180}
Evgenii Stepanov1e405e12016-08-16 15:39:54 -0700181
Martin Stjernholmb0249572020-09-15 02:32:35 +0100182type SanitizeProperties struct {
183 // Enable AddressSanitizer, ThreadSanitizer, UndefinedBehaviorSanitizer, and
184 // others. Please see SanitizerUserProps in build/soong/cc/sanitize.go for
185 // details.
186 Sanitize SanitizeUserProps `android:"arch_variant"`
187 SanitizerEnabled bool `blueprint:"mutated"`
188 SanitizeDep bool `blueprint:"mutated"`
189 MinimalRuntimeDep bool `blueprint:"mutated"`
190 BuiltinsDep bool `blueprint:"mutated"`
191 UbsanRuntimeDep bool `blueprint:"mutated"`
192 InSanitizerDir bool `blueprint:"mutated"`
193 Sanitizers []string `blueprint:"mutated"`
194 DiagSanitizers []string `blueprint:"mutated"`
Colin Cross16b23492016-01-06 14:41:07 -0800195}
196
197type sanitize struct {
198 Properties SanitizeProperties
199}
200
Vishwath Mohane7128792017-11-17 11:08:10 -0800201func init() {
202 android.RegisterMakeVarsProvider(pctx, cfiMakeVarsProvider)
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700203 android.RegisterMakeVarsProvider(pctx, hwasanMakeVarsProvider)
Vishwath Mohane7128792017-11-17 11:08:10 -0800204}
205
Colin Cross16b23492016-01-06 14:41:07 -0800206func (sanitize *sanitize) props() []interface{} {
207 return []interface{}{&sanitize.Properties}
208}
209
210func (sanitize *sanitize) begin(ctx BaseModuleContext) {
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700211 s := &sanitize.Properties.Sanitize
212
Colin Cross16b23492016-01-06 14:41:07 -0800213 // Don't apply sanitizers to NDK code.
Jeff Gastonaf3cc2d2017-09-27 17:01:44 -0700214 if ctx.useSdk() {
Nan Zhang0007d812017-11-07 10:57:05 -0800215 s.Never = BoolPtr(true)
Colin Cross16b23492016-01-06 14:41:07 -0800216 }
217
Doug Hornc32c6b02019-01-17 14:44:05 -0800218 // Sanitizers do not work on Fuchsia yet.
219 if ctx.Fuchsia() {
220 s.Never = BoolPtr(true)
221 }
222
Colin Cross16b23492016-01-06 14:41:07 -0800223 // Never always wins.
Nan Zhang0007d812017-11-07 10:57:05 -0800224 if Bool(s.Never) {
Colin Cross16b23492016-01-06 14:41:07 -0800225 return
226 }
227
Colin Cross16b23492016-01-06 14:41:07 -0800228 var globalSanitizers []string
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700229 var globalSanitizersDiag []string
230
Dan Willemsen8536d6b2018-10-07 20:54:34 -0700231 if ctx.Host() {
232 if !ctx.Windows() {
233 globalSanitizers = ctx.Config().SanitizeHost()
234 }
235 } else {
236 arches := ctx.Config().SanitizeDeviceArch()
237 if len(arches) == 0 || inList(ctx.Arch().ArchType.Name, arches) {
238 globalSanitizers = ctx.Config().SanitizeDevice()
239 globalSanitizersDiag = ctx.Config().SanitizeDeviceDiag()
Colin Cross16b23492016-01-06 14:41:07 -0800240 }
241 }
242
Colin Cross16b23492016-01-06 14:41:07 -0800243 if len(globalSanitizers) > 0 {
Evgenii Stepanov05bafd32016-07-07 17:38:41 +0000244 var found bool
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700245 if found, globalSanitizers = removeFromList("undefined", globalSanitizers); found && s.All_undefined == nil {
246 s.All_undefined = boolPtr(true)
Evgenii Stepanov05bafd32016-07-07 17:38:41 +0000247 }
Colin Cross16b23492016-01-06 14:41:07 -0800248
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700249 if found, globalSanitizers = removeFromList("default-ub", globalSanitizers); found && s.Undefined == nil {
250 s.Undefined = boolPtr(true)
Evgenii Stepanov05bafd32016-07-07 17:38:41 +0000251 }
252
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700253 if found, globalSanitizers = removeFromList("address", globalSanitizers); found && s.Address == nil {
254 s.Address = boolPtr(true)
Evgenii Stepanov05bafd32016-07-07 17:38:41 +0000255 }
256
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700257 if found, globalSanitizers = removeFromList("thread", globalSanitizers); found && s.Thread == nil {
258 s.Thread = boolPtr(true)
Evgenii Stepanov05bafd32016-07-07 17:38:41 +0000259 }
260
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700261 if found, globalSanitizers = removeFromList("fuzzer", globalSanitizers); found && s.Fuzzer == nil {
262 s.Fuzzer = boolPtr(true)
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700263 }
264
265 if found, globalSanitizers = removeFromList("safe-stack", globalSanitizers); found && s.Safestack == nil {
266 s.Safestack = boolPtr(true)
Evgenii Stepanov05bafd32016-07-07 17:38:41 +0000267 }
268
Evgenii Stepanov1e405e12016-08-16 15:39:54 -0700269 if found, globalSanitizers = removeFromList("cfi", globalSanitizers); found && s.Cfi == nil {
Colin Cross6510f912017-11-29 00:27:14 -0800270 if !ctx.Config().CFIDisabledForPath(ctx.ModuleDir()) {
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700271 s.Cfi = boolPtr(true)
272 }
Evgenii Stepanov1e405e12016-08-16 15:39:54 -0700273 }
274
Ivan Lozanoa9255a82018-03-13 10:41:07 -0700275 // Global integer_overflow builds do not support static libraries.
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700276 if found, globalSanitizers = removeFromList("integer_overflow", globalSanitizers); found && s.Integer_overflow == nil {
Ivan Lozanoa9255a82018-03-13 10:41:07 -0700277 if !ctx.Config().IntegerOverflowDisabledForPath(ctx.ModuleDir()) && !ctx.static() {
Ivan Lozano5f595532017-07-13 14:46:05 -0700278 s.Integer_overflow = boolPtr(true)
279 }
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700280 }
281
Kostya Kortchinskyd18ae5c2018-06-12 14:46:54 -0700282 if found, globalSanitizers = removeFromList("scudo", globalSanitizers); found && s.Scudo == nil {
283 s.Scudo = boolPtr(true)
284 }
285
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700286 if found, globalSanitizers = removeFromList("hwaddress", globalSanitizers); found && s.Hwaddress == nil {
287 s.Hwaddress = boolPtr(true)
288 }
289
Jasraj Bedibb4511d2020-07-23 22:58:17 +0000290 if found, globalSanitizers = removeFromList("writeonly", globalSanitizers); found && s.Writeonly == nil {
291 // Hwaddress and Address are set before, so we can check them here
292 // If they aren't explicitly set in the blueprint/SANITIZE_(HOST|TARGET), they would be nil instead of false
293 if s.Address == nil && s.Hwaddress == nil {
294 ctx.ModuleErrorf("writeonly modifier cannot be used without 'address' or 'hwaddress'")
295 }
296 s.Writeonly = boolPtr(true)
297 }
298
Evgenii Stepanov05bafd32016-07-07 17:38:41 +0000299 if len(globalSanitizers) > 0 {
300 ctx.ModuleErrorf("unknown global sanitizer option %s", globalSanitizers[0])
301 }
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700302
Ivan Lozanoa9255a82018-03-13 10:41:07 -0700303 // Global integer_overflow builds do not support static library diagnostics.
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700304 if found, globalSanitizersDiag = removeFromList("integer_overflow", globalSanitizersDiag); found &&
Ivan Lozanoa9255a82018-03-13 10:41:07 -0700305 s.Diag.Integer_overflow == nil && Bool(s.Integer_overflow) && !ctx.static() {
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700306 s.Diag.Integer_overflow = boolPtr(true)
307 }
308
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700309 if found, globalSanitizersDiag = removeFromList("cfi", globalSanitizersDiag); found &&
310 s.Diag.Cfi == nil && Bool(s.Cfi) {
311 s.Diag.Cfi = boolPtr(true)
312 }
313
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700314 if len(globalSanitizersDiag) > 0 {
315 ctx.ModuleErrorf("unknown global sanitizer diagnostics option %s", globalSanitizersDiag[0])
316 }
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700317 }
Colin Cross3c344ef2016-07-18 15:44:56 -0700318
Vishwath Mohan1c54f662018-05-24 18:36:18 -0700319 // Enable CFI for all components in the include paths (for Aarch64 only)
320 if s.Cfi == nil && ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) && ctx.Arch().ArchType == android.Arm64 {
Vishwath Mohan3af8ee02018-03-30 02:55:23 +0000321 s.Cfi = boolPtr(true)
322 if inList("cfi", ctx.Config().SanitizeDeviceDiag()) {
323 s.Diag.Cfi = boolPtr(true)
Vishwath Mohan1fa3ac52017-10-31 02:26:14 -0700324 }
325 }
326
Elliott Hughesda3a0712020-03-06 16:55:28 -0800327 // Is CFI actually enabled?
328 if !ctx.Config().EnableCFI() {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900329 s.Cfi = boolPtr(false)
330 s.Diag.Cfi = boolPtr(false)
Vishwath Mohan1b017a72017-01-19 13:54:55 -0800331 }
332
Vishwath Mohan6d67e6e2017-02-07 20:31:41 -0800333 // Also disable CFI for arm32 until b/35157333 is fixed.
334 if ctx.Arch().ArchType == android.Arm {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900335 s.Cfi = boolPtr(false)
336 s.Diag.Cfi = boolPtr(false)
Vishwath Mohan6d67e6e2017-02-07 20:31:41 -0800337 }
338
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700339 // HWASan requires AArch64 hardware feature (top-byte-ignore).
340 if ctx.Arch().ArchType != android.Arm64 {
341 s.Hwaddress = nil
342 }
343
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800344 // SCS is only implemented on AArch64.
Peter Collingbournebd19db02019-03-06 10:38:48 -0800345 if ctx.Arch().ArchType != android.Arm64 {
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800346 s.Scs = nil
347 }
348
Vishwath Mohan8f4fdd82017-04-20 07:42:52 -0700349 // Also disable CFI if ASAN is enabled.
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700350 if Bool(s.Address) || Bool(s.Hwaddress) {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900351 s.Cfi = boolPtr(false)
352 s.Diag.Cfi = boolPtr(false)
Vishwath Mohan8f4fdd82017-04-20 07:42:52 -0700353 }
354
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500355 // Disable sanitizers that depend on the UBSan runtime for windows/darwin builds.
356 if !ctx.Os().Linux() {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900357 s.Cfi = boolPtr(false)
358 s.Diag.Cfi = boolPtr(false)
Ivan Lozanoa9255a82018-03-13 10:41:07 -0700359 s.Misc_undefined = nil
360 s.Undefined = nil
361 s.All_undefined = nil
362 s.Integer_overflow = nil
Vishwath Mohane7128792017-11-17 11:08:10 -0800363 }
364
Vishwath Mohan9ccbba02018-05-28 13:54:48 -0700365 // Also disable CFI for VNDK variants of components
366 if ctx.isVndk() && ctx.useVndk() {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900367 if ctx.static() {
368 // Cfi variant for static vndk should be captured as vendor snapshot,
369 // so don't strictly disable Cfi.
370 s.Cfi = nil
371 s.Diag.Cfi = nil
372 } else {
373 s.Cfi = boolPtr(false)
374 s.Diag.Cfi = boolPtr(false)
375 }
Inseob Kimeec88e12020-01-22 11:11:29 +0900376 }
377
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700378 // HWASan ramdisk (which is built from recovery) goes over some bootloader limit.
Yifan Hong1b3348d2020-01-21 15:53:22 -0800379 // Keep libc instrumented so that ramdisk / recovery can run hwasan-instrumented code if necessary.
380 if (ctx.inRamdisk() || ctx.inRecovery()) && !strings.HasPrefix(ctx.ModuleDir(), "bionic/libc") {
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700381 s.Hwaddress = nil
382 }
383
Colin Cross3c344ef2016-07-18 15:44:56 -0700384 if ctx.staticBinary() {
385 s.Address = nil
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700386 s.Fuzzer = nil
Colin Cross3c344ef2016-07-18 15:44:56 -0700387 s.Thread = nil
Colin Cross16b23492016-01-06 14:41:07 -0800388 }
389
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700390 if Bool(s.All_undefined) {
391 s.Undefined = nil
392 }
393
Evgenii Stepanov0a8a0d02016-05-12 13:54:53 -0700394 if !ctx.toolchain().Is64Bit() {
395 // TSAN and SafeStack are not supported on 32-bit architectures
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700396 s.Thread = nil
397 s.Safestack = nil
Colin Cross16b23492016-01-06 14:41:07 -0800398 // TODO(ccross): error for compile_multilib = "32"?
399 }
400
Evgenii Stepanov76cee232017-01-27 15:44:44 -0800401 if ctx.Os() != android.Windows && (Bool(s.All_undefined) || Bool(s.Undefined) || Bool(s.Address) || Bool(s.Thread) ||
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700402 Bool(s.Fuzzer) || Bool(s.Safestack) || Bool(s.Cfi) || Bool(s.Integer_overflow) || len(s.Misc_undefined) > 0 ||
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800403 Bool(s.Scudo) || Bool(s.Hwaddress) || Bool(s.Scs)) {
Colin Cross3c344ef2016-07-18 15:44:56 -0700404 sanitize.Properties.SanitizerEnabled = true
405 }
406
Kostya Kortchinskyd5275c82019-02-01 08:42:56 -0800407 // Disable Scudo if ASan or TSan is enabled, or if it's disabled globally.
408 if Bool(s.Address) || Bool(s.Thread) || Bool(s.Hwaddress) || ctx.Config().DisableScudo() {
Kostya Kortchinskyd18ae5c2018-06-12 14:46:54 -0700409 s.Scudo = nil
410 }
411
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700412 if Bool(s.Hwaddress) {
413 s.Address = nil
414 s.Thread = nil
415 }
416
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700417 // TODO(b/131771163): CFI transiently depends on LTO, and thus Fuzzer is
418 // mutually incompatible.
419 if Bool(s.Fuzzer) {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900420 s.Cfi = boolPtr(false)
Colin Cross16b23492016-01-06 14:41:07 -0800421 }
422}
423
424func (sanitize *sanitize) deps(ctx BaseModuleContext, deps Deps) Deps {
425 if !sanitize.Properties.SanitizerEnabled { // || c.static() {
426 return deps
427 }
428
Colin Cross16b23492016-01-06 14:41:07 -0800429 return deps
430}
431
Chih-Hung Hsieh3567e622018-11-15 14:01:36 -0800432func toDisableImplicitIntegerChange(flags []string) bool {
433 // Returns true if any flag is fsanitize*integer, and there is
434 // no explicit flag about sanitize=implicit-integer-sign-change.
435 for _, f := range flags {
436 if strings.Contains(f, "sanitize=implicit-integer-sign-change") {
437 return false
438 }
439 }
440 for _, f := range flags {
441 if strings.HasPrefix(f, "-fsanitize") && strings.Contains(f, "integer") {
442 return true
443 }
444 }
445 return false
446}
447
Colin Cross16b23492016-01-06 14:41:07 -0800448func (sanitize *sanitize) flags(ctx ModuleContext, flags Flags) Flags {
Ivan Lozano59fdea22018-05-10 14:17:22 -0700449 minimalRuntimeLib := config.UndefinedBehaviorSanitizerMinimalRuntimeLibrary(ctx.toolchain()) + ".a"
450 minimalRuntimePath := "${config.ClangAsanLibDir}/" + minimalRuntimeLib
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500451 builtinsRuntimeLib := config.BuiltinsRuntimeLibrary(ctx.toolchain()) + ".a"
452 builtinsRuntimePath := "${config.ClangAsanLibDir}/" + builtinsRuntimeLib
Ivan Lozano30c5db22018-02-21 15:49:20 -0800453
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500454 if sanitize.Properties.MinimalRuntimeDep {
Colin Cross4af21ed2019-11-04 09:37:55 -0800455 flags.Local.LdFlags = append(flags.Local.LdFlags,
456 minimalRuntimePath,
457 "-Wl,--exclude-libs,"+minimalRuntimeLib)
Ivan Lozano30c5db22018-02-21 15:49:20 -0800458 }
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500459
460 if sanitize.Properties.BuiltinsDep {
461 flags.libFlags = append([]string{builtinsRuntimePath}, flags.libFlags...)
462 }
463
Ivan Lozanoa9255a82018-03-13 10:41:07 -0700464 if !sanitize.Properties.SanitizerEnabled && !sanitize.Properties.UbsanRuntimeDep {
Colin Cross16b23492016-01-06 14:41:07 -0800465 return flags
466 }
467
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700468 if Bool(sanitize.Properties.Sanitize.Address) {
Colin Cross635c3b02016-05-18 15:37:25 -0700469 if ctx.Arch().ArchType == android.Arm {
Colin Cross16b23492016-01-06 14:41:07 -0800470 // Frame pointer based unwinder in ASan requires ARM frame setup.
471 // TODO: put in flags?
472 flags.RequiredInstructionSet = "arm"
473 }
Colin Cross4af21ed2019-11-04 09:37:55 -0800474 flags.Local.CFlags = append(flags.Local.CFlags, asanCflags...)
475 flags.Local.LdFlags = append(flags.Local.LdFlags, asanLdflags...)
Colin Cross16b23492016-01-06 14:41:07 -0800476
Jasraj Bedibb4511d2020-07-23 22:58:17 +0000477 if Bool(sanitize.Properties.Sanitize.Writeonly) {
478 flags.Local.CFlags = append(flags.Local.CFlags, "-mllvm", "-asan-instrument-reads=0")
479 }
480
Colin Cross16b23492016-01-06 14:41:07 -0800481 if ctx.Host() {
482 // -nodefaultlibs (provided with libc++) prevents the driver from linking
483 // libraries needed with -fsanitize=address. http://b/18650275 (WAI)
Colin Cross4af21ed2019-11-04 09:37:55 -0800484 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--no-as-needed")
Colin Cross16b23492016-01-06 14:41:07 -0800485 } else {
Colin Cross4af21ed2019-11-04 09:37:55 -0800486 flags.Local.CFlags = append(flags.Local.CFlags, "-mllvm", "-asan-globals=0")
Jiyong Parka2aca282019-02-02 13:13:38 +0900487 if ctx.bootstrap() {
488 flags.DynamicLinker = "/system/bin/bootstrap/linker_asan"
489 } else {
490 flags.DynamicLinker = "/system/bin/linker_asan"
491 }
Colin Cross16b23492016-01-06 14:41:07 -0800492 if flags.Toolchain.Is64Bit() {
493 flags.DynamicLinker += "64"
494 }
495 }
Colin Cross16b23492016-01-06 14:41:07 -0800496 }
497
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700498 if Bool(sanitize.Properties.Sanitize.Hwaddress) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800499 flags.Local.CFlags = append(flags.Local.CFlags, hwasanCflags...)
Jasraj Bedibb4511d2020-07-23 22:58:17 +0000500 if Bool(sanitize.Properties.Sanitize.Writeonly) {
501 flags.Local.CFlags = append(flags.Local.CFlags, "-mllvm", "-hwasan-instrument-reads=0")
502 }
Yabin Cui6be405e2017-10-19 15:52:11 -0700503 }
504
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700505 if Bool(sanitize.Properties.Sanitize.Fuzzer) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800506 flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize=fuzzer-no-link")
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700507
508 // TODO(b/131771163): LTO and Fuzzer support is mutually incompatible.
Colin Cross4af21ed2019-11-04 09:37:55 -0800509 _, flags.Local.LdFlags = removeFromList("-flto", flags.Local.LdFlags)
510 _, flags.Local.CFlags = removeFromList("-flto", flags.Local.CFlags)
511 flags.Local.LdFlags = append(flags.Local.LdFlags, "-fno-lto")
512 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-lto")
Mitch Phillips74384752019-06-17 10:33:52 -0700513
Mitch Phillipsb8e593d2019-10-09 17:18:59 -0700514 // TODO(b/142430592): Upstream linker scripts for sanitizer runtime libraries
515 // discard the sancov_lowest_stack symbol, because it's emulated TLS (and thus
516 // doesn't match the linker script due to the "__emutls_v." prefix).
Colin Cross4af21ed2019-11-04 09:37:55 -0800517 flags.Local.LdFlags = append(flags.Local.LdFlags, "-fno-sanitize-coverage=stack-depth")
518 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-coverage=stack-depth")
Mitch Phillipsb8e593d2019-10-09 17:18:59 -0700519
Mitch Phillips74384752019-06-17 10:33:52 -0700520 // TODO(b/133876586): Experimental PM breaks sanitizer coverage.
Colin Cross4af21ed2019-11-04 09:37:55 -0800521 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-experimental-new-pass-manager")
Mitch Phillipsb9b3e792019-08-28 12:41:07 -0700522
523 // Disable fortify for fuzzing builds. Generally, we'll be building with
524 // UBSan or ASan here and the fortify checks pollute the stack traces.
Colin Cross4af21ed2019-11-04 09:37:55 -0800525 flags.Local.CFlags = append(flags.Local.CFlags, "-U_FORTIFY_SOURCE")
Mitch Phillips734b4cb2019-12-10 08:44:52 -0800526
527 // Build fuzzer-sanitized libraries with an $ORIGIN DT_RUNPATH. Android's
528 // linker uses DT_RUNPATH, not DT_RPATH. When we deploy cc_fuzz targets and
529 // their libraries to /data/fuzz/<arch>/lib, any transient shared library gets
530 // the DT_RUNPATH from the shared library above it, and not the executable,
531 // meaning that the lookup falls back to the system. Adding the $ORIGIN to the
532 // DT_RUNPATH here means that transient shared libraries can be found
533 // colocated with their parents.
534 flags.Local.LdFlags = append(flags.Local.LdFlags, `-Wl,-rpath,\$$ORIGIN`)
Colin Cross16b23492016-01-06 14:41:07 -0800535 }
536
Evgenii Stepanov1e405e12016-08-16 15:39:54 -0700537 if Bool(sanitize.Properties.Sanitize.Cfi) {
Evgenii Stepanov7ebf9fa2017-01-20 14:13:06 -0800538 if ctx.Arch().ArchType == android.Arm {
539 // __cfi_check needs to be built as Thumb (see the code in linker_cfi.cpp). LLVM is not set up
540 // to do this on a function basis, so force Thumb on the entire module.
541 flags.RequiredInstructionSet = "thumb"
542 }
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000543
Colin Cross4af21ed2019-11-04 09:37:55 -0800544 flags.Local.CFlags = append(flags.Local.CFlags, cfiCflags...)
545 flags.Local.AsFlags = append(flags.Local.AsFlags, cfiAsflags...)
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000546 // Only append the default visibility flag if -fvisibility has not already been set
547 // to hidden.
Colin Cross4af21ed2019-11-04 09:37:55 -0800548 if !inList("-fvisibility=hidden", flags.Local.CFlags) {
549 flags.Local.CFlags = append(flags.Local.CFlags, "-fvisibility=default")
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000550 }
Colin Cross4af21ed2019-11-04 09:37:55 -0800551 flags.Local.LdFlags = append(flags.Local.LdFlags, cfiLdflags...)
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000552
553 if ctx.staticBinary() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800554 _, flags.Local.CFlags = removeFromList("-fsanitize-cfi-cross-dso", flags.Local.CFlags)
555 _, flags.Local.LdFlags = removeFromList("-fsanitize-cfi-cross-dso", flags.Local.LdFlags)
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000556 }
Evgenii Stepanov1e405e12016-08-16 15:39:54 -0700557 }
558
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700559 if Bool(sanitize.Properties.Sanitize.Integer_overflow) {
Colin Cross4af21ed2019-11-04 09:37:55 -0800560 flags.Local.CFlags = append(flags.Local.CFlags, intOverflowCflags...)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700561 }
562
Jiyong Park379de2f2018-12-19 02:47:14 +0900563 if len(sanitize.Properties.Sanitizers) > 0 {
564 sanitizeArg := "-fsanitize=" + strings.Join(sanitize.Properties.Sanitizers, ",")
Ivan Lozano30c5db22018-02-21 15:49:20 -0800565
Colin Cross4af21ed2019-11-04 09:37:55 -0800566 flags.Local.CFlags = append(flags.Local.CFlags, sanitizeArg)
567 flags.Local.AsFlags = append(flags.Local.AsFlags, sanitizeArg)
Colin Cross16b23492016-01-06 14:41:07 -0800568 if ctx.Host() {
Evgenii Stepanov76cee232017-01-27 15:44:44 -0800569 // Host sanitizers only link symbols in the final executable, so
570 // there will always be undefined symbols in intermediate libraries.
Colin Cross4af21ed2019-11-04 09:37:55 -0800571 _, flags.Global.LdFlags = removeFromList("-Wl,--no-undefined", flags.Global.LdFlags)
572 flags.Local.LdFlags = append(flags.Local.LdFlags, sanitizeArg)
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500573
574 // non-Bionic toolchain prebuilts are missing UBSan's vptr and function sanitizers
575 if !ctx.toolchain().Bionic() {
576 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize=vptr,function")
577 }
578 }
579
580 if enableMinimalRuntime(sanitize) {
581 flags.Local.CFlags = append(flags.Local.CFlags, strings.Join(minimalRuntimeFlags, " "))
582 flags.libFlags = append([]string{minimalRuntimePath}, flags.libFlags...)
583 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--exclude-libs,"+minimalRuntimeLib)
584 if !ctx.toolchain().Bionic() {
585 flags.libFlags = append([]string{builtinsRuntimePath}, flags.libFlags...)
Ivan Lozano30c5db22018-02-21 15:49:20 -0800586 }
Colin Cross16b23492016-01-06 14:41:07 -0800587 }
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700588
589 if Bool(sanitize.Properties.Sanitize.Fuzzer) {
590 // When fuzzing, we wish to crash with diagnostics on any bug.
Colin Cross4af21ed2019-11-04 09:37:55 -0800591 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-trap=all", "-fno-sanitize-recover=all")
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700592 } else if ctx.Host() {
Colin Cross4af21ed2019-11-04 09:37:55 -0800593 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-recover=all")
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700594 } else {
Colin Cross4af21ed2019-11-04 09:37:55 -0800595 flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize-trap=all", "-ftrap-function=abort")
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700596 }
Chih-Hung Hsieh3567e622018-11-15 14:01:36 -0800597 // http://b/119329758, Android core does not boot up with this sanitizer yet.
Colin Cross4af21ed2019-11-04 09:37:55 -0800598 if toDisableImplicitIntegerChange(flags.Local.CFlags) {
599 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize=implicit-integer-sign-change")
Chih-Hung Hsieh3567e622018-11-15 14:01:36 -0800600 }
Colin Cross16b23492016-01-06 14:41:07 -0800601 }
602
Jiyong Park379de2f2018-12-19 02:47:14 +0900603 if len(sanitize.Properties.DiagSanitizers) > 0 {
Colin Cross4af21ed2019-11-04 09:37:55 -0800604 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-trap="+strings.Join(sanitize.Properties.DiagSanitizers, ","))
Evgenii Stepanov1e405e12016-08-16 15:39:54 -0700605 }
606 // FIXME: enable RTTI if diag + (cfi or vptr)
607
Andreas Gampe97071162017-05-08 13:15:23 -0700608 if sanitize.Properties.Sanitize.Recover != nil {
Colin Cross4af21ed2019-11-04 09:37:55 -0800609 flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize-recover="+
Andreas Gampe97071162017-05-08 13:15:23 -0700610 strings.Join(sanitize.Properties.Sanitize.Recover, ","))
611 }
612
Ivan Lozano7929bba2018-12-12 09:36:31 -0800613 if sanitize.Properties.Sanitize.Diag.No_recover != nil {
Colin Cross4af21ed2019-11-04 09:37:55 -0800614 flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-recover="+
Ivan Lozano7929bba2018-12-12 09:36:31 -0800615 strings.Join(sanitize.Properties.Sanitize.Diag.No_recover, ","))
616 }
617
Pirama Arumuga Nainar6c4ccca2020-07-27 11:49:51 -0700618 blocklist := android.OptionalPathForModuleSrc(ctx, sanitize.Properties.Sanitize.Blocklist)
619 if blocklist.Valid() {
620 flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize-blacklist="+blocklist.String())
621 flags.CFlagsDeps = append(flags.CFlagsDeps, blocklist.Path())
622 }
623
Colin Cross16b23492016-01-06 14:41:07 -0800624 return flags
625}
626
Colin Crossd80cbca2020-02-24 12:01:37 -0800627func (sanitize *sanitize) AndroidMkEntries(ctx AndroidMkContext, entries *android.AndroidMkEntries) {
Jiyong Park1d1119f2019-07-29 21:27:18 +0900628 // Add a suffix for cfi/hwasan/scs-enabled static/header libraries to allow surfacing
629 // both the sanitized and non-sanitized variants to make without a name conflict.
Colin Crossd80cbca2020-02-24 12:01:37 -0800630 if entries.Class == "STATIC_LIBRARIES" || entries.Class == "HEADER_LIBRARIES" {
Jiyong Park1d1119f2019-07-29 21:27:18 +0900631 if Bool(sanitize.Properties.Sanitize.Cfi) {
Colin Crossd80cbca2020-02-24 12:01:37 -0800632 entries.SubName += ".cfi"
Jiyong Park1d1119f2019-07-29 21:27:18 +0900633 }
634 if Bool(sanitize.Properties.Sanitize.Hwaddress) {
Colin Crossd80cbca2020-02-24 12:01:37 -0800635 entries.SubName += ".hwasan"
Jiyong Park1d1119f2019-07-29 21:27:18 +0900636 }
637 if Bool(sanitize.Properties.Sanitize.Scs) {
Colin Crossd80cbca2020-02-24 12:01:37 -0800638 entries.SubName += ".scs"
Jiyong Park1d1119f2019-07-29 21:27:18 +0900639 }
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800640 }
Colin Cross8ff9ef42017-05-08 13:44:11 -0700641}
642
Vishwath Mohan1dd88392017-03-29 22:00:18 -0700643func (sanitize *sanitize) inSanitizerDir() bool {
644 return sanitize.Properties.InSanitizerDir
Colin Cross30d5f512016-05-03 18:02:42 -0700645}
646
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000647func (sanitize *sanitize) getSanitizerBoolPtr(t sanitizerType) *bool {
Vishwath Mohan95229302017-08-11 00:53:16 +0000648 switch t {
649 case asan:
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000650 return sanitize.Properties.Sanitize.Address
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700651 case hwasan:
652 return sanitize.Properties.Sanitize.Hwaddress
Vishwath Mohan95229302017-08-11 00:53:16 +0000653 case tsan:
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000654 return sanitize.Properties.Sanitize.Thread
Vishwath Mohan95229302017-08-11 00:53:16 +0000655 case intOverflow:
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000656 return sanitize.Properties.Sanitize.Integer_overflow
657 case cfi:
658 return sanitize.Properties.Sanitize.Cfi
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800659 case scs:
660 return sanitize.Properties.Sanitize.Scs
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700661 case fuzzer:
662 return sanitize.Properties.Sanitize.Fuzzer
Vishwath Mohan95229302017-08-11 00:53:16 +0000663 default:
664 panic(fmt.Errorf("unknown sanitizerType %d", t))
665 }
666}
667
Dan Albert7d1eecf2018-01-19 12:30:45 -0800668func (sanitize *sanitize) isUnsanitizedVariant() bool {
669 return !sanitize.isSanitizerEnabled(asan) &&
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700670 !sanitize.isSanitizerEnabled(hwasan) &&
Dan Albert7d1eecf2018-01-19 12:30:45 -0800671 !sanitize.isSanitizerEnabled(tsan) &&
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800672 !sanitize.isSanitizerEnabled(cfi) &&
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700673 !sanitize.isSanitizerEnabled(scs) &&
674 !sanitize.isSanitizerEnabled(fuzzer)
Dan Albert7d1eecf2018-01-19 12:30:45 -0800675}
676
Jayant Chowdharyb7e08ca2018-05-10 15:29:24 -0700677func (sanitize *sanitize) isVariantOnProductionDevice() bool {
678 return !sanitize.isSanitizerEnabled(asan) &&
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700679 !sanitize.isSanitizerEnabled(hwasan) &&
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700680 !sanitize.isSanitizerEnabled(tsan) &&
681 !sanitize.isSanitizerEnabled(fuzzer)
Jayant Chowdharyb7e08ca2018-05-10 15:29:24 -0700682}
683
Colin Cross16b23492016-01-06 14:41:07 -0800684func (sanitize *sanitize) SetSanitizer(t sanitizerType, b bool) {
685 switch t {
686 case asan:
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700687 sanitize.Properties.Sanitize.Address = boolPtr(b)
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700688 case hwasan:
689 sanitize.Properties.Sanitize.Hwaddress = boolPtr(b)
Colin Cross16b23492016-01-06 14:41:07 -0800690 case tsan:
Evgenii Stepanovfcfe56d2016-07-07 10:54:07 -0700691 sanitize.Properties.Sanitize.Thread = boolPtr(b)
Ivan Lozano0c3a1ef2017-06-28 09:10:48 -0700692 case intOverflow:
693 sanitize.Properties.Sanitize.Integer_overflow = boolPtr(b)
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000694 case cfi:
695 sanitize.Properties.Sanitize.Cfi = boolPtr(b)
Peter Collingbourne8c7e6e22018-11-19 16:03:58 -0800696 case scs:
697 sanitize.Properties.Sanitize.Scs = boolPtr(b)
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700698 case fuzzer:
699 sanitize.Properties.Sanitize.Fuzzer = boolPtr(b)
Colin Cross16b23492016-01-06 14:41:07 -0800700 default:
701 panic(fmt.Errorf("unknown sanitizerType %d", t))
702 }
703 if b {
704 sanitize.Properties.SanitizerEnabled = true
705 }
706}
707
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000708// Check if the sanitizer is explicitly disabled (as opposed to nil by
709// virtue of not being set).
710func (sanitize *sanitize) isSanitizerExplicitlyDisabled(t sanitizerType) bool {
711 if sanitize == nil {
712 return false
713 }
714
715 sanitizerVal := sanitize.getSanitizerBoolPtr(t)
716 return sanitizerVal != nil && *sanitizerVal == false
717}
718
719// There isn't an analog of the method above (ie:isSanitizerExplicitlyEnabled)
720// because enabling a sanitizer either directly (via the blueprint) or
721// indirectly (via a mutator) sets the bool ptr to true, and you can't
722// distinguish between the cases. It isn't needed though - both cases can be
723// treated identically.
724func (sanitize *sanitize) isSanitizerEnabled(t sanitizerType) bool {
725 if sanitize == nil {
726 return false
727 }
728
729 sanitizerVal := sanitize.getSanitizerBoolPtr(t)
730 return sanitizerVal != nil && *sanitizerVal == true
731}
732
Colin Cross6b753602018-06-21 13:03:07 -0700733func isSanitizableDependencyTag(tag blueprint.DependencyTag) bool {
Colin Cross6e511a92020-07-27 21:26:48 -0700734 switch t := tag.(type) {
735 case dependencyTag:
736 return t == reuseObjTag || t == objDepTag
737 case libraryDependencyTag:
738 return true
739 default:
740 return false
741 }
Colin Cross6b753602018-06-21 13:03:07 -0700742}
743
Inseob Kimc42f2f22020-07-29 20:32:10 +0900744// Determines if the current module is a static library going to be captured
745// as vendor snapshot. Such modules must create both cfi and non-cfi variants,
746// except for ones which explicitly disable cfi.
747func needsCfiForVendorSnapshot(mctx android.TopDownMutatorContext) bool {
Bill Peckham945441c2020-08-31 16:07:58 -0700748 if isVendorProprietaryModule(mctx) {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900749 return false
750 }
751
752 c := mctx.Module().(*Module)
753
754 if !c.inVendor() {
755 return false
756 }
757
758 if !c.static() {
759 return false
760 }
761
762 if c.Prebuilt() != nil {
763 return false
764 }
765
766 return c.sanitize != nil &&
767 !Bool(c.sanitize.Properties.Sanitize.Never) &&
768 !c.sanitize.isSanitizerExplicitlyDisabled(cfi)
769}
770
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700771// Propagate sanitizer requirements down from binaries
Colin Cross635c3b02016-05-18 15:37:25 -0700772func sanitizerDepsMutator(t sanitizerType) func(android.TopDownMutatorContext) {
773 return func(mctx android.TopDownMutatorContext) {
Inseob Kimc42f2f22020-07-29 20:32:10 +0900774 if c, ok := mctx.Module().(*Module); ok {
775 enabled := c.sanitize.isSanitizerEnabled(t)
776 if t == cfi && needsCfiForVendorSnapshot(mctx) {
777 // We shouldn't change the result of isSanitizerEnabled(cfi) to correctly
778 // determine defaultVariation in sanitizerMutator below.
779 // Instead, just mark SanitizeDep to forcefully create cfi variant.
780 enabled = true
781 c.sanitize.Properties.SanitizeDep = true
782 }
783 if enabled {
784 mctx.WalkDeps(func(child, parent android.Module) bool {
785 if !isSanitizableDependencyTag(mctx.OtherModuleDependencyTag(child)) {
786 return false
787 }
788 if d, ok := child.(*Module); ok && d.sanitize != nil &&
789 !Bool(d.sanitize.Properties.Sanitize.Never) &&
790 !d.sanitize.isSanitizerExplicitlyDisabled(t) {
791 if t == cfi || t == hwasan || t == scs {
792 if d.static() {
793 d.sanitize.Properties.SanitizeDep = true
794 }
795 } else {
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -0700796 d.sanitize.Properties.SanitizeDep = true
797 }
Vishwath Mohanb743e9c2017-11-01 09:20:21 +0000798 }
Inseob Kimc42f2f22020-07-29 20:32:10 +0900799 return true
800 })
801 }
Jiyong Parkf97782b2019-02-13 20:28:58 +0900802 } else if sanitizeable, ok := mctx.Module().(Sanitizeable); ok {
803 // If an APEX module includes a lib which is enabled for a sanitizer T, then
804 // the APEX module is also enabled for the same sanitizer type.
805 mctx.VisitDirectDeps(func(child android.Module) {
806 if c, ok := child.(*Module); ok && c.sanitize.isSanitizerEnabled(t) {
807 sanitizeable.EnableSanitizer(t.name())
808 }
809 })
Colin Cross16b23492016-01-06 14:41:07 -0800810 }
811 }
812}
813
Ivan Lozano30c5db22018-02-21 15:49:20 -0800814// Propagate the ubsan minimal runtime dependency when there are integer overflow sanitized static dependencies.
Colin Cross6b753602018-06-21 13:03:07 -0700815func sanitizerRuntimeDepsMutator(mctx android.TopDownMutatorContext) {
816 if c, ok := mctx.Module().(*Module); ok && c.sanitize != nil {
817 mctx.WalkDeps(func(child, parent android.Module) bool {
818 if !isSanitizableDependencyTag(mctx.OtherModuleDependencyTag(child)) {
819 return false
820 }
Ivan Lozano30c5db22018-02-21 15:49:20 -0800821
Inseob Kimeec88e12020-01-22 11:11:29 +0900822 d, ok := child.(*Module)
823 if !ok || !d.static() {
824 return false
825 }
826 if d.sanitize != nil {
Colin Cross6b753602018-06-21 13:03:07 -0700827 if enableMinimalRuntime(d.sanitize) {
828 // If a static dependency is built with the minimal runtime,
829 // make sure we include the ubsan minimal runtime.
830 c.sanitize.Properties.MinimalRuntimeDep = true
Inseob Kim8471cda2019-11-15 09:59:12 +0900831 } else if enableUbsanRuntime(d.sanitize) {
Colin Cross6b753602018-06-21 13:03:07 -0700832 // If a static dependency runs with full ubsan diagnostics,
833 // make sure we include the ubsan runtime.
834 c.sanitize.Properties.UbsanRuntimeDep = true
Ivan Lozano30c5db22018-02-21 15:49:20 -0800835 }
Colin Cross0b908332019-06-19 23:00:20 -0700836
837 if c.sanitize.Properties.MinimalRuntimeDep &&
838 c.sanitize.Properties.UbsanRuntimeDep {
839 // both flags that this mutator might set are true, so don't bother recursing
840 return false
841 }
842
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500843 if c.Os() == android.Linux {
844 c.sanitize.Properties.BuiltinsDep = true
845 }
846
Colin Cross0b908332019-06-19 23:00:20 -0700847 return true
Colin Cross6b753602018-06-21 13:03:07 -0700848 }
Inseob Kimeec88e12020-01-22 11:11:29 +0900849
850 if p, ok := d.linker.(*vendorSnapshotLibraryDecorator); ok {
851 if Bool(p.properties.Sanitize_minimal_dep) {
852 c.sanitize.Properties.MinimalRuntimeDep = true
853 }
854 if Bool(p.properties.Sanitize_ubsan_dep) {
855 c.sanitize.Properties.UbsanRuntimeDep = true
856 }
857 }
858
859 return false
Colin Cross6b753602018-06-21 13:03:07 -0700860 })
Ivan Lozano30c5db22018-02-21 15:49:20 -0800861 }
862}
863
Jiyong Park379de2f2018-12-19 02:47:14 +0900864// Add the dependency to the runtime library for each of the sanitizer variants
865func sanitizerRuntimeMutator(mctx android.BottomUpMutatorContext) {
Jiyong Park379de2f2018-12-19 02:47:14 +0900866 if c, ok := mctx.Module().(*Module); ok && c.sanitize != nil {
Pirama Arumuga Nainar6aa21022019-01-25 00:20:35 +0000867 if !c.Enabled() {
868 return
869 }
Jiyong Park379de2f2018-12-19 02:47:14 +0900870 var sanitizers []string
871 var diagSanitizers []string
872
873 if Bool(c.sanitize.Properties.Sanitize.All_undefined) {
874 sanitizers = append(sanitizers, "undefined")
875 } else {
876 if Bool(c.sanitize.Properties.Sanitize.Undefined) {
877 sanitizers = append(sanitizers,
878 "bool",
879 "integer-divide-by-zero",
880 "return",
881 "returns-nonnull-attribute",
882 "shift-exponent",
883 "unreachable",
884 "vla-bound",
885 // TODO(danalbert): The following checks currently have compiler performance issues.
886 //"alignment",
887 //"bounds",
888 //"enum",
889 //"float-cast-overflow",
890 //"float-divide-by-zero",
891 //"nonnull-attribute",
892 //"null",
893 //"shift-base",
894 //"signed-integer-overflow",
895 // TODO(danalbert): Fix UB in libc++'s __tree so we can turn this on.
896 // https://llvm.org/PR19302
897 // http://reviews.llvm.org/D6974
898 // "object-size",
899 )
900 }
901 sanitizers = append(sanitizers, c.sanitize.Properties.Sanitize.Misc_undefined...)
902 }
903
904 if Bool(c.sanitize.Properties.Sanitize.Diag.Undefined) {
905 diagSanitizers = append(diagSanitizers, "undefined")
906 }
907
908 diagSanitizers = append(diagSanitizers, c.sanitize.Properties.Sanitize.Diag.Misc_undefined...)
909
910 if Bool(c.sanitize.Properties.Sanitize.Address) {
911 sanitizers = append(sanitizers, "address")
912 diagSanitizers = append(diagSanitizers, "address")
913 }
914
915 if Bool(c.sanitize.Properties.Sanitize.Hwaddress) {
916 sanitizers = append(sanitizers, "hwaddress")
917 }
918
919 if Bool(c.sanitize.Properties.Sanitize.Thread) {
920 sanitizers = append(sanitizers, "thread")
921 }
922
923 if Bool(c.sanitize.Properties.Sanitize.Safestack) {
924 sanitizers = append(sanitizers, "safe-stack")
925 }
926
927 if Bool(c.sanitize.Properties.Sanitize.Cfi) {
928 sanitizers = append(sanitizers, "cfi")
929
930 if Bool(c.sanitize.Properties.Sanitize.Diag.Cfi) {
931 diagSanitizers = append(diagSanitizers, "cfi")
932 }
933 }
934
935 if Bool(c.sanitize.Properties.Sanitize.Integer_overflow) {
936 sanitizers = append(sanitizers, "unsigned-integer-overflow")
937 sanitizers = append(sanitizers, "signed-integer-overflow")
938 if Bool(c.sanitize.Properties.Sanitize.Diag.Integer_overflow) {
939 diagSanitizers = append(diagSanitizers, "unsigned-integer-overflow")
940 diagSanitizers = append(diagSanitizers, "signed-integer-overflow")
941 }
942 }
943
944 if Bool(c.sanitize.Properties.Sanitize.Scudo) {
945 sanitizers = append(sanitizers, "scudo")
946 }
947
948 if Bool(c.sanitize.Properties.Sanitize.Scs) {
949 sanitizers = append(sanitizers, "shadow-call-stack")
950 }
951
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -0700952 if Bool(c.sanitize.Properties.Sanitize.Fuzzer) {
953 sanitizers = append(sanitizers, "fuzzer-no-link")
954 }
955
Jiyong Park379de2f2018-12-19 02:47:14 +0900956 // Save the list of sanitizers. These will be used again when generating
957 // the build rules (for Cflags, etc.)
958 c.sanitize.Properties.Sanitizers = sanitizers
959 c.sanitize.Properties.DiagSanitizers = diagSanitizers
960
Ivan Lozanof3b190f2020-03-06 12:01:21 -0500961 // TODO(b/150822854) Hosts have a different default behavior and assume the runtime library is used.
962 if c.Host() {
963 diagSanitizers = sanitizers
964 }
965
Jiyong Park379de2f2018-12-19 02:47:14 +0900966 // Determine the runtime library required
967 runtimeLibrary := ""
Ryan Prichardb49fe1b2019-10-11 15:03:34 -0700968 var extraStaticDeps []string
Jiyong Park379de2f2018-12-19 02:47:14 +0900969 toolchain := c.toolchain(mctx)
970 if Bool(c.sanitize.Properties.Sanitize.Address) {
971 runtimeLibrary = config.AddressSanitizerRuntimeLibrary(toolchain)
972 } else if Bool(c.sanitize.Properties.Sanitize.Hwaddress) {
973 if c.staticBinary() {
974 runtimeLibrary = config.HWAddressSanitizerStaticLibrary(toolchain)
Ryan Prichardb49fe1b2019-10-11 15:03:34 -0700975 extraStaticDeps = []string{"libdl"}
Jiyong Park379de2f2018-12-19 02:47:14 +0900976 } else {
977 runtimeLibrary = config.HWAddressSanitizerRuntimeLibrary(toolchain)
978 }
979 } else if Bool(c.sanitize.Properties.Sanitize.Thread) {
980 runtimeLibrary = config.ThreadSanitizerRuntimeLibrary(toolchain)
981 } else if Bool(c.sanitize.Properties.Sanitize.Scudo) {
982 if len(diagSanitizers) == 0 && !c.sanitize.Properties.UbsanRuntimeDep {
983 runtimeLibrary = config.ScudoMinimalRuntimeLibrary(toolchain)
984 } else {
985 runtimeLibrary = config.ScudoRuntimeLibrary(toolchain)
986 }
Mitch Phillipsb8e593d2019-10-09 17:18:59 -0700987 } else if len(diagSanitizers) > 0 || c.sanitize.Properties.UbsanRuntimeDep ||
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500988 Bool(c.sanitize.Properties.Sanitize.Fuzzer) ||
989 Bool(c.sanitize.Properties.Sanitize.Undefined) ||
990 Bool(c.sanitize.Properties.Sanitize.All_undefined) {
Jiyong Park379de2f2018-12-19 02:47:14 +0900991 runtimeLibrary = config.UndefinedBehaviorSanitizerRuntimeLibrary(toolchain)
992 }
993
Ivan Lozano9ac32c72020-02-19 15:24:02 -0500994 if runtimeLibrary != "" && (toolchain.Bionic() || c.sanitize.Properties.UbsanRuntimeDep) {
995 // UBSan is supported on non-bionic linux host builds as well
Jooyung Han0302a842019-10-30 18:43:49 +0900996 if isLlndkLibrary(runtimeLibrary, mctx.Config()) && !c.static() && c.UseVndk() {
Jiyong Park379de2f2018-12-19 02:47:14 +0900997 runtimeLibrary = runtimeLibrary + llndkLibrarySuffix
998 }
999
1000 // Adding dependency to the runtime library. We are using *FarVariation*
1001 // because the runtime libraries themselves are not mutated by sanitizer
1002 // mutators and thus don't have sanitizer variants whereas this module
1003 // has been already mutated.
1004 //
1005 // Note that by adding dependency with {static|shared}DepTag, the lib is
1006 // added to libFlags and LOCAL_SHARED_LIBRARIES by cc.Module
1007 if c.staticBinary() {
Inseob Kimeec88e12020-01-22 11:11:29 +09001008 deps := append(extraStaticDeps, runtimeLibrary)
1009 // If we're using snapshots and in vendor, redirect to snapshot whenever possible
1010 if c.VndkVersion() == mctx.DeviceConfig().VndkVersion() {
1011 snapshots := vendorSnapshotStaticLibs(mctx.Config())
1012 for idx, dep := range deps {
1013 if lib, ok := snapshots.get(dep, mctx.Arch().ArchType); ok {
1014 deps[idx] = lib
1015 }
1016 }
1017 }
1018
Jiyong Park379de2f2018-12-19 02:47:14 +09001019 // static executable gets static runtime libs
Colin Cross6e511a92020-07-27 21:26:48 -07001020 depTag := libraryDependencyTag{Kind: staticLibraryDependency}
Colin Cross42507332020-08-21 16:15:23 -07001021 variations := append(mctx.Target().Variations(),
1022 blueprint.Variation{Mutator: "link", Variation: "static"})
1023 if c.Device() {
1024 variations = append(variations, c.ImageVariation())
1025 }
1026 mctx.AddFarVariationDependencies(variations, depTag, deps...)
Jiyong Park1d1119f2019-07-29 21:27:18 +09001027 } else if !c.static() && !c.header() {
Inseob Kimeec88e12020-01-22 11:11:29 +09001028 // If we're using snapshots and in vendor, redirect to snapshot whenever possible
1029 if c.VndkVersion() == mctx.DeviceConfig().VndkVersion() {
1030 snapshots := vendorSnapshotSharedLibs(mctx.Config())
1031 if lib, ok := snapshots.get(runtimeLibrary, mctx.Arch().ArchType); ok {
1032 runtimeLibrary = lib
1033 }
1034 }
1035
Jiyong Park3b1746a2019-01-29 11:15:04 +09001036 // dynamic executable and shared libs get shared runtime libs
Colin Cross6e511a92020-07-27 21:26:48 -07001037 depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: earlyLibraryDependency}
Colin Cross42507332020-08-21 16:15:23 -07001038 variations := append(mctx.Target().Variations(),
1039 blueprint.Variation{Mutator: "link", Variation: "shared"})
1040 if c.Device() {
1041 variations = append(variations, c.ImageVariation())
1042 }
1043 mctx.AddFarVariationDependencies(variations, depTag, runtimeLibrary)
Jiyong Park379de2f2018-12-19 02:47:14 +09001044 }
1045 // static lib does not have dependency to the runtime library. The
1046 // dependency will be added to the executables or shared libs using
1047 // the static lib.
1048 }
1049 }
1050}
1051
1052type Sanitizeable interface {
1053 android.Module
Jiyong Park388ef3f2019-01-28 19:47:32 +09001054 IsSanitizerEnabled(ctx android.BaseModuleContext, sanitizerName string) bool
Jiyong Parkf97782b2019-02-13 20:28:58 +09001055 EnableSanitizer(sanitizerName string)
Jooyung Han8ce8db92020-05-15 19:05:05 +09001056 AddSanitizerDependencies(ctx android.BottomUpMutatorContext, sanitizerName string)
Jiyong Park379de2f2018-12-19 02:47:14 +09001057}
1058
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001059// Create sanitized variants for modules that need them
Colin Cross635c3b02016-05-18 15:37:25 -07001060func sanitizerMutator(t sanitizerType) func(android.BottomUpMutatorContext) {
1061 return func(mctx android.BottomUpMutatorContext) {
Vishwath Mohane6153452017-08-11 00:52:44 +00001062 if c, ok := mctx.Module().(*Module); ok && c.sanitize != nil {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001063 if c.isDependencyRoot() && c.sanitize.isSanitizerEnabled(t) {
Jiyong Park82226632019-02-01 10:50:50 +09001064 modules := mctx.CreateVariations(t.variationName())
Colin Cross30d5f512016-05-03 18:02:42 -07001065 modules[0].(*Module).sanitize.SetSanitizer(t, true)
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001066 } else if c.sanitize.isSanitizerEnabled(t) || c.sanitize.Properties.SanitizeDep {
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001067 isSanitizerEnabled := c.sanitize.isSanitizerEnabled(t)
Jiyong Park1d1119f2019-07-29 21:27:18 +09001068 if c.static() || c.header() || t == asan || t == fuzzer {
1069 // Static and header libs are split into non-sanitized and sanitized variants.
1070 // Shared libs are not split. However, for asan and fuzzer, we split even for shared
1071 // libs because a library sanitized for asan/fuzzer can't be linked from a library
1072 // that isn't sanitized for asan/fuzzer.
1073 //
1074 // Note for defaultVariation: since we don't split for shared libs but for static/header
1075 // libs, it is possible for the sanitized variant of a static/header lib to depend
1076 // on non-sanitized variant of a shared lib. Such unfulfilled variation causes an
1077 // error when the module is split. defaultVariation is the name of the variation that
1078 // will be used when such a dangling dependency occurs during the split of the current
1079 // module. By setting it to the name of the sanitized variation, the dangling dependency
1080 // is redirected to the sanitized variant of the dependent module.
1081 defaultVariation := t.variationName()
1082 mctx.SetDefaultDependencyVariation(&defaultVariation)
1083 modules := mctx.CreateVariations("", t.variationName())
1084 modules[0].(*Module).sanitize.SetSanitizer(t, false)
1085 modules[1].(*Module).sanitize.SetSanitizer(t, true)
1086 modules[0].(*Module).sanitize.Properties.SanitizeDep = false
1087 modules[1].(*Module).sanitize.Properties.SanitizeDep = false
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001088
Ivan Lozano4774a812020-03-10 16:23:57 -04001089 if mctx.Device() && t.incompatibleWithCfi() {
1090 // TODO: Make sure that cfi mutator runs "after" any of the sanitizers that
1091 // are incompatible with cfi
1092 modules[1].(*Module).sanitize.SetSanitizer(cfi, false)
1093 }
1094
Jiyong Park1d1119f2019-07-29 21:27:18 +09001095 // For cfi/scs/hwasan, we can export both sanitized and un-sanitized variants
1096 // to Make, because the sanitized version has a different suffix in name.
1097 // For other types of sanitizers, suppress the variation that is disabled.
1098 if t != cfi && t != scs && t != hwasan {
1099 if isSanitizerEnabled {
1100 modules[0].(*Module).Properties.PreventInstall = true
1101 modules[0].(*Module).Properties.HideFromMake = true
1102 } else {
1103 modules[1].(*Module).Properties.PreventInstall = true
1104 modules[1].(*Module).Properties.HideFromMake = true
1105 }
1106 }
Vishwath Mohanb743e9c2017-11-01 09:20:21 +00001107
Jiyong Park1d1119f2019-07-29 21:27:18 +09001108 // Export the static lib name to make
Dan Willemsenb5b2aba2020-05-03 21:28:32 -07001109 if c.static() && c.ExportedToMake() {
Jiyong Park1d1119f2019-07-29 21:27:18 +09001110 if t == cfi {
Inseob Kim74d25562020-08-04 00:41:38 +09001111 cfiStaticLibs(mctx.Config()).add(c, c.Name())
Jiyong Park1d1119f2019-07-29 21:27:18 +09001112 } else if t == hwasan {
Inseob Kim74d25562020-08-04 00:41:38 +09001113 hwasanStaticLibs(mctx.Config()).add(c, c.Name())
Jiyong Park1d1119f2019-07-29 21:27:18 +09001114 }
1115 }
1116 } else {
1117 // Shared libs are not split. Only the sanitized variant is created.
1118 modules := mctx.CreateVariations(t.variationName())
1119 modules[0].(*Module).sanitize.SetSanitizer(t, true)
1120 modules[0].(*Module).sanitize.Properties.SanitizeDep = false
Vishwath Mohane7128792017-11-17 11:08:10 -08001121
Jiyong Park1d1119f2019-07-29 21:27:18 +09001122 // locate the asan libraries under /data/asan
1123 if mctx.Device() && t == asan && isSanitizerEnabled {
1124 modules[0].(*Module).sanitize.Properties.InSanitizerDir = true
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -07001125 }
Ivan Lozano4774a812020-03-10 16:23:57 -04001126
1127 if mctx.Device() && t.incompatibleWithCfi() {
1128 // TODO: Make sure that cfi mutator runs "after" any of the sanitizers that
1129 // are incompatible with cfi
1130 modules[0].(*Module).sanitize.SetSanitizer(cfi, false)
1131 }
Vishwath Mohane21fe422017-11-01 19:42:45 -07001132 }
Colin Cross16b23492016-01-06 14:41:07 -08001133 }
1134 c.sanitize.Properties.SanitizeDep = false
Jiyong Park82226632019-02-01 10:50:50 +09001135 } else if sanitizeable, ok := mctx.Module().(Sanitizeable); ok && sanitizeable.IsSanitizerEnabled(mctx, t.name()) {
Jiyong Park379de2f2018-12-19 02:47:14 +09001136 // APEX modules fall here
Jooyung Han8ce8db92020-05-15 19:05:05 +09001137 sanitizeable.AddSanitizerDependencies(mctx, t.name())
Jiyong Park82226632019-02-01 10:50:50 +09001138 mctx.CreateVariations(t.variationName())
Inseob Kimc42f2f22020-07-29 20:32:10 +09001139 } else if c, ok := mctx.Module().(*Module); ok {
1140 // Check if it's a snapshot module supporting sanitizer
1141 if s, ok := c.linker.(snapshotSanitizer); ok && s.isSanitizerEnabled(t) {
1142 // Set default variation as above.
1143 defaultVariation := t.variationName()
1144 mctx.SetDefaultDependencyVariation(&defaultVariation)
1145 modules := mctx.CreateVariations("", t.variationName())
1146 modules[0].(*Module).linker.(snapshotSanitizer).setSanitizerVariation(t, false)
1147 modules[1].(*Module).linker.(snapshotSanitizer).setSanitizerVariation(t, true)
1148
1149 // Export the static lib name to make
1150 if c.static() && c.ExportedToMake() {
1151 if t == cfi {
1152 // use BaseModuleName which is the name for Make.
1153 cfiStaticLibs(mctx.Config()).add(c, c.BaseModuleName())
1154 }
1155 }
1156 }
Colin Cross16b23492016-01-06 14:41:07 -08001157 }
1158 }
1159}
Vishwath Mohane7128792017-11-17 11:08:10 -08001160
Inseob Kim74d25562020-08-04 00:41:38 +09001161type sanitizerStaticLibsMap struct {
1162 // libsMap contains one list of modules per each image and each arch.
1163 // e.g. libs[vendor]["arm"] contains arm modules installed to vendor
1164 libsMap map[imageVariantType]map[string][]string
1165 libsMapLock sync.Mutex
1166 sanitizerType sanitizerType
1167}
1168
1169func newSanitizerStaticLibsMap(t sanitizerType) *sanitizerStaticLibsMap {
1170 return &sanitizerStaticLibsMap{
1171 sanitizerType: t,
1172 libsMap: make(map[imageVariantType]map[string][]string),
1173 }
1174}
1175
1176// Add the current module to sanitizer static libs maps
1177// Each module should pass its exported name as names of Make and Soong can differ.
1178func (s *sanitizerStaticLibsMap) add(c *Module, name string) {
1179 image := c.getImageVariantType()
1180 arch := c.Arch().ArchType.String()
1181
1182 s.libsMapLock.Lock()
1183 defer s.libsMapLock.Unlock()
1184
1185 if _, ok := s.libsMap[image]; !ok {
1186 s.libsMap[image] = make(map[string][]string)
1187 }
1188
1189 s.libsMap[image][arch] = append(s.libsMap[image][arch], name)
1190}
1191
1192// Exports makefile variables in the following format:
1193// SOONG_{sanitizer}_{image}_{arch}_STATIC_LIBRARIES
1194// e.g. SOONG_cfi_core_x86_STATIC_LIBRARIES
1195// These are to be used by use_soong_sanitized_static_libraries.
1196// See build/make/core/binary.mk for more details.
1197func (s *sanitizerStaticLibsMap) exportToMake(ctx android.MakeVarsContext) {
1198 for _, image := range android.SortedStringKeys(s.libsMap) {
1199 archMap := s.libsMap[imageVariantType(image)]
1200 for _, arch := range android.SortedStringKeys(archMap) {
1201 libs := archMap[arch]
1202 sort.Strings(libs)
1203
1204 key := fmt.Sprintf(
1205 "SOONG_%s_%s_%s_STATIC_LIBRARIES",
1206 s.sanitizerType.variationName(),
1207 image, // already upper
1208 arch)
1209
1210 ctx.Strict(key, strings.Join(libs, " "))
1211 }
1212 }
1213}
1214
Colin Cross571cccf2019-02-04 11:22:08 -08001215var cfiStaticLibsKey = android.NewOnceKey("cfiStaticLibs")
1216
Inseob Kim74d25562020-08-04 00:41:38 +09001217func cfiStaticLibs(config android.Config) *sanitizerStaticLibsMap {
Colin Cross571cccf2019-02-04 11:22:08 -08001218 return config.Once(cfiStaticLibsKey, func() interface{} {
Inseob Kim74d25562020-08-04 00:41:38 +09001219 return newSanitizerStaticLibsMap(cfi)
1220 }).(*sanitizerStaticLibsMap)
Vishwath Mohane7128792017-11-17 11:08:10 -08001221}
1222
Colin Cross571cccf2019-02-04 11:22:08 -08001223var hwasanStaticLibsKey = android.NewOnceKey("hwasanStaticLibs")
1224
Inseob Kim74d25562020-08-04 00:41:38 +09001225func hwasanStaticLibs(config android.Config) *sanitizerStaticLibsMap {
Colin Cross571cccf2019-02-04 11:22:08 -08001226 return config.Once(hwasanStaticLibsKey, func() interface{} {
Inseob Kim74d25562020-08-04 00:41:38 +09001227 return newSanitizerStaticLibsMap(hwasan)
1228 }).(*sanitizerStaticLibsMap)
Jiyong Park1d1119f2019-07-29 21:27:18 +09001229}
1230
Ivan Lozano30c5db22018-02-21 15:49:20 -08001231func enableMinimalRuntime(sanitize *sanitize) bool {
1232 if !Bool(sanitize.Properties.Sanitize.Address) &&
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -07001233 !Bool(sanitize.Properties.Sanitize.Hwaddress) &&
Mitch Phillips5a6ea6c2019-05-01 14:42:05 -07001234 !Bool(sanitize.Properties.Sanitize.Fuzzer) &&
Ivan Lozano9ac32c72020-02-19 15:24:02 -05001235
Ivan Lozano30c5db22018-02-21 15:49:20 -08001236 (Bool(sanitize.Properties.Sanitize.Integer_overflow) ||
Ivan Lozano9ac32c72020-02-19 15:24:02 -05001237 len(sanitize.Properties.Sanitize.Misc_undefined) > 0 ||
1238 Bool(sanitize.Properties.Sanitize.Undefined) ||
1239 Bool(sanitize.Properties.Sanitize.All_undefined)) &&
1240
Ivan Lozano30c5db22018-02-21 15:49:20 -08001241 !(Bool(sanitize.Properties.Sanitize.Diag.Integer_overflow) ||
1242 Bool(sanitize.Properties.Sanitize.Diag.Cfi) ||
Ivan Lozano9ac32c72020-02-19 15:24:02 -05001243 Bool(sanitize.Properties.Sanitize.Diag.Undefined) ||
Ivan Lozano30c5db22018-02-21 15:49:20 -08001244 len(sanitize.Properties.Sanitize.Diag.Misc_undefined) > 0) {
Ivan Lozano9ac32c72020-02-19 15:24:02 -05001245
Ivan Lozano30c5db22018-02-21 15:49:20 -08001246 return true
1247 }
1248 return false
1249}
1250
Inseob Kim8471cda2019-11-15 09:59:12 +09001251func enableUbsanRuntime(sanitize *sanitize) bool {
1252 return Bool(sanitize.Properties.Sanitize.Diag.Integer_overflow) ||
Ivan Lozano9ac32c72020-02-19 15:24:02 -05001253 Bool(sanitize.Properties.Sanitize.Diag.Undefined) ||
Inseob Kim8471cda2019-11-15 09:59:12 +09001254 len(sanitize.Properties.Sanitize.Diag.Misc_undefined) > 0
1255}
1256
Vishwath Mohane7128792017-11-17 11:08:10 -08001257func cfiMakeVarsProvider(ctx android.MakeVarsContext) {
Inseob Kim74d25562020-08-04 00:41:38 +09001258 cfiStaticLibs(ctx.Config()).exportToMake(ctx)
Vishwath Mohane7128792017-11-17 11:08:10 -08001259}
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -07001260
1261func hwasanMakeVarsProvider(ctx android.MakeVarsContext) {
Inseob Kim74d25562020-08-04 00:41:38 +09001262 hwasanStaticLibs(ctx.Config()).exportToMake(ctx)
Evgenii Stepanovd97a6e92018-08-02 16:19:13 -07001263}