1*68d75effSDimitry Andric //===-- msan.cpp ----------------------------------------------------------===// 2*68d75effSDimitry Andric // 3*68d75effSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4*68d75effSDimitry Andric // See https://llvm.org/LICENSE.txt for license information. 5*68d75effSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6*68d75effSDimitry Andric // 7*68d75effSDimitry Andric //===----------------------------------------------------------------------===// 8*68d75effSDimitry Andric // 9*68d75effSDimitry Andric // This file is a part of MemorySanitizer. 10*68d75effSDimitry Andric // 11*68d75effSDimitry Andric // MemorySanitizer runtime. 12*68d75effSDimitry Andric //===----------------------------------------------------------------------===// 13*68d75effSDimitry Andric 14*68d75effSDimitry Andric #include "msan.h" 15*68d75effSDimitry Andric #include "msan_chained_origin_depot.h" 16*68d75effSDimitry Andric #include "msan_origin.h" 17*68d75effSDimitry Andric #include "msan_report.h" 18*68d75effSDimitry Andric #include "msan_thread.h" 19*68d75effSDimitry Andric #include "msan_poisoning.h" 20*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_atomic.h" 21*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_common.h" 22*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_flags.h" 23*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_flag_parser.h" 24*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_libc.h" 25*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_procmaps.h" 26*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_stacktrace.h" 27*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_symbolizer.h" 28*68d75effSDimitry Andric #include "sanitizer_common/sanitizer_stackdepot.h" 29*68d75effSDimitry Andric #include "ubsan/ubsan_flags.h" 30*68d75effSDimitry Andric #include "ubsan/ubsan_init.h" 31*68d75effSDimitry Andric 32*68d75effSDimitry Andric // ACHTUNG! No system header includes in this file. 33*68d75effSDimitry Andric 34*68d75effSDimitry Andric using namespace __sanitizer; 35*68d75effSDimitry Andric 36*68d75effSDimitry Andric // Globals. 37*68d75effSDimitry Andric static THREADLOCAL int msan_expect_umr = 0; 38*68d75effSDimitry Andric static THREADLOCAL int msan_expected_umr_found = 0; 39*68d75effSDimitry Andric 40*68d75effSDimitry Andric // Function argument shadow. Each argument starts at the next available 8-byte 41*68d75effSDimitry Andric // aligned address. 42*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 43*68d75effSDimitry Andric THREADLOCAL u64 __msan_param_tls[kMsanParamTlsSize / sizeof(u64)]; 44*68d75effSDimitry Andric 45*68d75effSDimitry Andric // Function argument origin. Each argument starts at the same offset as the 46*68d75effSDimitry Andric // corresponding shadow in (__msan_param_tls). Slightly weird, but changing this 47*68d75effSDimitry Andric // would break compatibility with older prebuilt binaries. 48*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 49*68d75effSDimitry Andric THREADLOCAL u32 __msan_param_origin_tls[kMsanParamTlsSize / sizeof(u32)]; 50*68d75effSDimitry Andric 51*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 52*68d75effSDimitry Andric THREADLOCAL u64 __msan_retval_tls[kMsanRetvalTlsSize / sizeof(u64)]; 53*68d75effSDimitry Andric 54*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 55*68d75effSDimitry Andric THREADLOCAL u32 __msan_retval_origin_tls; 56*68d75effSDimitry Andric 57*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 58*68d75effSDimitry Andric ALIGNED(16) THREADLOCAL u64 __msan_va_arg_tls[kMsanParamTlsSize / sizeof(u64)]; 59*68d75effSDimitry Andric 60*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 61*68d75effSDimitry Andric ALIGNED(16) 62*68d75effSDimitry Andric THREADLOCAL u32 __msan_va_arg_origin_tls[kMsanParamTlsSize / sizeof(u32)]; 63*68d75effSDimitry Andric 64*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 65*68d75effSDimitry Andric THREADLOCAL u64 __msan_va_arg_overflow_size_tls; 66*68d75effSDimitry Andric 67*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 68*68d75effSDimitry Andric THREADLOCAL u32 __msan_origin_tls; 69*68d75effSDimitry Andric 70*68d75effSDimitry Andric static THREADLOCAL int is_in_symbolizer; 71*68d75effSDimitry Andric 72*68d75effSDimitry Andric extern "C" SANITIZER_WEAK_ATTRIBUTE const int __msan_track_origins; 73*68d75effSDimitry Andric 74*68d75effSDimitry Andric int __msan_get_track_origins() { 75*68d75effSDimitry Andric return &__msan_track_origins ? __msan_track_origins : 0; 76*68d75effSDimitry Andric } 77*68d75effSDimitry Andric 78*68d75effSDimitry Andric extern "C" SANITIZER_WEAK_ATTRIBUTE const int __msan_keep_going; 79*68d75effSDimitry Andric 80*68d75effSDimitry Andric namespace __msan { 81*68d75effSDimitry Andric 82*68d75effSDimitry Andric void EnterSymbolizer() { ++is_in_symbolizer; } 83*68d75effSDimitry Andric void ExitSymbolizer() { --is_in_symbolizer; } 84*68d75effSDimitry Andric bool IsInSymbolizer() { return is_in_symbolizer; } 85*68d75effSDimitry Andric 86*68d75effSDimitry Andric static Flags msan_flags; 87*68d75effSDimitry Andric 88*68d75effSDimitry Andric Flags *flags() { 89*68d75effSDimitry Andric return &msan_flags; 90*68d75effSDimitry Andric } 91*68d75effSDimitry Andric 92*68d75effSDimitry Andric int msan_inited = 0; 93*68d75effSDimitry Andric bool msan_init_is_running; 94*68d75effSDimitry Andric 95*68d75effSDimitry Andric int msan_report_count = 0; 96*68d75effSDimitry Andric 97*68d75effSDimitry Andric // Array of stack origins. 98*68d75effSDimitry Andric // FIXME: make it resizable. 99*68d75effSDimitry Andric static const uptr kNumStackOriginDescrs = 1024 * 1024; 100*68d75effSDimitry Andric static const char *StackOriginDescr[kNumStackOriginDescrs]; 101*68d75effSDimitry Andric static uptr StackOriginPC[kNumStackOriginDescrs]; 102*68d75effSDimitry Andric static atomic_uint32_t NumStackOriginDescrs; 103*68d75effSDimitry Andric 104*68d75effSDimitry Andric void Flags::SetDefaults() { 105*68d75effSDimitry Andric #define MSAN_FLAG(Type, Name, DefaultValue, Description) Name = DefaultValue; 106*68d75effSDimitry Andric #include "msan_flags.inc" 107*68d75effSDimitry Andric #undef MSAN_FLAG 108*68d75effSDimitry Andric } 109*68d75effSDimitry Andric 110*68d75effSDimitry Andric // keep_going is an old name for halt_on_error, 111*68d75effSDimitry Andric // and it has inverse meaning. 112*68d75effSDimitry Andric class FlagHandlerKeepGoing : public FlagHandlerBase { 113*68d75effSDimitry Andric bool *halt_on_error_; 114*68d75effSDimitry Andric 115*68d75effSDimitry Andric public: 116*68d75effSDimitry Andric explicit FlagHandlerKeepGoing(bool *halt_on_error) 117*68d75effSDimitry Andric : halt_on_error_(halt_on_error) {} 118*68d75effSDimitry Andric bool Parse(const char *value) final { 119*68d75effSDimitry Andric bool tmp; 120*68d75effSDimitry Andric FlagHandler<bool> h(&tmp); 121*68d75effSDimitry Andric if (!h.Parse(value)) return false; 122*68d75effSDimitry Andric *halt_on_error_ = !tmp; 123*68d75effSDimitry Andric return true; 124*68d75effSDimitry Andric } 125*68d75effSDimitry Andric }; 126*68d75effSDimitry Andric 127*68d75effSDimitry Andric static void RegisterMsanFlags(FlagParser *parser, Flags *f) { 128*68d75effSDimitry Andric #define MSAN_FLAG(Type, Name, DefaultValue, Description) \ 129*68d75effSDimitry Andric RegisterFlag(parser, #Name, Description, &f->Name); 130*68d75effSDimitry Andric #include "msan_flags.inc" 131*68d75effSDimitry Andric #undef MSAN_FLAG 132*68d75effSDimitry Andric 133*68d75effSDimitry Andric FlagHandlerKeepGoing *fh_keep_going = 134*68d75effSDimitry Andric new (FlagParser::Alloc) FlagHandlerKeepGoing(&f->halt_on_error); 135*68d75effSDimitry Andric parser->RegisterHandler("keep_going", fh_keep_going, 136*68d75effSDimitry Andric "deprecated, use halt_on_error"); 137*68d75effSDimitry Andric } 138*68d75effSDimitry Andric 139*68d75effSDimitry Andric static void InitializeFlags() { 140*68d75effSDimitry Andric SetCommonFlagsDefaults(); 141*68d75effSDimitry Andric { 142*68d75effSDimitry Andric CommonFlags cf; 143*68d75effSDimitry Andric cf.CopyFrom(*common_flags()); 144*68d75effSDimitry Andric cf.external_symbolizer_path = GetEnv("MSAN_SYMBOLIZER_PATH"); 145*68d75effSDimitry Andric cf.malloc_context_size = 20; 146*68d75effSDimitry Andric cf.handle_ioctl = true; 147*68d75effSDimitry Andric // FIXME: test and enable. 148*68d75effSDimitry Andric cf.check_printf = false; 149*68d75effSDimitry Andric cf.intercept_tls_get_addr = true; 150*68d75effSDimitry Andric cf.exitcode = 77; 151*68d75effSDimitry Andric OverrideCommonFlags(cf); 152*68d75effSDimitry Andric } 153*68d75effSDimitry Andric 154*68d75effSDimitry Andric Flags *f = flags(); 155*68d75effSDimitry Andric f->SetDefaults(); 156*68d75effSDimitry Andric 157*68d75effSDimitry Andric FlagParser parser; 158*68d75effSDimitry Andric RegisterMsanFlags(&parser, f); 159*68d75effSDimitry Andric RegisterCommonFlags(&parser); 160*68d75effSDimitry Andric 161*68d75effSDimitry Andric #if MSAN_CONTAINS_UBSAN 162*68d75effSDimitry Andric __ubsan::Flags *uf = __ubsan::flags(); 163*68d75effSDimitry Andric uf->SetDefaults(); 164*68d75effSDimitry Andric 165*68d75effSDimitry Andric FlagParser ubsan_parser; 166*68d75effSDimitry Andric __ubsan::RegisterUbsanFlags(&ubsan_parser, uf); 167*68d75effSDimitry Andric RegisterCommonFlags(&ubsan_parser); 168*68d75effSDimitry Andric #endif 169*68d75effSDimitry Andric 170*68d75effSDimitry Andric // Override from user-specified string. 171*68d75effSDimitry Andric if (__msan_default_options) 172*68d75effSDimitry Andric parser.ParseString(__msan_default_options()); 173*68d75effSDimitry Andric #if MSAN_CONTAINS_UBSAN 174*68d75effSDimitry Andric const char *ubsan_default_options = __ubsan::MaybeCallUbsanDefaultOptions(); 175*68d75effSDimitry Andric ubsan_parser.ParseString(ubsan_default_options); 176*68d75effSDimitry Andric #endif 177*68d75effSDimitry Andric 178*68d75effSDimitry Andric parser.ParseStringFromEnv("MSAN_OPTIONS"); 179*68d75effSDimitry Andric #if MSAN_CONTAINS_UBSAN 180*68d75effSDimitry Andric ubsan_parser.ParseStringFromEnv("UBSAN_OPTIONS"); 181*68d75effSDimitry Andric #endif 182*68d75effSDimitry Andric 183*68d75effSDimitry Andric InitializeCommonFlags(); 184*68d75effSDimitry Andric 185*68d75effSDimitry Andric if (Verbosity()) ReportUnrecognizedFlags(); 186*68d75effSDimitry Andric 187*68d75effSDimitry Andric if (common_flags()->help) parser.PrintFlagDescriptions(); 188*68d75effSDimitry Andric 189*68d75effSDimitry Andric // Check if deprecated exit_code MSan flag is set. 190*68d75effSDimitry Andric if (f->exit_code != -1) { 191*68d75effSDimitry Andric if (Verbosity()) 192*68d75effSDimitry Andric Printf("MSAN_OPTIONS=exit_code is deprecated! " 193*68d75effSDimitry Andric "Please use MSAN_OPTIONS=exitcode instead.\n"); 194*68d75effSDimitry Andric CommonFlags cf; 195*68d75effSDimitry Andric cf.CopyFrom(*common_flags()); 196*68d75effSDimitry Andric cf.exitcode = f->exit_code; 197*68d75effSDimitry Andric OverrideCommonFlags(cf); 198*68d75effSDimitry Andric } 199*68d75effSDimitry Andric 200*68d75effSDimitry Andric // Check flag values: 201*68d75effSDimitry Andric if (f->origin_history_size < 0 || 202*68d75effSDimitry Andric f->origin_history_size > Origin::kMaxDepth) { 203*68d75effSDimitry Andric Printf( 204*68d75effSDimitry Andric "Origin history size invalid: %d. Must be 0 (unlimited) or in [1, %d] " 205*68d75effSDimitry Andric "range.\n", 206*68d75effSDimitry Andric f->origin_history_size, Origin::kMaxDepth); 207*68d75effSDimitry Andric Die(); 208*68d75effSDimitry Andric } 209*68d75effSDimitry Andric // Limiting to kStackDepotMaxUseCount / 2 to avoid overflow in 210*68d75effSDimitry Andric // StackDepotHandle::inc_use_count_unsafe. 211*68d75effSDimitry Andric if (f->origin_history_per_stack_limit < 0 || 212*68d75effSDimitry Andric f->origin_history_per_stack_limit > kStackDepotMaxUseCount / 2) { 213*68d75effSDimitry Andric Printf( 214*68d75effSDimitry Andric "Origin per-stack limit invalid: %d. Must be 0 (unlimited) or in [1, " 215*68d75effSDimitry Andric "%d] range.\n", 216*68d75effSDimitry Andric f->origin_history_per_stack_limit, kStackDepotMaxUseCount / 2); 217*68d75effSDimitry Andric Die(); 218*68d75effSDimitry Andric } 219*68d75effSDimitry Andric if (f->store_context_size < 1) f->store_context_size = 1; 220*68d75effSDimitry Andric } 221*68d75effSDimitry Andric 222*68d75effSDimitry Andric void PrintWarning(uptr pc, uptr bp) { 223*68d75effSDimitry Andric PrintWarningWithOrigin(pc, bp, __msan_origin_tls); 224*68d75effSDimitry Andric } 225*68d75effSDimitry Andric 226*68d75effSDimitry Andric void PrintWarningWithOrigin(uptr pc, uptr bp, u32 origin) { 227*68d75effSDimitry Andric if (msan_expect_umr) { 228*68d75effSDimitry Andric // Printf("Expected UMR\n"); 229*68d75effSDimitry Andric __msan_origin_tls = origin; 230*68d75effSDimitry Andric msan_expected_umr_found = 1; 231*68d75effSDimitry Andric return; 232*68d75effSDimitry Andric } 233*68d75effSDimitry Andric 234*68d75effSDimitry Andric ++msan_report_count; 235*68d75effSDimitry Andric 236*68d75effSDimitry Andric GET_FATAL_STACK_TRACE_PC_BP(pc, bp); 237*68d75effSDimitry Andric 238*68d75effSDimitry Andric u32 report_origin = 239*68d75effSDimitry Andric (__msan_get_track_origins() && Origin::isValidId(origin)) ? origin : 0; 240*68d75effSDimitry Andric ReportUMR(&stack, report_origin); 241*68d75effSDimitry Andric 242*68d75effSDimitry Andric if (__msan_get_track_origins() && !Origin::isValidId(origin)) { 243*68d75effSDimitry Andric Printf( 244*68d75effSDimitry Andric " ORIGIN: invalid (%x). Might be a bug in MemorySanitizer origin " 245*68d75effSDimitry Andric "tracking.\n This could still be a bug in your code, too!\n", 246*68d75effSDimitry Andric origin); 247*68d75effSDimitry Andric } 248*68d75effSDimitry Andric } 249*68d75effSDimitry Andric 250*68d75effSDimitry Andric void UnpoisonParam(uptr n) { 251*68d75effSDimitry Andric internal_memset(__msan_param_tls, 0, n * sizeof(*__msan_param_tls)); 252*68d75effSDimitry Andric } 253*68d75effSDimitry Andric 254*68d75effSDimitry Andric // Backup MSan runtime TLS state. 255*68d75effSDimitry Andric // Implementation must be async-signal-safe. 256*68d75effSDimitry Andric // Instances of this class may live on the signal handler stack, and data size 257*68d75effSDimitry Andric // may be an issue. 258*68d75effSDimitry Andric void ScopedThreadLocalStateBackup::Backup() { 259*68d75effSDimitry Andric va_arg_overflow_size_tls = __msan_va_arg_overflow_size_tls; 260*68d75effSDimitry Andric } 261*68d75effSDimitry Andric 262*68d75effSDimitry Andric void ScopedThreadLocalStateBackup::Restore() { 263*68d75effSDimitry Andric // A lame implementation that only keeps essential state and resets the rest. 264*68d75effSDimitry Andric __msan_va_arg_overflow_size_tls = va_arg_overflow_size_tls; 265*68d75effSDimitry Andric 266*68d75effSDimitry Andric internal_memset(__msan_param_tls, 0, sizeof(__msan_param_tls)); 267*68d75effSDimitry Andric internal_memset(__msan_retval_tls, 0, sizeof(__msan_retval_tls)); 268*68d75effSDimitry Andric internal_memset(__msan_va_arg_tls, 0, sizeof(__msan_va_arg_tls)); 269*68d75effSDimitry Andric internal_memset(__msan_va_arg_origin_tls, 0, 270*68d75effSDimitry Andric sizeof(__msan_va_arg_origin_tls)); 271*68d75effSDimitry Andric 272*68d75effSDimitry Andric if (__msan_get_track_origins()) { 273*68d75effSDimitry Andric internal_memset(&__msan_retval_origin_tls, 0, 274*68d75effSDimitry Andric sizeof(__msan_retval_origin_tls)); 275*68d75effSDimitry Andric internal_memset(__msan_param_origin_tls, 0, 276*68d75effSDimitry Andric sizeof(__msan_param_origin_tls)); 277*68d75effSDimitry Andric } 278*68d75effSDimitry Andric } 279*68d75effSDimitry Andric 280*68d75effSDimitry Andric void UnpoisonThreadLocalState() { 281*68d75effSDimitry Andric } 282*68d75effSDimitry Andric 283*68d75effSDimitry Andric const char *GetStackOriginDescr(u32 id, uptr *pc) { 284*68d75effSDimitry Andric CHECK_LT(id, kNumStackOriginDescrs); 285*68d75effSDimitry Andric if (pc) *pc = StackOriginPC[id]; 286*68d75effSDimitry Andric return StackOriginDescr[id]; 287*68d75effSDimitry Andric } 288*68d75effSDimitry Andric 289*68d75effSDimitry Andric u32 ChainOrigin(u32 id, StackTrace *stack) { 290*68d75effSDimitry Andric MsanThread *t = GetCurrentThread(); 291*68d75effSDimitry Andric if (t && t->InSignalHandler()) 292*68d75effSDimitry Andric return id; 293*68d75effSDimitry Andric 294*68d75effSDimitry Andric Origin o = Origin::FromRawId(id); 295*68d75effSDimitry Andric stack->tag = StackTrace::TAG_UNKNOWN; 296*68d75effSDimitry Andric Origin chained = Origin::CreateChainedOrigin(o, stack); 297*68d75effSDimitry Andric return chained.raw_id(); 298*68d75effSDimitry Andric } 299*68d75effSDimitry Andric 300*68d75effSDimitry Andric } // namespace __msan 301*68d75effSDimitry Andric 302*68d75effSDimitry Andric void __sanitizer::BufferedStackTrace::UnwindImpl( 303*68d75effSDimitry Andric uptr pc, uptr bp, void *context, bool request_fast, u32 max_depth) { 304*68d75effSDimitry Andric using namespace __msan; 305*68d75effSDimitry Andric MsanThread *t = GetCurrentThread(); 306*68d75effSDimitry Andric if (!t || !StackTrace::WillUseFastUnwind(request_fast)) { 307*68d75effSDimitry Andric // Block reports from our interceptors during _Unwind_Backtrace. 308*68d75effSDimitry Andric SymbolizerScope sym_scope; 309*68d75effSDimitry Andric return Unwind(max_depth, pc, bp, context, 0, 0, false); 310*68d75effSDimitry Andric } 311*68d75effSDimitry Andric if (StackTrace::WillUseFastUnwind(request_fast)) 312*68d75effSDimitry Andric Unwind(max_depth, pc, bp, nullptr, t->stack_top(), t->stack_bottom(), true); 313*68d75effSDimitry Andric else 314*68d75effSDimitry Andric Unwind(max_depth, pc, 0, context, 0, 0, false); 315*68d75effSDimitry Andric } 316*68d75effSDimitry Andric 317*68d75effSDimitry Andric // Interface. 318*68d75effSDimitry Andric 319*68d75effSDimitry Andric using namespace __msan; 320*68d75effSDimitry Andric 321*68d75effSDimitry Andric #define MSAN_MAYBE_WARNING(type, size) \ 322*68d75effSDimitry Andric void __msan_maybe_warning_##size(type s, u32 o) { \ 323*68d75effSDimitry Andric GET_CALLER_PC_BP_SP; \ 324*68d75effSDimitry Andric (void) sp; \ 325*68d75effSDimitry Andric if (UNLIKELY(s)) { \ 326*68d75effSDimitry Andric PrintWarningWithOrigin(pc, bp, o); \ 327*68d75effSDimitry Andric if (__msan::flags()->halt_on_error) { \ 328*68d75effSDimitry Andric Printf("Exiting\n"); \ 329*68d75effSDimitry Andric Die(); \ 330*68d75effSDimitry Andric } \ 331*68d75effSDimitry Andric } \ 332*68d75effSDimitry Andric } 333*68d75effSDimitry Andric 334*68d75effSDimitry Andric MSAN_MAYBE_WARNING(u8, 1) 335*68d75effSDimitry Andric MSAN_MAYBE_WARNING(u16, 2) 336*68d75effSDimitry Andric MSAN_MAYBE_WARNING(u32, 4) 337*68d75effSDimitry Andric MSAN_MAYBE_WARNING(u64, 8) 338*68d75effSDimitry Andric 339*68d75effSDimitry Andric #define MSAN_MAYBE_STORE_ORIGIN(type, size) \ 340*68d75effSDimitry Andric void __msan_maybe_store_origin_##size(type s, void *p, u32 o) { \ 341*68d75effSDimitry Andric if (UNLIKELY(s)) { \ 342*68d75effSDimitry Andric if (__msan_get_track_origins() > 1) { \ 343*68d75effSDimitry Andric GET_CALLER_PC_BP_SP; \ 344*68d75effSDimitry Andric (void) sp; \ 345*68d75effSDimitry Andric GET_STORE_STACK_TRACE_PC_BP(pc, bp); \ 346*68d75effSDimitry Andric o = ChainOrigin(o, &stack); \ 347*68d75effSDimitry Andric } \ 348*68d75effSDimitry Andric *(u32 *)MEM_TO_ORIGIN((uptr)p & ~3UL) = o; \ 349*68d75effSDimitry Andric } \ 350*68d75effSDimitry Andric } 351*68d75effSDimitry Andric 352*68d75effSDimitry Andric MSAN_MAYBE_STORE_ORIGIN(u8, 1) 353*68d75effSDimitry Andric MSAN_MAYBE_STORE_ORIGIN(u16, 2) 354*68d75effSDimitry Andric MSAN_MAYBE_STORE_ORIGIN(u32, 4) 355*68d75effSDimitry Andric MSAN_MAYBE_STORE_ORIGIN(u64, 8) 356*68d75effSDimitry Andric 357*68d75effSDimitry Andric void __msan_warning() { 358*68d75effSDimitry Andric GET_CALLER_PC_BP_SP; 359*68d75effSDimitry Andric (void)sp; 360*68d75effSDimitry Andric PrintWarning(pc, bp); 361*68d75effSDimitry Andric if (__msan::flags()->halt_on_error) { 362*68d75effSDimitry Andric if (__msan::flags()->print_stats) 363*68d75effSDimitry Andric ReportStats(); 364*68d75effSDimitry Andric Printf("Exiting\n"); 365*68d75effSDimitry Andric Die(); 366*68d75effSDimitry Andric } 367*68d75effSDimitry Andric } 368*68d75effSDimitry Andric 369*68d75effSDimitry Andric void __msan_warning_noreturn() { 370*68d75effSDimitry Andric GET_CALLER_PC_BP_SP; 371*68d75effSDimitry Andric (void)sp; 372*68d75effSDimitry Andric PrintWarning(pc, bp); 373*68d75effSDimitry Andric if (__msan::flags()->print_stats) 374*68d75effSDimitry Andric ReportStats(); 375*68d75effSDimitry Andric Printf("Exiting\n"); 376*68d75effSDimitry Andric Die(); 377*68d75effSDimitry Andric } 378*68d75effSDimitry Andric 379*68d75effSDimitry Andric static void OnStackUnwind(const SignalContext &sig, const void *, 380*68d75effSDimitry Andric BufferedStackTrace *stack) { 381*68d75effSDimitry Andric stack->Unwind(StackTrace::GetNextInstructionPc(sig.pc), sig.bp, sig.context, 382*68d75effSDimitry Andric common_flags()->fast_unwind_on_fatal); 383*68d75effSDimitry Andric } 384*68d75effSDimitry Andric 385*68d75effSDimitry Andric static void MsanOnDeadlySignal(int signo, void *siginfo, void *context) { 386*68d75effSDimitry Andric HandleDeadlySignal(siginfo, context, GetTid(), &OnStackUnwind, nullptr); 387*68d75effSDimitry Andric } 388*68d75effSDimitry Andric 389*68d75effSDimitry Andric static void MsanCheckFailed(const char *file, int line, const char *cond, 390*68d75effSDimitry Andric u64 v1, u64 v2) { 391*68d75effSDimitry Andric Report("MemorySanitizer CHECK failed: %s:%d \"%s\" (0x%zx, 0x%zx)\n", file, 392*68d75effSDimitry Andric line, cond, (uptr)v1, (uptr)v2); 393*68d75effSDimitry Andric PRINT_CURRENT_STACK_CHECK(); 394*68d75effSDimitry Andric Die(); 395*68d75effSDimitry Andric } 396*68d75effSDimitry Andric 397*68d75effSDimitry Andric void __msan_init() { 398*68d75effSDimitry Andric CHECK(!msan_init_is_running); 399*68d75effSDimitry Andric if (msan_inited) return; 400*68d75effSDimitry Andric msan_init_is_running = 1; 401*68d75effSDimitry Andric SanitizerToolName = "MemorySanitizer"; 402*68d75effSDimitry Andric 403*68d75effSDimitry Andric AvoidCVE_2016_2143(); 404*68d75effSDimitry Andric 405*68d75effSDimitry Andric CacheBinaryName(); 406*68d75effSDimitry Andric InitializeFlags(); 407*68d75effSDimitry Andric 408*68d75effSDimitry Andric // Install tool-specific callbacks in sanitizer_common. 409*68d75effSDimitry Andric SetCheckFailedCallback(MsanCheckFailed); 410*68d75effSDimitry Andric 411*68d75effSDimitry Andric __sanitizer_set_report_path(common_flags()->log_path); 412*68d75effSDimitry Andric 413*68d75effSDimitry Andric InitializeInterceptors(); 414*68d75effSDimitry Andric CheckASLR(); 415*68d75effSDimitry Andric InitTlsSize(); 416*68d75effSDimitry Andric InstallDeadlySignalHandlers(MsanOnDeadlySignal); 417*68d75effSDimitry Andric InstallAtExitHandler(); // Needs __cxa_atexit interceptor. 418*68d75effSDimitry Andric 419*68d75effSDimitry Andric DisableCoreDumperIfNecessary(); 420*68d75effSDimitry Andric if (StackSizeIsUnlimited()) { 421*68d75effSDimitry Andric VPrintf(1, "Unlimited stack, doing reexec\n"); 422*68d75effSDimitry Andric // A reasonably large stack size. It is bigger than the usual 8Mb, because, 423*68d75effSDimitry Andric // well, the program could have been run with unlimited stack for a reason. 424*68d75effSDimitry Andric SetStackSizeLimitInBytes(32 * 1024 * 1024); 425*68d75effSDimitry Andric ReExec(); 426*68d75effSDimitry Andric } 427*68d75effSDimitry Andric 428*68d75effSDimitry Andric __msan_clear_on_return(); 429*68d75effSDimitry Andric if (__msan_get_track_origins()) 430*68d75effSDimitry Andric VPrintf(1, "msan_track_origins\n"); 431*68d75effSDimitry Andric if (!InitShadow(__msan_get_track_origins())) { 432*68d75effSDimitry Andric Printf("FATAL: MemorySanitizer can not mmap the shadow memory.\n"); 433*68d75effSDimitry Andric Printf("FATAL: Make sure to compile with -fPIE and to link with -pie.\n"); 434*68d75effSDimitry Andric Printf("FATAL: Disabling ASLR is known to cause this error.\n"); 435*68d75effSDimitry Andric Printf("FATAL: If running under GDB, try " 436*68d75effSDimitry Andric "'set disable-randomization off'.\n"); 437*68d75effSDimitry Andric DumpProcessMap(); 438*68d75effSDimitry Andric Die(); 439*68d75effSDimitry Andric } 440*68d75effSDimitry Andric 441*68d75effSDimitry Andric Symbolizer::GetOrInit()->AddHooks(EnterSymbolizer, ExitSymbolizer); 442*68d75effSDimitry Andric 443*68d75effSDimitry Andric InitializeCoverage(common_flags()->coverage, common_flags()->coverage_dir); 444*68d75effSDimitry Andric 445*68d75effSDimitry Andric MsanTSDInit(MsanTSDDtor); 446*68d75effSDimitry Andric 447*68d75effSDimitry Andric MsanAllocatorInit(); 448*68d75effSDimitry Andric 449*68d75effSDimitry Andric MsanThread *main_thread = MsanThread::Create(nullptr, nullptr); 450*68d75effSDimitry Andric SetCurrentThread(main_thread); 451*68d75effSDimitry Andric main_thread->ThreadStart(); 452*68d75effSDimitry Andric 453*68d75effSDimitry Andric #if MSAN_CONTAINS_UBSAN 454*68d75effSDimitry Andric __ubsan::InitAsPlugin(); 455*68d75effSDimitry Andric #endif 456*68d75effSDimitry Andric 457*68d75effSDimitry Andric VPrintf(1, "MemorySanitizer init done\n"); 458*68d75effSDimitry Andric 459*68d75effSDimitry Andric msan_init_is_running = 0; 460*68d75effSDimitry Andric msan_inited = 1; 461*68d75effSDimitry Andric } 462*68d75effSDimitry Andric 463*68d75effSDimitry Andric void __msan_set_keep_going(int keep_going) { 464*68d75effSDimitry Andric flags()->halt_on_error = !keep_going; 465*68d75effSDimitry Andric } 466*68d75effSDimitry Andric 467*68d75effSDimitry Andric void __msan_set_expect_umr(int expect_umr) { 468*68d75effSDimitry Andric if (expect_umr) { 469*68d75effSDimitry Andric msan_expected_umr_found = 0; 470*68d75effSDimitry Andric } else if (!msan_expected_umr_found) { 471*68d75effSDimitry Andric GET_CALLER_PC_BP_SP; 472*68d75effSDimitry Andric (void)sp; 473*68d75effSDimitry Andric GET_FATAL_STACK_TRACE_PC_BP(pc, bp); 474*68d75effSDimitry Andric ReportExpectedUMRNotFound(&stack); 475*68d75effSDimitry Andric Die(); 476*68d75effSDimitry Andric } 477*68d75effSDimitry Andric msan_expect_umr = expect_umr; 478*68d75effSDimitry Andric } 479*68d75effSDimitry Andric 480*68d75effSDimitry Andric void __msan_print_shadow(const void *x, uptr size) { 481*68d75effSDimitry Andric if (!MEM_IS_APP(x)) { 482*68d75effSDimitry Andric Printf("Not a valid application address: %p\n", x); 483*68d75effSDimitry Andric return; 484*68d75effSDimitry Andric } 485*68d75effSDimitry Andric 486*68d75effSDimitry Andric DescribeMemoryRange(x, size); 487*68d75effSDimitry Andric } 488*68d75effSDimitry Andric 489*68d75effSDimitry Andric void __msan_dump_shadow(const void *x, uptr size) { 490*68d75effSDimitry Andric if (!MEM_IS_APP(x)) { 491*68d75effSDimitry Andric Printf("Not a valid application address: %p\n", x); 492*68d75effSDimitry Andric return; 493*68d75effSDimitry Andric } 494*68d75effSDimitry Andric 495*68d75effSDimitry Andric unsigned char *s = (unsigned char*)MEM_TO_SHADOW(x); 496*68d75effSDimitry Andric for (uptr i = 0; i < size; i++) 497*68d75effSDimitry Andric Printf("%x%x ", s[i] >> 4, s[i] & 0xf); 498*68d75effSDimitry Andric Printf("\n"); 499*68d75effSDimitry Andric } 500*68d75effSDimitry Andric 501*68d75effSDimitry Andric sptr __msan_test_shadow(const void *x, uptr size) { 502*68d75effSDimitry Andric if (!MEM_IS_APP(x)) return -1; 503*68d75effSDimitry Andric unsigned char *s = (unsigned char *)MEM_TO_SHADOW((uptr)x); 504*68d75effSDimitry Andric for (uptr i = 0; i < size; ++i) 505*68d75effSDimitry Andric if (s[i]) 506*68d75effSDimitry Andric return i; 507*68d75effSDimitry Andric return -1; 508*68d75effSDimitry Andric } 509*68d75effSDimitry Andric 510*68d75effSDimitry Andric void __msan_check_mem_is_initialized(const void *x, uptr size) { 511*68d75effSDimitry Andric if (!__msan::flags()->report_umrs) return; 512*68d75effSDimitry Andric sptr offset = __msan_test_shadow(x, size); 513*68d75effSDimitry Andric if (offset < 0) 514*68d75effSDimitry Andric return; 515*68d75effSDimitry Andric 516*68d75effSDimitry Andric GET_CALLER_PC_BP_SP; 517*68d75effSDimitry Andric (void)sp; 518*68d75effSDimitry Andric ReportUMRInsideAddressRange(__func__, x, size, offset); 519*68d75effSDimitry Andric __msan::PrintWarningWithOrigin(pc, bp, 520*68d75effSDimitry Andric __msan_get_origin(((const char *)x) + offset)); 521*68d75effSDimitry Andric if (__msan::flags()->halt_on_error) { 522*68d75effSDimitry Andric Printf("Exiting\n"); 523*68d75effSDimitry Andric Die(); 524*68d75effSDimitry Andric } 525*68d75effSDimitry Andric } 526*68d75effSDimitry Andric 527*68d75effSDimitry Andric int __msan_set_poison_in_malloc(int do_poison) { 528*68d75effSDimitry Andric int old = flags()->poison_in_malloc; 529*68d75effSDimitry Andric flags()->poison_in_malloc = do_poison; 530*68d75effSDimitry Andric return old; 531*68d75effSDimitry Andric } 532*68d75effSDimitry Andric 533*68d75effSDimitry Andric int __msan_has_dynamic_component() { return false; } 534*68d75effSDimitry Andric 535*68d75effSDimitry Andric NOINLINE 536*68d75effSDimitry Andric void __msan_clear_on_return() { 537*68d75effSDimitry Andric __msan_param_tls[0] = 0; 538*68d75effSDimitry Andric } 539*68d75effSDimitry Andric 540*68d75effSDimitry Andric void __msan_partial_poison(const void* data, void* shadow, uptr size) { 541*68d75effSDimitry Andric internal_memcpy((void*)MEM_TO_SHADOW((uptr)data), shadow, size); 542*68d75effSDimitry Andric } 543*68d75effSDimitry Andric 544*68d75effSDimitry Andric void __msan_load_unpoisoned(const void *src, uptr size, void *dst) { 545*68d75effSDimitry Andric internal_memcpy(dst, src, size); 546*68d75effSDimitry Andric __msan_unpoison(dst, size); 547*68d75effSDimitry Andric } 548*68d75effSDimitry Andric 549*68d75effSDimitry Andric void __msan_set_origin(const void *a, uptr size, u32 origin) { 550*68d75effSDimitry Andric if (__msan_get_track_origins()) SetOrigin(a, size, origin); 551*68d75effSDimitry Andric } 552*68d75effSDimitry Andric 553*68d75effSDimitry Andric // 'descr' is created at compile time and contains '----' in the beginning. 554*68d75effSDimitry Andric // When we see descr for the first time we replace '----' with a uniq id 555*68d75effSDimitry Andric // and set the origin to (id | (31-th bit)). 556*68d75effSDimitry Andric void __msan_set_alloca_origin(void *a, uptr size, char *descr) { 557*68d75effSDimitry Andric __msan_set_alloca_origin4(a, size, descr, 0); 558*68d75effSDimitry Andric } 559*68d75effSDimitry Andric 560*68d75effSDimitry Andric void __msan_set_alloca_origin4(void *a, uptr size, char *descr, uptr pc) { 561*68d75effSDimitry Andric static const u32 dash = '-'; 562*68d75effSDimitry Andric static const u32 first_timer = 563*68d75effSDimitry Andric dash + (dash << 8) + (dash << 16) + (dash << 24); 564*68d75effSDimitry Andric u32 *id_ptr = (u32*)descr; 565*68d75effSDimitry Andric bool print = false; // internal_strstr(descr + 4, "AllocaTOTest") != 0; 566*68d75effSDimitry Andric u32 id = *id_ptr; 567*68d75effSDimitry Andric if (id == first_timer) { 568*68d75effSDimitry Andric u32 idx = atomic_fetch_add(&NumStackOriginDescrs, 1, memory_order_relaxed); 569*68d75effSDimitry Andric CHECK_LT(idx, kNumStackOriginDescrs); 570*68d75effSDimitry Andric StackOriginDescr[idx] = descr + 4; 571*68d75effSDimitry Andric #if SANITIZER_PPC64V1 572*68d75effSDimitry Andric // On PowerPC64 ELFv1, the address of a function actually points to a 573*68d75effSDimitry Andric // three-doubleword data structure with the first field containing 574*68d75effSDimitry Andric // the address of the function's code. 575*68d75effSDimitry Andric if (pc) 576*68d75effSDimitry Andric pc = *reinterpret_cast<uptr*>(pc); 577*68d75effSDimitry Andric #endif 578*68d75effSDimitry Andric StackOriginPC[idx] = pc; 579*68d75effSDimitry Andric id = Origin::CreateStackOrigin(idx).raw_id(); 580*68d75effSDimitry Andric *id_ptr = id; 581*68d75effSDimitry Andric if (print) 582*68d75effSDimitry Andric Printf("First time: idx=%d id=%d %s %p \n", idx, id, descr + 4, pc); 583*68d75effSDimitry Andric } 584*68d75effSDimitry Andric if (print) 585*68d75effSDimitry Andric Printf("__msan_set_alloca_origin: descr=%s id=%x\n", descr + 4, id); 586*68d75effSDimitry Andric __msan_set_origin(a, size, id); 587*68d75effSDimitry Andric } 588*68d75effSDimitry Andric 589*68d75effSDimitry Andric u32 __msan_chain_origin(u32 id) { 590*68d75effSDimitry Andric GET_CALLER_PC_BP_SP; 591*68d75effSDimitry Andric (void)sp; 592*68d75effSDimitry Andric GET_STORE_STACK_TRACE_PC_BP(pc, bp); 593*68d75effSDimitry Andric return ChainOrigin(id, &stack); 594*68d75effSDimitry Andric } 595*68d75effSDimitry Andric 596*68d75effSDimitry Andric u32 __msan_get_origin(const void *a) { 597*68d75effSDimitry Andric if (!__msan_get_track_origins()) return 0; 598*68d75effSDimitry Andric uptr x = (uptr)a; 599*68d75effSDimitry Andric uptr aligned = x & ~3ULL; 600*68d75effSDimitry Andric uptr origin_ptr = MEM_TO_ORIGIN(aligned); 601*68d75effSDimitry Andric return *(u32*)origin_ptr; 602*68d75effSDimitry Andric } 603*68d75effSDimitry Andric 604*68d75effSDimitry Andric int __msan_origin_is_descendant_or_same(u32 this_id, u32 prev_id) { 605*68d75effSDimitry Andric Origin o = Origin::FromRawId(this_id); 606*68d75effSDimitry Andric while (o.raw_id() != prev_id && o.isChainedOrigin()) 607*68d75effSDimitry Andric o = o.getNextChainedOrigin(nullptr); 608*68d75effSDimitry Andric return o.raw_id() == prev_id; 609*68d75effSDimitry Andric } 610*68d75effSDimitry Andric 611*68d75effSDimitry Andric u32 __msan_get_umr_origin() { 612*68d75effSDimitry Andric return __msan_origin_tls; 613*68d75effSDimitry Andric } 614*68d75effSDimitry Andric 615*68d75effSDimitry Andric u16 __sanitizer_unaligned_load16(const uu16 *p) { 616*68d75effSDimitry Andric *(uu16 *)&__msan_retval_tls[0] = *(uu16 *)MEM_TO_SHADOW((uptr)p); 617*68d75effSDimitry Andric if (__msan_get_track_origins()) 618*68d75effSDimitry Andric __msan_retval_origin_tls = GetOriginIfPoisoned((uptr)p, sizeof(*p)); 619*68d75effSDimitry Andric return *p; 620*68d75effSDimitry Andric } 621*68d75effSDimitry Andric u32 __sanitizer_unaligned_load32(const uu32 *p) { 622*68d75effSDimitry Andric *(uu32 *)&__msan_retval_tls[0] = *(uu32 *)MEM_TO_SHADOW((uptr)p); 623*68d75effSDimitry Andric if (__msan_get_track_origins()) 624*68d75effSDimitry Andric __msan_retval_origin_tls = GetOriginIfPoisoned((uptr)p, sizeof(*p)); 625*68d75effSDimitry Andric return *p; 626*68d75effSDimitry Andric } 627*68d75effSDimitry Andric u64 __sanitizer_unaligned_load64(const uu64 *p) { 628*68d75effSDimitry Andric __msan_retval_tls[0] = *(uu64 *)MEM_TO_SHADOW((uptr)p); 629*68d75effSDimitry Andric if (__msan_get_track_origins()) 630*68d75effSDimitry Andric __msan_retval_origin_tls = GetOriginIfPoisoned((uptr)p, sizeof(*p)); 631*68d75effSDimitry Andric return *p; 632*68d75effSDimitry Andric } 633*68d75effSDimitry Andric void __sanitizer_unaligned_store16(uu16 *p, u16 x) { 634*68d75effSDimitry Andric u16 s = *(uu16 *)&__msan_param_tls[1]; 635*68d75effSDimitry Andric *(uu16 *)MEM_TO_SHADOW((uptr)p) = s; 636*68d75effSDimitry Andric if (s && __msan_get_track_origins()) 637*68d75effSDimitry Andric if (uu32 o = __msan_param_origin_tls[2]) 638*68d75effSDimitry Andric SetOriginIfPoisoned((uptr)p, (uptr)&s, sizeof(s), o); 639*68d75effSDimitry Andric *p = x; 640*68d75effSDimitry Andric } 641*68d75effSDimitry Andric void __sanitizer_unaligned_store32(uu32 *p, u32 x) { 642*68d75effSDimitry Andric u32 s = *(uu32 *)&__msan_param_tls[1]; 643*68d75effSDimitry Andric *(uu32 *)MEM_TO_SHADOW((uptr)p) = s; 644*68d75effSDimitry Andric if (s && __msan_get_track_origins()) 645*68d75effSDimitry Andric if (uu32 o = __msan_param_origin_tls[2]) 646*68d75effSDimitry Andric SetOriginIfPoisoned((uptr)p, (uptr)&s, sizeof(s), o); 647*68d75effSDimitry Andric *p = x; 648*68d75effSDimitry Andric } 649*68d75effSDimitry Andric void __sanitizer_unaligned_store64(uu64 *p, u64 x) { 650*68d75effSDimitry Andric u64 s = __msan_param_tls[1]; 651*68d75effSDimitry Andric *(uu64 *)MEM_TO_SHADOW((uptr)p) = s; 652*68d75effSDimitry Andric if (s && __msan_get_track_origins()) 653*68d75effSDimitry Andric if (uu32 o = __msan_param_origin_tls[2]) 654*68d75effSDimitry Andric SetOriginIfPoisoned((uptr)p, (uptr)&s, sizeof(s), o); 655*68d75effSDimitry Andric *p = x; 656*68d75effSDimitry Andric } 657*68d75effSDimitry Andric 658*68d75effSDimitry Andric void __msan_set_death_callback(void (*callback)(void)) { 659*68d75effSDimitry Andric SetUserDieCallback(callback); 660*68d75effSDimitry Andric } 661*68d75effSDimitry Andric 662*68d75effSDimitry Andric #if !SANITIZER_SUPPORTS_WEAK_HOOKS 663*68d75effSDimitry Andric extern "C" { 664*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE 665*68d75effSDimitry Andric const char* __msan_default_options() { return ""; } 666*68d75effSDimitry Andric } // extern "C" 667*68d75effSDimitry Andric #endif 668*68d75effSDimitry Andric 669*68d75effSDimitry Andric extern "C" { 670*68d75effSDimitry Andric SANITIZER_INTERFACE_ATTRIBUTE 671*68d75effSDimitry Andric void __sanitizer_print_stack_trace() { 672*68d75effSDimitry Andric GET_FATAL_STACK_TRACE_PC_BP(StackTrace::GetCurrentPc(), GET_CURRENT_FRAME()); 673*68d75effSDimitry Andric stack.Print(); 674*68d75effSDimitry Andric } 675*68d75effSDimitry Andric } // extern "C" 676