msan.cc revision 99bf1d71c634ab0ed39d7614fd8f8f2c2201e111
1//===-- msan.cc -----------------------------------------------------------===// 2// 3// The LLVM Compiler Infrastructure 4// 5// This file is distributed under the University of Illinois Open Source 6// License. See LICENSE.TXT for details. 7// 8//===----------------------------------------------------------------------===// 9// 10// This file is a part of MemorySanitizer. 11// 12// MemorySanitizer runtime. 13//===----------------------------------------------------------------------===// 14 15#include "msan.h" 16#include "sanitizer_common/sanitizer_atomic.h" 17#include "sanitizer_common/sanitizer_common.h" 18#include "sanitizer_common/sanitizer_flags.h" 19#include "sanitizer_common/sanitizer_libc.h" 20#include "sanitizer_common/sanitizer_procmaps.h" 21#include "sanitizer_common/sanitizer_stacktrace.h" 22#include "sanitizer_common/sanitizer_symbolizer.h" 23 24#include "interception/interception.h" 25 26// ACHTUNG! No system header includes in this file. 27 28using namespace __sanitizer; 29 30// Globals. 31static THREADLOCAL int msan_expect_umr = 0; 32static THREADLOCAL int msan_expected_umr_found = 0; 33 34static int msan_running_under_dr = 0; 35 36SANITIZER_INTERFACE_ATTRIBUTE 37THREADLOCAL u64 __msan_param_tls[kMsanParamTlsSizeInWords]; 38 39SANITIZER_INTERFACE_ATTRIBUTE 40THREADLOCAL u32 __msan_param_origin_tls[kMsanParamTlsSizeInWords]; 41 42SANITIZER_INTERFACE_ATTRIBUTE 43THREADLOCAL u64 __msan_retval_tls[kMsanRetvalTlsSizeInWords]; 44 45SANITIZER_INTERFACE_ATTRIBUTE 46THREADLOCAL u32 __msan_retval_origin_tls; 47 48SANITIZER_INTERFACE_ATTRIBUTE 49THREADLOCAL u64 __msan_va_arg_tls[kMsanParamTlsSizeInWords]; 50 51SANITIZER_INTERFACE_ATTRIBUTE 52THREADLOCAL u64 __msan_va_arg_overflow_size_tls; 53 54SANITIZER_INTERFACE_ATTRIBUTE 55THREADLOCAL u32 __msan_origin_tls; 56 57static THREADLOCAL struct { 58 uptr stack_top, stack_bottom; 59} __msan_stack_bounds; 60 61extern const int __msan_track_origins; 62int __msan_get_track_origins() { 63 return __msan_track_origins; 64} 65 66namespace __msan { 67 68static bool IsRunningUnderDr() { 69 bool result = false; 70 MemoryMappingLayout proc_maps; 71 const sptr kBufSize = 4095; 72 char *filename = (char*)MmapOrDie(kBufSize, __FUNCTION__); 73 while (proc_maps.Next(/* start */0, /* end */0, /* file_offset */0, 74 filename, kBufSize)) { 75 if (internal_strstr(filename, "libdynamorio") != 0) { 76 result = true; 77 break; 78 } 79 } 80 UnmapOrDie(filename, kBufSize); 81 return result; 82} 83 84static Flags msan_flags; 85 86Flags *flags() { 87 return &msan_flags; 88} 89 90int msan_inited = 0; 91bool msan_init_is_running; 92 93int msan_report_count = 0; 94 95// Array of stack origins. 96// FIXME: make it resizable. 97static const uptr kNumStackOriginDescrs = 1024 * 1024; 98static const char *StackOriginDescr[kNumStackOriginDescrs]; 99static atomic_uint32_t NumStackOriginDescrs; 100 101static void ParseFlagsFromString(Flags *f, const char *str) { 102 ParseFlag(str, &f->poison_heap_with_zeroes, "poison_heap_with_zeroes"); 103 ParseFlag(str, &f->poison_stack_with_zeroes, "poison_stack_with_zeroes"); 104 ParseFlag(str, &f->poison_in_malloc, "poison_in_malloc"); 105 ParseFlag(str, &f->exit_code, "exit_code"); 106 if (f->exit_code < 0 || f->exit_code > 127) { 107 Printf("Exit code not in [0, 128) range: %d\n", f->exit_code); 108 f->exit_code = 1; 109 Die(); 110 } 111 ParseFlag(str, &f->num_callers, "num_callers"); 112 ParseFlag(str, &f->report_umrs, "report_umrs"); 113 ParseFlag(str, &f->verbosity, "verbosity"); 114} 115 116static void InitializeFlags(Flags *f, const char *options) { 117 internal_memset(f, 0, sizeof(*f)); 118 119 f->poison_heap_with_zeroes = false; 120 f->poison_stack_with_zeroes = false; 121 f->poison_in_malloc = true; 122 f->exit_code = 77; 123 f->num_callers = 20; 124 f->report_umrs = true; 125 f->verbosity = 0; 126 127 ParseFlagsFromString(f, options); 128} 129 130static void GetCurrentStackBounds(uptr *stack_top, uptr *stack_bottom) { 131 if (__msan_stack_bounds.stack_top == 0) { 132 // Break recursion (GetStackTrace -> GetThreadStackTopAndBottom -> 133 // realloc -> GetStackTrace). 134 __msan_stack_bounds.stack_top = __msan_stack_bounds.stack_bottom = 1; 135 GetThreadStackTopAndBottom(/* at_initialization */false, 136 &__msan_stack_bounds.stack_top, 137 &__msan_stack_bounds.stack_bottom); 138 } 139 *stack_top = __msan_stack_bounds.stack_top; 140 *stack_bottom = __msan_stack_bounds.stack_bottom; 141} 142 143void GetStackTrace(StackTrace *stack, uptr max_s, uptr pc, uptr bp) { 144 uptr stack_top, stack_bottom; 145 GetCurrentStackBounds(&stack_top, &stack_bottom); 146 stack->size = 0; 147 stack->trace[0] = pc; 148 stack->max_size = max_s; 149 stack->FastUnwindStack(pc, bp, stack_top, stack_bottom); 150} 151 152void PrintWarning(uptr pc, uptr bp) { 153 PrintWarningWithOrigin(pc, bp, __msan_origin_tls); 154} 155 156bool OriginIsValid(u32 origin) { 157 return origin != 0 && origin != (u32)-1; 158} 159 160void PrintWarningWithOrigin(uptr pc, uptr bp, u32 origin) { 161 if (msan_expect_umr) { 162 // Printf("Expected UMR\n"); 163 __msan_origin_tls = origin; 164 msan_expected_umr_found = 1; 165 return; 166 } 167 168 ++msan_report_count; 169 170 StackTrace stack; 171 GetStackTrace(&stack, kStackTraceMax, pc, bp); 172 173 u32 report_origin = 174 (__msan_track_origins && OriginIsValid(origin)) ? origin : 0; 175 ReportUMR(&stack, report_origin); 176 177 if (__msan_track_origins && !OriginIsValid(origin)) { 178 Printf(" ORIGIN: invalid (%x). Might be a bug in MemorySanitizer, " 179 "please report to MemorySanitizer developers.\n", 180 origin); 181 } 182} 183 184} // namespace __msan 185 186// Interface. 187 188using namespace __msan; 189 190void __msan_warning() { 191 GET_CALLER_PC_BP_SP; 192 (void)sp; 193 PrintWarning(pc, bp); 194} 195 196void __msan_warning_noreturn() { 197 GET_CALLER_PC_BP_SP; 198 (void)sp; 199 PrintWarning(pc, bp); 200 Printf("Exiting\n"); 201 Die(); 202} 203 204void __msan_init() { 205 if (msan_inited) return; 206 msan_init_is_running = 1; 207 208 InstallAtExitHandler(); 209 SetDieCallback(MsanDie); 210 InitializeInterceptors(); 211 212 ReplaceOperatorsNewAndDelete(); 213 if (StackSizeIsUnlimited()) { 214 if (flags()->verbosity) 215 Printf("Unlimited stack, doing reexec\n"); 216 // A reasonably large stack size. It is bigger than the usual 8Mb, because, 217 // well, the program could have been run with unlimited stack for a reason. 218 SetStackSizeLimitInBytes(32 * 1024 * 1024); 219 ReExec(); 220 } 221 const char *msan_options = GetEnv("MSAN_OPTIONS"); 222 InitializeFlags(&msan_flags, msan_options); 223 if (flags()->verbosity) 224 Printf("MSAN_OPTIONS: %s\n", msan_options ? msan_options : "<empty>"); 225 msan_running_under_dr = IsRunningUnderDr(); 226 __msan_clear_on_return(); 227 if (__msan_track_origins && flags()->verbosity > 0) 228 Printf("msan_track_origins\n"); 229 if (!InitShadow(/* prot1 */false, /* prot2 */true, /* map_shadow */true, 230 __msan_track_origins)) { 231 // FIXME: prot1 = false is only required when running under DR. 232 Printf("FATAL: MemorySanitizer can not mmap the shadow memory.\n"); 233 Printf("FATAL: Make sure to compile with -fPIE and to link with -pie.\n"); 234 Printf("FATAL: Disabling ASLR is known to cause this error.\n"); 235 Printf("FATAL: If running under GDB, try " 236 "'set disable-randomization off'.\n"); 237 DumpProcessMap(); 238 Die(); 239 } 240 241 InstallTrapHandler(); 242 243 const char *external_symbolizer = GetEnv("MSAN_SYMBOLIZER_PATH"); 244 if (external_symbolizer && external_symbolizer[0]) { 245 CHECK(InitializeExternalSymbolizer(external_symbolizer)); 246 } 247 248 GetThreadStackTopAndBottom(/* at_initialization */true, 249 &__msan_stack_bounds.stack_top, 250 &__msan_stack_bounds.stack_bottom); 251 if (flags()->verbosity) 252 Printf("MemorySanitizer init done\n"); 253 msan_init_is_running = 0; 254 msan_inited = 1; 255} 256 257void __msan_set_exit_code(int exit_code) { 258 flags()->exit_code = exit_code; 259} 260 261void __msan_set_expect_umr(int expect_umr) { 262 if (expect_umr) { 263 msan_expected_umr_found = 0; 264 } else if (!msan_expected_umr_found) { 265 GET_CALLER_PC_BP_SP; 266 (void)sp; 267 StackTrace stack; 268 GetStackTrace(&stack, kStackTraceMax, pc, bp); 269 ReportExpectedUMRNotFound(&stack); 270 Die(); 271 } 272 msan_expect_umr = expect_umr; 273} 274 275void __msan_print_shadow(const void *x, uptr size) { 276 unsigned char *s = (unsigned char*)MEM_TO_SHADOW(x); 277 u32 *o = (u32*)MEM_TO_ORIGIN(x); 278 for (uptr i = 0; i < size; i++) { 279 Printf("%x%x ", s[i] >> 4, s[i] & 0xf); 280 } 281 Printf("\n"); 282 if (__msan_track_origins) { 283 for (uptr i = 0; i < size / 4; i++) { 284 Printf(" o: %x ", o[i]); 285 } 286 Printf("\n"); 287 } 288} 289 290void __msan_print_param_shadow() { 291 for (int i = 0; i < 16; i++) { 292 Printf("#%d:%zx ", i, __msan_param_tls[i]); 293 } 294 Printf("\n"); 295} 296 297sptr __msan_test_shadow(const void *x, uptr size) { 298 unsigned char *s = (unsigned char*)MEM_TO_SHADOW((uptr)x); 299 for (uptr i = 0; i < size; ++i) 300 if (s[i]) 301 return i; 302 return -1; 303} 304 305int __msan_set_poison_in_malloc(int do_poison) { 306 int old = flags()->poison_in_malloc; 307 flags()->poison_in_malloc = do_poison; 308 return old; 309} 310 311void __msan_break_optimization(void *x) { } 312 313int __msan_has_dynamic_component() { 314 return msan_running_under_dr; 315} 316 317NOINLINE 318void __msan_clear_on_return() { 319 __msan_param_tls[0] = 0; 320} 321 322static void* get_tls_base() { 323 u64 p; 324 asm("mov %%fs:0, %0" 325 : "=r"(p) ::); 326 return (void*)p; 327} 328 329int __msan_get_retval_tls_offset() { 330 // volatile here is needed to avoid UB, because the compiler thinks that we 331 // are doing address arithmetics on unrelated pointers, and takes some 332 // shortcuts 333 volatile sptr retval_tls_p = (sptr)&__msan_retval_tls; 334 volatile sptr tls_base_p = (sptr)get_tls_base(); 335 return retval_tls_p - tls_base_p; 336} 337 338int __msan_get_param_tls_offset() { 339 // volatile here is needed to avoid UB, because the compiler thinks that we 340 // are doing address arithmetics on unrelated pointers, and takes some 341 // shortcuts 342 volatile sptr param_tls_p = (sptr)&__msan_param_tls; 343 volatile sptr tls_base_p = (sptr)get_tls_base(); 344 return param_tls_p - tls_base_p; 345} 346 347void __msan_partial_poison(void* data, void* shadow, uptr size) { 348 internal_memcpy((void*)MEM_TO_SHADOW((uptr)data), shadow, size); 349} 350 351void __msan_load_unpoisoned(void *src, uptr size, void *dst) { 352 internal_memcpy(dst, src, size); 353 __msan_unpoison(dst, size); 354} 355 356void __msan_set_origin(void *a, uptr size, u32 origin) { 357 // Origin mapping is 4 bytes per 4 bytes of application memory. 358 // Here we extend the range such that its left and right bounds are both 359 // 4 byte aligned. 360 if (!__msan_track_origins) return; 361 uptr x = MEM_TO_ORIGIN((uptr)a); 362 uptr beg = x & ~3UL; // align down. 363 uptr end = (x + size + 3) & ~3UL; // align up. 364 u64 origin64 = ((u64)origin << 32) | origin; 365 // This is like memset, but the value is 32-bit. We unroll by 2 two write 366 // 64-bits at once. May want to unroll further to get 128-bit stores. 367 if (beg & 7ULL) { 368 *(u32*)beg = origin; 369 beg += 4; 370 } 371 for (uptr addr = beg; addr < (end & ~7UL); addr += 8) 372 *(u64*)addr = origin64; 373 if (end & 7ULL) 374 *(u32*)(end - 4) = origin; 375} 376 377// 'descr' is created at compile time and contains '----' in the beginning. 378// When we see descr for the first time we replace '----' with a uniq id 379// and set the origin to (id | (31-th bit)). 380void __msan_set_alloca_origin(void *a, uptr size, const char *descr) { 381 static const u32 dash = '-'; 382 static const u32 first_timer = 383 dash + (dash << 8) + (dash << 16) + (dash << 24); 384 u32 *id_ptr = (u32*)descr; 385 bool print = false; // internal_strstr(descr + 4, "AllocaTOTest") != 0; 386 u32 id = *id_ptr; 387 if (id == first_timer) { 388 id = atomic_fetch_add(&NumStackOriginDescrs, 389 1, memory_order_relaxed); 390 *id_ptr = id; 391 CHECK_LT(id, kNumStackOriginDescrs); 392 StackOriginDescr[id] = descr + 4; 393 if (print) 394 Printf("First time: id=%d %s \n", id, descr + 4); 395 } 396 id |= 1U << 31; 397 if (print) 398 Printf("__msan_set_alloca_origin: descr=%s id=%x\n", descr + 4, id); 399 __msan_set_origin(a, size, id); 400} 401 402const char *__msan_get_origin_descr_if_stack(u32 id) { 403 if ((id >> 31) == 0) return 0; 404 id &= (1U << 31) - 1; 405 CHECK_LT(id, kNumStackOriginDescrs); 406 return StackOriginDescr[id]; 407} 408 409 410u32 __msan_get_origin(void *a) { 411 if (!__msan_track_origins) return 0; 412 uptr x = (uptr)a; 413 uptr aligned = x & ~3ULL; 414 uptr origin_ptr = MEM_TO_ORIGIN(aligned); 415 return *(u32*)origin_ptr; 416} 417 418u32 __msan_get_origin_tls() { 419 return __msan_origin_tls; 420} 421