xref: /freebsd/contrib/llvm-project/compiler-rt/lib/tsan/rtl/tsan_interface.h (revision 162ae9c834f6d9f9cb443bd62cceb23e0b5fef48)
1 //===-- tsan_interface.h ----------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file is a part of ThreadSanitizer (TSan), a race detector.
10 //
11 // The functions declared in this header will be inserted by the instrumentation
12 // module.
13 // This header can be included by the instrumented program or by TSan tests.
14 //===----------------------------------------------------------------------===//
15 #ifndef TSAN_INTERFACE_H
16 #define TSAN_INTERFACE_H
17 
18 #include <sanitizer_common/sanitizer_internal_defs.h>
19 using __sanitizer::uptr;
20 using __sanitizer::tid_t;
21 
22 // This header should NOT include any other headers.
23 // All functions in this header are extern "C" and start with __tsan_.
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
29 #if !SANITIZER_GO
30 
31 // This function should be called at the very beginning of the process,
32 // before any instrumented code is executed and before any call to malloc.
33 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_init();
34 
35 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_flush_memory();
36 
37 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read1(void *addr);
38 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read2(void *addr);
39 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read4(void *addr);
40 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read8(void *addr);
41 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read16(void *addr);
42 
43 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write1(void *addr);
44 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write2(void *addr);
45 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write4(void *addr);
46 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write8(void *addr);
47 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write16(void *addr);
48 
49 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_read2(const void *addr);
50 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_read4(const void *addr);
51 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_read8(const void *addr);
52 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_read16(const void *addr);
53 
54 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_write2(void *addr);
55 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_write4(void *addr);
56 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_write8(void *addr);
57 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_unaligned_write16(void *addr);
58 
59 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read1_pc(void *addr, void *pc);
60 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read2_pc(void *addr, void *pc);
61 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read4_pc(void *addr, void *pc);
62 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read8_pc(void *addr, void *pc);
63 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_read16_pc(void *addr, void *pc);
64 
65 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write1_pc(void *addr, void *pc);
66 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write2_pc(void *addr, void *pc);
67 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write4_pc(void *addr, void *pc);
68 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write8_pc(void *addr, void *pc);
69 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_write16_pc(void *addr, void *pc);
70 
71 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_vptr_read(void **vptr_p);
72 SANITIZER_INTERFACE_ATTRIBUTE
73 void __tsan_vptr_update(void **vptr_p, void *new_val);
74 
75 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_func_entry(void *call_pc);
76 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_func_exit();
77 
78 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_ignore_thread_begin();
79 SANITIZER_INTERFACE_ATTRIBUTE void __tsan_ignore_thread_end();
80 
81 SANITIZER_INTERFACE_ATTRIBUTE
82 void *__tsan_external_register_tag(const char *object_type);
83 SANITIZER_INTERFACE_ATTRIBUTE
84 void __tsan_external_register_header(void *tag, const char *header);
85 SANITIZER_INTERFACE_ATTRIBUTE
86 void __tsan_external_assign_tag(void *addr, void *tag);
87 SANITIZER_INTERFACE_ATTRIBUTE
88 void __tsan_external_read(void *addr, void *caller_pc, void *tag);
89 SANITIZER_INTERFACE_ATTRIBUTE
90 void __tsan_external_write(void *addr, void *caller_pc, void *tag);
91 
92 SANITIZER_INTERFACE_ATTRIBUTE
93 void __tsan_read_range(void *addr, unsigned long size);  // NOLINT
94 SANITIZER_INTERFACE_ATTRIBUTE
95 void __tsan_write_range(void *addr, unsigned long size);  // NOLINT
96 
97 // User may provide function that would be called right when TSan detects
98 // an error. The argument 'report' is an opaque pointer that can be used to
99 // gather additional information using other TSan report API functions.
100 SANITIZER_INTERFACE_ATTRIBUTE
101 void __tsan_on_report(void *report);
102 
103 // If TSan is currently reporting a detected issue on the current thread,
104 // returns an opaque pointer to the current report. Otherwise returns NULL.
105 SANITIZER_INTERFACE_ATTRIBUTE
106 void *__tsan_get_current_report();
107 
108 // Returns a report's description (issue type), number of duplicate issues
109 // found, counts of array data (stack traces, memory operations, locations,
110 // mutexes, threads, unique thread IDs) and a stack trace of a sleep() call (if
111 // one was involved in the issue).
112 SANITIZER_INTERFACE_ATTRIBUTE
113 int __tsan_get_report_data(void *report, const char **description, int *count,
114                            int *stack_count, int *mop_count, int *loc_count,
115                            int *mutex_count, int *thread_count,
116                            int *unique_tid_count, void **sleep_trace,
117                            uptr trace_size);
118 
119 /// Retrieves the "tag" from a report (for external-race report types). External
120 /// races can be associated with a tag which give them more meaning. For example
121 /// tag value '1' means "Swift access race". Tag value '0' indicated a plain
122 /// external race.
123 ///
124 /// \param report opaque pointer to the current report (obtained as argument in
125 ///               __tsan_on_report, or from __tsan_get_current_report)
126 /// \param [out] tag points to storage that will be filled with the tag value
127 ///
128 /// \returns non-zero value on success, zero on failure
129 SANITIZER_INTERFACE_ATTRIBUTE
130 int __tsan_get_report_tag(void *report, uptr *tag);
131 
132 // Returns information about stack traces included in the report.
133 SANITIZER_INTERFACE_ATTRIBUTE
134 int __tsan_get_report_stack(void *report, uptr idx, void **trace,
135                             uptr trace_size);
136 
137 // Returns information about memory operations included in the report.
138 SANITIZER_INTERFACE_ATTRIBUTE
139 int __tsan_get_report_mop(void *report, uptr idx, int *tid, void **addr,
140                           int *size, int *write, int *atomic, void **trace,
141                           uptr trace_size);
142 
143 // Returns information about locations included in the report.
144 SANITIZER_INTERFACE_ATTRIBUTE
145 int __tsan_get_report_loc(void *report, uptr idx, const char **type,
146                           void **addr, uptr *start, uptr *size, int *tid,
147                           int *fd, int *suppressable, void **trace,
148                           uptr trace_size);
149 
150 SANITIZER_INTERFACE_ATTRIBUTE
151 int __tsan_get_report_loc_object_type(void *report, uptr idx,
152                                       const char **object_type);
153 
154 // Returns information about mutexes included in the report.
155 SANITIZER_INTERFACE_ATTRIBUTE
156 int __tsan_get_report_mutex(void *report, uptr idx, uptr *mutex_id, void **addr,
157                             int *destroyed, void **trace, uptr trace_size);
158 
159 // Returns information about threads included in the report.
160 SANITIZER_INTERFACE_ATTRIBUTE
161 int __tsan_get_report_thread(void *report, uptr idx, int *tid, tid_t *os_id,
162                              int *running, const char **name, int *parent_tid,
163                              void **trace, uptr trace_size);
164 
165 // Returns information about unique thread IDs included in the report.
166 SANITIZER_INTERFACE_ATTRIBUTE
167 int __tsan_get_report_unique_tid(void *report, uptr idx, int *tid);
168 
169 // Returns the type of the pointer (heap, stack, global, ...) and if possible
170 // also the starting address (e.g. of a heap allocation) and size.
171 SANITIZER_INTERFACE_ATTRIBUTE
172 const char *__tsan_locate_address(uptr addr, char *name, uptr name_size,
173                                   uptr *region_address, uptr *region_size);
174 
175 // Returns the allocation stack for a heap pointer.
176 SANITIZER_INTERFACE_ATTRIBUTE
177 int __tsan_get_alloc_stack(uptr addr, uptr *trace, uptr size, int *thread_id,
178                            tid_t *os_id);
179 
180 #endif  // SANITIZER_GO
181 
182 #ifdef __cplusplus
183 }  // extern "C"
184 #endif
185 
186 namespace __tsan {
187 
188 // These should match declarations from public tsan_interface_atomic.h header.
189 typedef unsigned char      a8;
190 typedef unsigned short     a16;  // NOLINT
191 typedef unsigned int       a32;
192 typedef unsigned long long a64;  // NOLINT
193 #if !SANITIZER_GO && (defined(__SIZEOF_INT128__) \
194     || (__clang_major__ * 100 + __clang_minor__ >= 302)) && !defined(__mips64)
195 __extension__ typedef __int128 a128;
196 # define __TSAN_HAS_INT128 1
197 #else
198 # define __TSAN_HAS_INT128 0
199 #endif
200 
201 // Part of ABI, do not change.
202 // https://github.com/llvm/llvm-project/blob/master/libcxx/include/atomic
203 typedef enum {
204   mo_relaxed,
205   mo_consume,
206   mo_acquire,
207   mo_release,
208   mo_acq_rel,
209   mo_seq_cst
210 } morder;
211 
212 struct ThreadState;
213 
214 extern "C" {
215 SANITIZER_INTERFACE_ATTRIBUTE
216 a8 __tsan_atomic8_load(const volatile a8 *a, morder mo);
217 SANITIZER_INTERFACE_ATTRIBUTE
218 a16 __tsan_atomic16_load(const volatile a16 *a, morder mo);
219 SANITIZER_INTERFACE_ATTRIBUTE
220 a32 __tsan_atomic32_load(const volatile a32 *a, morder mo);
221 SANITIZER_INTERFACE_ATTRIBUTE
222 a64 __tsan_atomic64_load(const volatile a64 *a, morder mo);
223 #if __TSAN_HAS_INT128
224 SANITIZER_INTERFACE_ATTRIBUTE
225 a128 __tsan_atomic128_load(const volatile a128 *a, morder mo);
226 #endif
227 
228 SANITIZER_INTERFACE_ATTRIBUTE
229 void __tsan_atomic8_store(volatile a8 *a, a8 v, morder mo);
230 SANITIZER_INTERFACE_ATTRIBUTE
231 void __tsan_atomic16_store(volatile a16 *a, a16 v, morder mo);
232 SANITIZER_INTERFACE_ATTRIBUTE
233 void __tsan_atomic32_store(volatile a32 *a, a32 v, morder mo);
234 SANITIZER_INTERFACE_ATTRIBUTE
235 void __tsan_atomic64_store(volatile a64 *a, a64 v, morder mo);
236 #if __TSAN_HAS_INT128
237 SANITIZER_INTERFACE_ATTRIBUTE
238 void __tsan_atomic128_store(volatile a128 *a, a128 v, morder mo);
239 #endif
240 
241 SANITIZER_INTERFACE_ATTRIBUTE
242 a8 __tsan_atomic8_exchange(volatile a8 *a, a8 v, morder mo);
243 SANITIZER_INTERFACE_ATTRIBUTE
244 a16 __tsan_atomic16_exchange(volatile a16 *a, a16 v, morder mo);
245 SANITIZER_INTERFACE_ATTRIBUTE
246 a32 __tsan_atomic32_exchange(volatile a32 *a, a32 v, morder mo);
247 SANITIZER_INTERFACE_ATTRIBUTE
248 a64 __tsan_atomic64_exchange(volatile a64 *a, a64 v, morder mo);
249 #if __TSAN_HAS_INT128
250 SANITIZER_INTERFACE_ATTRIBUTE
251 a128 __tsan_atomic128_exchange(volatile a128 *a, a128 v, morder mo);
252 #endif
253 
254 SANITIZER_INTERFACE_ATTRIBUTE
255 a8 __tsan_atomic8_fetch_add(volatile a8 *a, a8 v, morder mo);
256 SANITIZER_INTERFACE_ATTRIBUTE
257 a16 __tsan_atomic16_fetch_add(volatile a16 *a, a16 v, morder mo);
258 SANITIZER_INTERFACE_ATTRIBUTE
259 a32 __tsan_atomic32_fetch_add(volatile a32 *a, a32 v, morder mo);
260 SANITIZER_INTERFACE_ATTRIBUTE
261 a64 __tsan_atomic64_fetch_add(volatile a64 *a, a64 v, morder mo);
262 #if __TSAN_HAS_INT128
263 SANITIZER_INTERFACE_ATTRIBUTE
264 a128 __tsan_atomic128_fetch_add(volatile a128 *a, a128 v, morder mo);
265 #endif
266 
267 SANITIZER_INTERFACE_ATTRIBUTE
268 a8 __tsan_atomic8_fetch_sub(volatile a8 *a, a8 v, morder mo);
269 SANITIZER_INTERFACE_ATTRIBUTE
270 a16 __tsan_atomic16_fetch_sub(volatile a16 *a, a16 v, morder mo);
271 SANITIZER_INTERFACE_ATTRIBUTE
272 a32 __tsan_atomic32_fetch_sub(volatile a32 *a, a32 v, morder mo);
273 SANITIZER_INTERFACE_ATTRIBUTE
274 a64 __tsan_atomic64_fetch_sub(volatile a64 *a, a64 v, morder mo);
275 #if __TSAN_HAS_INT128
276 SANITIZER_INTERFACE_ATTRIBUTE
277 a128 __tsan_atomic128_fetch_sub(volatile a128 *a, a128 v, morder mo);
278 #endif
279 
280 SANITIZER_INTERFACE_ATTRIBUTE
281 a8 __tsan_atomic8_fetch_and(volatile a8 *a, a8 v, morder mo);
282 SANITIZER_INTERFACE_ATTRIBUTE
283 a16 __tsan_atomic16_fetch_and(volatile a16 *a, a16 v, morder mo);
284 SANITIZER_INTERFACE_ATTRIBUTE
285 a32 __tsan_atomic32_fetch_and(volatile a32 *a, a32 v, morder mo);
286 SANITIZER_INTERFACE_ATTRIBUTE
287 a64 __tsan_atomic64_fetch_and(volatile a64 *a, a64 v, morder mo);
288 #if __TSAN_HAS_INT128
289 SANITIZER_INTERFACE_ATTRIBUTE
290 a128 __tsan_atomic128_fetch_and(volatile a128 *a, a128 v, morder mo);
291 #endif
292 
293 SANITIZER_INTERFACE_ATTRIBUTE
294 a8 __tsan_atomic8_fetch_or(volatile a8 *a, a8 v, morder mo);
295 SANITIZER_INTERFACE_ATTRIBUTE
296 a16 __tsan_atomic16_fetch_or(volatile a16 *a, a16 v, morder mo);
297 SANITIZER_INTERFACE_ATTRIBUTE
298 a32 __tsan_atomic32_fetch_or(volatile a32 *a, a32 v, morder mo);
299 SANITIZER_INTERFACE_ATTRIBUTE
300 a64 __tsan_atomic64_fetch_or(volatile a64 *a, a64 v, morder mo);
301 #if __TSAN_HAS_INT128
302 SANITIZER_INTERFACE_ATTRIBUTE
303 a128 __tsan_atomic128_fetch_or(volatile a128 *a, a128 v, morder mo);
304 #endif
305 
306 SANITIZER_INTERFACE_ATTRIBUTE
307 a8 __tsan_atomic8_fetch_xor(volatile a8 *a, a8 v, morder mo);
308 SANITIZER_INTERFACE_ATTRIBUTE
309 a16 __tsan_atomic16_fetch_xor(volatile a16 *a, a16 v, morder mo);
310 SANITIZER_INTERFACE_ATTRIBUTE
311 a32 __tsan_atomic32_fetch_xor(volatile a32 *a, a32 v, morder mo);
312 SANITIZER_INTERFACE_ATTRIBUTE
313 a64 __tsan_atomic64_fetch_xor(volatile a64 *a, a64 v, morder mo);
314 #if __TSAN_HAS_INT128
315 SANITIZER_INTERFACE_ATTRIBUTE
316 a128 __tsan_atomic128_fetch_xor(volatile a128 *a, a128 v, morder mo);
317 #endif
318 
319 SANITIZER_INTERFACE_ATTRIBUTE
320 a8 __tsan_atomic8_fetch_nand(volatile a8 *a, a8 v, morder mo);
321 SANITIZER_INTERFACE_ATTRIBUTE
322 a16 __tsan_atomic16_fetch_nand(volatile a16 *a, a16 v, morder mo);
323 SANITIZER_INTERFACE_ATTRIBUTE
324 a32 __tsan_atomic32_fetch_nand(volatile a32 *a, a32 v, morder mo);
325 SANITIZER_INTERFACE_ATTRIBUTE
326 a64 __tsan_atomic64_fetch_nand(volatile a64 *a, a64 v, morder mo);
327 #if __TSAN_HAS_INT128
328 SANITIZER_INTERFACE_ATTRIBUTE
329 a128 __tsan_atomic128_fetch_nand(volatile a128 *a, a128 v, morder mo);
330 #endif
331 
332 SANITIZER_INTERFACE_ATTRIBUTE
333 int __tsan_atomic8_compare_exchange_strong(volatile a8 *a, a8 *c, a8 v,
334                                            morder mo, morder fmo);
335 SANITIZER_INTERFACE_ATTRIBUTE
336 int __tsan_atomic16_compare_exchange_strong(volatile a16 *a, a16 *c, a16 v,
337                                             morder mo, morder fmo);
338 SANITIZER_INTERFACE_ATTRIBUTE
339 int __tsan_atomic32_compare_exchange_strong(volatile a32 *a, a32 *c, a32 v,
340                                             morder mo, morder fmo);
341 SANITIZER_INTERFACE_ATTRIBUTE
342 int __tsan_atomic64_compare_exchange_strong(volatile a64 *a, a64 *c, a64 v,
343                                             morder mo, morder fmo);
344 #if __TSAN_HAS_INT128
345 SANITIZER_INTERFACE_ATTRIBUTE
346 int __tsan_atomic128_compare_exchange_strong(volatile a128 *a, a128 *c, a128 v,
347                                              morder mo, morder fmo);
348 #endif
349 
350 SANITIZER_INTERFACE_ATTRIBUTE
351 int __tsan_atomic8_compare_exchange_weak(volatile a8 *a, a8 *c, a8 v, morder mo,
352                                          morder fmo);
353 SANITIZER_INTERFACE_ATTRIBUTE
354 int __tsan_atomic16_compare_exchange_weak(volatile a16 *a, a16 *c, a16 v,
355                                           morder mo, morder fmo);
356 SANITIZER_INTERFACE_ATTRIBUTE
357 int __tsan_atomic32_compare_exchange_weak(volatile a32 *a, a32 *c, a32 v,
358                                           morder mo, morder fmo);
359 SANITIZER_INTERFACE_ATTRIBUTE
360 int __tsan_atomic64_compare_exchange_weak(volatile a64 *a, a64 *c, a64 v,
361                                           morder mo, morder fmo);
362 #if __TSAN_HAS_INT128
363 SANITIZER_INTERFACE_ATTRIBUTE
364 int __tsan_atomic128_compare_exchange_weak(volatile a128 *a, a128 *c, a128 v,
365                                            morder mo, morder fmo);
366 #endif
367 
368 SANITIZER_INTERFACE_ATTRIBUTE
369 a8 __tsan_atomic8_compare_exchange_val(volatile a8 *a, a8 c, a8 v, morder mo,
370                                        morder fmo);
371 SANITIZER_INTERFACE_ATTRIBUTE
372 a16 __tsan_atomic16_compare_exchange_val(volatile a16 *a, a16 c, a16 v,
373                                          morder mo, morder fmo);
374 SANITIZER_INTERFACE_ATTRIBUTE
375 a32 __tsan_atomic32_compare_exchange_val(volatile a32 *a, a32 c, a32 v,
376                                          morder mo, morder fmo);
377 SANITIZER_INTERFACE_ATTRIBUTE
378 a64 __tsan_atomic64_compare_exchange_val(volatile a64 *a, a64 c, a64 v,
379                                          morder mo, morder fmo);
380 #if __TSAN_HAS_INT128
381 SANITIZER_INTERFACE_ATTRIBUTE
382 a128 __tsan_atomic128_compare_exchange_val(volatile a128 *a, a128 c, a128 v,
383                                            morder mo, morder fmo);
384 #endif
385 
386 SANITIZER_INTERFACE_ATTRIBUTE
387 void __tsan_atomic_thread_fence(morder mo);
388 SANITIZER_INTERFACE_ATTRIBUTE
389 void __tsan_atomic_signal_fence(morder mo);
390 
391 SANITIZER_INTERFACE_ATTRIBUTE
392 void __tsan_go_atomic32_load(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
393 SANITIZER_INTERFACE_ATTRIBUTE
394 void __tsan_go_atomic64_load(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
395 SANITIZER_INTERFACE_ATTRIBUTE
396 void __tsan_go_atomic32_store(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
397 SANITIZER_INTERFACE_ATTRIBUTE
398 void __tsan_go_atomic64_store(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
399 SANITIZER_INTERFACE_ATTRIBUTE
400 void __tsan_go_atomic32_fetch_add(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
401 SANITIZER_INTERFACE_ATTRIBUTE
402 void __tsan_go_atomic64_fetch_add(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
403 SANITIZER_INTERFACE_ATTRIBUTE
404 void __tsan_go_atomic32_exchange(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
405 SANITIZER_INTERFACE_ATTRIBUTE
406 void __tsan_go_atomic64_exchange(ThreadState *thr, uptr cpc, uptr pc, u8 *a);
407 SANITIZER_INTERFACE_ATTRIBUTE
408 void __tsan_go_atomic32_compare_exchange(ThreadState *thr, uptr cpc, uptr pc,
409                                          u8 *a);
410 SANITIZER_INTERFACE_ATTRIBUTE
411 void __tsan_go_atomic64_compare_exchange(ThreadState *thr, uptr cpc, uptr pc,
412                                          u8 *a);
413 }  // extern "C"
414 
415 }  // namespace __tsan
416 
417 #endif  // TSAN_INTERFACE_H
418