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/// Copies memory annotations from a source storage region to a destination
212/// storage region. After the operation, the destination region has the same
213/// memory annotations as the source region, as long as sanitizer limitations
214/// allow it (more bytes may be unpoisoned than in the source region, resulting
215/// in more false negatives, but never false positives). If the source and
216/// destination regions overlap, only the minimal required changes are made to
217/// preserve the correct annotations. Old storage bytes that are not in the new
218/// storage should have the same annotations, as long as sanitizer limitations
219/// allow it.
220///
221/// This function is primarily designed to be used when moving trivially
222/// relocatable objects that may have poisoned memory, making direct copying
223/// problematic under sanitizer. However, this function does not move memory
224/// content itself, only annotations.
225///
226/// A contiguous container is a container that keeps all of its elements in a
227/// contiguous region of memory. The container owns the region of memory
228/// <c>[src_begin, src_end)</c> and <c>[dst_begin, dst_end)</c>. The memory
229/// within these regions may be alternately poisoned and non-poisoned, with
230/// possibly smaller poisoned and unpoisoned regions.
231///
232/// If this function fully poisons a granule, it is marked as "container
233/// overflow".
234///
235/// Argument requirements: The destination container must have the same size as
236/// the source container, which is inferred from the beginning and end of the
237/// source region. Addresses may be granule-unaligned, but this may affect
238/// performance.
239///
240/// \param src_begin Begin of the source container region.
241/// \param src_end End of the source container region.
242/// \param dst_begin Begin of the destination container region.
243/// \param dst_end End of the destination container region.
244#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
245__attribute__((__internal_linkage__)) inline void SANITIZER_CDECL
246__sanitizer_copy_contiguous_container_annotations(const void *src_begin,
247 const void *src_end,
248 const void *dst_begin,
249 const void *dst_end) {}
250#else
251void SANITIZER_CDECL __sanitizer_copy_contiguous_container_annotations(
252 const void *src_begin, const void *src_end, const void *dst_begin,
253 const void *dst_end);
254#endif
255
256/// Returns true if the contiguous container <c>[beg, end)</c> is properly
257/// poisoned.
258///
259/// Proper poisoning could occur, for example, with
260/// <c>__sanitizer_annotate_contiguous_container</c>), that is, if
261/// <c>[beg, mid)</c> is addressable and <c>[mid, end)</c> is unaddressable.
262/// Full verification requires O (<c>end - beg</c>) time; this function tries
263/// to avoid such complexity by touching only parts of the container around
264/// <c><i>beg</i></c>, <c><i>mid</i></c>, and <c><i>end</i></c>.
265///
266/// \param beg Beginning of memory region.
267/// \param mid Middle of memory region.
268/// \param end Old end of memory region.
269///
270/// \returns True if the contiguous container <c>[beg, end)</c> is properly
271/// poisoned.
272#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
273__attribute__((__internal_linkage__)) inline int
274 SANITIZER_CDECL __sanitizer_verify_contiguous_container(const void *beg,
275 const void *mid,
276 const void *end) {
277 return 1;
278}
279#else
280int SANITIZER_CDECL __sanitizer_verify_contiguous_container(const void *beg,
281 const void *mid,
282 const void *end);
283#endif
284
285/// Returns true if the double ended contiguous
286/// container <c>[storage_beg, storage_end)</c> is properly poisoned.
287///
288/// Proper poisoning could occur, for example, with
289/// <c>__sanitizer_annotate_double_ended_contiguous_container</c>), that is, if
290/// <c>[storage_beg, container_beg)</c> is not addressable, <c>[container_beg,
291/// container_end)</c> is addressable and <c>[container_end, end)</c> is
292/// unaddressable. Full verification requires O (<c>storage_end -
293/// storage_beg</c>) time; this function tries to avoid such complexity by
294/// touching only parts of the container around <c><i>storage_beg</i></c>,
295/// <c><i>container_beg</i></c>, <c><i>container_end</i></c>, and
296/// <c><i>storage_end</i></c>.
297///
298/// \param storage_beg Beginning of memory region.
299/// \param container_beg Beginning of used region.
300/// \param container_end End of used region.
301/// \param storage_end End of memory region.
302///
303/// \returns True if the double-ended contiguous container <c>[storage_beg,
304/// container_beg, container_end, end)</c> is properly poisoned - only
305/// [container_beg; container_end) is addressable.
306#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
307__attribute__((__internal_linkage__)) inline int SANITIZER_CDECL
308__sanitizer_verify_double_ended_contiguous_container(const void *storage_beg,
309 const void *container_beg,
310 const void *container_end,
311 const void *storage_end) {
312 return 1;
313}
314#else
315int SANITIZER_CDECL __sanitizer_verify_double_ended_contiguous_container(
316 const void *storage_beg, const void *container_beg,
317 const void *container_end, const void *storage_end);
318#endif
319
320/// Similar to <c>__sanitizer_verify_contiguous_container()</c> but also
321/// returns the address of the first improperly poisoned byte.
322///
323/// Returns NULL if the area is poisoned properly.
324///
325/// \param beg Beginning of memory region.
326/// \param mid Middle of memory region.
327/// \param end Old end of memory region.
328///
329/// \returns The bad address or NULL.
330#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
331__attribute__((__internal_linkage__)) inline const void *SANITIZER_CDECL
332__sanitizer_contiguous_container_find_bad_address(const void *beg,
333 const void *mid,
334 const void *end) {
335 return NULL;
336}
337#else
338const void *SANITIZER_CDECL __sanitizer_contiguous_container_find_bad_address(
339 const void *beg, const void *mid, const void *end);
340#endif
341
342/// returns the address of the first improperly poisoned byte.
343///
344/// Returns NULL if the area is poisoned properly.
345///
346/// \param storage_beg Beginning of memory region.
347/// \param container_beg Beginning of used region.
348/// \param container_end End of used region.
349/// \param storage_end End of memory region.
350///
351/// \returns The bad address or NULL.
352#ifdef __SANITIZER_DISABLE_CONTAINER_OVERFLOW__
353__attribute__((__internal_linkage__)) inline const void *SANITIZER_CDECL
354__sanitizer_double_ended_contiguous_container_find_bad_address(
355 const void *storage_beg, const void *container_beg,
356 const void *container_end, const void *storage_end) {
357 return NULL;
358}
359#else
360const void *SANITIZER_CDECL
361__sanitizer_double_ended_contiguous_container_find_bad_address(
362 const void *storage_beg, const void *container_beg,
363 const void *container_end, const void *storage_end);
364#endif
365
366/// Prints the stack trace leading to this call (useful for calling from the
367/// debugger).
368void SANITIZER_CDECL __sanitizer_print_stack_trace(void);
369
370// Symbolizes the supplied 'pc' using the format string 'fmt'.
371// Outputs at most 'out_buf_size' bytes into 'out_buf'.
372// If 'out_buf' is not empty then output is zero or more non empty C strings
373// followed by single empty C string. Multiple strings can be returned if PC
374// corresponds to inlined function. Inlined frames are printed in the order
375// from "most-inlined" to the "least-inlined", so the last frame should be the
376// not inlined function.
377// Inlined frames can be removed with 'symbolize_inline_frames=0'.
378// The format syntax is described in
379// lib/sanitizer_common/sanitizer_stacktrace_printer.h.
380void SANITIZER_CDECL __sanitizer_symbolize_pc(void *pc, const char *fmt,
381 char *out_buf,
382 size_t out_buf_size);
383// Same as __sanitizer_symbolize_pc, but for data section (i.e. globals).
384void SANITIZER_CDECL __sanitizer_symbolize_global(void *data_ptr,
385 const char *fmt,
386 char *out_buf,
387 size_t out_buf_size);
388// Determine the return address.
389#if !defined(_MSC_VER) || defined(__clang__)
390#define __sanitizer_return_address() \
391 __builtin_extract_return_addr(__builtin_return_address(0))
392#else
393void *_ReturnAddress(void);
394#pragma intrinsic(_ReturnAddress)
395#define __sanitizer_return_address() _ReturnAddress()
396#endif
397
398/// Sets the callback to be called immediately before death on error.
399///
400/// Passing 0 will unset the callback.
401///
402/// \param callback User-provided callback.
403void SANITIZER_CDECL __sanitizer_set_death_callback(void (*callback)(void));
404
405// Interceptor hooks.
406// Whenever a libc function interceptor is called, it checks if the
407// corresponding weak hook is defined, and calls it if it is indeed defined.
408// The primary use-case is data-flow-guided fuzzing, where the fuzzer needs
409// to know what is being passed to libc functions (for example memcmp).
410// FIXME: implement more hooks.
411
412/// Interceptor hook for <c>memcmp()</c>.
413///
414/// \param called_pc PC (program counter) address of the original call.
415/// \param s1 Pointer to block of memory.
416/// \param s2 Pointer to block of memory.
417/// \param n Number of bytes to compare.
418/// \param result Value returned by the intercepted function.
419void SANITIZER_CDECL __sanitizer_weak_hook_memcmp(void *called_pc,
420 const void *s1,
421 const void *s2, size_t n,
422 int result);
423
424/// Interceptor hook for <c>strncmp()</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 n Number of bytes to compare.
430/// \param result Value returned by the intercepted function.
431void SANITIZER_CDECL __sanitizer_weak_hook_strncmp(void *called_pc,
432 const char *s1,
433 const char *s2, size_t n,
434 int result);
435
436/// Interceptor hook for <c>strncasecmp()</c>.
437///
438/// \param called_pc PC (program counter) address of the original call.
439/// \param s1 Pointer to block of memory.
440/// \param s2 Pointer to block of memory.
441/// \param n Number of bytes to compare.
442/// \param result Value returned by the intercepted function.
443void SANITIZER_CDECL __sanitizer_weak_hook_strncasecmp(void *called_pc,
444 const char *s1,
445 const char *s2, size_t n,
446 int result);
447
448/// Interceptor hook for <c>strcmp()</c>.
449///
450/// \param called_pc PC (program counter) address of the original call.
451/// \param s1 Pointer to block of memory.
452/// \param s2 Pointer to block of memory.
453/// \param result Value returned by the intercepted function.
454void SANITIZER_CDECL __sanitizer_weak_hook_strcmp(void *called_pc,
455 const char *s1,
456 const char *s2, int result);
457
458/// Interceptor hook for <c>strcasecmp()</c>.
459///
460/// \param called_pc PC (program counter) address of the original call.
461/// \param s1 Pointer to block of memory.
462/// \param s2 Pointer to block of memory.
463/// \param result Value returned by the intercepted function.
464void SANITIZER_CDECL __sanitizer_weak_hook_strcasecmp(void *called_pc,
465 const char *s1,
466 const char *s2,
467 int result);
468
469/// Interceptor hook for <c>strstr()</c>.
470///
471/// \param called_pc PC (program counter) address of the original call.
472/// \param s1 Pointer to block of memory.
473/// \param s2 Pointer to block of memory.
474/// \param result Value returned by the intercepted function.
475void SANITIZER_CDECL __sanitizer_weak_hook_strstr(void *called_pc,
476 const char *s1,
477 const char *s2, char *result);
478
479void SANITIZER_CDECL __sanitizer_weak_hook_strcasestr(void *called_pc,
480 const char *s1,
481 const char *s2,
482 char *result);
483
484void SANITIZER_CDECL __sanitizer_weak_hook_memmem(void *called_pc,
485 const void *s1, size_t len1,
486 const void *s2, size_t len2,
487 void *result);
488
489// Prints stack traces for all live heap allocations ordered by total
490// allocation size until top_percent of total live heap is shown. top_percent
491// should be between 1 and 100. At most max_number_of_contexts contexts
492// (stack traces) are printed.
493// Experimental feature currently available only with ASan on Linux/x86_64.
494void SANITIZER_CDECL __sanitizer_print_memory_profile(
495 size_t top_percent, size_t max_number_of_contexts);
496
497/// Notify ASan that a fiber switch has started (required only if implementing
498/// your own fiber library).
499///
500/// Before switching to a different stack, you must call
501/// <c>__sanitizer_start_switch_fiber()</c> with a pointer to the bottom of the
502/// destination stack and with its size. When code starts running on the new
503/// stack, it must call <c>__sanitizer_finish_switch_fiber()</c> to finalize
504/// the switch. The <c>__sanitizer_start_switch_fiber()</c> function takes a
505/// <c>void**</c> pointer argument to store the current fake stack if there is
506/// one (it is necessary when the runtime option
507/// <c>detect_stack_use_after_return</c> is enabled).
508///
509/// When restoring a stack, this <c>void**</c> pointer must be given to the
510/// <c>__sanitizer_finish_switch_fiber()</c> function. In most cases, this
511/// pointer can be stored on the stack immediately before switching. When
512/// leaving a fiber definitely, NULL must be passed as the first argument to
513/// the <c>__sanitizer_start_switch_fiber()</c> function so that the fake stack
514/// is destroyed. If your program does not need stack use-after-return
515/// detection, you can always pass NULL to these two functions.
516///
517/// \note The fake stack mechanism is disabled during fiber switch, so if a
518/// signal callback runs during the switch, it will not benefit from stack
519/// use-after-return detection.
520///
521/// \param[out] fake_stack_save Fake stack save location.
522/// \param bottom Bottom address of stack.
523/// \param size Size of stack in bytes.
524void SANITIZER_CDECL __sanitizer_start_switch_fiber(void **fake_stack_save,
525 const void *bottom,
526 size_t size);
527
528/// Notify ASan that a fiber switch has completed (required only if
529/// implementing your own fiber library).
530///
531/// When code starts running on the new stack, it must call
532/// <c>__sanitizer_finish_switch_fiber()</c> to finalize
533/// the switch. For usage details, see the description of
534/// <c>__sanitizer_start_switch_fiber()</c>.
535///
536/// \param fake_stack_save Fake stack save location.
537/// \param[out] bottom_old Bottom address of old stack.
538/// \param[out] size_old Size of old stack in bytes.
539void SANITIZER_CDECL __sanitizer_finish_switch_fiber(void *fake_stack_save,
540 const void **bottom_old,
541 size_t *size_old);
542
543// Get full module name and calculate pc offset within it.
544// Returns 1 if pc belongs to some module, 0 if module was not found.
545int SANITIZER_CDECL __sanitizer_get_module_and_offset_for_pc(
546 void *pc, char *module_path, size_t module_path_len, void **pc_offset);
547
548#ifdef __cplusplus
549} // extern "C"
550#endif
551
552#endif // SANITIZER_COMMON_INTERFACE_DEFS_H
553