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 flags()->exit_code.
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 SANITIZER_INTERFACE_ATTRIBUTE
41 void __msan_unpoison(const void *a, uptr size);
42 SANITIZER_INTERFACE_ATTRIBUTE
43 void __msan_unpoison_string(const char *s);
44 SANITIZER_INTERFACE_ATTRIBUTE
45 void __msan_clear_and_unpoison(void *a, uptr size);
46 SANITIZER_INTERFACE_ATTRIBUTE
47 void* __msan_memcpy(void *dst, const void *src, uptr size);
48 SANITIZER_INTERFACE_ATTRIBUTE
49 void* __msan_memset(void *s, int c, uptr n);
50 SANITIZER_INTERFACE_ATTRIBUTE
51 void* __msan_memmove(void* dest, const void* src, uptr n);
52 SANITIZER_INTERFACE_ATTRIBUTE
53 void __msan_poison(const void *a, uptr size);
54 SANITIZER_INTERFACE_ATTRIBUTE
55 void __msan_poison_stack(void *a, uptr size);
56 
57 // Copy size bytes from src to dst and unpoison the result.
58 // Useful to implement unsafe loads.
59 SANITIZER_INTERFACE_ATTRIBUTE
60 void __msan_load_unpoisoned(void *src, uptr size, void *dst);
61 
62 // Returns the offset of the first (at least partially) poisoned byte,
63 // or -1 if the whole range is good.
64 SANITIZER_INTERFACE_ATTRIBUTE
65 sptr __msan_test_shadow(const void *x, uptr size);
66 
67 SANITIZER_INTERFACE_ATTRIBUTE
68 void __msan_check_mem_is_initialized(const void *x, uptr size);
69 
70 SANITIZER_INTERFACE_ATTRIBUTE
71 void __msan_set_origin(const void *a, uptr size, u32 origin);
72 SANITIZER_INTERFACE_ATTRIBUTE
73 void __msan_set_alloca_origin(void *a, uptr size, const char *descr);
74 SANITIZER_INTERFACE_ATTRIBUTE
75 void __msan_set_alloca_origin4(void *a, uptr size, const char *descr, uptr pc);
76 SANITIZER_INTERFACE_ATTRIBUTE
77 u32 __msan_chain_origin(u32 id);
78 SANITIZER_INTERFACE_ATTRIBUTE
79 u32 __msan_get_origin(const void *a);
80 
81 SANITIZER_INTERFACE_ATTRIBUTE
82 void __msan_clear_on_return();
83 
84 // Default: -1 (don't exit on error).
85 SANITIZER_INTERFACE_ATTRIBUTE
86 void __msan_set_exit_code(int exit_code);
87 
88 SANITIZER_INTERFACE_ATTRIBUTE
89 void __msan_set_keep_going(int keep_going);
90 
91 SANITIZER_INTERFACE_ATTRIBUTE
92 int __msan_set_poison_in_malloc(int do_poison);
93 
94 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
95 /* OPTIONAL */ const char* __msan_default_options();
96 
97 // For testing.
98 SANITIZER_INTERFACE_ATTRIBUTE
99 void __msan_set_expect_umr(int expect_umr);
100 SANITIZER_INTERFACE_ATTRIBUTE
101 void __msan_print_shadow(const void *x, uptr size);
102 SANITIZER_INTERFACE_ATTRIBUTE
103 int  __msan_has_dynamic_component();
104 
105 // Returns x such that %fs:x is the first byte of __msan_retval_tls.
106 SANITIZER_INTERFACE_ATTRIBUTE
107 int __msan_get_retval_tls_offset();
108 SANITIZER_INTERFACE_ATTRIBUTE
109 int __msan_get_param_tls_offset();
110 
111 // For intercepting mmap from ld.so in msandr.
112 SANITIZER_INTERFACE_ATTRIBUTE
113 bool __msan_is_in_loader();
114 
115 // For testing.
116 SANITIZER_INTERFACE_ATTRIBUTE
117 u32 __msan_get_umr_origin();
118 SANITIZER_INTERFACE_ATTRIBUTE
119 const char *__msan_get_origin_descr_if_stack(u32 id);
120 SANITIZER_INTERFACE_ATTRIBUTE
121 void __msan_partial_poison(const void* data, void* shadow, uptr size);
122 
123 // Tell MSan about newly allocated memory (ex.: custom allocator).
124 // Memory will be marked uninitialized, with origin at the call site.
125 SANITIZER_INTERFACE_ATTRIBUTE
126 void __msan_allocated_memory(const void* data, uptr size);
127 
128 SANITIZER_INTERFACE_ATTRIBUTE
129 u16 __sanitizer_unaligned_load16(const uu16 *p);
130 
131 SANITIZER_INTERFACE_ATTRIBUTE
132 u32 __sanitizer_unaligned_load32(const uu32 *p);
133 
134 SANITIZER_INTERFACE_ATTRIBUTE
135 u64 __sanitizer_unaligned_load64(const uu64 *p);
136 
137 SANITIZER_INTERFACE_ATTRIBUTE
138 void __sanitizer_unaligned_store16(uu16 *p, u16 x);
139 
140 SANITIZER_INTERFACE_ATTRIBUTE
141 void __sanitizer_unaligned_store32(uu32 *p, u32 x);
142 
143 SANITIZER_INTERFACE_ATTRIBUTE
144 void __sanitizer_unaligned_store64(uu64 *p, u64 x);
145 
146 SANITIZER_INTERFACE_ATTRIBUTE
147 uptr __msan_get_estimated_allocated_size(uptr size);
148 
149 SANITIZER_INTERFACE_ATTRIBUTE
150 int __msan_get_ownership(const void *p);
151 
152 SANITIZER_INTERFACE_ATTRIBUTE
153 uptr __msan_get_allocated_size(const void *p);
154 
155 SANITIZER_INTERFACE_ATTRIBUTE
156 uptr __msan_get_current_allocated_bytes();
157 
158 SANITIZER_INTERFACE_ATTRIBUTE
159 uptr __msan_get_heap_size();
160 
161 SANITIZER_INTERFACE_ATTRIBUTE
162 uptr __msan_get_free_bytes();
163 
164 SANITIZER_INTERFACE_ATTRIBUTE
165 uptr __msan_get_unmapped_bytes();
166 
167 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
168 /* OPTIONAL */ void __msan_malloc_hook(void *ptr, uptr size);
169 
170 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
171 /* OPTIONAL */ void __msan_free_hook(void *ptr);
172 
173 SANITIZER_INTERFACE_ATTRIBUTE
174 void __msan_dr_is_initialized();
175 
176 SANITIZER_INTERFACE_ATTRIBUTE
177 void *__msan_wrap_indirect_call(void *target);
178 
179 SANITIZER_INTERFACE_ATTRIBUTE
180 void __msan_set_indirect_call_wrapper(uptr wrapper);
181 
182 SANITIZER_INTERFACE_ATTRIBUTE
183 void __msan_set_death_callback(void (*callback)(void));
184 }  // extern "C"
185 
186 #endif  // MSAN_INTERFACE_INTERNAL_H
187