1 //===-- sanitizer/asan_interface.h ------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 // 10 // This file is a part of AddressSanitizer. 11 // 12 // Public interface header. 13 //===----------------------------------------------------------------------===// 14 #ifndef SANITIZER_ASAN_INTERFACE_H 15 #define SANITIZER_ASAN_INTERFACE_H 16 17 #include <sanitizer/common_interface_defs.h> 18 19 #ifdef __cplusplus 20 extern "C" { 21 #endif 22 // Marks memory region [addr, addr+size) as unaddressable. 23 // This memory must be previously allocated by the user program. Accessing 24 // addresses in this region from instrumented code is forbidden until 25 // this region is unpoisoned. This function is not guaranteed to poison 26 // the whole region - it may poison only subregion of [addr, addr+size) due 27 // to ASan alignment restrictions. 28 // Method is NOT thread-safe in the sense that no two threads can 29 // (un)poison memory in the same memory region simultaneously. 30 void __asan_poison_memory_region(void const volatile *addr, size_t size); 31 // Marks memory region [addr, addr+size) as addressable. 32 // This memory must be previously allocated by the user program. Accessing 33 // addresses in this region is allowed until this region is poisoned again. 34 // This function may unpoison a superregion of [addr, addr+size) due to 35 // ASan alignment restrictions. 36 // Method is NOT thread-safe in the sense that no two threads can 37 // (un)poison memory in the same memory region simultaneously. 38 void __asan_unpoison_memory_region(void const volatile *addr, size_t size); 39 40 // User code should use macros instead of functions. 41 #if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__) 42 #define ASAN_POISON_MEMORY_REGION(addr, size) \ 43 __asan_poison_memory_region((addr), (size)) 44 #define ASAN_UNPOISON_MEMORY_REGION(addr, size) \ 45 __asan_unpoison_memory_region((addr), (size)) 46 #else 47 #define ASAN_POISON_MEMORY_REGION(addr, size) \ 48 ((void)(addr), (void)(size)) 49 #define ASAN_UNPOISON_MEMORY_REGION(addr, size) \ 50 ((void)(addr), (void)(size)) 51 #endif 52 53 // Returns 1 if addr is poisoned (i.e. 1-byte read/write access to this 54 // address will result in error report from AddressSanitizer). 55 // Otherwise returns 0. 56 int __asan_address_is_poisoned(void const volatile *addr); 57 58 // If at least one byte in [beg, beg+size) is poisoned, return the address 59 // of the first such byte. Otherwise return 0. 60 void *__asan_region_is_poisoned(void *beg, size_t size); 61 62 // Print the description of addr (useful when debugging in gdb). 63 void __asan_describe_address(void *addr); 64 65 // Useful for calling from a debugger to get information about an ASan error. 66 // Returns 1 if an error has been (or is being) reported, otherwise returns 0. 67 int __asan_report_present(); 68 69 // Useful for calling from a debugger to get information about an ASan error. 70 // If an error has been (or is being) reported, the following functions return 71 // the pc, bp, sp, address, access type (0 = read, 1 = write), access size and 72 // bug description (e.g. "heap-use-after-free"). Otherwise they return 0. 73 void *__asan_get_report_pc(); 74 void *__asan_get_report_bp(); 75 void *__asan_get_report_sp(); 76 void *__asan_get_report_address(); 77 int __asan_get_report_access_type(); 78 size_t __asan_get_report_access_size(); 79 const char *__asan_get_report_description(); 80 81 // Useful for calling from the debugger to get information about a pointer. 82 // Returns the category of the given pointer as a constant string. 83 // Possible return values are "global", "stack", "stack-fake", "heap", 84 // "heap-invalid", "shadow-low", "shadow-gap", "shadow-high", "unknown". 85 // If global or stack, tries to also return the variable name, address and 86 // size. If heap, tries to return the chunk address and size. 'name' should 87 // point to an allocated buffer of size 'name_size'. 88 const char *__asan_locate_address(void *addr, char *name, size_t name_size, 89 void **region_address, size_t *region_size); 90 91 // Useful for calling from the debugger to get the allocation stack trace 92 // and thread ID for a heap address. Stores up to 'size' frames into 'trace', 93 // returns the number of stored frames or 0 on error. 94 size_t __asan_get_alloc_stack(void *addr, void **trace, size_t size, 95 int *thread_id); 96 97 // Useful for calling from the debugger to get the free stack trace 98 // and thread ID for a heap address. Stores up to 'size' frames into 'trace', 99 // returns the number of stored frames or 0 on error. 100 size_t __asan_get_free_stack(void *addr, void **trace, size_t size, 101 int *thread_id); 102 103 // Useful for calling from the debugger to get the current shadow memory 104 // mapping. 105 void __asan_get_shadow_mapping(size_t *shadow_scale, size_t *shadow_offset); 106 107 // This is an internal function that is called to report an error. 108 // However it is still a part of the interface because users may want to 109 // set a breakpoint on this function in a debugger. 110 void __asan_report_error(void *pc, void *bp, void *sp, 111 void *addr, int is_write, size_t access_size); 112 113 // Deprecated. Call __sanitizer_set_death_callback instead. 114 void __asan_set_death_callback(void (*callback)(void)); 115 116 void __asan_set_error_report_callback(void (*callback)(const char*)); 117 118 // User may provide function that would be called right when ASan detects 119 // an error. This can be used to notice cases when ASan detects an error, but 120 // the program crashes before ASan report is printed. 121 void __asan_on_error(); 122 123 // Prints accumulated stats to stderr. Used for debugging. 124 void __asan_print_accumulated_stats(); 125 126 // This function may be optionally provided by user and should return 127 // a string containing ASan runtime options. See asan_flags.h for details. 128 const char* __asan_default_options(); 129 130 // The following 2 functions facilitate garbage collection in presence of 131 // asan's fake stack. 132 133 // Returns an opaque handler to be used later in __asan_addr_is_in_fake_stack. 134 // Returns NULL if the current thread does not have a fake stack. 135 void *__asan_get_current_fake_stack(); 136 137 // If fake_stack is non-NULL and addr belongs to a fake frame in 138 // fake_stack, returns the address on real stack that corresponds to 139 // the fake frame and sets beg/end to the boundaries of this fake frame. 140 // Otherwise returns NULL and does not touch beg/end. 141 // If beg/end are NULL, they are not touched. 142 // This function may be called from a thread other than the owner of 143 // fake_stack, but the owner thread need to be alive. 144 void *__asan_addr_is_in_fake_stack(void *fake_stack, void *addr, void **beg, 145 void **end); 146 147 // Performs cleanup before a [[noreturn]] function. Must be called 148 // before things like _exit and execl to avoid false positives on stack. 149 void __asan_handle_no_return(void); 150 151 #ifdef __cplusplus 152 } // extern "C" 153 #endif 154 155 #endif // SANITIZER_ASAN_INTERFACE_H 156
