libsanitizer/asan/asan_interface_internal.h

   1 //===-- asan_interface_internal.h -------------------------------*- C++ -*-===//
   2 //
   3 // This file is distributed under the University of Illinois Open Source
   4 // License. See LICENSE.TXT for details.
   5 //
   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 program
  12 // could call them.
  13 //
  14 // See also include/sanitizer/asan_interface.h
  15 //===----------------------------------------------------------------------===//
  16 #ifndef ASAN_INTERFACE_INTERNAL_H
  17 #define ASAN_INTERFACE_INTERNAL_H
  18
  19 #include "sanitizer_common/sanitizer_internal_defs.h"
  20
  21 #include "asan_init_version.h"
  22
  23 using __sanitizer::uptr;
  24
  25 extern "C" {
  26   // This function should be called at the very beginning of the process,
  27   // before any instrumented code is executed and before any call to malloc.
  28   SANITIZER_INTERFACE_ATTRIBUTE void __asan_init();
  29
  30   // This function exists purely to get a linker/loader error when using
  31   // incompatible versions of instrumentation and runtime library. Please note
  32   // that __asan_version_mismatch_check is a macro that is replaced with
  33   // __asan_version_mismatch_check_vXXX at compile-time.
  34   SANITIZER_INTERFACE_ATTRIBUTE void __asan_version_mismatch_check();
  35
  36   // This structure is used to describe the source location of a place where
  37   // global was defined.
  38   struct __asan_global_source_location {
  39     const char *filename;
  40     int line_no;
  41     int column_no;
  42   };
  43
  44   // This structure describes an instrumented global variable.
  45   struct __asan_global {
  46     uptr beg;                // The address of the global.
  47     uptr size;               // The original size of the global.
  48     uptr size_with_redzone;  // The size with the redzone.
  49     const char *name;        // Name as a C string.
  50     const char *module_name; // Module name as a C string. This pointer is a
  51                              // unique identifier of a module.
  52     uptr has_dynamic_init;   // Non-zero if the global has dynamic initializer.
  53     __asan_global_source_location *location;  // Source location of a global,
  54                                               // or NULL if it is unknown.
  55   };
  56
  57   // These two functions should be called by the instrumented code.
  58   // 'globals' is an array of structures describing 'n' globals.
  59   SANITIZER_INTERFACE_ATTRIBUTE
  60   void __asan_register_globals(__asan_global *globals, uptr n);
  61   SANITIZER_INTERFACE_ATTRIBUTE
  62   void __asan_unregister_globals(__asan_global *globals, uptr n);
  63
  64   // These two functions should be called before and after dynamic initializers
  65   // of a single module run, respectively.
  66   SANITIZER_INTERFACE_ATTRIBUTE
  67   void __asan_before_dynamic_init(const char *module_name);
  68   SANITIZER_INTERFACE_ATTRIBUTE
  69   void __asan_after_dynamic_init();
  70
  71   // These two functions are used by instrumented code in the
  72   // use-after-scope mode. They mark memory for local variables as
  73   // unaddressable when they leave scope and addressable before the
  74   // function exits.
  75   SANITIZER_INTERFACE_ATTRIBUTE
  76   void __asan_poison_stack_memory(uptr addr, uptr size);
  77   SANITIZER_INTERFACE_ATTRIBUTE
  78   void __asan_unpoison_stack_memory(uptr addr, uptr size);
  79
  80   // Performs cleanup before a NoReturn function. Must be called before things
  81   // like _exit and execl to avoid false positives on stack.
  82   SANITIZER_INTERFACE_ATTRIBUTE void __asan_handle_no_return();
  83
  84   SANITIZER_INTERFACE_ATTRIBUTE
  85   void __asan_poison_memory_region(void const volatile *addr, uptr size);
  86   SANITIZER_INTERFACE_ATTRIBUTE
  87   void __asan_unpoison_memory_region(void const volatile *addr, uptr size);
  88
  89   SANITIZER_INTERFACE_ATTRIBUTE
  90   int __asan_address_is_poisoned(void const volatile *addr);
  91
  92   SANITIZER_INTERFACE_ATTRIBUTE
  93   uptr __asan_region_is_poisoned(uptr beg, uptr size);
  94
  95   SANITIZER_INTERFACE_ATTRIBUTE
  96   void __asan_describe_address(uptr addr);
  97
  98   SANITIZER_INTERFACE_ATTRIBUTE
  99   int __asan_report_present();
 100
 101   SANITIZER_INTERFACE_ATTRIBUTE
 102   uptr __asan_get_report_pc();
 103   SANITIZER_INTERFACE_ATTRIBUTE
 104   uptr __asan_get_report_bp();
 105   SANITIZER_INTERFACE_ATTRIBUTE
 106   uptr __asan_get_report_sp();
 107   SANITIZER_INTERFACE_ATTRIBUTE
 108   uptr __asan_get_report_address();
 109   SANITIZER_INTERFACE_ATTRIBUTE
 110   int __asan_get_report_access_type();
 111   SANITIZER_INTERFACE_ATTRIBUTE
 112   uptr __asan_get_report_access_size();
 113   SANITIZER_INTERFACE_ATTRIBUTE
 114   const char * __asan_get_report_description();
 115
 116   SANITIZER_INTERFACE_ATTRIBUTE
 117   const char * __asan_locate_address(uptr addr, char *name, uptr name_size,
 118                                      uptr *region_address, uptr *region_size);
 119
 120   SANITIZER_INTERFACE_ATTRIBUTE
 121   uptr __asan_get_alloc_stack(uptr addr, uptr *trace, uptr size,
 122                               u32 *thread_id);
 123
 124   SANITIZER_INTERFACE_ATTRIBUTE
 125   uptr __asan_get_free_stack(uptr addr, uptr *trace, uptr size,
 126                              u32 *thread_id);
 127
 128   SANITIZER_INTERFACE_ATTRIBUTE
 129   void __asan_get_shadow_mapping(uptr *shadow_scale, uptr *shadow_offset);
 130
 131   SANITIZER_INTERFACE_ATTRIBUTE
 132   void __asan_report_error(uptr pc, uptr bp, uptr sp,
 133                            uptr addr, int is_write, uptr access_size, u32 exp);
 134
 135   SANITIZER_INTERFACE_ATTRIBUTE
 136   void __asan_set_death_callback(void (*callback)(void));
 137   SANITIZER_INTERFACE_ATTRIBUTE
 138   void __asan_set_error_report_callback(void (*callback)(const char*));
 139
 140   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 141   /* OPTIONAL */ void __asan_on_error();
 142
 143   SANITIZER_INTERFACE_ATTRIBUTE void __asan_print_accumulated_stats();
 144
 145   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 146   /* OPTIONAL */ const char* __asan_default_options();
 147
 148   // Global flag, copy of ASAN_OPTIONS=detect_stack_use_after_return
 149   SANITIZER_INTERFACE_ATTRIBUTE
 150   extern int __asan_option_detect_stack_use_after_return;
 151
 152   SANITIZER_INTERFACE_ATTRIBUTE
 153   extern uptr *__asan_test_only_reported_buggy_pointer;
 154
 155   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1(uptr p);
 156   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2(uptr p);
 157   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4(uptr p);
 158   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8(uptr p);
 159   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16(uptr p);
 160   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1(uptr p);
 161   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2(uptr p);
 162   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4(uptr p);
 163   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8(uptr p);
 164   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16(uptr p);
 165   SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN(uptr p, uptr size);
 166   SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN(uptr p, uptr size);
 167
 168   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1_noabort(uptr p);
 169   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2_noabort(uptr p);
 170   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4_noabort(uptr p);
 171   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8_noabort(uptr p);
 172   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16_noabort(uptr p);
 173   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1_noabort(uptr p);
 174   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2_noabort(uptr p);
 175   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4_noabort(uptr p);
 176   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8_noabort(uptr p);
 177   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16_noabort(uptr p);
 178   SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN_noabort(uptr p, uptr size);
 179   SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN_noabort(uptr p, uptr size);
 180
 181   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load1(uptr p, u32 exp);
 182   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load2(uptr p, u32 exp);
 183   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load4(uptr p, u32 exp);
 184   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load8(uptr p, u32 exp);
 185   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load16(uptr p, u32 exp);
 186   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store1(uptr p, u32 exp);
 187   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store2(uptr p, u32 exp);
 188   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store4(uptr p, u32 exp);
 189   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store8(uptr p, u32 exp);
 190   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store16(uptr p, u32 exp);
 191   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_loadN(uptr p, uptr size,
 192                                                       u32 exp);
 193   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_storeN(uptr p, uptr size,
 194                                                        u32 exp);
 195
 196   SANITIZER_INTERFACE_ATTRIBUTE
 197       void* __asan_memcpy(void *dst, const void *src, uptr size);
 198   SANITIZER_INTERFACE_ATTRIBUTE
 199       void* __asan_memset(void *s, int c, uptr n);
 200   SANITIZER_INTERFACE_ATTRIBUTE
 201       void* __asan_memmove(void* dest, const void* src, uptr n);
 202
 203   SANITIZER_INTERFACE_ATTRIBUTE
 204   void __asan_poison_cxx_array_cookie(uptr p);
 205   SANITIZER_INTERFACE_ATTRIBUTE
 206   uptr __asan_load_cxx_array_cookie(uptr *p);
 207   SANITIZER_INTERFACE_ATTRIBUTE
 208   void __asan_poison_intra_object_redzone(uptr p, uptr size);
 209   SANITIZER_INTERFACE_ATTRIBUTE
 210   void __asan_unpoison_intra_object_redzone(uptr p, uptr size);
 211   SANITIZER_INTERFACE_ATTRIBUTE
 212   void __asan_alloca_poison(uptr addr, uptr size);
 213   SANITIZER_INTERFACE_ATTRIBUTE
 214   void __asan_allocas_unpoison(uptr top, uptr bottom);
 215 }  // extern "C"
 216
 217 #endif  // ASAN_INTERFACE_INTERNAL_H