• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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(void *a, uptr size);
42 SANITIZER_INTERFACE_ATTRIBUTE
43 void __msan_clear_and_unpoison(void *a, uptr size);
44 SANITIZER_INTERFACE_ATTRIBUTE
45 void* __msan_memcpy(void *dst, const void *src, uptr size);
46 SANITIZER_INTERFACE_ATTRIBUTE
47 void* __msan_memset(void *s, int c, uptr n);
48 SANITIZER_INTERFACE_ATTRIBUTE
49 void* __msan_memmove(void* dest, const void* src, uptr n);
50 SANITIZER_INTERFACE_ATTRIBUTE
51 void __msan_copy_poison(void *dst, const void *src, uptr size);
52 SANITIZER_INTERFACE_ATTRIBUTE
53 void __msan_copy_origin(void *dst, const void *src, uptr size);
54 SANITIZER_INTERFACE_ATTRIBUTE
55 void __msan_move_poison(void *dst, const void *src, uptr size);
56 SANITIZER_INTERFACE_ATTRIBUTE
57 void __msan_poison(void *a, uptr size);
58 SANITIZER_INTERFACE_ATTRIBUTE
59 void __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.
63 SANITIZER_INTERFACE_ATTRIBUTE
64 void __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.
68 SANITIZER_INTERFACE_ATTRIBUTE
69 sptr __msan_test_shadow(const void *x, uptr size);
70 
71 SANITIZER_INTERFACE_ATTRIBUTE
72 void __msan_set_origin(void *a, uptr size, u32 origin);
73 SANITIZER_INTERFACE_ATTRIBUTE
74 void __msan_set_alloca_origin(void *a, uptr size, const char *descr);
75 SANITIZER_INTERFACE_ATTRIBUTE
76 u32 __msan_get_origin(void *a);
77 
78 SANITIZER_INTERFACE_ATTRIBUTE
79 void __msan_clear_on_return();
80 
81 // Default: -1 (don't exit on error).
82 SANITIZER_INTERFACE_ATTRIBUTE
83 void __msan_set_exit_code(int exit_code);
84 
85 SANITIZER_INTERFACE_ATTRIBUTE
86 int __msan_set_poison_in_malloc(int do_poison);
87 
88 SANITIZER_WEAK_ATTRIBUTE SANITIZER_INTERFACE_ATTRIBUTE
89 /* OPTIONAL */ const char* __msan_default_options();
90 
91 // For testing.
92 SANITIZER_INTERFACE_ATTRIBUTE
93 void __msan_set_expect_umr(int expect_umr);
94 SANITIZER_INTERFACE_ATTRIBUTE
95 void __msan_print_shadow(const void *x, uptr size);
96 SANITIZER_INTERFACE_ATTRIBUTE
97 void __msan_print_param_shadow();
98 SANITIZER_INTERFACE_ATTRIBUTE
99 int  __msan_has_dynamic_component();
100 
101 // Returns x such that %fs:x is the first byte of __msan_retval_tls.
102 SANITIZER_INTERFACE_ATTRIBUTE
103 int __msan_get_retval_tls_offset();
104 SANITIZER_INTERFACE_ATTRIBUTE
105 int __msan_get_param_tls_offset();
106 
107 // For intercepting mmap from ld.so in msandr.
108 SANITIZER_INTERFACE_ATTRIBUTE
109 bool __msan_is_in_loader();
110 
111 // For testing.
112 SANITIZER_INTERFACE_ATTRIBUTE
113 u32 __msan_get_umr_origin();
114 SANITIZER_INTERFACE_ATTRIBUTE
115 const char *__msan_get_origin_descr_if_stack(u32 id);
116 SANITIZER_INTERFACE_ATTRIBUTE
117 void __msan_partial_poison(void* data, void* shadow, uptr size);
118 
119 // Tell MSan about newly allocated memory (ex.: custom allocator).
120 // Memory will be marked uninitialized, with origin at the call site.
121 SANITIZER_INTERFACE_ATTRIBUTE
122 void __msan_allocated_memory(void* data, uptr size);
123 }  // extern "C"
124 
125 #endif  // MSAN_INTERFACE_INTERNAL_H
126