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