| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 1 | // 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 |  | 
|  | 15 | package cc | 
|  | 16 |  | 
|  | 17 | import ( | 
|  | 18 | "fmt" | 
| Jeff Gaston | 7276539 | 2017-11-28 16:37:53 -0800 | [diff] [blame] | 19 | "sort" | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 20 | "strings" | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 21 | "sync" | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 22 |  | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 23 | "github.com/google/blueprint" | 
|  | 24 |  | 
| Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 25 | "android/soong/android" | 
| Evgenii Stepanov | af36db1 | 2016-08-15 14:18:24 -0700 | [diff] [blame] | 26 | "android/soong/cc/config" | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 27 | ) | 
|  | 28 |  | 
| Jayant Chowdhary | 9677e8c | 2017-06-15 14:45:18 -0700 | [diff] [blame] | 29 | var ( | 
|  | 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 Mohan | f3918d3 | 2017-02-14 07:59:33 -0800 | [diff] [blame] | 33 |  | 
| Yi Kong | 20233a4 | 2019-08-21 01:38:40 -0700 | [diff] [blame] | 34 | asanCflags = []string{ | 
|  | 35 | "-fno-omit-frame-pointer", | 
|  | 36 | "-fno-experimental-new-pass-manager", | 
|  | 37 | } | 
| Jayant Chowdhary | 9677e8c | 2017-06-15 14:45:18 -0700 | [diff] [blame] | 38 | asanLdflags = []string{"-Wl,-u,__asan_preinit"} | 
| Jayant Chowdhary | 9677e8c | 2017-06-15 14:45:18 -0700 | [diff] [blame] | 39 |  | 
| Peter Collingbourne | 967511a | 2019-03-19 21:39:54 -0700 | [diff] [blame] | 40 | hwasanCflags = []string{"-fno-omit-frame-pointer", "-Wno-frame-larger-than=", | 
| Evgenii Stepanov | 96fa3dd | 2020-03-27 19:38:42 +0000 | [diff] [blame] | 41 | "-fsanitize-hwaddress-abi=platform", | 
|  | 42 | "-fno-experimental-new-pass-manager", | 
| Evgenii Stepanov | 64bee4d | 2019-11-22 18:37:10 -0800 | [diff] [blame] | 43 | // 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 Phillips | b1c574f | 2020-06-22 13:28:23 -0700 | [diff] [blame] | 51 | // 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 Stepanov | 64bee4d | 2019-11-22 18:37:10 -0800 | [diff] [blame] | 55 | } | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 56 |  | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 57 | cfiCflags = []string{"-flto", "-fsanitize-cfi-cross-dso", | 
| Pirama Arumuga Nainar | eb8d403 | 2020-07-27 11:22:35 -0700 | [diff] [blame] | 58 | "-fsanitize-blacklist=external/compiler-rt/lib/cfi/cfi_blocklist.txt"} | 
| Evgenii Stepanov | dbf1d4f | 2018-08-31 12:54:33 -0700 | [diff] [blame] | 59 | // -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 Chowdhary | 9677e8c | 2017-06-15 14:45:18 -0700 | [diff] [blame] | 62 | cfiLdflags = []string{"-flto", "-fsanitize-cfi-cross-dso", "-fsanitize=cfi", | 
| Pirama Arumuga Nainar | bdb17f0 | 2017-08-28 21:50:17 -0700 | [diff] [blame] | 63 | "-Wl,-plugin-opt,O1"} | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 64 | cfiExportsMapPath = "build/soong/cc/config/cfi_exports.map" | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 65 |  | 
| Pirama Arumuga Nainar | eb8d403 | 2020-07-27 11:22:35 -0700 | [diff] [blame] | 66 | intOverflowCflags = []string{"-fsanitize-blacklist=build/soong/cc/config/integer_overflow_blocklist.txt"} | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 67 |  | 
| Peter Collingbourne | bd19db0 | 2019-03-06 10:38:48 -0800 | [diff] [blame] | 68 | minimalRuntimeFlags = []string{"-fsanitize-minimal-runtime", "-fno-sanitize-trap=integer,undefined", | 
| Ivan Lozano | ae6ae1d | 2018-10-08 09:29:39 -0700 | [diff] [blame] | 69 | "-fno-sanitize-recover=integer,undefined"} | 
| Evgenii Stepanov | 2c6484e | 2019-05-15 12:49:54 -0700 | [diff] [blame] | 70 | hwasanGlobalOptions = []string{"heap_history_size=1023", "stack_history_size=512", | 
|  | 71 | "export_memory_stats=0", "max_malloc_fill_size=0"} | 
| Dan Willemsen | cbceaab | 2016-10-13 16:44:07 -0700 | [diff] [blame] | 72 | ) | 
|  | 73 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 74 | type sanitizerType int | 
|  | 75 |  | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 76 | func boolPtr(v bool) *bool { | 
|  | 77 | if v { | 
|  | 78 | return &v | 
|  | 79 | } else { | 
|  | 80 | return nil | 
|  | 81 | } | 
|  | 82 | } | 
|  | 83 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 84 | const ( | 
|  | 85 | asan sanitizerType = iota + 1 | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 86 | hwasan | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 87 | tsan | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 88 | intOverflow | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 89 | cfi | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 90 | scs | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 91 | fuzzer | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 92 | ) | 
|  | 93 |  | 
| Jiyong Park | 8222663 | 2019-02-01 10:50:50 +0900 | [diff] [blame] | 94 | // Name of the sanitizer variation for this sanitizer type | 
|  | 95 | func (t sanitizerType) variationName() string { | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 96 | switch t { | 
|  | 97 | case asan: | 
|  | 98 | return "asan" | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 99 | case hwasan: | 
|  | 100 | return "hwasan" | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 101 | case tsan: | 
|  | 102 | return "tsan" | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 103 | case intOverflow: | 
|  | 104 | return "intOverflow" | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 105 | case cfi: | 
|  | 106 | return "cfi" | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 107 | case scs: | 
|  | 108 | return "scs" | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 109 | case fuzzer: | 
|  | 110 | return "fuzzer" | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 111 | default: | 
|  | 112 | panic(fmt.Errorf("unknown sanitizerType %d", t)) | 
|  | 113 | } | 
|  | 114 | } | 
|  | 115 |  | 
| Jiyong Park | 8222663 | 2019-02-01 10:50:50 +0900 | [diff] [blame] | 116 | // This is the sanitizer names in SANITIZE_[TARGET|HOST] | 
|  | 117 | func (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 Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 131 | case fuzzer: | 
|  | 132 | return "fuzzer" | 
| Jiyong Park | 8222663 | 2019-02-01 10:50:50 +0900 | [diff] [blame] | 133 | default: | 
|  | 134 | panic(fmt.Errorf("unknown sanitizerType %d", t)) | 
|  | 135 | } | 
|  | 136 | } | 
|  | 137 |  | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 138 | func (t sanitizerType) incompatibleWithCfi() bool { | 
|  | 139 | return t == asan || t == fuzzer || t == hwasan | 
|  | 140 | } | 
|  | 141 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 142 | type SanitizeProperties struct { | 
|  | 143 | // enable AddressSanitizer, ThreadSanitizer, or UndefinedBehaviorSanitizer | 
|  | 144 | Sanitize struct { | 
| Nan Zhang | 0007d81 | 2017-11-07 10:57:05 -0800 | [diff] [blame] | 145 | Never *bool `android:"arch_variant"` | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 146 |  | 
|  | 147 | // main sanitizers | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 148 | Address   *bool `android:"arch_variant"` | 
|  | 149 | Thread    *bool `android:"arch_variant"` | 
|  | 150 | Hwaddress *bool `android:"arch_variant"` | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 151 |  | 
|  | 152 | // local sanitizers | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 153 | Undefined        *bool    `android:"arch_variant"` | 
|  | 154 | All_undefined    *bool    `android:"arch_variant"` | 
|  | 155 | Misc_undefined   []string `android:"arch_variant"` | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 156 | Fuzzer           *bool    `android:"arch_variant"` | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 157 | Safestack        *bool    `android:"arch_variant"` | 
|  | 158 | Cfi              *bool    `android:"arch_variant"` | 
|  | 159 | Integer_overflow *bool    `android:"arch_variant"` | 
| Kostya Kortchinsky | d18ae5c | 2018-06-12 14:46:54 -0700 | [diff] [blame] | 160 | Scudo            *bool    `android:"arch_variant"` | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 161 | Scs              *bool    `android:"arch_variant"` | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 162 |  | 
| Jasraj Bedi | bb4511d | 2020-07-23 22:58:17 +0000 | [diff] [blame] | 163 | // A modifier for ASAN and HWASAN for write only instrumentation | 
|  | 164 | Writeonly *bool `android:"arch_variant"` | 
|  | 165 |  | 
| Evgenii Stepanov | 1e405e1 | 2016-08-16 15:39:54 -0700 | [diff] [blame] | 166 | // Sanitizers to run in the diagnostic mode (as opposed to the release mode). | 
|  | 167 | // Replaces abort() on error with a human-readable error message. | 
|  | 168 | // Address and Thread sanitizers always run in diagnostic mode. | 
|  | 169 | Diag struct { | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 170 | Undefined        *bool    `android:"arch_variant"` | 
|  | 171 | Cfi              *bool    `android:"arch_variant"` | 
|  | 172 | Integer_overflow *bool    `android:"arch_variant"` | 
|  | 173 | Misc_undefined   []string `android:"arch_variant"` | 
| Ivan Lozano | 7929bba | 2018-12-12 09:36:31 -0800 | [diff] [blame] | 174 | No_recover       []string | 
| Evgenii Stepanov | 1e405e1 | 2016-08-16 15:39:54 -0700 | [diff] [blame] | 175 | } | 
|  | 176 |  | 
|  | 177 | // value to pass to -fsanitize-recover= | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 178 | Recover []string | 
|  | 179 |  | 
|  | 180 | // value to pass to -fsanitize-blacklist | 
| Pirama Arumuga Nainar | 6c4ccca | 2020-07-27 11:49:51 -0700 | [diff] [blame] | 181 | Blocklist *string | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 182 | } `android:"arch_variant"` | 
|  | 183 |  | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 184 | SanitizerEnabled  bool     `blueprint:"mutated"` | 
|  | 185 | SanitizeDep       bool     `blueprint:"mutated"` | 
|  | 186 | MinimalRuntimeDep bool     `blueprint:"mutated"` | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 187 | BuiltinsDep       bool     `blueprint:"mutated"` | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 188 | UbsanRuntimeDep   bool     `blueprint:"mutated"` | 
|  | 189 | InSanitizerDir    bool     `blueprint:"mutated"` | 
|  | 190 | Sanitizers        []string `blueprint:"mutated"` | 
|  | 191 | DiagSanitizers    []string `blueprint:"mutated"` | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 192 | } | 
|  | 193 |  | 
|  | 194 | type sanitize struct { | 
|  | 195 | Properties SanitizeProperties | 
|  | 196 | } | 
|  | 197 |  | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 198 | func init() { | 
|  | 199 | android.RegisterMakeVarsProvider(pctx, cfiMakeVarsProvider) | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 200 | android.RegisterMakeVarsProvider(pctx, hwasanMakeVarsProvider) | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 201 | } | 
|  | 202 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 203 | func (sanitize *sanitize) props() []interface{} { | 
|  | 204 | return []interface{}{&sanitize.Properties} | 
|  | 205 | } | 
|  | 206 |  | 
|  | 207 | func (sanitize *sanitize) begin(ctx BaseModuleContext) { | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 208 | s := &sanitize.Properties.Sanitize | 
|  | 209 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 210 | // Don't apply sanitizers to NDK code. | 
| Jeff Gaston | af3cc2d | 2017-09-27 17:01:44 -0700 | [diff] [blame] | 211 | if ctx.useSdk() { | 
| Nan Zhang | 0007d81 | 2017-11-07 10:57:05 -0800 | [diff] [blame] | 212 | s.Never = BoolPtr(true) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 213 | } | 
|  | 214 |  | 
| Doug Horn | c32c6b0 | 2019-01-17 14:44:05 -0800 | [diff] [blame] | 215 | // Sanitizers do not work on Fuchsia yet. | 
|  | 216 | if ctx.Fuchsia() { | 
|  | 217 | s.Never = BoolPtr(true) | 
|  | 218 | } | 
|  | 219 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 220 | // Never always wins. | 
| Nan Zhang | 0007d81 | 2017-11-07 10:57:05 -0800 | [diff] [blame] | 221 | if Bool(s.Never) { | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 222 | return | 
|  | 223 | } | 
|  | 224 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 225 | var globalSanitizers []string | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 226 | var globalSanitizersDiag []string | 
|  | 227 |  | 
| Dan Willemsen | 8536d6b | 2018-10-07 20:54:34 -0700 | [diff] [blame] | 228 | if ctx.Host() { | 
|  | 229 | if !ctx.Windows() { | 
|  | 230 | globalSanitizers = ctx.Config().SanitizeHost() | 
|  | 231 | } | 
|  | 232 | } else { | 
|  | 233 | arches := ctx.Config().SanitizeDeviceArch() | 
|  | 234 | if len(arches) == 0 || inList(ctx.Arch().ArchType.Name, arches) { | 
|  | 235 | globalSanitizers = ctx.Config().SanitizeDevice() | 
|  | 236 | globalSanitizersDiag = ctx.Config().SanitizeDeviceDiag() | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 237 | } | 
|  | 238 | } | 
|  | 239 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 240 | if len(globalSanitizers) > 0 { | 
| Evgenii Stepanov | 05bafd3 | 2016-07-07 17:38:41 +0000 | [diff] [blame] | 241 | var found bool | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 242 | if found, globalSanitizers = removeFromList("undefined", globalSanitizers); found && s.All_undefined == nil { | 
|  | 243 | s.All_undefined = boolPtr(true) | 
| Evgenii Stepanov | 05bafd3 | 2016-07-07 17:38:41 +0000 | [diff] [blame] | 244 | } | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 245 |  | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 246 | if found, globalSanitizers = removeFromList("default-ub", globalSanitizers); found && s.Undefined == nil { | 
|  | 247 | s.Undefined = boolPtr(true) | 
| Evgenii Stepanov | 05bafd3 | 2016-07-07 17:38:41 +0000 | [diff] [blame] | 248 | } | 
|  | 249 |  | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 250 | if found, globalSanitizers = removeFromList("address", globalSanitizers); found && s.Address == nil { | 
|  | 251 | s.Address = boolPtr(true) | 
| Evgenii Stepanov | 05bafd3 | 2016-07-07 17:38:41 +0000 | [diff] [blame] | 252 | } | 
|  | 253 |  | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 254 | if found, globalSanitizers = removeFromList("thread", globalSanitizers); found && s.Thread == nil { | 
|  | 255 | s.Thread = boolPtr(true) | 
| Evgenii Stepanov | 05bafd3 | 2016-07-07 17:38:41 +0000 | [diff] [blame] | 256 | } | 
|  | 257 |  | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 258 | if found, globalSanitizers = removeFromList("fuzzer", globalSanitizers); found && s.Fuzzer == nil { | 
|  | 259 | s.Fuzzer = boolPtr(true) | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 260 | } | 
|  | 261 |  | 
|  | 262 | if found, globalSanitizers = removeFromList("safe-stack", globalSanitizers); found && s.Safestack == nil { | 
|  | 263 | s.Safestack = boolPtr(true) | 
| Evgenii Stepanov | 05bafd3 | 2016-07-07 17:38:41 +0000 | [diff] [blame] | 264 | } | 
|  | 265 |  | 
| Evgenii Stepanov | 1e405e1 | 2016-08-16 15:39:54 -0700 | [diff] [blame] | 266 | if found, globalSanitizers = removeFromList("cfi", globalSanitizers); found && s.Cfi == nil { | 
| Colin Cross | 6510f91 | 2017-11-29 00:27:14 -0800 | [diff] [blame] | 267 | if !ctx.Config().CFIDisabledForPath(ctx.ModuleDir()) { | 
| Vishwath Mohan | 1fa3ac5 | 2017-10-31 02:26:14 -0700 | [diff] [blame] | 268 | s.Cfi = boolPtr(true) | 
|  | 269 | } | 
| Evgenii Stepanov | 1e405e1 | 2016-08-16 15:39:54 -0700 | [diff] [blame] | 270 | } | 
|  | 271 |  | 
| Ivan Lozano | a9255a8 | 2018-03-13 10:41:07 -0700 | [diff] [blame] | 272 | // Global integer_overflow builds do not support static libraries. | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 273 | if found, globalSanitizers = removeFromList("integer_overflow", globalSanitizers); found && s.Integer_overflow == nil { | 
| Ivan Lozano | a9255a8 | 2018-03-13 10:41:07 -0700 | [diff] [blame] | 274 | if !ctx.Config().IntegerOverflowDisabledForPath(ctx.ModuleDir()) && !ctx.static() { | 
| Ivan Lozano | 5f59553 | 2017-07-13 14:46:05 -0700 | [diff] [blame] | 275 | s.Integer_overflow = boolPtr(true) | 
|  | 276 | } | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 277 | } | 
|  | 278 |  | 
| Kostya Kortchinsky | d18ae5c | 2018-06-12 14:46:54 -0700 | [diff] [blame] | 279 | if found, globalSanitizers = removeFromList("scudo", globalSanitizers); found && s.Scudo == nil { | 
|  | 280 | s.Scudo = boolPtr(true) | 
|  | 281 | } | 
|  | 282 |  | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 283 | if found, globalSanitizers = removeFromList("hwaddress", globalSanitizers); found && s.Hwaddress == nil { | 
|  | 284 | s.Hwaddress = boolPtr(true) | 
|  | 285 | } | 
|  | 286 |  | 
| Jasraj Bedi | bb4511d | 2020-07-23 22:58:17 +0000 | [diff] [blame] | 287 | if found, globalSanitizers = removeFromList("writeonly", globalSanitizers); found && s.Writeonly == nil { | 
|  | 288 | // Hwaddress and Address are set before, so we can check them here | 
|  | 289 | // If they aren't explicitly set in the blueprint/SANITIZE_(HOST|TARGET), they would be nil instead of false | 
|  | 290 | if s.Address == nil && s.Hwaddress == nil { | 
|  | 291 | ctx.ModuleErrorf("writeonly modifier cannot be used without 'address' or 'hwaddress'") | 
|  | 292 | } | 
|  | 293 | s.Writeonly = boolPtr(true) | 
|  | 294 | } | 
|  | 295 |  | 
| Evgenii Stepanov | 05bafd3 | 2016-07-07 17:38:41 +0000 | [diff] [blame] | 296 | if len(globalSanitizers) > 0 { | 
|  | 297 | ctx.ModuleErrorf("unknown global sanitizer option %s", globalSanitizers[0]) | 
|  | 298 | } | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 299 |  | 
| Ivan Lozano | a9255a8 | 2018-03-13 10:41:07 -0700 | [diff] [blame] | 300 | // Global integer_overflow builds do not support static library diagnostics. | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 301 | if found, globalSanitizersDiag = removeFromList("integer_overflow", globalSanitizersDiag); found && | 
| Ivan Lozano | a9255a8 | 2018-03-13 10:41:07 -0700 | [diff] [blame] | 302 | s.Diag.Integer_overflow == nil && Bool(s.Integer_overflow) && !ctx.static() { | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 303 | s.Diag.Integer_overflow = boolPtr(true) | 
|  | 304 | } | 
|  | 305 |  | 
| Vishwath Mohan | 1fa3ac5 | 2017-10-31 02:26:14 -0700 | [diff] [blame] | 306 | if found, globalSanitizersDiag = removeFromList("cfi", globalSanitizersDiag); found && | 
|  | 307 | s.Diag.Cfi == nil && Bool(s.Cfi) { | 
|  | 308 | s.Diag.Cfi = boolPtr(true) | 
|  | 309 | } | 
|  | 310 |  | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 311 | if len(globalSanitizersDiag) > 0 { | 
|  | 312 | ctx.ModuleErrorf("unknown global sanitizer diagnostics option %s", globalSanitizersDiag[0]) | 
|  | 313 | } | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 314 | } | 
| Colin Cross | 3c344ef | 2016-07-18 15:44:56 -0700 | [diff] [blame] | 315 |  | 
| Vishwath Mohan | 1c54f66 | 2018-05-24 18:36:18 -0700 | [diff] [blame] | 316 | // Enable CFI for all components in the include paths (for Aarch64 only) | 
|  | 317 | if s.Cfi == nil && ctx.Config().CFIEnabledForPath(ctx.ModuleDir()) && ctx.Arch().ArchType == android.Arm64 { | 
| Vishwath Mohan | 3af8ee0 | 2018-03-30 02:55:23 +0000 | [diff] [blame] | 318 | s.Cfi = boolPtr(true) | 
|  | 319 | if inList("cfi", ctx.Config().SanitizeDeviceDiag()) { | 
|  | 320 | s.Diag.Cfi = boolPtr(true) | 
| Vishwath Mohan | 1fa3ac5 | 2017-10-31 02:26:14 -0700 | [diff] [blame] | 321 | } | 
|  | 322 | } | 
|  | 323 |  | 
| Elliott Hughes | da3a071 | 2020-03-06 16:55:28 -0800 | [diff] [blame] | 324 | // Is CFI actually enabled? | 
|  | 325 | if !ctx.Config().EnableCFI() { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 326 | s.Cfi = boolPtr(false) | 
|  | 327 | s.Diag.Cfi = boolPtr(false) | 
| Vishwath Mohan | 1b017a7 | 2017-01-19 13:54:55 -0800 | [diff] [blame] | 328 | } | 
|  | 329 |  | 
| Vishwath Mohan | 6d67e6e | 2017-02-07 20:31:41 -0800 | [diff] [blame] | 330 | // Also disable CFI for arm32 until b/35157333 is fixed. | 
|  | 331 | if ctx.Arch().ArchType == android.Arm { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 332 | s.Cfi = boolPtr(false) | 
|  | 333 | s.Diag.Cfi = boolPtr(false) | 
| Vishwath Mohan | 6d67e6e | 2017-02-07 20:31:41 -0800 | [diff] [blame] | 334 | } | 
|  | 335 |  | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 336 | // HWASan requires AArch64 hardware feature (top-byte-ignore). | 
|  | 337 | if ctx.Arch().ArchType != android.Arm64 { | 
|  | 338 | s.Hwaddress = nil | 
|  | 339 | } | 
|  | 340 |  | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 341 | // SCS is only implemented on AArch64. | 
| Peter Collingbourne | bd19db0 | 2019-03-06 10:38:48 -0800 | [diff] [blame] | 342 | if ctx.Arch().ArchType != android.Arm64 { | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 343 | s.Scs = nil | 
|  | 344 | } | 
|  | 345 |  | 
| Vishwath Mohan | 8f4fdd8 | 2017-04-20 07:42:52 -0700 | [diff] [blame] | 346 | // Also disable CFI if ASAN is enabled. | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 347 | if Bool(s.Address) || Bool(s.Hwaddress) { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 348 | s.Cfi = boolPtr(false) | 
|  | 349 | s.Diag.Cfi = boolPtr(false) | 
| Vishwath Mohan | 8f4fdd8 | 2017-04-20 07:42:52 -0700 | [diff] [blame] | 350 | } | 
|  | 351 |  | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 352 | // Disable sanitizers that depend on the UBSan runtime for windows/darwin builds. | 
|  | 353 | if !ctx.Os().Linux() { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 354 | s.Cfi = boolPtr(false) | 
|  | 355 | s.Diag.Cfi = boolPtr(false) | 
| Ivan Lozano | a9255a8 | 2018-03-13 10:41:07 -0700 | [diff] [blame] | 356 | s.Misc_undefined = nil | 
|  | 357 | s.Undefined = nil | 
|  | 358 | s.All_undefined = nil | 
|  | 359 | s.Integer_overflow = nil | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 360 | } | 
|  | 361 |  | 
| Vishwath Mohan | 9ccbba0 | 2018-05-28 13:54:48 -0700 | [diff] [blame] | 362 | // Also disable CFI for VNDK variants of components | 
|  | 363 | if ctx.isVndk() && ctx.useVndk() { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 364 | if ctx.static() { | 
|  | 365 | // Cfi variant for static vndk should be captured as vendor snapshot, | 
|  | 366 | // so don't strictly disable Cfi. | 
|  | 367 | s.Cfi = nil | 
|  | 368 | s.Diag.Cfi = nil | 
|  | 369 | } else { | 
|  | 370 | s.Cfi = boolPtr(false) | 
|  | 371 | s.Diag.Cfi = boolPtr(false) | 
|  | 372 | } | 
| Inseob Kim | eec88e1 | 2020-01-22 11:11:29 +0900 | [diff] [blame] | 373 | } | 
|  | 374 |  | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 375 | // HWASan ramdisk (which is built from recovery) goes over some bootloader limit. | 
| Yifan Hong | 1b3348d | 2020-01-21 15:53:22 -0800 | [diff] [blame] | 376 | // Keep libc instrumented so that ramdisk / recovery can run hwasan-instrumented code if necessary. | 
|  | 377 | if (ctx.inRamdisk() || ctx.inRecovery()) && !strings.HasPrefix(ctx.ModuleDir(), "bionic/libc") { | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 378 | s.Hwaddress = nil | 
|  | 379 | } | 
|  | 380 |  | 
| Colin Cross | 3c344ef | 2016-07-18 15:44:56 -0700 | [diff] [blame] | 381 | if ctx.staticBinary() { | 
|  | 382 | s.Address = nil | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 383 | s.Fuzzer = nil | 
| Colin Cross | 3c344ef | 2016-07-18 15:44:56 -0700 | [diff] [blame] | 384 | s.Thread = nil | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 385 | } | 
|  | 386 |  | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 387 | if Bool(s.All_undefined) { | 
|  | 388 | s.Undefined = nil | 
|  | 389 | } | 
|  | 390 |  | 
| Evgenii Stepanov | 0a8a0d0 | 2016-05-12 13:54:53 -0700 | [diff] [blame] | 391 | if !ctx.toolchain().Is64Bit() { | 
|  | 392 | // TSAN and SafeStack are not supported on 32-bit architectures | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 393 | s.Thread = nil | 
|  | 394 | s.Safestack = nil | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 395 | // TODO(ccross): error for compile_multilib = "32"? | 
|  | 396 | } | 
|  | 397 |  | 
| Evgenii Stepanov | 76cee23 | 2017-01-27 15:44:44 -0800 | [diff] [blame] | 398 | if ctx.Os() != android.Windows && (Bool(s.All_undefined) || Bool(s.Undefined) || Bool(s.Address) || Bool(s.Thread) || | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 399 | Bool(s.Fuzzer) || Bool(s.Safestack) || Bool(s.Cfi) || Bool(s.Integer_overflow) || len(s.Misc_undefined) > 0 || | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 400 | Bool(s.Scudo) || Bool(s.Hwaddress) || Bool(s.Scs)) { | 
| Colin Cross | 3c344ef | 2016-07-18 15:44:56 -0700 | [diff] [blame] | 401 | sanitize.Properties.SanitizerEnabled = true | 
|  | 402 | } | 
|  | 403 |  | 
| Kostya Kortchinsky | d5275c8 | 2019-02-01 08:42:56 -0800 | [diff] [blame] | 404 | // Disable Scudo if ASan or TSan is enabled, or if it's disabled globally. | 
|  | 405 | if Bool(s.Address) || Bool(s.Thread) || Bool(s.Hwaddress) || ctx.Config().DisableScudo() { | 
| Kostya Kortchinsky | d18ae5c | 2018-06-12 14:46:54 -0700 | [diff] [blame] | 406 | s.Scudo = nil | 
|  | 407 | } | 
|  | 408 |  | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 409 | if Bool(s.Hwaddress) { | 
|  | 410 | s.Address = nil | 
|  | 411 | s.Thread = nil | 
|  | 412 | } | 
|  | 413 |  | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 414 | // TODO(b/131771163): CFI transiently depends on LTO, and thus Fuzzer is | 
|  | 415 | // mutually incompatible. | 
|  | 416 | if Bool(s.Fuzzer) { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 417 | s.Cfi = boolPtr(false) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 418 | } | 
|  | 419 | } | 
|  | 420 |  | 
|  | 421 | func (sanitize *sanitize) deps(ctx BaseModuleContext, deps Deps) Deps { | 
|  | 422 | if !sanitize.Properties.SanitizerEnabled { // || c.static() { | 
|  | 423 | return deps | 
|  | 424 | } | 
|  | 425 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 426 | return deps | 
|  | 427 | } | 
|  | 428 |  | 
| Chih-Hung Hsieh | 3567e62 | 2018-11-15 14:01:36 -0800 | [diff] [blame] | 429 | func toDisableImplicitIntegerChange(flags []string) bool { | 
|  | 430 | // Returns true if any flag is fsanitize*integer, and there is | 
|  | 431 | // no explicit flag about sanitize=implicit-integer-sign-change. | 
|  | 432 | for _, f := range flags { | 
|  | 433 | if strings.Contains(f, "sanitize=implicit-integer-sign-change") { | 
|  | 434 | return false | 
|  | 435 | } | 
|  | 436 | } | 
|  | 437 | for _, f := range flags { | 
|  | 438 | if strings.HasPrefix(f, "-fsanitize") && strings.Contains(f, "integer") { | 
|  | 439 | return true | 
|  | 440 | } | 
|  | 441 | } | 
|  | 442 | return false | 
|  | 443 | } | 
|  | 444 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 445 | func (sanitize *sanitize) flags(ctx ModuleContext, flags Flags) Flags { | 
| Ivan Lozano | 59fdea2 | 2018-05-10 14:17:22 -0700 | [diff] [blame] | 446 | minimalRuntimeLib := config.UndefinedBehaviorSanitizerMinimalRuntimeLibrary(ctx.toolchain()) + ".a" | 
|  | 447 | minimalRuntimePath := "${config.ClangAsanLibDir}/" + minimalRuntimeLib | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 448 | builtinsRuntimeLib := config.BuiltinsRuntimeLibrary(ctx.toolchain()) + ".a" | 
|  | 449 | builtinsRuntimePath := "${config.ClangAsanLibDir}/" + builtinsRuntimeLib | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 450 |  | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 451 | if sanitize.Properties.MinimalRuntimeDep { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 452 | flags.Local.LdFlags = append(flags.Local.LdFlags, | 
|  | 453 | minimalRuntimePath, | 
|  | 454 | "-Wl,--exclude-libs,"+minimalRuntimeLib) | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 455 | } | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 456 |  | 
|  | 457 | if sanitize.Properties.BuiltinsDep { | 
|  | 458 | flags.libFlags = append([]string{builtinsRuntimePath}, flags.libFlags...) | 
|  | 459 | } | 
|  | 460 |  | 
| Ivan Lozano | a9255a8 | 2018-03-13 10:41:07 -0700 | [diff] [blame] | 461 | if !sanitize.Properties.SanitizerEnabled && !sanitize.Properties.UbsanRuntimeDep { | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 462 | return flags | 
|  | 463 | } | 
|  | 464 |  | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 465 | if Bool(sanitize.Properties.Sanitize.Address) { | 
| Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 466 | if ctx.Arch().ArchType == android.Arm { | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 467 | // Frame pointer based unwinder in ASan requires ARM frame setup. | 
|  | 468 | // TODO: put in flags? | 
|  | 469 | flags.RequiredInstructionSet = "arm" | 
|  | 470 | } | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 471 | flags.Local.CFlags = append(flags.Local.CFlags, asanCflags...) | 
|  | 472 | flags.Local.LdFlags = append(flags.Local.LdFlags, asanLdflags...) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 473 |  | 
| Jasraj Bedi | bb4511d | 2020-07-23 22:58:17 +0000 | [diff] [blame] | 474 | if Bool(sanitize.Properties.Sanitize.Writeonly) { | 
|  | 475 | flags.Local.CFlags = append(flags.Local.CFlags, "-mllvm", "-asan-instrument-reads=0") | 
|  | 476 | } | 
|  | 477 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 478 | if ctx.Host() { | 
|  | 479 | // -nodefaultlibs (provided with libc++) prevents the driver from linking | 
|  | 480 | // libraries needed with -fsanitize=address. http://b/18650275 (WAI) | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 481 | flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--no-as-needed") | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 482 | } else { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 483 | flags.Local.CFlags = append(flags.Local.CFlags, "-mllvm", "-asan-globals=0") | 
| Jiyong Park | a2aca28 | 2019-02-02 13:13:38 +0900 | [diff] [blame] | 484 | if ctx.bootstrap() { | 
|  | 485 | flags.DynamicLinker = "/system/bin/bootstrap/linker_asan" | 
|  | 486 | } else { | 
|  | 487 | flags.DynamicLinker = "/system/bin/linker_asan" | 
|  | 488 | } | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 489 | if flags.Toolchain.Is64Bit() { | 
|  | 490 | flags.DynamicLinker += "64" | 
|  | 491 | } | 
|  | 492 | } | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 493 | } | 
|  | 494 |  | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 495 | if Bool(sanitize.Properties.Sanitize.Hwaddress) { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 496 | flags.Local.CFlags = append(flags.Local.CFlags, hwasanCflags...) | 
| Jasraj Bedi | bb4511d | 2020-07-23 22:58:17 +0000 | [diff] [blame] | 497 | if Bool(sanitize.Properties.Sanitize.Writeonly) { | 
|  | 498 | flags.Local.CFlags = append(flags.Local.CFlags, "-mllvm", "-hwasan-instrument-reads=0") | 
|  | 499 | } | 
| Yabin Cui | 6be405e | 2017-10-19 15:52:11 -0700 | [diff] [blame] | 500 | } | 
|  | 501 |  | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 502 | if Bool(sanitize.Properties.Sanitize.Fuzzer) { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 503 | flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize=fuzzer-no-link") | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 504 |  | 
|  | 505 | // TODO(b/131771163): LTO and Fuzzer support is mutually incompatible. | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 506 | _, flags.Local.LdFlags = removeFromList("-flto", flags.Local.LdFlags) | 
|  | 507 | _, flags.Local.CFlags = removeFromList("-flto", flags.Local.CFlags) | 
|  | 508 | flags.Local.LdFlags = append(flags.Local.LdFlags, "-fno-lto") | 
|  | 509 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-lto") | 
| Mitch Phillips | 7438475 | 2019-06-17 10:33:52 -0700 | [diff] [blame] | 510 |  | 
| Mitch Phillips | b8e593d | 2019-10-09 17:18:59 -0700 | [diff] [blame] | 511 | // TODO(b/142430592): Upstream linker scripts for sanitizer runtime libraries | 
|  | 512 | // discard the sancov_lowest_stack symbol, because it's emulated TLS (and thus | 
|  | 513 | // doesn't match the linker script due to the "__emutls_v." prefix). | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 514 | flags.Local.LdFlags = append(flags.Local.LdFlags, "-fno-sanitize-coverage=stack-depth") | 
|  | 515 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-coverage=stack-depth") | 
| Mitch Phillips | b8e593d | 2019-10-09 17:18:59 -0700 | [diff] [blame] | 516 |  | 
| Mitch Phillips | 7438475 | 2019-06-17 10:33:52 -0700 | [diff] [blame] | 517 | // TODO(b/133876586): Experimental PM breaks sanitizer coverage. | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 518 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-experimental-new-pass-manager") | 
| Mitch Phillips | b9b3e79 | 2019-08-28 12:41:07 -0700 | [diff] [blame] | 519 |  | 
|  | 520 | // Disable fortify for fuzzing builds. Generally, we'll be building with | 
|  | 521 | // UBSan or ASan here and the fortify checks pollute the stack traces. | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 522 | flags.Local.CFlags = append(flags.Local.CFlags, "-U_FORTIFY_SOURCE") | 
| Mitch Phillips | 734b4cb | 2019-12-10 08:44:52 -0800 | [diff] [blame] | 523 |  | 
|  | 524 | // Build fuzzer-sanitized libraries with an $ORIGIN DT_RUNPATH. Android's | 
|  | 525 | // linker uses DT_RUNPATH, not DT_RPATH. When we deploy cc_fuzz targets and | 
|  | 526 | // their libraries to /data/fuzz/<arch>/lib, any transient shared library gets | 
|  | 527 | // the DT_RUNPATH from the shared library above it, and not the executable, | 
|  | 528 | // meaning that the lookup falls back to the system. Adding the $ORIGIN to the | 
|  | 529 | // DT_RUNPATH here means that transient shared libraries can be found | 
|  | 530 | // colocated with their parents. | 
|  | 531 | flags.Local.LdFlags = append(flags.Local.LdFlags, `-Wl,-rpath,\$$ORIGIN`) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 532 | } | 
|  | 533 |  | 
| Evgenii Stepanov | 1e405e1 | 2016-08-16 15:39:54 -0700 | [diff] [blame] | 534 | if Bool(sanitize.Properties.Sanitize.Cfi) { | 
| Evgenii Stepanov | 7ebf9fa | 2017-01-20 14:13:06 -0800 | [diff] [blame] | 535 | if ctx.Arch().ArchType == android.Arm { | 
|  | 536 | // __cfi_check needs to be built as Thumb (see the code in linker_cfi.cpp). LLVM is not set up | 
|  | 537 | // to do this on a function basis, so force Thumb on the entire module. | 
|  | 538 | flags.RequiredInstructionSet = "thumb" | 
|  | 539 | } | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 540 |  | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 541 | flags.Local.CFlags = append(flags.Local.CFlags, cfiCflags...) | 
|  | 542 | flags.Local.AsFlags = append(flags.Local.AsFlags, cfiAsflags...) | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 543 | // Only append the default visibility flag if -fvisibility has not already been set | 
|  | 544 | // to hidden. | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 545 | if !inList("-fvisibility=hidden", flags.Local.CFlags) { | 
|  | 546 | flags.Local.CFlags = append(flags.Local.CFlags, "-fvisibility=default") | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 547 | } | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 548 | flags.Local.LdFlags = append(flags.Local.LdFlags, cfiLdflags...) | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 549 |  | 
|  | 550 | if ctx.staticBinary() { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 551 | _, flags.Local.CFlags = removeFromList("-fsanitize-cfi-cross-dso", flags.Local.CFlags) | 
|  | 552 | _, flags.Local.LdFlags = removeFromList("-fsanitize-cfi-cross-dso", flags.Local.LdFlags) | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 553 | } | 
| Evgenii Stepanov | 1e405e1 | 2016-08-16 15:39:54 -0700 | [diff] [blame] | 554 | } | 
|  | 555 |  | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 556 | if Bool(sanitize.Properties.Sanitize.Integer_overflow) { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 557 | flags.Local.CFlags = append(flags.Local.CFlags, intOverflowCflags...) | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 558 | } | 
|  | 559 |  | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 560 | if len(sanitize.Properties.Sanitizers) > 0 { | 
|  | 561 | sanitizeArg := "-fsanitize=" + strings.Join(sanitize.Properties.Sanitizers, ",") | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 562 |  | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 563 | flags.Local.CFlags = append(flags.Local.CFlags, sanitizeArg) | 
|  | 564 | flags.Local.AsFlags = append(flags.Local.AsFlags, sanitizeArg) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 565 | if ctx.Host() { | 
| Evgenii Stepanov | 76cee23 | 2017-01-27 15:44:44 -0800 | [diff] [blame] | 566 | // Host sanitizers only link symbols in the final executable, so | 
|  | 567 | // there will always be undefined symbols in intermediate libraries. | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 568 | _, flags.Global.LdFlags = removeFromList("-Wl,--no-undefined", flags.Global.LdFlags) | 
|  | 569 | flags.Local.LdFlags = append(flags.Local.LdFlags, sanitizeArg) | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 570 |  | 
|  | 571 | // non-Bionic toolchain prebuilts are missing UBSan's vptr and function sanitizers | 
|  | 572 | if !ctx.toolchain().Bionic() { | 
|  | 573 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize=vptr,function") | 
|  | 574 | } | 
|  | 575 | } | 
|  | 576 |  | 
|  | 577 | if enableMinimalRuntime(sanitize) { | 
|  | 578 | flags.Local.CFlags = append(flags.Local.CFlags, strings.Join(minimalRuntimeFlags, " ")) | 
|  | 579 | flags.libFlags = append([]string{minimalRuntimePath}, flags.libFlags...) | 
|  | 580 | flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,--exclude-libs,"+minimalRuntimeLib) | 
|  | 581 | if !ctx.toolchain().Bionic() { | 
|  | 582 | flags.libFlags = append([]string{builtinsRuntimePath}, flags.libFlags...) | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 583 | } | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 584 | } | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 585 |  | 
|  | 586 | if Bool(sanitize.Properties.Sanitize.Fuzzer) { | 
|  | 587 | // When fuzzing, we wish to crash with diagnostics on any bug. | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 588 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-trap=all", "-fno-sanitize-recover=all") | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 589 | } else if ctx.Host() { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 590 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-recover=all") | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 591 | } else { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 592 | flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize-trap=all", "-ftrap-function=abort") | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 593 | } | 
| Chih-Hung Hsieh | 3567e62 | 2018-11-15 14:01:36 -0800 | [diff] [blame] | 594 | // http://b/119329758, Android core does not boot up with this sanitizer yet. | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 595 | if toDisableImplicitIntegerChange(flags.Local.CFlags) { | 
|  | 596 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize=implicit-integer-sign-change") | 
| Chih-Hung Hsieh | 3567e62 | 2018-11-15 14:01:36 -0800 | [diff] [blame] | 597 | } | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 598 | } | 
|  | 599 |  | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 600 | if len(sanitize.Properties.DiagSanitizers) > 0 { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 601 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-trap="+strings.Join(sanitize.Properties.DiagSanitizers, ",")) | 
| Evgenii Stepanov | 1e405e1 | 2016-08-16 15:39:54 -0700 | [diff] [blame] | 602 | } | 
|  | 603 | // FIXME: enable RTTI if diag + (cfi or vptr) | 
|  | 604 |  | 
| Andreas Gampe | 9707116 | 2017-05-08 13:15:23 -0700 | [diff] [blame] | 605 | if sanitize.Properties.Sanitize.Recover != nil { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 606 | flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize-recover="+ | 
| Andreas Gampe | 9707116 | 2017-05-08 13:15:23 -0700 | [diff] [blame] | 607 | strings.Join(sanitize.Properties.Sanitize.Recover, ",")) | 
|  | 608 | } | 
|  | 609 |  | 
| Ivan Lozano | 7929bba | 2018-12-12 09:36:31 -0800 | [diff] [blame] | 610 | if sanitize.Properties.Sanitize.Diag.No_recover != nil { | 
| Colin Cross | 4af21ed | 2019-11-04 09:37:55 -0800 | [diff] [blame] | 611 | flags.Local.CFlags = append(flags.Local.CFlags, "-fno-sanitize-recover="+ | 
| Ivan Lozano | 7929bba | 2018-12-12 09:36:31 -0800 | [diff] [blame] | 612 | strings.Join(sanitize.Properties.Sanitize.Diag.No_recover, ",")) | 
|  | 613 | } | 
|  | 614 |  | 
| Pirama Arumuga Nainar | 6c4ccca | 2020-07-27 11:49:51 -0700 | [diff] [blame] | 615 | blocklist := android.OptionalPathForModuleSrc(ctx, sanitize.Properties.Sanitize.Blocklist) | 
|  | 616 | if blocklist.Valid() { | 
|  | 617 | flags.Local.CFlags = append(flags.Local.CFlags, "-fsanitize-blacklist="+blocklist.String()) | 
|  | 618 | flags.CFlagsDeps = append(flags.CFlagsDeps, blocklist.Path()) | 
|  | 619 | } | 
|  | 620 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 621 | return flags | 
|  | 622 | } | 
|  | 623 |  | 
| Colin Cross | d80cbca | 2020-02-24 12:01:37 -0800 | [diff] [blame] | 624 | func (sanitize *sanitize) AndroidMkEntries(ctx AndroidMkContext, entries *android.AndroidMkEntries) { | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 625 | // Add a suffix for cfi/hwasan/scs-enabled static/header libraries to allow surfacing | 
|  | 626 | // both the sanitized and non-sanitized variants to make without a name conflict. | 
| Colin Cross | d80cbca | 2020-02-24 12:01:37 -0800 | [diff] [blame] | 627 | if entries.Class == "STATIC_LIBRARIES" || entries.Class == "HEADER_LIBRARIES" { | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 628 | if Bool(sanitize.Properties.Sanitize.Cfi) { | 
| Colin Cross | d80cbca | 2020-02-24 12:01:37 -0800 | [diff] [blame] | 629 | entries.SubName += ".cfi" | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 630 | } | 
|  | 631 | if Bool(sanitize.Properties.Sanitize.Hwaddress) { | 
| Colin Cross | d80cbca | 2020-02-24 12:01:37 -0800 | [diff] [blame] | 632 | entries.SubName += ".hwasan" | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 633 | } | 
|  | 634 | if Bool(sanitize.Properties.Sanitize.Scs) { | 
| Colin Cross | d80cbca | 2020-02-24 12:01:37 -0800 | [diff] [blame] | 635 | entries.SubName += ".scs" | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 636 | } | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 637 | } | 
| Colin Cross | 8ff9ef4 | 2017-05-08 13:44:11 -0700 | [diff] [blame] | 638 | } | 
|  | 639 |  | 
| Vishwath Mohan | 1dd8839 | 2017-03-29 22:00:18 -0700 | [diff] [blame] | 640 | func (sanitize *sanitize) inSanitizerDir() bool { | 
|  | 641 | return sanitize.Properties.InSanitizerDir | 
| Colin Cross | 30d5f51 | 2016-05-03 18:02:42 -0700 | [diff] [blame] | 642 | } | 
|  | 643 |  | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 644 | func (sanitize *sanitize) getSanitizerBoolPtr(t sanitizerType) *bool { | 
| Vishwath Mohan | 9522930 | 2017-08-11 00:53:16 +0000 | [diff] [blame] | 645 | switch t { | 
|  | 646 | case asan: | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 647 | return sanitize.Properties.Sanitize.Address | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 648 | case hwasan: | 
|  | 649 | return sanitize.Properties.Sanitize.Hwaddress | 
| Vishwath Mohan | 9522930 | 2017-08-11 00:53:16 +0000 | [diff] [blame] | 650 | case tsan: | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 651 | return sanitize.Properties.Sanitize.Thread | 
| Vishwath Mohan | 9522930 | 2017-08-11 00:53:16 +0000 | [diff] [blame] | 652 | case intOverflow: | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 653 | return sanitize.Properties.Sanitize.Integer_overflow | 
|  | 654 | case cfi: | 
|  | 655 | return sanitize.Properties.Sanitize.Cfi | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 656 | case scs: | 
|  | 657 | return sanitize.Properties.Sanitize.Scs | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 658 | case fuzzer: | 
|  | 659 | return sanitize.Properties.Sanitize.Fuzzer | 
| Vishwath Mohan | 9522930 | 2017-08-11 00:53:16 +0000 | [diff] [blame] | 660 | default: | 
|  | 661 | panic(fmt.Errorf("unknown sanitizerType %d", t)) | 
|  | 662 | } | 
|  | 663 | } | 
|  | 664 |  | 
| Dan Albert | 7d1eecf | 2018-01-19 12:30:45 -0800 | [diff] [blame] | 665 | func (sanitize *sanitize) isUnsanitizedVariant() bool { | 
|  | 666 | return !sanitize.isSanitizerEnabled(asan) && | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 667 | !sanitize.isSanitizerEnabled(hwasan) && | 
| Dan Albert | 7d1eecf | 2018-01-19 12:30:45 -0800 | [diff] [blame] | 668 | !sanitize.isSanitizerEnabled(tsan) && | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 669 | !sanitize.isSanitizerEnabled(cfi) && | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 670 | !sanitize.isSanitizerEnabled(scs) && | 
|  | 671 | !sanitize.isSanitizerEnabled(fuzzer) | 
| Dan Albert | 7d1eecf | 2018-01-19 12:30:45 -0800 | [diff] [blame] | 672 | } | 
|  | 673 |  | 
| Jayant Chowdhary | b7e08ca | 2018-05-10 15:29:24 -0700 | [diff] [blame] | 674 | func (sanitize *sanitize) isVariantOnProductionDevice() bool { | 
|  | 675 | return !sanitize.isSanitizerEnabled(asan) && | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 676 | !sanitize.isSanitizerEnabled(hwasan) && | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 677 | !sanitize.isSanitizerEnabled(tsan) && | 
|  | 678 | !sanitize.isSanitizerEnabled(fuzzer) | 
| Jayant Chowdhary | b7e08ca | 2018-05-10 15:29:24 -0700 | [diff] [blame] | 679 | } | 
|  | 680 |  | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 681 | func (sanitize *sanitize) SetSanitizer(t sanitizerType, b bool) { | 
|  | 682 | switch t { | 
|  | 683 | case asan: | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 684 | sanitize.Properties.Sanitize.Address = boolPtr(b) | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 685 | case hwasan: | 
|  | 686 | sanitize.Properties.Sanitize.Hwaddress = boolPtr(b) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 687 | case tsan: | 
| Evgenii Stepanov | fcfe56d | 2016-07-07 10:54:07 -0700 | [diff] [blame] | 688 | sanitize.Properties.Sanitize.Thread = boolPtr(b) | 
| Ivan Lozano | 0c3a1ef | 2017-06-28 09:10:48 -0700 | [diff] [blame] | 689 | case intOverflow: | 
|  | 690 | sanitize.Properties.Sanitize.Integer_overflow = boolPtr(b) | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 691 | case cfi: | 
|  | 692 | sanitize.Properties.Sanitize.Cfi = boolPtr(b) | 
| Peter Collingbourne | 8c7e6e2 | 2018-11-19 16:03:58 -0800 | [diff] [blame] | 693 | case scs: | 
|  | 694 | sanitize.Properties.Sanitize.Scs = boolPtr(b) | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 695 | case fuzzer: | 
|  | 696 | sanitize.Properties.Sanitize.Fuzzer = boolPtr(b) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 697 | default: | 
|  | 698 | panic(fmt.Errorf("unknown sanitizerType %d", t)) | 
|  | 699 | } | 
|  | 700 | if b { | 
|  | 701 | sanitize.Properties.SanitizerEnabled = true | 
|  | 702 | } | 
|  | 703 | } | 
|  | 704 |  | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 705 | // Check if the sanitizer is explicitly disabled (as opposed to nil by | 
|  | 706 | // virtue of not being set). | 
|  | 707 | func (sanitize *sanitize) isSanitizerExplicitlyDisabled(t sanitizerType) bool { | 
|  | 708 | if sanitize == nil { | 
|  | 709 | return false | 
|  | 710 | } | 
|  | 711 |  | 
|  | 712 | sanitizerVal := sanitize.getSanitizerBoolPtr(t) | 
|  | 713 | return sanitizerVal != nil && *sanitizerVal == false | 
|  | 714 | } | 
|  | 715 |  | 
|  | 716 | // There isn't an analog of the method above (ie:isSanitizerExplicitlyEnabled) | 
|  | 717 | // because enabling a sanitizer either directly (via the blueprint) or | 
|  | 718 | // indirectly (via a mutator) sets the bool ptr to true, and you can't | 
|  | 719 | // distinguish between the cases. It isn't needed though - both cases can be | 
|  | 720 | // treated identically. | 
|  | 721 | func (sanitize *sanitize) isSanitizerEnabled(t sanitizerType) bool { | 
|  | 722 | if sanitize == nil { | 
|  | 723 | return false | 
|  | 724 | } | 
|  | 725 |  | 
|  | 726 | sanitizerVal := sanitize.getSanitizerBoolPtr(t) | 
|  | 727 | return sanitizerVal != nil && *sanitizerVal == true | 
|  | 728 | } | 
|  | 729 |  | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 730 | func isSanitizableDependencyTag(tag blueprint.DependencyTag) bool { | 
| Colin Cross | 6e511a9 | 2020-07-27 21:26:48 -0700 | [diff] [blame] | 731 | switch t := tag.(type) { | 
|  | 732 | case dependencyTag: | 
|  | 733 | return t == reuseObjTag || t == objDepTag | 
|  | 734 | case libraryDependencyTag: | 
|  | 735 | return true | 
|  | 736 | default: | 
|  | 737 | return false | 
|  | 738 | } | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 739 | } | 
|  | 740 |  | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 741 | // Determines if the current module is a static library going to be captured | 
|  | 742 | // as vendor snapshot. Such modules must create both cfi and non-cfi variants, | 
|  | 743 | // except for ones which explicitly disable cfi. | 
|  | 744 | func needsCfiForVendorSnapshot(mctx android.TopDownMutatorContext) bool { | 
| Bill Peckham | 945441c | 2020-08-31 16:07:58 -0700 | [diff] [blame] | 745 | if isVendorProprietaryModule(mctx) { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 746 | return false | 
|  | 747 | } | 
|  | 748 |  | 
|  | 749 | c := mctx.Module().(*Module) | 
|  | 750 |  | 
|  | 751 | if !c.inVendor() { | 
|  | 752 | return false | 
|  | 753 | } | 
|  | 754 |  | 
|  | 755 | if !c.static() { | 
|  | 756 | return false | 
|  | 757 | } | 
|  | 758 |  | 
|  | 759 | if c.Prebuilt() != nil { | 
|  | 760 | return false | 
|  | 761 | } | 
|  | 762 |  | 
|  | 763 | return c.sanitize != nil && | 
|  | 764 | !Bool(c.sanitize.Properties.Sanitize.Never) && | 
|  | 765 | !c.sanitize.isSanitizerExplicitlyDisabled(cfi) | 
|  | 766 | } | 
|  | 767 |  | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 768 | // Propagate sanitizer requirements down from binaries | 
| Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 769 | func sanitizerDepsMutator(t sanitizerType) func(android.TopDownMutatorContext) { | 
|  | 770 | return func(mctx android.TopDownMutatorContext) { | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 771 | if c, ok := mctx.Module().(*Module); ok { | 
|  | 772 | enabled := c.sanitize.isSanitizerEnabled(t) | 
|  | 773 | if t == cfi && needsCfiForVendorSnapshot(mctx) { | 
|  | 774 | // We shouldn't change the result of isSanitizerEnabled(cfi) to correctly | 
|  | 775 | // determine defaultVariation in sanitizerMutator below. | 
|  | 776 | // Instead, just mark SanitizeDep to forcefully create cfi variant. | 
|  | 777 | enabled = true | 
|  | 778 | c.sanitize.Properties.SanitizeDep = true | 
|  | 779 | } | 
|  | 780 | if enabled { | 
|  | 781 | mctx.WalkDeps(func(child, parent android.Module) bool { | 
|  | 782 | if !isSanitizableDependencyTag(mctx.OtherModuleDependencyTag(child)) { | 
|  | 783 | return false | 
|  | 784 | } | 
|  | 785 | if d, ok := child.(*Module); ok && d.sanitize != nil && | 
|  | 786 | !Bool(d.sanitize.Properties.Sanitize.Never) && | 
|  | 787 | !d.sanitize.isSanitizerExplicitlyDisabled(t) { | 
|  | 788 | if t == cfi || t == hwasan || t == scs { | 
|  | 789 | if d.static() { | 
|  | 790 | d.sanitize.Properties.SanitizeDep = true | 
|  | 791 | } | 
|  | 792 | } else { | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 793 | d.sanitize.Properties.SanitizeDep = true | 
|  | 794 | } | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 795 | } | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 796 | return true | 
|  | 797 | }) | 
|  | 798 | } | 
| Jiyong Park | f97782b | 2019-02-13 20:28:58 +0900 | [diff] [blame] | 799 | } else if sanitizeable, ok := mctx.Module().(Sanitizeable); ok { | 
|  | 800 | // If an APEX module includes a lib which is enabled for a sanitizer T, then | 
|  | 801 | // the APEX module is also enabled for the same sanitizer type. | 
|  | 802 | mctx.VisitDirectDeps(func(child android.Module) { | 
|  | 803 | if c, ok := child.(*Module); ok && c.sanitize.isSanitizerEnabled(t) { | 
|  | 804 | sanitizeable.EnableSanitizer(t.name()) | 
|  | 805 | } | 
|  | 806 | }) | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 807 | } | 
|  | 808 | } | 
|  | 809 | } | 
|  | 810 |  | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 811 | // Propagate the ubsan minimal runtime dependency when there are integer overflow sanitized static dependencies. | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 812 | func sanitizerRuntimeDepsMutator(mctx android.TopDownMutatorContext) { | 
|  | 813 | if c, ok := mctx.Module().(*Module); ok && c.sanitize != nil { | 
|  | 814 | mctx.WalkDeps(func(child, parent android.Module) bool { | 
|  | 815 | if !isSanitizableDependencyTag(mctx.OtherModuleDependencyTag(child)) { | 
|  | 816 | return false | 
|  | 817 | } | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 818 |  | 
| Inseob Kim | eec88e1 | 2020-01-22 11:11:29 +0900 | [diff] [blame] | 819 | d, ok := child.(*Module) | 
|  | 820 | if !ok || !d.static() { | 
|  | 821 | return false | 
|  | 822 | } | 
|  | 823 | if d.sanitize != nil { | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 824 | if enableMinimalRuntime(d.sanitize) { | 
|  | 825 | // If a static dependency is built with the minimal runtime, | 
|  | 826 | // make sure we include the ubsan minimal runtime. | 
|  | 827 | c.sanitize.Properties.MinimalRuntimeDep = true | 
| Inseob Kim | 8471cda | 2019-11-15 09:59:12 +0900 | [diff] [blame] | 828 | } else if enableUbsanRuntime(d.sanitize) { | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 829 | // If a static dependency runs with full ubsan diagnostics, | 
|  | 830 | // make sure we include the ubsan runtime. | 
|  | 831 | c.sanitize.Properties.UbsanRuntimeDep = true | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 832 | } | 
| Colin Cross | 0b90833 | 2019-06-19 23:00:20 -0700 | [diff] [blame] | 833 |  | 
|  | 834 | if c.sanitize.Properties.MinimalRuntimeDep && | 
|  | 835 | c.sanitize.Properties.UbsanRuntimeDep { | 
|  | 836 | // both flags that this mutator might set are true, so don't bother recursing | 
|  | 837 | return false | 
|  | 838 | } | 
|  | 839 |  | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 840 | if c.Os() == android.Linux { | 
|  | 841 | c.sanitize.Properties.BuiltinsDep = true | 
|  | 842 | } | 
|  | 843 |  | 
| Colin Cross | 0b90833 | 2019-06-19 23:00:20 -0700 | [diff] [blame] | 844 | return true | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 845 | } | 
| Inseob Kim | eec88e1 | 2020-01-22 11:11:29 +0900 | [diff] [blame] | 846 |  | 
|  | 847 | if p, ok := d.linker.(*vendorSnapshotLibraryDecorator); ok { | 
|  | 848 | if Bool(p.properties.Sanitize_minimal_dep) { | 
|  | 849 | c.sanitize.Properties.MinimalRuntimeDep = true | 
|  | 850 | } | 
|  | 851 | if Bool(p.properties.Sanitize_ubsan_dep) { | 
|  | 852 | c.sanitize.Properties.UbsanRuntimeDep = true | 
|  | 853 | } | 
|  | 854 | } | 
|  | 855 |  | 
|  | 856 | return false | 
| Colin Cross | 6b75360 | 2018-06-21 13:03:07 -0700 | [diff] [blame] | 857 | }) | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 858 | } | 
|  | 859 | } | 
|  | 860 |  | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 861 | // Add the dependency to the runtime library for each of the sanitizer variants | 
|  | 862 | func sanitizerRuntimeMutator(mctx android.BottomUpMutatorContext) { | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 863 | if c, ok := mctx.Module().(*Module); ok && c.sanitize != nil { | 
| Pirama Arumuga Nainar | 6aa2102 | 2019-01-25 00:20:35 +0000 | [diff] [blame] | 864 | if !c.Enabled() { | 
|  | 865 | return | 
|  | 866 | } | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 867 | var sanitizers []string | 
|  | 868 | var diagSanitizers []string | 
|  | 869 |  | 
|  | 870 | if Bool(c.sanitize.Properties.Sanitize.All_undefined) { | 
|  | 871 | sanitizers = append(sanitizers, "undefined") | 
|  | 872 | } else { | 
|  | 873 | if Bool(c.sanitize.Properties.Sanitize.Undefined) { | 
|  | 874 | sanitizers = append(sanitizers, | 
|  | 875 | "bool", | 
|  | 876 | "integer-divide-by-zero", | 
|  | 877 | "return", | 
|  | 878 | "returns-nonnull-attribute", | 
|  | 879 | "shift-exponent", | 
|  | 880 | "unreachable", | 
|  | 881 | "vla-bound", | 
|  | 882 | // TODO(danalbert): The following checks currently have compiler performance issues. | 
|  | 883 | //"alignment", | 
|  | 884 | //"bounds", | 
|  | 885 | //"enum", | 
|  | 886 | //"float-cast-overflow", | 
|  | 887 | //"float-divide-by-zero", | 
|  | 888 | //"nonnull-attribute", | 
|  | 889 | //"null", | 
|  | 890 | //"shift-base", | 
|  | 891 | //"signed-integer-overflow", | 
|  | 892 | // TODO(danalbert): Fix UB in libc++'s __tree so we can turn this on. | 
|  | 893 | // https://llvm.org/PR19302 | 
|  | 894 | // http://reviews.llvm.org/D6974 | 
|  | 895 | // "object-size", | 
|  | 896 | ) | 
|  | 897 | } | 
|  | 898 | sanitizers = append(sanitizers, c.sanitize.Properties.Sanitize.Misc_undefined...) | 
|  | 899 | } | 
|  | 900 |  | 
|  | 901 | if Bool(c.sanitize.Properties.Sanitize.Diag.Undefined) { | 
|  | 902 | diagSanitizers = append(diagSanitizers, "undefined") | 
|  | 903 | } | 
|  | 904 |  | 
|  | 905 | diagSanitizers = append(diagSanitizers, c.sanitize.Properties.Sanitize.Diag.Misc_undefined...) | 
|  | 906 |  | 
|  | 907 | if Bool(c.sanitize.Properties.Sanitize.Address) { | 
|  | 908 | sanitizers = append(sanitizers, "address") | 
|  | 909 | diagSanitizers = append(diagSanitizers, "address") | 
|  | 910 | } | 
|  | 911 |  | 
|  | 912 | if Bool(c.sanitize.Properties.Sanitize.Hwaddress) { | 
|  | 913 | sanitizers = append(sanitizers, "hwaddress") | 
|  | 914 | } | 
|  | 915 |  | 
|  | 916 | if Bool(c.sanitize.Properties.Sanitize.Thread) { | 
|  | 917 | sanitizers = append(sanitizers, "thread") | 
|  | 918 | } | 
|  | 919 |  | 
|  | 920 | if Bool(c.sanitize.Properties.Sanitize.Safestack) { | 
|  | 921 | sanitizers = append(sanitizers, "safe-stack") | 
|  | 922 | } | 
|  | 923 |  | 
|  | 924 | if Bool(c.sanitize.Properties.Sanitize.Cfi) { | 
|  | 925 | sanitizers = append(sanitizers, "cfi") | 
|  | 926 |  | 
|  | 927 | if Bool(c.sanitize.Properties.Sanitize.Diag.Cfi) { | 
|  | 928 | diagSanitizers = append(diagSanitizers, "cfi") | 
|  | 929 | } | 
|  | 930 | } | 
|  | 931 |  | 
|  | 932 | if Bool(c.sanitize.Properties.Sanitize.Integer_overflow) { | 
|  | 933 | sanitizers = append(sanitizers, "unsigned-integer-overflow") | 
|  | 934 | sanitizers = append(sanitizers, "signed-integer-overflow") | 
|  | 935 | if Bool(c.sanitize.Properties.Sanitize.Diag.Integer_overflow) { | 
|  | 936 | diagSanitizers = append(diagSanitizers, "unsigned-integer-overflow") | 
|  | 937 | diagSanitizers = append(diagSanitizers, "signed-integer-overflow") | 
|  | 938 | } | 
|  | 939 | } | 
|  | 940 |  | 
|  | 941 | if Bool(c.sanitize.Properties.Sanitize.Scudo) { | 
|  | 942 | sanitizers = append(sanitizers, "scudo") | 
|  | 943 | } | 
|  | 944 |  | 
|  | 945 | if Bool(c.sanitize.Properties.Sanitize.Scs) { | 
|  | 946 | sanitizers = append(sanitizers, "shadow-call-stack") | 
|  | 947 | } | 
|  | 948 |  | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 949 | if Bool(c.sanitize.Properties.Sanitize.Fuzzer) { | 
|  | 950 | sanitizers = append(sanitizers, "fuzzer-no-link") | 
|  | 951 | } | 
|  | 952 |  | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 953 | // Save the list of sanitizers. These will be used again when generating | 
|  | 954 | // the build rules (for Cflags, etc.) | 
|  | 955 | c.sanitize.Properties.Sanitizers = sanitizers | 
|  | 956 | c.sanitize.Properties.DiagSanitizers = diagSanitizers | 
|  | 957 |  | 
| Ivan Lozano | f3b190f | 2020-03-06 12:01:21 -0500 | [diff] [blame] | 958 | // TODO(b/150822854) Hosts have a different default behavior and assume the runtime library is used. | 
|  | 959 | if c.Host() { | 
|  | 960 | diagSanitizers = sanitizers | 
|  | 961 | } | 
|  | 962 |  | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 963 | // Determine the runtime library required | 
|  | 964 | runtimeLibrary := "" | 
| Ryan Prichard | b49fe1b | 2019-10-11 15:03:34 -0700 | [diff] [blame] | 965 | var extraStaticDeps []string | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 966 | toolchain := c.toolchain(mctx) | 
|  | 967 | if Bool(c.sanitize.Properties.Sanitize.Address) { | 
|  | 968 | runtimeLibrary = config.AddressSanitizerRuntimeLibrary(toolchain) | 
|  | 969 | } else if Bool(c.sanitize.Properties.Sanitize.Hwaddress) { | 
|  | 970 | if c.staticBinary() { | 
|  | 971 | runtimeLibrary = config.HWAddressSanitizerStaticLibrary(toolchain) | 
| Ryan Prichard | b49fe1b | 2019-10-11 15:03:34 -0700 | [diff] [blame] | 972 | extraStaticDeps = []string{"libdl"} | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 973 | } else { | 
|  | 974 | runtimeLibrary = config.HWAddressSanitizerRuntimeLibrary(toolchain) | 
|  | 975 | } | 
|  | 976 | } else if Bool(c.sanitize.Properties.Sanitize.Thread) { | 
|  | 977 | runtimeLibrary = config.ThreadSanitizerRuntimeLibrary(toolchain) | 
|  | 978 | } else if Bool(c.sanitize.Properties.Sanitize.Scudo) { | 
|  | 979 | if len(diagSanitizers) == 0 && !c.sanitize.Properties.UbsanRuntimeDep { | 
|  | 980 | runtimeLibrary = config.ScudoMinimalRuntimeLibrary(toolchain) | 
|  | 981 | } else { | 
|  | 982 | runtimeLibrary = config.ScudoRuntimeLibrary(toolchain) | 
|  | 983 | } | 
| Mitch Phillips | b8e593d | 2019-10-09 17:18:59 -0700 | [diff] [blame] | 984 | } else if len(diagSanitizers) > 0 || c.sanitize.Properties.UbsanRuntimeDep || | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 985 | Bool(c.sanitize.Properties.Sanitize.Fuzzer) || | 
|  | 986 | Bool(c.sanitize.Properties.Sanitize.Undefined) || | 
|  | 987 | Bool(c.sanitize.Properties.Sanitize.All_undefined) { | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 988 | runtimeLibrary = config.UndefinedBehaviorSanitizerRuntimeLibrary(toolchain) | 
|  | 989 | } | 
|  | 990 |  | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 991 | if runtimeLibrary != "" && (toolchain.Bionic() || c.sanitize.Properties.UbsanRuntimeDep) { | 
|  | 992 | // UBSan is supported on non-bionic linux host builds as well | 
| Jooyung Han | 0302a84 | 2019-10-30 18:43:49 +0900 | [diff] [blame] | 993 | if isLlndkLibrary(runtimeLibrary, mctx.Config()) && !c.static() && c.UseVndk() { | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 994 | runtimeLibrary = runtimeLibrary + llndkLibrarySuffix | 
|  | 995 | } | 
|  | 996 |  | 
|  | 997 | // Adding dependency to the runtime library. We are using *FarVariation* | 
|  | 998 | // because the runtime libraries themselves are not mutated by sanitizer | 
|  | 999 | // mutators and thus don't have sanitizer variants whereas this module | 
|  | 1000 | // has been already mutated. | 
|  | 1001 | // | 
|  | 1002 | // Note that by adding dependency with {static|shared}DepTag, the lib is | 
|  | 1003 | // added to libFlags and LOCAL_SHARED_LIBRARIES by cc.Module | 
|  | 1004 | if c.staticBinary() { | 
| Inseob Kim | eec88e1 | 2020-01-22 11:11:29 +0900 | [diff] [blame] | 1005 | deps := append(extraStaticDeps, runtimeLibrary) | 
|  | 1006 | // If we're using snapshots and in vendor, redirect to snapshot whenever possible | 
|  | 1007 | if c.VndkVersion() == mctx.DeviceConfig().VndkVersion() { | 
|  | 1008 | snapshots := vendorSnapshotStaticLibs(mctx.Config()) | 
|  | 1009 | for idx, dep := range deps { | 
|  | 1010 | if lib, ok := snapshots.get(dep, mctx.Arch().ArchType); ok { | 
|  | 1011 | deps[idx] = lib | 
|  | 1012 | } | 
|  | 1013 | } | 
|  | 1014 | } | 
|  | 1015 |  | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 1016 | // static executable gets static runtime libs | 
| Colin Cross | 6e511a9 | 2020-07-27 21:26:48 -0700 | [diff] [blame] | 1017 | depTag := libraryDependencyTag{Kind: staticLibraryDependency} | 
| Colin Cross | 4250733 | 2020-08-21 16:15:23 -0700 | [diff] [blame] | 1018 | variations := append(mctx.Target().Variations(), | 
|  | 1019 | blueprint.Variation{Mutator: "link", Variation: "static"}) | 
|  | 1020 | if c.Device() { | 
|  | 1021 | variations = append(variations, c.ImageVariation()) | 
|  | 1022 | } | 
|  | 1023 | mctx.AddFarVariationDependencies(variations, depTag, deps...) | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1024 | } else if !c.static() && !c.header() { | 
| Inseob Kim | eec88e1 | 2020-01-22 11:11:29 +0900 | [diff] [blame] | 1025 | // If we're using snapshots and in vendor, redirect to snapshot whenever possible | 
|  | 1026 | if c.VndkVersion() == mctx.DeviceConfig().VndkVersion() { | 
|  | 1027 | snapshots := vendorSnapshotSharedLibs(mctx.Config()) | 
|  | 1028 | if lib, ok := snapshots.get(runtimeLibrary, mctx.Arch().ArchType); ok { | 
|  | 1029 | runtimeLibrary = lib | 
|  | 1030 | } | 
|  | 1031 | } | 
|  | 1032 |  | 
| Jiyong Park | 3b1746a | 2019-01-29 11:15:04 +0900 | [diff] [blame] | 1033 | // dynamic executable and shared libs get shared runtime libs | 
| Colin Cross | 6e511a9 | 2020-07-27 21:26:48 -0700 | [diff] [blame] | 1034 | depTag := libraryDependencyTag{Kind: sharedLibraryDependency, Order: earlyLibraryDependency} | 
| Colin Cross | 4250733 | 2020-08-21 16:15:23 -0700 | [diff] [blame] | 1035 | variations := append(mctx.Target().Variations(), | 
|  | 1036 | blueprint.Variation{Mutator: "link", Variation: "shared"}) | 
|  | 1037 | if c.Device() { | 
|  | 1038 | variations = append(variations, c.ImageVariation()) | 
|  | 1039 | } | 
|  | 1040 | mctx.AddFarVariationDependencies(variations, depTag, runtimeLibrary) | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 1041 | } | 
|  | 1042 | // static lib does not have dependency to the runtime library. The | 
|  | 1043 | // dependency will be added to the executables or shared libs using | 
|  | 1044 | // the static lib. | 
|  | 1045 | } | 
|  | 1046 | } | 
|  | 1047 | } | 
|  | 1048 |  | 
|  | 1049 | type Sanitizeable interface { | 
|  | 1050 | android.Module | 
| Jiyong Park | 388ef3f | 2019-01-28 19:47:32 +0900 | [diff] [blame] | 1051 | IsSanitizerEnabled(ctx android.BaseModuleContext, sanitizerName string) bool | 
| Jiyong Park | f97782b | 2019-02-13 20:28:58 +0900 | [diff] [blame] | 1052 | EnableSanitizer(sanitizerName string) | 
| Jooyung Han | 8ce8db9 | 2020-05-15 19:05:05 +0900 | [diff] [blame] | 1053 | AddSanitizerDependencies(ctx android.BottomUpMutatorContext, sanitizerName string) | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 1054 | } | 
|  | 1055 |  | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 1056 | // Create sanitized variants for modules that need them | 
| Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 1057 | func sanitizerMutator(t sanitizerType) func(android.BottomUpMutatorContext) { | 
|  | 1058 | return func(mctx android.BottomUpMutatorContext) { | 
| Vishwath Mohan | e615345 | 2017-08-11 00:52:44 +0000 | [diff] [blame] | 1059 | if c, ok := mctx.Module().(*Module); ok && c.sanitize != nil { | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 1060 | if c.isDependencyRoot() && c.sanitize.isSanitizerEnabled(t) { | 
| Jiyong Park | 8222663 | 2019-02-01 10:50:50 +0900 | [diff] [blame] | 1061 | modules := mctx.CreateVariations(t.variationName()) | 
| Colin Cross | 30d5f51 | 2016-05-03 18:02:42 -0700 | [diff] [blame] | 1062 | modules[0].(*Module).sanitize.SetSanitizer(t, true) | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 1063 | } else if c.sanitize.isSanitizerEnabled(t) || c.sanitize.Properties.SanitizeDep { | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 1064 | isSanitizerEnabled := c.sanitize.isSanitizerEnabled(t) | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1065 | if c.static() || c.header() || t == asan || t == fuzzer { | 
|  | 1066 | // Static and header libs are split into non-sanitized and sanitized variants. | 
|  | 1067 | // Shared libs are not split. However, for asan and fuzzer, we split even for shared | 
|  | 1068 | // libs because a library sanitized for asan/fuzzer can't be linked from a library | 
|  | 1069 | // that isn't sanitized for asan/fuzzer. | 
|  | 1070 | // | 
|  | 1071 | // Note for defaultVariation: since we don't split for shared libs but for static/header | 
|  | 1072 | // libs, it is possible for the sanitized variant of a static/header lib to depend | 
|  | 1073 | // on non-sanitized variant of a shared lib. Such unfulfilled variation causes an | 
|  | 1074 | // error when the module is split. defaultVariation is the name of the variation that | 
|  | 1075 | // will be used when such a dangling dependency occurs during the split of the current | 
|  | 1076 | // module. By setting it to the name of the sanitized variation, the dangling dependency | 
|  | 1077 | // is redirected to the sanitized variant of the dependent module. | 
|  | 1078 | defaultVariation := t.variationName() | 
|  | 1079 | mctx.SetDefaultDependencyVariation(&defaultVariation) | 
|  | 1080 | modules := mctx.CreateVariations("", t.variationName()) | 
|  | 1081 | modules[0].(*Module).sanitize.SetSanitizer(t, false) | 
|  | 1082 | modules[1].(*Module).sanitize.SetSanitizer(t, true) | 
|  | 1083 | modules[0].(*Module).sanitize.Properties.SanitizeDep = false | 
|  | 1084 | modules[1].(*Module).sanitize.Properties.SanitizeDep = false | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 1085 |  | 
| Ivan Lozano | 4774a81 | 2020-03-10 16:23:57 -0400 | [diff] [blame] | 1086 | if mctx.Device() && t.incompatibleWithCfi() { | 
|  | 1087 | // TODO: Make sure that cfi mutator runs "after" any of the sanitizers that | 
|  | 1088 | // are incompatible with cfi | 
|  | 1089 | modules[1].(*Module).sanitize.SetSanitizer(cfi, false) | 
|  | 1090 | } | 
|  | 1091 |  | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1092 | // For cfi/scs/hwasan, we can export both sanitized and un-sanitized variants | 
|  | 1093 | // to Make, because the sanitized version has a different suffix in name. | 
|  | 1094 | // For other types of sanitizers, suppress the variation that is disabled. | 
|  | 1095 | if t != cfi && t != scs && t != hwasan { | 
|  | 1096 | if isSanitizerEnabled { | 
|  | 1097 | modules[0].(*Module).Properties.PreventInstall = true | 
|  | 1098 | modules[0].(*Module).Properties.HideFromMake = true | 
|  | 1099 | } else { | 
|  | 1100 | modules[1].(*Module).Properties.PreventInstall = true | 
|  | 1101 | modules[1].(*Module).Properties.HideFromMake = true | 
|  | 1102 | } | 
|  | 1103 | } | 
| Vishwath Mohan | b743e9c | 2017-11-01 09:20:21 +0000 | [diff] [blame] | 1104 |  | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1105 | // Export the static lib name to make | 
| Dan Willemsen | b5b2aba | 2020-05-03 21:28:32 -0700 | [diff] [blame] | 1106 | if c.static() && c.ExportedToMake() { | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1107 | if t == cfi { | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1108 | cfiStaticLibs(mctx.Config()).add(c, c.Name()) | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1109 | } else if t == hwasan { | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1110 | hwasanStaticLibs(mctx.Config()).add(c, c.Name()) | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1111 | } | 
|  | 1112 | } | 
|  | 1113 | } else { | 
|  | 1114 | // Shared libs are not split. Only the sanitized variant is created. | 
|  | 1115 | modules := mctx.CreateVariations(t.variationName()) | 
|  | 1116 | modules[0].(*Module).sanitize.SetSanitizer(t, true) | 
|  | 1117 | modules[0].(*Module).sanitize.Properties.SanitizeDep = false | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 1118 |  | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1119 | // locate the asan libraries under /data/asan | 
|  | 1120 | if mctx.Device() && t == asan && isSanitizerEnabled { | 
|  | 1121 | modules[0].(*Module).sanitize.Properties.InSanitizerDir = true | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 1122 | } | 
| Ivan Lozano | 4774a81 | 2020-03-10 16:23:57 -0400 | [diff] [blame] | 1123 |  | 
|  | 1124 | if mctx.Device() && t.incompatibleWithCfi() { | 
|  | 1125 | // TODO: Make sure that cfi mutator runs "after" any of the sanitizers that | 
|  | 1126 | // are incompatible with cfi | 
|  | 1127 | modules[0].(*Module).sanitize.SetSanitizer(cfi, false) | 
|  | 1128 | } | 
| Vishwath Mohan | e21fe42 | 2017-11-01 19:42:45 -0700 | [diff] [blame] | 1129 | } | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 1130 | } | 
|  | 1131 | c.sanitize.Properties.SanitizeDep = false | 
| Jiyong Park | 8222663 | 2019-02-01 10:50:50 +0900 | [diff] [blame] | 1132 | } else if sanitizeable, ok := mctx.Module().(Sanitizeable); ok && sanitizeable.IsSanitizerEnabled(mctx, t.name()) { | 
| Jiyong Park | 379de2f | 2018-12-19 02:47:14 +0900 | [diff] [blame] | 1133 | // APEX modules fall here | 
| Jooyung Han | 8ce8db9 | 2020-05-15 19:05:05 +0900 | [diff] [blame] | 1134 | sanitizeable.AddSanitizerDependencies(mctx, t.name()) | 
| Jiyong Park | 8222663 | 2019-02-01 10:50:50 +0900 | [diff] [blame] | 1135 | mctx.CreateVariations(t.variationName()) | 
| Inseob Kim | c42f2f2 | 2020-07-29 20:32:10 +0900 | [diff] [blame] | 1136 | } else if c, ok := mctx.Module().(*Module); ok { | 
|  | 1137 | // Check if it's a snapshot module supporting sanitizer | 
|  | 1138 | if s, ok := c.linker.(snapshotSanitizer); ok && s.isSanitizerEnabled(t) { | 
|  | 1139 | // Set default variation as above. | 
|  | 1140 | defaultVariation := t.variationName() | 
|  | 1141 | mctx.SetDefaultDependencyVariation(&defaultVariation) | 
|  | 1142 | modules := mctx.CreateVariations("", t.variationName()) | 
|  | 1143 | modules[0].(*Module).linker.(snapshotSanitizer).setSanitizerVariation(t, false) | 
|  | 1144 | modules[1].(*Module).linker.(snapshotSanitizer).setSanitizerVariation(t, true) | 
|  | 1145 |  | 
|  | 1146 | // Export the static lib name to make | 
|  | 1147 | if c.static() && c.ExportedToMake() { | 
|  | 1148 | if t == cfi { | 
|  | 1149 | // use BaseModuleName which is the name for Make. | 
|  | 1150 | cfiStaticLibs(mctx.Config()).add(c, c.BaseModuleName()) | 
|  | 1151 | } | 
|  | 1152 | } | 
|  | 1153 | } | 
| Colin Cross | 16b2349 | 2016-01-06 14:41:07 -0800 | [diff] [blame] | 1154 | } | 
|  | 1155 | } | 
|  | 1156 | } | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 1157 |  | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1158 | type sanitizerStaticLibsMap struct { | 
|  | 1159 | // libsMap contains one list of modules per each image and each arch. | 
|  | 1160 | // e.g. libs[vendor]["arm"] contains arm modules installed to vendor | 
|  | 1161 | libsMap       map[imageVariantType]map[string][]string | 
|  | 1162 | libsMapLock   sync.Mutex | 
|  | 1163 | sanitizerType sanitizerType | 
|  | 1164 | } | 
|  | 1165 |  | 
|  | 1166 | func newSanitizerStaticLibsMap(t sanitizerType) *sanitizerStaticLibsMap { | 
|  | 1167 | return &sanitizerStaticLibsMap{ | 
|  | 1168 | sanitizerType: t, | 
|  | 1169 | libsMap:       make(map[imageVariantType]map[string][]string), | 
|  | 1170 | } | 
|  | 1171 | } | 
|  | 1172 |  | 
|  | 1173 | // Add the current module to sanitizer static libs maps | 
|  | 1174 | // Each module should pass its exported name as names of Make and Soong can differ. | 
|  | 1175 | func (s *sanitizerStaticLibsMap) add(c *Module, name string) { | 
|  | 1176 | image := c.getImageVariantType() | 
|  | 1177 | arch := c.Arch().ArchType.String() | 
|  | 1178 |  | 
|  | 1179 | s.libsMapLock.Lock() | 
|  | 1180 | defer s.libsMapLock.Unlock() | 
|  | 1181 |  | 
|  | 1182 | if _, ok := s.libsMap[image]; !ok { | 
|  | 1183 | s.libsMap[image] = make(map[string][]string) | 
|  | 1184 | } | 
|  | 1185 |  | 
|  | 1186 | s.libsMap[image][arch] = append(s.libsMap[image][arch], name) | 
|  | 1187 | } | 
|  | 1188 |  | 
|  | 1189 | // Exports makefile variables in the following format: | 
|  | 1190 | // SOONG_{sanitizer}_{image}_{arch}_STATIC_LIBRARIES | 
|  | 1191 | // e.g. SOONG_cfi_core_x86_STATIC_LIBRARIES | 
|  | 1192 | // These are to be used by use_soong_sanitized_static_libraries. | 
|  | 1193 | // See build/make/core/binary.mk for more details. | 
|  | 1194 | func (s *sanitizerStaticLibsMap) exportToMake(ctx android.MakeVarsContext) { | 
|  | 1195 | for _, image := range android.SortedStringKeys(s.libsMap) { | 
|  | 1196 | archMap := s.libsMap[imageVariantType(image)] | 
|  | 1197 | for _, arch := range android.SortedStringKeys(archMap) { | 
|  | 1198 | libs := archMap[arch] | 
|  | 1199 | sort.Strings(libs) | 
|  | 1200 |  | 
|  | 1201 | key := fmt.Sprintf( | 
|  | 1202 | "SOONG_%s_%s_%s_STATIC_LIBRARIES", | 
|  | 1203 | s.sanitizerType.variationName(), | 
|  | 1204 | image, // already upper | 
|  | 1205 | arch) | 
|  | 1206 |  | 
|  | 1207 | ctx.Strict(key, strings.Join(libs, " ")) | 
|  | 1208 | } | 
|  | 1209 | } | 
|  | 1210 | } | 
|  | 1211 |  | 
| Colin Cross | 571cccf | 2019-02-04 11:22:08 -0800 | [diff] [blame] | 1212 | var cfiStaticLibsKey = android.NewOnceKey("cfiStaticLibs") | 
|  | 1213 |  | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1214 | func cfiStaticLibs(config android.Config) *sanitizerStaticLibsMap { | 
| Colin Cross | 571cccf | 2019-02-04 11:22:08 -0800 | [diff] [blame] | 1215 | return config.Once(cfiStaticLibsKey, func() interface{} { | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1216 | return newSanitizerStaticLibsMap(cfi) | 
|  | 1217 | }).(*sanitizerStaticLibsMap) | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 1218 | } | 
|  | 1219 |  | 
| Colin Cross | 571cccf | 2019-02-04 11:22:08 -0800 | [diff] [blame] | 1220 | var hwasanStaticLibsKey = android.NewOnceKey("hwasanStaticLibs") | 
|  | 1221 |  | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1222 | func hwasanStaticLibs(config android.Config) *sanitizerStaticLibsMap { | 
| Colin Cross | 571cccf | 2019-02-04 11:22:08 -0800 | [diff] [blame] | 1223 | return config.Once(hwasanStaticLibsKey, func() interface{} { | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1224 | return newSanitizerStaticLibsMap(hwasan) | 
|  | 1225 | }).(*sanitizerStaticLibsMap) | 
| Jiyong Park | 1d1119f | 2019-07-29 21:27:18 +0900 | [diff] [blame] | 1226 | } | 
|  | 1227 |  | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 1228 | func enableMinimalRuntime(sanitize *sanitize) bool { | 
|  | 1229 | if !Bool(sanitize.Properties.Sanitize.Address) && | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 1230 | !Bool(sanitize.Properties.Sanitize.Hwaddress) && | 
| Mitch Phillips | 5a6ea6c | 2019-05-01 14:42:05 -0700 | [diff] [blame] | 1231 | !Bool(sanitize.Properties.Sanitize.Fuzzer) && | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 1232 |  | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 1233 | (Bool(sanitize.Properties.Sanitize.Integer_overflow) || | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 1234 | len(sanitize.Properties.Sanitize.Misc_undefined) > 0 || | 
|  | 1235 | Bool(sanitize.Properties.Sanitize.Undefined) || | 
|  | 1236 | Bool(sanitize.Properties.Sanitize.All_undefined)) && | 
|  | 1237 |  | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 1238 | !(Bool(sanitize.Properties.Sanitize.Diag.Integer_overflow) || | 
|  | 1239 | Bool(sanitize.Properties.Sanitize.Diag.Cfi) || | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 1240 | Bool(sanitize.Properties.Sanitize.Diag.Undefined) || | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 1241 | len(sanitize.Properties.Sanitize.Diag.Misc_undefined) > 0) { | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 1242 |  | 
| Ivan Lozano | 30c5db2 | 2018-02-21 15:49:20 -0800 | [diff] [blame] | 1243 | return true | 
|  | 1244 | } | 
|  | 1245 | return false | 
|  | 1246 | } | 
|  | 1247 |  | 
| Inseob Kim | 8471cda | 2019-11-15 09:59:12 +0900 | [diff] [blame] | 1248 | func enableUbsanRuntime(sanitize *sanitize) bool { | 
|  | 1249 | return Bool(sanitize.Properties.Sanitize.Diag.Integer_overflow) || | 
| Ivan Lozano | 9ac32c7 | 2020-02-19 15:24:02 -0500 | [diff] [blame] | 1250 | Bool(sanitize.Properties.Sanitize.Diag.Undefined) || | 
| Inseob Kim | 8471cda | 2019-11-15 09:59:12 +0900 | [diff] [blame] | 1251 | len(sanitize.Properties.Sanitize.Diag.Misc_undefined) > 0 | 
|  | 1252 | } | 
|  | 1253 |  | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 1254 | func cfiMakeVarsProvider(ctx android.MakeVarsContext) { | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1255 | cfiStaticLibs(ctx.Config()).exportToMake(ctx) | 
| Vishwath Mohan | e712879 | 2017-11-17 11:08:10 -0800 | [diff] [blame] | 1256 | } | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 1257 |  | 
|  | 1258 | func hwasanMakeVarsProvider(ctx android.MakeVarsContext) { | 
| Inseob Kim | 74d2556 | 2020-08-04 00:41:38 +0900 | [diff] [blame] | 1259 | hwasanStaticLibs(ctx.Config()).exportToMake(ctx) | 
| Evgenii Stepanov | d97a6e9 | 2018-08-02 16:19:13 -0700 | [diff] [blame] | 1260 | } |