msan_interface_internal.h revision 3c80c6c574850106481f82b9e23d1c728458d4a9 
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
76u32 __msan_get_origin(const void *a);
77
78SANITIZER_INTERFACE_ATTRIBUTE
79void __msan_clear_on_return();
80
81// Default: -1 (don't exit on error).
82SANITIZER_INTERFACE_ATTRIBUTE
83void __msan_set_exit_code(int exit_code);
84
85SANITIZER_INTERFACE_ATTRIBUTE
86void __msan_set_keep_going(int keep_going);
87
88SANITIZER_INTERFACE_ATTRIBUTE
89int __msan_set_poison_in_malloc(int do_poison);
90
91SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
92/* OPTIONAL */ const char* __msan_default_options();
93
94// For testing.
95SANITIZER_INTERFACE_ATTRIBUTE
96void __msan_set_expect_umr(int expect_umr);
97SANITIZER_INTERFACE_ATTRIBUTE
98void __msan_print_shadow(const void *x, uptr size);
99SANITIZER_INTERFACE_ATTRIBUTE
100void __msan_print_param_shadow();
101SANITIZER_INTERFACE_ATTRIBUTE
102int  __msan_has_dynamic_component();
103
104// Returns x such that %fs:x is the first byte of __msan_retval_tls.
105SANITIZER_INTERFACE_ATTRIBUTE
106int __msan_get_retval_tls_offset();
107SANITIZER_INTERFACE_ATTRIBUTE
108int __msan_get_param_tls_offset();
109
110// For intercepting mmap from ld.so in msandr.
111SANITIZER_INTERFACE_ATTRIBUTE
112bool __msan_is_in_loader();
113
114// For testing.
115SANITIZER_INTERFACE_ATTRIBUTE
116u32 __msan_get_umr_origin();
117SANITIZER_INTERFACE_ATTRIBUTE
118const char *__msan_get_origin_descr_if_stack(u32 id);
119SANITIZER_INTERFACE_ATTRIBUTE
120void __msan_partial_poison(const void* data, void* shadow, uptr size);
121
122// Tell MSan about newly allocated memory (ex.: custom allocator).
123// Memory will be marked uninitialized, with origin at the call site.
124SANITIZER_INTERFACE_ATTRIBUTE
125void __msan_allocated_memory(const void* data, uptr size);
126
127SANITIZER_INTERFACE_ATTRIBUTE
128u16 __sanitizer_unaligned_load16(const uu16 *p);
129
130SANITIZER_INTERFACE_ATTRIBUTE
131u32 __sanitizer_unaligned_load32(const uu32 *p);
132
133SANITIZER_INTERFACE_ATTRIBUTE
134u64 __sanitizer_unaligned_load64(const uu64 *p);
135
136SANITIZER_INTERFACE_ATTRIBUTE
137void __sanitizer_unaligned_store16(uu16 *p, u16 x);
138
139SANITIZER_INTERFACE_ATTRIBUTE
140void __sanitizer_unaligned_store32(uu32 *p, u32 x);
141
142SANITIZER_INTERFACE_ATTRIBUTE
143void __sanitizer_unaligned_store64(uu64 *p, u64 x);
144
145SANITIZER_INTERFACE_ATTRIBUTE
146uptr __msan_get_estimated_allocated_size(uptr size);
147
148SANITIZER_INTERFACE_ATTRIBUTE
149bool __msan_get_ownership(const void *p);
150
151SANITIZER_INTERFACE_ATTRIBUTE
152uptr __msan_get_allocated_size(const void *p);
153
154SANITIZER_INTERFACE_ATTRIBUTE
155uptr __msan_get_current_allocated_bytes();
156
157SANITIZER_INTERFACE_ATTRIBUTE
158uptr __msan_get_heap_size();
159
160SANITIZER_INTERFACE_ATTRIBUTE
161uptr __msan_get_free_bytes();
162
163SANITIZER_INTERFACE_ATTRIBUTE
164uptr __msan_get_unmapped_bytes();
165
166SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
167/* OPTIONAL */ void __msan_malloc_hook(void *ptr, uptr size);
168
169SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
170/* OPTIONAL */ void __msan_free_hook(void *ptr);
171}  // extern "C"
172
173#endif  // MSAN_INTERFACE_INTERNAL_H
174