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