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