Path: blob/main/contrib/llvm-project/compiler-rt/lib/asan/asan_interface_internal.h
35233 views
//===-- asan_interface_internal.h -------------------------------*- C++ -*-===//1//2// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.3// See https://llvm.org/LICENSE.txt for license information.4// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception5//6//===----------------------------------------------------------------------===//7//8// This file is a part of AddressSanitizer, an address sanity checker.9//10// This header declares the AddressSanitizer runtime interface functions.11// The runtime library has to define these functions so the instrumented program12// could call them.13//14// See also include/sanitizer/asan_interface.h15//===----------------------------------------------------------------------===//16#ifndef ASAN_INTERFACE_INTERNAL_H17#define ASAN_INTERFACE_INTERNAL_H1819#include "sanitizer_common/sanitizer_internal_defs.h"2021#include "asan_init_version.h"2223using __sanitizer::uptr;24using __sanitizer::u64;25using __sanitizer::u32;2627extern "C" {28// This function should be called at the very beginning of the process,29// before any instrumented code is executed and before any call to malloc.30SANITIZER_INTERFACE_ATTRIBUTE void __asan_init();3132// This function exists purely to get a linker/loader error when using33// incompatible versions of instrumentation and runtime library. Please note34// that __asan_version_mismatch_check is a macro that is replaced with35// __asan_version_mismatch_check_vXXX at compile-time.36SANITIZER_INTERFACE_ATTRIBUTE void __asan_version_mismatch_check();3738// This structure is used to describe the source location of a place where39// global was defined.40struct __asan_global_source_location {41const char *filename;42int line_no;43int column_no;44};4546// This structure describes an instrumented global variable.47struct __asan_global {48uptr beg; // The address of the global.49uptr size; // The original size of the global.50uptr size_with_redzone; // The size with the redzone.51const char *name; // Name as a C string.52const char *module_name; // Module name as a C string. This pointer is a53// unique identifier of a module.54uptr has_dynamic_init; // Non-zero if the global has dynamic initializer.55__asan_global_source_location *gcc_location; // Source location of a global,56// used by GCC compiler. LLVM uses57// llvm-symbolizer that relies58// on DWARF debugging info.59uptr odr_indicator; // The address of the ODR indicator symbol.60};6162// These functions can be called on some platforms to find globals in the same63// loaded image as `flag' and apply __asan_(un)register_globals to them,64// filtering out redundant calls.65SANITIZER_INTERFACE_ATTRIBUTE66void __asan_register_image_globals(uptr *flag);67SANITIZER_INTERFACE_ATTRIBUTE68void __asan_unregister_image_globals(uptr *flag);6970SANITIZER_INTERFACE_ATTRIBUTE71void __asan_register_elf_globals(uptr *flag, void *start, void *stop);72SANITIZER_INTERFACE_ATTRIBUTE73void __asan_unregister_elf_globals(uptr *flag, void *start, void *stop);7475// These two functions should be called by the instrumented code.76// 'globals' is an array of structures describing 'n' globals.77SANITIZER_INTERFACE_ATTRIBUTE78void __asan_register_globals(__asan_global *globals, uptr n);79SANITIZER_INTERFACE_ATTRIBUTE80void __asan_unregister_globals(__asan_global *globals, uptr n);8182// These two functions should be called before and after dynamic initializers83// of a single module run, respectively.84SANITIZER_INTERFACE_ATTRIBUTE85void __asan_before_dynamic_init(const char *module_name);86SANITIZER_INTERFACE_ATTRIBUTE87void __asan_after_dynamic_init();8889// Sets bytes of the given range of the shadow memory into specific value.90SANITIZER_INTERFACE_ATTRIBUTE91void __asan_set_shadow_00(uptr addr, uptr size);92SANITIZER_INTERFACE_ATTRIBUTE93void __asan_set_shadow_01(uptr addr, uptr size);94SANITIZER_INTERFACE_ATTRIBUTE95void __asan_set_shadow_02(uptr addr, uptr size);96SANITIZER_INTERFACE_ATTRIBUTE97void __asan_set_shadow_03(uptr addr, uptr size);98SANITIZER_INTERFACE_ATTRIBUTE99void __asan_set_shadow_04(uptr addr, uptr size);100SANITIZER_INTERFACE_ATTRIBUTE101void __asan_set_shadow_05(uptr addr, uptr size);102SANITIZER_INTERFACE_ATTRIBUTE103void __asan_set_shadow_06(uptr addr, uptr size);104SANITIZER_INTERFACE_ATTRIBUTE105void __asan_set_shadow_07(uptr addr, uptr size);106SANITIZER_INTERFACE_ATTRIBUTE107void __asan_set_shadow_f1(uptr addr, uptr size);108SANITIZER_INTERFACE_ATTRIBUTE109void __asan_set_shadow_f2(uptr addr, uptr size);110SANITIZER_INTERFACE_ATTRIBUTE111void __asan_set_shadow_f3(uptr addr, uptr size);112SANITIZER_INTERFACE_ATTRIBUTE113void __asan_set_shadow_f5(uptr addr, uptr size);114SANITIZER_INTERFACE_ATTRIBUTE115void __asan_set_shadow_f8(uptr addr, uptr size);116117// These two functions are used by instrumented code in the118// use-after-scope mode. They mark memory for local variables as119// unaddressable when they leave scope and addressable before the120// function exits.121SANITIZER_INTERFACE_ATTRIBUTE122void __asan_poison_stack_memory(uptr addr, uptr size);123SANITIZER_INTERFACE_ATTRIBUTE124void __asan_unpoison_stack_memory(uptr addr, uptr size);125126// Performs cleanup before a NoReturn function. Must be called before things127// like _exit and execl to avoid false positives on stack.128SANITIZER_INTERFACE_ATTRIBUTE void __asan_handle_no_return();129130SANITIZER_INTERFACE_ATTRIBUTE131void __asan_poison_memory_region(void const volatile *addr, uptr size);132SANITIZER_INTERFACE_ATTRIBUTE133void __asan_unpoison_memory_region(void const volatile *addr, uptr size);134135SANITIZER_INTERFACE_ATTRIBUTE136int __asan_address_is_poisoned(void const volatile *addr);137138SANITIZER_INTERFACE_ATTRIBUTE139uptr __asan_region_is_poisoned(uptr beg, uptr size);140141SANITIZER_INTERFACE_ATTRIBUTE142void __asan_describe_address(uptr addr);143144SANITIZER_INTERFACE_ATTRIBUTE145int __asan_report_present();146147SANITIZER_INTERFACE_ATTRIBUTE148uptr __asan_get_report_pc();149SANITIZER_INTERFACE_ATTRIBUTE150uptr __asan_get_report_bp();151SANITIZER_INTERFACE_ATTRIBUTE152uptr __asan_get_report_sp();153SANITIZER_INTERFACE_ATTRIBUTE154uptr __asan_get_report_address();155SANITIZER_INTERFACE_ATTRIBUTE156int __asan_get_report_access_type();157SANITIZER_INTERFACE_ATTRIBUTE158uptr __asan_get_report_access_size();159SANITIZER_INTERFACE_ATTRIBUTE160const char * __asan_get_report_description();161162SANITIZER_INTERFACE_ATTRIBUTE163const char * __asan_locate_address(uptr addr, char *name, uptr name_size,164uptr *region_address, uptr *region_size);165166SANITIZER_INTERFACE_ATTRIBUTE167uptr __asan_get_alloc_stack(uptr addr, uptr *trace, uptr size,168u32 *thread_id);169170SANITIZER_INTERFACE_ATTRIBUTE171uptr __asan_get_free_stack(uptr addr, uptr *trace, uptr size,172u32 *thread_id);173174SANITIZER_INTERFACE_ATTRIBUTE175void __asan_get_shadow_mapping(uptr *shadow_scale, uptr *shadow_offset);176177SANITIZER_INTERFACE_ATTRIBUTE178void __asan_report_error(uptr pc, uptr bp, uptr sp,179uptr addr, int is_write, uptr access_size, u32 exp);180181SANITIZER_INTERFACE_ATTRIBUTE182void __asan_set_death_callback(void (*callback)(void));183SANITIZER_INTERFACE_ATTRIBUTE184void __asan_set_error_report_callback(void (*callback)(const char*));185186SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE187void __asan_on_error();188189SANITIZER_INTERFACE_ATTRIBUTE void __asan_print_accumulated_stats();190191SANITIZER_INTERFACE_ATTRIBUTE192const char *__asan_default_options();193194SANITIZER_INTERFACE_ATTRIBUTE195extern uptr __asan_shadow_memory_dynamic_address;196197// Global flag, copy of ASAN_OPTIONS=detect_stack_use_after_return198SANITIZER_INTERFACE_ATTRIBUTE199extern int __asan_option_detect_stack_use_after_return;200201SANITIZER_INTERFACE_ATTRIBUTE202extern uptr *__asan_test_only_reported_buggy_pointer;203204SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1(uptr p);205SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2(uptr p);206SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4(uptr p);207SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8(uptr p);208SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16(uptr p);209SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1(uptr p);210SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2(uptr p);211SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4(uptr p);212SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8(uptr p);213SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16(uptr p);214SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN(uptr p, uptr size);215SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN(uptr p, uptr size);216217SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1_noabort(uptr p);218SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2_noabort(uptr p);219SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4_noabort(uptr p);220SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8_noabort(uptr p);221SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16_noabort(uptr p);222SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1_noabort(uptr p);223SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2_noabort(uptr p);224SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4_noabort(uptr p);225SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8_noabort(uptr p);226SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16_noabort(uptr p);227SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN_noabort(uptr p, uptr size);228SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN_noabort(uptr p, uptr size);229230SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load1(uptr p, u32 exp);231SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load2(uptr p, u32 exp);232SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load4(uptr p, u32 exp);233SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load8(uptr p, u32 exp);234SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load16(uptr p, u32 exp);235SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store1(uptr p, u32 exp);236SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store2(uptr p, u32 exp);237SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store4(uptr p, u32 exp);238SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store8(uptr p, u32 exp);239SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store16(uptr p, u32 exp);240SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_loadN(uptr p, uptr size,241u32 exp);242SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_storeN(uptr p, uptr size,243u32 exp);244245SANITIZER_INTERFACE_ATTRIBUTE246void* __asan_memcpy(void *dst, const void *src, uptr size);247SANITIZER_INTERFACE_ATTRIBUTE248void* __asan_memset(void *s, int c, uptr n);249SANITIZER_INTERFACE_ATTRIBUTE250void* __asan_memmove(void* dest, const void* src, uptr n);251252SANITIZER_INTERFACE_ATTRIBUTE253void __asan_poison_cxx_array_cookie(uptr p);254SANITIZER_INTERFACE_ATTRIBUTE255uptr __asan_load_cxx_array_cookie(uptr *p);256SANITIZER_INTERFACE_ATTRIBUTE257void __asan_poison_intra_object_redzone(uptr p, uptr size);258SANITIZER_INTERFACE_ATTRIBUTE259void __asan_unpoison_intra_object_redzone(uptr p, uptr size);260SANITIZER_INTERFACE_ATTRIBUTE261void __asan_alloca_poison(uptr addr, uptr size);262SANITIZER_INTERFACE_ATTRIBUTE263void __asan_allocas_unpoison(uptr top, uptr bottom);264265SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE266const char* __asan_default_suppressions();267268SANITIZER_INTERFACE_ATTRIBUTE void __asan_handle_vfork(void *sp);269270SANITIZER_INTERFACE_ATTRIBUTE int __asan_update_allocation_context(271void *addr);272} // extern "C"273274#endif // ASAN_INTERFACE_INTERNAL_H275276277