1 //===-- sanitizer_interface_internal.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 shared between run-time libraries of sanitizers.
10 //
11 // This header declares the sanitizer runtime interface functions.
12 // The runtime library has to define these functions so the instrumented program
13 // could call them.
14 //
15 // See also include/sanitizer/common_interface_defs.h
16 //===----------------------------------------------------------------------===//
17 #ifndef SANITIZER_INTERFACE_INTERNAL_H
18 #define SANITIZER_INTERFACE_INTERNAL_H
19 
20 #include "sanitizer_internal_defs.h"
21 
22 extern "C" {
23   // Tell the tools to write their reports to "path.<pid>" instead of stderr.
24   // The special values are "stdout" and "stderr".
25   SANITIZER_INTERFACE_ATTRIBUTE
26   void __sanitizer_set_report_path(const char *path);
27   // Tell the tools to write their reports to the provided file descriptor
28   // (casted to void *).
29   SANITIZER_INTERFACE_ATTRIBUTE
30   void __sanitizer_set_report_fd(void *fd);
31   // Get the current full report file path, if a path was specified by
32   // an earlier call to __sanitizer_set_report_path. Returns null otherwise.
33   SANITIZER_INTERFACE_ATTRIBUTE
34   const char *__sanitizer_get_report_path();
35 
36   typedef struct {
37       int coverage_sandboxed;
38       __sanitizer::sptr coverage_fd;
39       unsigned int coverage_max_block_size;
40   } __sanitizer_sandbox_arguments;
41 
42   // Notify the tools that the sandbox is going to be turned on.
43   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE void
44       __sanitizer_sandbox_on_notify(__sanitizer_sandbox_arguments *args);
45 
46   // This function is called by the tool when it has just finished reporting
47   // an error. 'error_summary' is a one-line string that summarizes
48   // the error message. This function can be overridden by the client.
49   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
50   void __sanitizer_report_error_summary(const char *error_summary);
51 
52   SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov_dump();
53   SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_dump_coverage(
54       const __sanitizer::uptr *pcs, const __sanitizer::uptr len);
55   SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_dump_trace_pc_guard_coverage();
56 
57   SANITIZER_INTERFACE_ATTRIBUTE void __sanitizer_cov(__sanitizer::u32 *guard);
58 
59   // Returns 1 on the first call, then returns 0 thereafter.  Called by the tool
60   // to ensure only one report is printed when multiple errors occur
61   // simultaneously.
62   SANITIZER_INTERFACE_ATTRIBUTE int __sanitizer_acquire_crash_state();
63 
64   SANITIZER_INTERFACE_ATTRIBUTE
65   void __sanitizer_annotate_contiguous_container(const void *beg,
66                                                  const void *end,
67                                                  const void *old_mid,
68                                                  const void *new_mid);
69   SANITIZER_INTERFACE_ATTRIBUTE
70   int __sanitizer_verify_contiguous_container(const void *beg, const void *mid,
71                                               const void *end);
72   SANITIZER_INTERFACE_ATTRIBUTE
73   const void *__sanitizer_contiguous_container_find_bad_address(
74       const void *beg, const void *mid, const void *end);
75 
76   SANITIZER_INTERFACE_ATTRIBUTE
77   int __sanitizer_get_module_and_offset_for_pc(
78       __sanitizer::uptr pc, char *module_path,
79       __sanitizer::uptr module_path_len, __sanitizer::uptr *pc_offset);
80 
81   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
82   void __sanitizer_cov_trace_cmp();
83   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
84   void __sanitizer_cov_trace_cmp1();
85   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
86   void __sanitizer_cov_trace_cmp2();
87   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
88   void __sanitizer_cov_trace_cmp4();
89   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
90   void __sanitizer_cov_trace_cmp8();
91   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
92   void __sanitizer_cov_trace_const_cmp1();
93   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
94   void __sanitizer_cov_trace_const_cmp2();
95   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
96   void __sanitizer_cov_trace_const_cmp4();
97   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
98   void __sanitizer_cov_trace_const_cmp8();
99   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
100   void __sanitizer_cov_trace_switch();
101   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
102   void __sanitizer_cov_trace_div4();
103   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
104   void __sanitizer_cov_trace_div8();
105   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
106   void __sanitizer_cov_trace_gep();
107   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
108   void __sanitizer_cov_trace_pc_indir();
109   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
110   void __sanitizer_cov_trace_pc_guard(__sanitizer::u32*);
111   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
112   void __sanitizer_cov_trace_pc_guard_init(__sanitizer::u32*,
113                                            __sanitizer::u32*);
114   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE void
115   __sanitizer_cov_8bit_counters_init(char *, char *);
116   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE void
117   __sanitizer_cov_bool_flag_init();
118   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE void
119   __sanitizer_cov_pcs_init(const __sanitizer::uptr *,
120                            const __sanitizer::uptr *);
121 } // extern "C"
122 
123 #endif  // SANITIZER_INTERFACE_INTERNAL_H
124