asan_interface_internal.h revision 314564 
1//===-- asan_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 AddressSanitizer, an address sanity checker.
11//
12// This header declares the AddressSanitizer runtime interface functions.
13// The runtime library has to define these functions so the instrumented program
14// could call them.
15//
16// See also include/sanitizer/asan_interface.h
17//===----------------------------------------------------------------------===//
18#ifndef ASAN_INTERFACE_INTERNAL_H
19#define ASAN_INTERFACE_INTERNAL_H
20
21#include "sanitizer_common/sanitizer_internal_defs.h"
22
23#include "asan_init_version.h"
24
25using __sanitizer::uptr;
26using __sanitizer::u64;
27using __sanitizer::u32;
28
29extern "C" {
30  // This function should be called at the very beginning of the process,
31  // before any instrumented code is executed and before any call to malloc.
32  SANITIZER_INTERFACE_ATTRIBUTE void __asan_init();
33
34  // This function exists purely to get a linker/loader error when using
35  // incompatible versions of instrumentation and runtime library. Please note
36  // that __asan_version_mismatch_check is a macro that is replaced with
37  // __asan_version_mismatch_check_vXXX at compile-time.
38  SANITIZER_INTERFACE_ATTRIBUTE void __asan_version_mismatch_check();
39
40  // This structure is used to describe the source location of a place where
41  // global was defined.
42  struct __asan_global_source_location {
43    const char *filename;
44    int line_no;
45    int column_no;
46  };
47
48  // This structure describes an instrumented global variable.
49  struct __asan_global {
50    uptr beg;                // The address of the global.
51    uptr size;               // The original size of the global.
52    uptr size_with_redzone;  // The size with the redzone.
53    const char *name;        // Name as a C string.
54    const char *module_name; // Module name as a C string. This pointer is a
55                             // unique identifier of a module.
56    uptr has_dynamic_init;   // Non-zero if the global has dynamic initializer.
57    __asan_global_source_location *location;  // Source location of a global,
58                                              // or NULL if it is unknown.
59    uptr odr_indicator;      // The address of the ODR indicator symbol.
60  };
61
62  // These functions can be called on some platforms to find globals in the same
63  // loaded image as `flag' and apply __asan_(un)register_globals to them,
64  // filtering out redundant calls.
65  SANITIZER_INTERFACE_ATTRIBUTE
66  void __asan_register_image_globals(uptr *flag);
67  SANITIZER_INTERFACE_ATTRIBUTE
68  void __asan_unregister_image_globals(uptr *flag);
69
70  // These two functions should be called by the instrumented code.
71  // 'globals' is an array of structures describing 'n' globals.
72  SANITIZER_INTERFACE_ATTRIBUTE
73  void __asan_register_globals(__asan_global *globals, uptr n);
74  SANITIZER_INTERFACE_ATTRIBUTE
75  void __asan_unregister_globals(__asan_global *globals, uptr n);
76
77  // These two functions should be called before and after dynamic initializers
78  // of a single module run, respectively.
79  SANITIZER_INTERFACE_ATTRIBUTE
80  void __asan_before_dynamic_init(const char *module_name);
81  SANITIZER_INTERFACE_ATTRIBUTE
82  void __asan_after_dynamic_init();
83
84  // Sets bytes of the given range of the shadow memory into specific value.
85  SANITIZER_INTERFACE_ATTRIBUTE
86  void __asan_set_shadow_00(uptr addr, uptr size);
87  SANITIZER_INTERFACE_ATTRIBUTE
88  void __asan_set_shadow_f1(uptr addr, uptr size);
89  SANITIZER_INTERFACE_ATTRIBUTE
90  void __asan_set_shadow_f2(uptr addr, uptr size);
91  SANITIZER_INTERFACE_ATTRIBUTE
92  void __asan_set_shadow_f3(uptr addr, uptr size);
93  SANITIZER_INTERFACE_ATTRIBUTE
94  void __asan_set_shadow_f5(uptr addr, uptr size);
95  SANITIZER_INTERFACE_ATTRIBUTE
96  void __asan_set_shadow_f8(uptr addr, uptr size);
97
98  // These two functions are used by instrumented code in the
99  // use-after-scope mode. They mark memory for local variables as
100  // unaddressable when they leave scope and addressable before the
101  // function exits.
102  SANITIZER_INTERFACE_ATTRIBUTE
103  void __asan_poison_stack_memory(uptr addr, uptr size);
104  SANITIZER_INTERFACE_ATTRIBUTE
105  void __asan_unpoison_stack_memory(uptr addr, uptr size);
106
107  // Performs cleanup before a NoReturn function. Must be called before things
108  // like _exit and execl to avoid false positives on stack.
109  SANITIZER_INTERFACE_ATTRIBUTE void __asan_handle_no_return();
110
111  SANITIZER_INTERFACE_ATTRIBUTE
112  void __asan_poison_memory_region(void const volatile *addr, uptr size);
113  SANITIZER_INTERFACE_ATTRIBUTE
114  void __asan_unpoison_memory_region(void const volatile *addr, uptr size);
115
116  SANITIZER_INTERFACE_ATTRIBUTE
117  int __asan_address_is_poisoned(void const volatile *addr);
118
119  SANITIZER_INTERFACE_ATTRIBUTE
120  uptr __asan_region_is_poisoned(uptr beg, uptr size);
121
122  SANITIZER_INTERFACE_ATTRIBUTE
123  void __asan_describe_address(uptr addr);
124
125  SANITIZER_INTERFACE_ATTRIBUTE
126  int __asan_report_present();
127
128  SANITIZER_INTERFACE_ATTRIBUTE
129  uptr __asan_get_report_pc();
130  SANITIZER_INTERFACE_ATTRIBUTE
131  uptr __asan_get_report_bp();
132  SANITIZER_INTERFACE_ATTRIBUTE
133  uptr __asan_get_report_sp();
134  SANITIZER_INTERFACE_ATTRIBUTE
135  uptr __asan_get_report_address();
136  SANITIZER_INTERFACE_ATTRIBUTE
137  int __asan_get_report_access_type();
138  SANITIZER_INTERFACE_ATTRIBUTE
139  uptr __asan_get_report_access_size();
140  SANITIZER_INTERFACE_ATTRIBUTE
141  const char * __asan_get_report_description();
142
143  SANITIZER_INTERFACE_ATTRIBUTE
144  const char * __asan_locate_address(uptr addr, char *name, uptr name_size,
145                                     uptr *region_address, uptr *region_size);
146
147  SANITIZER_INTERFACE_ATTRIBUTE
148  uptr __asan_get_alloc_stack(uptr addr, uptr *trace, uptr size,
149                              u32 *thread_id);
150
151  SANITIZER_INTERFACE_ATTRIBUTE
152  uptr __asan_get_free_stack(uptr addr, uptr *trace, uptr size,
153                             u32 *thread_id);
154
155  SANITIZER_INTERFACE_ATTRIBUTE
156  void __asan_get_shadow_mapping(uptr *shadow_scale, uptr *shadow_offset);
157
158  SANITIZER_INTERFACE_ATTRIBUTE
159  void __asan_report_error(uptr pc, uptr bp, uptr sp,
160                           uptr addr, int is_write, uptr access_size, u32 exp);
161
162  SANITIZER_INTERFACE_ATTRIBUTE
163  void __asan_set_death_callback(void (*callback)(void));
164  SANITIZER_INTERFACE_ATTRIBUTE
165  void __asan_set_error_report_callback(void (*callback)(const char*));
166
167  SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
168  /* OPTIONAL */ void __asan_on_error();
169
170  SANITIZER_INTERFACE_ATTRIBUTE void __asan_print_accumulated_stats();
171
172  SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
173  /* OPTIONAL */ const char* __asan_default_options();
174
175  SANITIZER_INTERFACE_ATTRIBUTE
176  extern uptr __asan_shadow_memory_dynamic_address;
177
178  // Global flag, copy of ASAN_OPTIONS=detect_stack_use_after_return
179  SANITIZER_INTERFACE_ATTRIBUTE
180  extern int __asan_option_detect_stack_use_after_return;
181
182  SANITIZER_INTERFACE_ATTRIBUTE
183  extern uptr *__asan_test_only_reported_buggy_pointer;
184
185  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1(uptr p);
186  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2(uptr p);
187  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4(uptr p);
188  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8(uptr p);
189  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16(uptr p);
190  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1(uptr p);
191  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2(uptr p);
192  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4(uptr p);
193  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8(uptr p);
194  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16(uptr p);
195  SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN(uptr p, uptr size);
196  SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN(uptr p, uptr size);
197
198  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1_noabort(uptr p);
199  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2_noabort(uptr p);
200  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4_noabort(uptr p);
201  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8_noabort(uptr p);
202  SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16_noabort(uptr p);
203  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1_noabort(uptr p);
204  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2_noabort(uptr p);
205  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4_noabort(uptr p);
206  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8_noabort(uptr p);
207  SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16_noabort(uptr p);
208  SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN_noabort(uptr p, uptr size);
209  SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN_noabort(uptr p, uptr size);
210
211  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load1(uptr p, u32 exp);
212  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load2(uptr p, u32 exp);
213  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load4(uptr p, u32 exp);
214  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load8(uptr p, u32 exp);
215  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load16(uptr p, u32 exp);
216  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store1(uptr p, u32 exp);
217  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store2(uptr p, u32 exp);
218  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store4(uptr p, u32 exp);
219  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store8(uptr p, u32 exp);
220  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store16(uptr p, u32 exp);
221  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_loadN(uptr p, uptr size,
222                                                      u32 exp);
223  SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_storeN(uptr p, uptr size,
224                                                       u32 exp);
225
226  SANITIZER_INTERFACE_ATTRIBUTE
227      void* __asan_memcpy(void *dst, const void *src, uptr size);
228  SANITIZER_INTERFACE_ATTRIBUTE
229      void* __asan_memset(void *s, int c, uptr n);
230  SANITIZER_INTERFACE_ATTRIBUTE
231      void* __asan_memmove(void* dest, const void* src, uptr n);
232
233  SANITIZER_INTERFACE_ATTRIBUTE
234  void __asan_poison_cxx_array_cookie(uptr p);
235  SANITIZER_INTERFACE_ATTRIBUTE
236  uptr __asan_load_cxx_array_cookie(uptr *p);
237  SANITIZER_INTERFACE_ATTRIBUTE
238  void __asan_poison_intra_object_redzone(uptr p, uptr size);
239  SANITIZER_INTERFACE_ATTRIBUTE
240  void __asan_unpoison_intra_object_redzone(uptr p, uptr size);
241  SANITIZER_INTERFACE_ATTRIBUTE
242  void __asan_alloca_poison(uptr addr, uptr size);
243  SANITIZER_INTERFACE_ATTRIBUTE
244  void __asan_allocas_unpoison(uptr top, uptr bottom);
245}  // extern "C"
246
247#endif  // ASAN_INTERFACE_INTERNAL_H
248