1//===-- sanitizer/common_interface_defs.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// Common part of the public sanitizer interface.
10//===----------------------------------------------------------------------===//
11
12#ifndef SANITIZER_COMMON_INTERFACE_DEFS_H
13#define SANITIZER_COMMON_INTERFACE_DEFS_H
14
15#include <stddef.h>
16#include <stdint.h>
17
18// Windows allows a user to set their default calling convention, but we always
19// use __cdecl
20#ifdef _WIN32
21#define SANITIZER_CDECL __cdecl
22#else
23#define SANITIZER_CDECL
24#endif
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29// Arguments for __sanitizer_sandbox_on_notify() below.
30typedef struct {
31 // Enable sandbox support in sanitizer coverage.
32 int coverage_sandboxed;
33 // File descriptor to write coverage data to. If -1 is passed, a file will
34 // be pre-opened by __sanitizer_sandbox_on_notify(). This field has no
35 // effect if coverage_sandboxed == 0.
36 intptr_t coverage_fd;
37 // If non-zero, split the coverage data into well-formed blocks. This is
38 // useful when coverage_fd is a socket descriptor. Each block will contain
39 // a header, allowing data from multiple processes to be sent over the same
40 // socket.
41 unsigned int coverage_max_block_size;
42} __sanitizer_sandbox_arguments;
43
44// Tell the tools to write their reports to "path.<pid>" instead of stderr.
45void SANITIZER_CDECL __sanitizer_set_report_path(const char *path);
46// Tell the tools to write their reports to the provided file descriptor
47// (casted to void *).
48void SANITIZER_CDECL __sanitizer_set_report_fd(void *fd);
49// Get the current full report file path, if a path was specified by
50// an earlier call to __sanitizer_set_report_path. Returns null otherwise.
51const char *SANITIZER_CDECL __sanitizer_get_report_path();
52
53// Notify the tools that the sandbox is going to be turned on. The reserved
54// parameter will be used in the future to hold a structure with functions
55// that the tools may call to bypass the sandbox.
56void SANITIZER_CDECL
57__sanitizer_sandbox_on_notify(__sanitizer_sandbox_arguments *args);
58
59// This function is called by the tool when it has just finished reporting
60// an error. 'error_summary' is a one-line string that summarizes
61// the error message. This function can be overridden by the client.
62void SANITIZER_CDECL
63__sanitizer_report_error_summary(const char *error_summary);
64
65// Some of the sanitizers (for example ASan/TSan) could miss bugs that happen
66// in unaligned loads/stores. To find such bugs reliably, you need to replace
67// plain unaligned loads/stores with these calls.
68
69/// Loads a 16-bit unaligned value.
70//
71/// \param p Pointer to unaligned memory.
72///
73/// \returns Loaded value.
74uint16_t SANITIZER_CDECL __sanitizer_unaligned_load16(const void *p);
75
76/// Loads a 32-bit unaligned value.
77///
78/// \param p Pointer to unaligned memory.
79///
80/// \returns Loaded value.
81uint32_t SANITIZER_CDECL __sanitizer_unaligned_load32(const void *p);
82
83/// Loads a 64-bit unaligned value.
84///
85/// \param p Pointer to unaligned memory.
86///
87/// \returns Loaded value.
88uint64_t SANITIZER_CDECL __sanitizer_unaligned_load64(const void *p);
89
90/// Stores a 16-bit unaligned value.
91///
92/// \param p Pointer to unaligned memory.
93/// \param x 16-bit value to store.
94void SANITIZER_CDECL __sanitizer_unaligned_store16(void *p, uint16_t x);
95
96/// Stores a 32-bit unaligned value.
97///
98/// \param p Pointer to unaligned memory.
99/// \param x 32-bit value to store.
100void SANITIZER_CDECL __sanitizer_unaligned_store32(void *p, uint32_t x);
101
102/// Stores a 64-bit unaligned value.
103///
104/// \param p Pointer to unaligned memory.
105/// \param x 64-bit value to store.
106void SANITIZER_CDECL __sanitizer_unaligned_store64(void *p, uint64_t x);
107
108// Returns 1 on the first call, then returns 0 thereafter. Called by the tool
109// to ensure only one report is printed when multiple errors occur
110// simultaneously.
111int SANITIZER_CDECL __sanitizer_acquire_crash_state();
112
113/// Annotates the current state of a contiguous container, such as
114/// <c>std::vector</c>, <c>std::string</c>, or similar.
115///
116/// A contiguous container is a container that keeps all of its elements
117/// in a contiguous region of memory. The container owns the region of memory
118/// <c>[beg, end)</c>; the memory <c>[beg, mid)</c> is used to store the
119/// current elements, and the memory <c>[mid, end)</c> is reserved for future
120/// elements (<c>beg <= mid <= end</c>). For example, in
121/// <c>std::vector<> v</c>:
122///
123/// \code
124/// beg = &v[0];
125/// end = beg + v.capacity() * sizeof(v[0]);
126/// mid = beg + v.size() * sizeof(v[0]);
127/// \endcode
128///
129/// This annotation tells the Sanitizer tool about the current state of the
130/// container so that the tool can report errors when memory from
131/// <c>[mid, end)</c> is accessed. Insert this annotation into methods like
132/// <c>push_back()</c> or <c>pop_back()</c>. Supply the old and new values of
133/// <c>mid</c>(<c><i>old_mid</i></c> and <c><i>new_mid</i></c>). In the initial
134/// state <c>mid == end</c>, so that should be the final state when the
135/// container is destroyed or when the container reallocates the storage.
136///
137/// For ASan, <c><i>beg</i></c> no longer needs to be 8-aligned,
138/// first and last granule may be shared with other objects
139/// and therefore the function can be used for any allocator.
140///
141/// The following example shows how to use the function:
142///
143/// \code
144/// int32_t x[3]; // 12 bytes
145/// char *beg = (char*)&x[0];
146/// char *end = beg + 12;
147/// __sanitizer_annotate_contiguous_container(beg, end, beg, end);
148/// \endcode
149///
150/// \note Use this function with caution and do not use for anything other
151/// than vector-like classes.
152/// \note Unaligned <c><i>beg</i></c> or <c><i>end</i></c> may miss bugs in
153/// these granules.
154///
155/// \param beg Beginning of memory region.
156/// \param end End of memory region.
157/// \param old_mid Old middle of memory region.
158/// \param new_mid New middle of memory region.
159#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
160__attribute__((__internal_linkage__)) inline void SANITIZER_CDECL
161__sanitizer_annotate_contiguous_container(const void *beg, const void *end,
162 const void *old_mid,
163 const void *new_mid) {}
164#else
165void SANITIZER_CDECL __sanitizer_annotate_contiguous_container(
166 const void *beg, const void *end, const void *old_mid, const void *new_mid);
167#endif
168
169/// Similar to <c>__sanitizer_annotate_contiguous_container</c>.
170///
171/// Annotates the current state of a contiguous container memory,
172/// such as <c>std::deque</c>'s single chunk, when the boundries are moved.
173///
174/// A contiguous chunk is a chunk that keeps all of its elements
175/// in a contiguous region of memory. The container owns the region of memory
176/// <c>[storage_beg, storage_end)</c>; the memory <c>[container_beg,
177/// container_end)</c> is used to store the current elements, and the memory
178/// <c>[storage_beg, container_beg), [container_end, storage_end)</c> is
179/// reserved for future elements (<c>storage_beg <= container_beg <=
180/// container_end <= storage_end</c>). For example, in <c> std::deque </c>:
181/// - chunk with a frist deques element will have container_beg equal to address
182/// of the first element.
183/// - in every next chunk with elements, true is <c> container_beg ==
184/// storage_beg </c>.
185///
186/// Argument requirements:
187/// During unpoisoning memory of empty container (before first element is
188/// added):
189/// - old_container_beg_p == old_container_end_p
190/// During poisoning after last element was removed:
191/// - new_container_beg_p == new_container_end_p
192/// \param storage_beg Beginning of memory region.
193/// \param storage_end End of memory region.
194/// \param old_container_beg Old beginning of used region.
195/// \param old_container_end End of used region.
196/// \param new_container_beg New beginning of used region.
197/// \param new_container_end New end of used region.
198#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
199__attribute__((__internal_linkage__)) inline void
200 SANITIZER_CDECL __sanitizer_annotate_double_ended_contiguous_container(
201 const void *storage_beg, const void *storage_end,
202 const void *old_container_beg, const void *old_container_end,
203 const void *new_container_beg, const void *new_container_end) {}
204#else
205void SANITIZER_CDECL __sanitizer_annotate_double_ended_contiguous_container(
206 const void *storage_beg, const void *storage_end,
207 const void *old_container_beg, const void *old_container_end,
208 const void *new_container_beg, const void *new_container_end);
209#endif
210
211/// Returns true if the contiguous container <c>[beg, end)</c> is properly
212/// poisoned.
213///
214/// Proper poisoning could occur, for example, with
215/// <c>__sanitizer_annotate_contiguous_container</c>), that is, if
216/// <c>[beg, mid)</c> is addressable and <c>[mid, end)</c> is unaddressable.
217/// Full verification requires O (<c>end - beg</c>) time; this function tries
218/// to avoid such complexity by touching only parts of the container around
219/// <c><i>beg</i></c>, <c><i>mid</i></c>, and <c><i>end</i></c>.
220///
221/// \param beg Beginning of memory region.
222/// \param mid Middle of memory region.
223/// \param end Old end of memory region.
224///
225/// \returns True if the contiguous container <c>[beg, end)</c> is properly
226/// poisoned.
227#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
228__attribute__((__internal_linkage__)) inline int
229 SANITIZER_CDECL __sanitizer_verify_contiguous_container(const void *beg,
230 const void *mid,
231 const void *end) {
232 return 1;
233}
234#else
235int SANITIZER_CDECL __sanitizer_verify_contiguous_container(const void *beg,
236 const void *mid,
237 const void *end);
238#endif
239
240/// Returns true if the double ended contiguous
241/// container <c>[storage_beg, storage_end)</c> is properly poisoned.
242///
243/// Proper poisoning could occur, for example, with
244/// <c>__sanitizer_annotate_double_ended_contiguous_container</c>), that is, if
245/// <c>[storage_beg, container_beg)</c> is not addressable, <c>[container_beg,
246/// container_end)</c> is addressable and <c>[container_end, end)</c> is
247/// unaddressable. Full verification requires O (<c>storage_end -
248/// storage_beg</c>) time; this function tries to avoid such complexity by
249/// touching only parts of the container around <c><i>storage_beg</i></c>,
250/// <c><i>container_beg</i></c>, <c><i>container_end</i></c>, and
251/// <c><i>storage_end</i></c>.
252///
253/// \param storage_beg Beginning of memory region.
254/// \param container_beg Beginning of used region.
255/// \param container_end End of used region.
256/// \param storage_end End of memory region.
257///
258/// \returns True if the double-ended contiguous container <c>[storage_beg,
259/// container_beg, container_end, end)</c> is properly poisoned - only
260/// [container_beg; container_end) is addressable.
261#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
262__attribute__((__internal_linkage__)) inline int SANITIZER_CDECL
263__sanitizer_verify_double_ended_contiguous_container(const void *storage_beg,
264 const void *container_beg,
265 const void *container_end,
266 const void *storage_end) {
267 return 1;
268}
269#else
270int SANITIZER_CDECL __sanitizer_verify_double_ended_contiguous_container(
271 const void *storage_beg, const void *container_beg,
272 const void *container_end, const void *storage_end);
273#endif
274
275/// Similar to <c>__sanitizer_verify_contiguous_container()</c> but also
276/// returns the address of the first improperly poisoned byte.
277///
278/// Returns NULL if the area is poisoned properly.
279///
280/// \param beg Beginning of memory region.
281/// \param mid Middle of memory region.
282/// \param end Old end of memory region.
283///
284/// \returns The bad address or NULL.
285#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
286__attribute__((__internal_linkage__)) inline const void *SANITIZER_CDECL
287__sanitizer_contiguous_container_find_bad_address(const void *beg,
288 const void *mid,
289 const void *end) {
290 return NULL;
291}
292#else
293const void *SANITIZER_CDECL __sanitizer_contiguous_container_find_bad_address(
294 const void *beg, const void *mid, const void *end);
295#endif
296
297/// returns the address of the first improperly poisoned byte.
298///
299/// Returns NULL if the area is poisoned properly.
300///
301/// \param storage_beg Beginning of memory region.
302/// \param container_beg Beginning of used region.
303/// \param container_end End of used region.
304/// \param storage_end End of memory region.
305///
306/// \returns The bad address or NULL.
307#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
308__attribute__((__internal_linkage__)) inline const void *SANITIZER_CDECL
309__sanitizer_double_ended_contiguous_container_find_bad_address(
310 const void *storage_beg, const void *container_beg,
311 const void *container_end, const void *storage_end) {
312 return NULL;
313}
314#else
315const void *SANITIZER_CDECL
316__sanitizer_double_ended_contiguous_container_find_bad_address(
317 const void *storage_beg, const void *container_beg,
318 const void *container_end, const void *storage_end);
319#endif
320
321/// Prints the stack trace leading to this call (useful for calling from the
322/// debugger).
323void SANITIZER_CDECL __sanitizer_print_stack_trace(void);
324
325// Symbolizes the supplied 'pc' using the format string 'fmt'.
326// Outputs at most 'out_buf_size' bytes into 'out_buf'.
327// If 'out_buf' is not empty then output is zero or more non empty C strings
328// followed by single empty C string. Multiple strings can be returned if PC
329// corresponds to inlined function. Inlined frames are printed in the order
330// from "most-inlined" to the "least-inlined", so the last frame should be the
331// not inlined function.
332// Inlined frames can be removed with 'symbolize_inline_frames=0'.
333// The format syntax is described in
334// lib/sanitizer_common/sanitizer_stacktrace_printer.h.
335void SANITIZER_CDECL __sanitizer_symbolize_pc(void *pc, const char *fmt,
336 char *out_buf,
337 size_t out_buf_size);
338// Same as __sanitizer_symbolize_pc, but for data section (i.e. globals).
339void SANITIZER_CDECL __sanitizer_symbolize_global(void *data_ptr,
340 const char *fmt,
341 char *out_buf,
342 size_t out_buf_size);
343// Determine the return address.
344#if !defined(_MSC_VER) || defined(__clang__)
345#define __sanitizer_return_address() \
346 __builtin_extract_return_addr(__builtin_return_address(0))
347#else
348void *_ReturnAddress(void);
349#pragma intrinsic(_ReturnAddress)
350#define __sanitizer_return_address() _ReturnAddress()
351#endif
352
353/// Sets the callback to be called immediately before death on error.
354///
355/// Passing 0 will unset the callback.
356///
357/// \param callback User-provided callback.
358void SANITIZER_CDECL __sanitizer_set_death_callback(void (*callback)(void));
359
360// Interceptor hooks.
361// Whenever a libc function interceptor is called, it checks if the
362// corresponding weak hook is defined, and calls it if it is indeed defined.
363// The primary use-case is data-flow-guided fuzzing, where the fuzzer needs
364// to know what is being passed to libc functions (for example memcmp).
365// FIXME: implement more hooks.
366
367/// Interceptor hook for <c>memcmp()</c>.
368///
369/// \param called_pc PC (program counter) address of the original call.
370/// \param s1 Pointer to block of memory.
371/// \param s2 Pointer to block of memory.
372/// \param n Number of bytes to compare.
373/// \param result Value returned by the intercepted function.
374void SANITIZER_CDECL __sanitizer_weak_hook_memcmp(void *called_pc,
375 const void *s1,
376 const void *s2, size_t n,
377 int result);
378
379/// Interceptor hook for <c>strncmp()</c>.
380///
381/// \param called_pc PC (program counter) address of the original call.
382/// \param s1 Pointer to block of memory.
383/// \param s2 Pointer to block of memory.
384/// \param n Number of bytes to compare.
385/// \param result Value returned by the intercepted function.
386void SANITIZER_CDECL __sanitizer_weak_hook_strncmp(void *called_pc,
387 const char *s1,
388 const char *s2, size_t n,
389 int result);
390
391/// Interceptor hook for <c>strncasecmp()</c>.
392///
393/// \param called_pc PC (program counter) address of the original call.
394/// \param s1 Pointer to block of memory.
395/// \param s2 Pointer to block of memory.
396/// \param n Number of bytes to compare.
397/// \param result Value returned by the intercepted function.
398void SANITIZER_CDECL __sanitizer_weak_hook_strncasecmp(void *called_pc,
399 const char *s1,
400 const char *s2, size_t n,
401 int result);
402
403/// Interceptor hook for <c>strcmp()</c>.
404///
405/// \param called_pc PC (program counter) address of the original call.
406/// \param s1 Pointer to block of memory.
407/// \param s2 Pointer to block of memory.
408/// \param result Value returned by the intercepted function.
409void SANITIZER_CDECL __sanitizer_weak_hook_strcmp(void *called_pc,
410 const char *s1,
411 const char *s2, int result);
412
413/// Interceptor hook for <c>strcasecmp()</c>.
414///
415/// \param called_pc PC (program counter) address of the original call.
416/// \param s1 Pointer to block of memory.
417/// \param s2 Pointer to block of memory.
418/// \param result Value returned by the intercepted function.
419void SANITIZER_CDECL __sanitizer_weak_hook_strcasecmp(void *called_pc,
420 const char *s1,
421 const char *s2,
422 int result);
423
424/// Interceptor hook for <c>strstr()</c>.
425///
426/// \param called_pc PC (program counter) address of the original call.
427/// \param s1 Pointer to block of memory.
428/// \param s2 Pointer to block of memory.
429/// \param result Value returned by the intercepted function.
430void SANITIZER_CDECL __sanitizer_weak_hook_strstr(void *called_pc,
431 const char *s1,
432 const char *s2, char *result);
433
434void SANITIZER_CDECL __sanitizer_weak_hook_strcasestr(void *called_pc,
435 const char *s1,
436 const char *s2,
437 char *result);
438
439void SANITIZER_CDECL __sanitizer_weak_hook_memmem(void *called_pc,
440 const void *s1, size_t len1,
441 const void *s2, size_t len2,
442 void *result);
443
444// Prints stack traces for all live heap allocations ordered by total
445// allocation size until top_percent of total live heap is shown. top_percent
446// should be between 1 and 100. At most max_number_of_contexts contexts
447// (stack traces) are printed.
448// Experimental feature currently available only with ASan on Linux/x86_64.
449void SANITIZER_CDECL __sanitizer_print_memory_profile(
450 size_t top_percent, size_t max_number_of_contexts);
451
452/// Notify ASan that a fiber switch has started (required only if implementing
453/// your own fiber library).
454///
455/// Before switching to a different stack, you must call
456/// <c>__sanitizer_start_switch_fiber()</c> with a pointer to the bottom of the
457/// destination stack and with its size. When code starts running on the new
458/// stack, it must call <c>__sanitizer_finish_switch_fiber()</c> to finalize
459/// the switch. The <c>__sanitizer_start_switch_fiber()</c> function takes a
460/// <c>void**</c> pointer argument to store the current fake stack if there is
461/// one (it is necessary when the runtime option
462/// <c>detect_stack_use_after_return</c> is enabled).
463///
464/// When restoring a stack, this <c>void**</c> pointer must be given to the
465/// <c>__sanitizer_finish_switch_fiber()</c> function. In most cases, this
466/// pointer can be stored on the stack immediately before switching. When
467/// leaving a fiber definitely, NULL must be passed as the first argument to
468/// the <c>__sanitizer_start_switch_fiber()</c> function so that the fake stack
469/// is destroyed. If your program does not need stack use-after-return
470/// detection, you can always pass NULL to these two functions.
471///
472/// \note The fake stack mechanism is disabled during fiber switch, so if a
473/// signal callback runs during the switch, it will not benefit from stack
474/// use-after-return detection.
475///
476/// \param[out] fake_stack_save Fake stack save location.
477/// \param bottom Bottom address of stack.
478/// \param size Size of stack in bytes.
479void SANITIZER_CDECL __sanitizer_start_switch_fiber(void **fake_stack_save,
480 const void *bottom,
481 size_t size);
482
483/// Notify ASan that a fiber switch has completed (required only if
484/// implementing your own fiber library).
485///
486/// When code starts running on the new stack, it must call
487/// <c>__sanitizer_finish_switch_fiber()</c> to finalize
488/// the switch. For usage details, see the description of
489/// <c>__sanitizer_start_switch_fiber()</c>.
490///
491/// \param fake_stack_save Fake stack save location.
492/// \param[out] bottom_old Bottom address of old stack.
493/// \param[out] size_old Size of old stack in bytes.
494void SANITIZER_CDECL __sanitizer_finish_switch_fiber(void *fake_stack_save,
495 const void **bottom_old,
496 size_t *size_old);
497
498// Get full module name and calculate pc offset within it.
499// Returns 1 if pc belongs to some module, 0 if module was not found.
500int SANITIZER_CDECL __sanitizer_get_module_and_offset_for_pc(
501 void *pc, char *module_path, size_t module_path_len, void **pc_offset);
502
503#ifdef __cplusplus
504} // extern "C"
505#endif
506
507#endif // SANITIZER_COMMON_INTERFACE_DEFS_H
508