1 //===-- msan_interface_internal.h -------------------------------*- C++ -*-===// 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 // Private MSan interface header. 13 //===----------------------------------------------------------------------===// 14 15 #ifndef MSAN_INTERFACE_INTERNAL_H 16 #define MSAN_INTERFACE_INTERNAL_H 17 18 #include "sanitizer_common/sanitizer_internal_defs.h" 19 20 extern "C" { 21 // FIXME: document all interface functions. 22 23 SANITIZER_INTERFACE_ATTRIBUTE 24 int __msan_get_track_origins(); 25 26 SANITIZER_INTERFACE_ATTRIBUTE 27 void __msan_init(); 28 29 // Print a warning and maybe return. 30 // This function can die based on common_flags()->exitcode. 31 SANITIZER_INTERFACE_ATTRIBUTE 32 void __msan_warning(); 33 34 // Print a warning and die. 35 // Intrumentation inserts calls to this function when building in "fast" mode 36 // (i.e. -mllvm -msan-keep-going) 37 SANITIZER_INTERFACE_ATTRIBUTE __attribute__((noreturn)) 38 void __msan_warning_noreturn(); 39 40 using __sanitizer::uptr; 41 using __sanitizer::sptr; 42 using __sanitizer::uu64; 43 using __sanitizer::uu32; 44 using __sanitizer::uu16; 45 using __sanitizer::u64; 46 using __sanitizer::u32; 47 using __sanitizer::u16; 48 using __sanitizer::u8; 49 50 SANITIZER_INTERFACE_ATTRIBUTE 51 void __msan_maybe_warning_1(u8 s, u32 o); 52 SANITIZER_INTERFACE_ATTRIBUTE 53 void __msan_maybe_warning_2(u16 s, u32 o); 54 SANITIZER_INTERFACE_ATTRIBUTE 55 void __msan_maybe_warning_4(u32 s, u32 o); 56 SANITIZER_INTERFACE_ATTRIBUTE 57 void __msan_maybe_warning_8(u64 s, u32 o); 58 59 SANITIZER_INTERFACE_ATTRIBUTE 60 void __msan_maybe_store_origin_1(u8 s, void *p, u32 o); 61 SANITIZER_INTERFACE_ATTRIBUTE 62 void __msan_maybe_store_origin_2(u16 s, void *p, u32 o); 63 SANITIZER_INTERFACE_ATTRIBUTE 64 void __msan_maybe_store_origin_4(u32 s, void *p, u32 o); 65 SANITIZER_INTERFACE_ATTRIBUTE 66 void __msan_maybe_store_origin_8(u64 s, void *p, u32 o); 67 68 SANITIZER_INTERFACE_ATTRIBUTE 69 void __msan_unpoison(const void *a, uptr size); 70 SANITIZER_INTERFACE_ATTRIBUTE 71 void __msan_unpoison_string(const char *s); 72 SANITIZER_INTERFACE_ATTRIBUTE 73 void __msan_clear_and_unpoison(void *a, uptr size); 74 SANITIZER_INTERFACE_ATTRIBUTE 75 void* __msan_memcpy(void *dst, const void *src, uptr size); 76 SANITIZER_INTERFACE_ATTRIBUTE 77 void* __msan_memset(void *s, int c, uptr n); 78 SANITIZER_INTERFACE_ATTRIBUTE 79 void* __msan_memmove(void* dest, const void* src, uptr n); 80 SANITIZER_INTERFACE_ATTRIBUTE 81 void __msan_poison(const void *a, uptr size); 82 SANITIZER_INTERFACE_ATTRIBUTE 83 void __msan_poison_stack(void *a, uptr size); 84 85 // Copy size bytes from src to dst and unpoison the result. 86 // Useful to implement unsafe loads. 87 SANITIZER_INTERFACE_ATTRIBUTE 88 void __msan_load_unpoisoned(void *src, uptr size, void *dst); 89 90 // Returns the offset of the first (at least partially) poisoned byte, 91 // or -1 if the whole range is good. 92 SANITIZER_INTERFACE_ATTRIBUTE 93 sptr __msan_test_shadow(const void *x, uptr size); 94 95 SANITIZER_INTERFACE_ATTRIBUTE 96 void __msan_check_mem_is_initialized(const void *x, uptr size); 97 98 SANITIZER_INTERFACE_ATTRIBUTE 99 void __msan_set_origin(const void *a, uptr size, u32 origin); 100 SANITIZER_INTERFACE_ATTRIBUTE 101 void __msan_set_alloca_origin(void *a, uptr size, char *descr); 102 SANITIZER_INTERFACE_ATTRIBUTE 103 void __msan_set_alloca_origin4(void *a, uptr size, char *descr, uptr pc); 104 SANITIZER_INTERFACE_ATTRIBUTE 105 u32 __msan_chain_origin(u32 id); 106 SANITIZER_INTERFACE_ATTRIBUTE 107 u32 __msan_get_origin(const void *a); 108 109 // Test that this_id is a descendant of prev_id (or they are simply equal). 110 // "descendant" here means that are part of the same chain, created with 111 // __msan_chain_origin. 112 SANITIZER_INTERFACE_ATTRIBUTE 113 int __msan_origin_is_descendant_or_same(u32 this_id, u32 prev_id); 114 115 116 SANITIZER_INTERFACE_ATTRIBUTE 117 void __msan_clear_on_return(); 118 119 SANITIZER_INTERFACE_ATTRIBUTE 120 void __msan_set_keep_going(int keep_going); 121 122 SANITIZER_INTERFACE_ATTRIBUTE 123 int __msan_set_poison_in_malloc(int do_poison); 124 125 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE 126 /* OPTIONAL */ const char* __msan_default_options(); 127 128 // For testing. 129 SANITIZER_INTERFACE_ATTRIBUTE 130 void __msan_set_expect_umr(int expect_umr); 131 SANITIZER_INTERFACE_ATTRIBUTE 132 void __msan_print_shadow(const void *x, uptr size); 133 SANITIZER_INTERFACE_ATTRIBUTE 134 void __msan_dump_shadow(const void *x, uptr size); 135 SANITIZER_INTERFACE_ATTRIBUTE 136 int __msan_has_dynamic_component(); 137 138 // For testing. 139 SANITIZER_INTERFACE_ATTRIBUTE 140 u32 __msan_get_umr_origin(); 141 SANITIZER_INTERFACE_ATTRIBUTE 142 void __msan_partial_poison(const void* data, void* shadow, uptr size); 143 144 // Tell MSan about newly allocated memory (ex.: custom allocator). 145 // Memory will be marked uninitialized, with origin at the call site. 146 SANITIZER_INTERFACE_ATTRIBUTE 147 void __msan_allocated_memory(const void* data, uptr size); 148 149 // Tell MSan about newly destroyed memory. Memory will be marked 150 // uninitialized. 151 SANITIZER_INTERFACE_ATTRIBUTE 152 void __sanitizer_dtor_callback(const void* data, uptr size); 153 154 SANITIZER_INTERFACE_ATTRIBUTE 155 u16 __sanitizer_unaligned_load16(const uu16 *p); 156 157 SANITIZER_INTERFACE_ATTRIBUTE 158 u32 __sanitizer_unaligned_load32(const uu32 *p); 159 160 SANITIZER_INTERFACE_ATTRIBUTE 161 u64 __sanitizer_unaligned_load64(const uu64 *p); 162 163 SANITIZER_INTERFACE_ATTRIBUTE 164 void __sanitizer_unaligned_store16(uu16 *p, u16 x); 165 166 SANITIZER_INTERFACE_ATTRIBUTE 167 void __sanitizer_unaligned_store32(uu32 *p, u32 x); 168 169 SANITIZER_INTERFACE_ATTRIBUTE 170 void __sanitizer_unaligned_store64(uu64 *p, u64 x); 171 172 SANITIZER_INTERFACE_ATTRIBUTE 173 void __msan_set_death_callback(void (*callback)(void)); 174 175 SANITIZER_INTERFACE_ATTRIBUTE 176 void __msan_copy_shadow(void *dst, const void *src, uptr size); 177 178 SANITIZER_INTERFACE_ATTRIBUTE 179 void __msan_scoped_disable_interceptor_checks(); 180 181 SANITIZER_INTERFACE_ATTRIBUTE 182 void __msan_scoped_enable_interceptor_checks(); 183 } // extern "C" 184 185 #endif // MSAN_INTERFACE_INTERNAL_H 186