annotate libsanitizer/asan/asan_interface_internal.h @ 113:bdf41c9fa0b7

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