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 using __sanitizer::u64;
  25 using __sanitizer::u32;
  26
  27 extern "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.
  30   SANITIZER_INTERFACE_ATTRIBUTE void __asan_init();
  31
  32   // This function exists purely to get a linker/loader error when using
  33   // incompatible versions of instrumentation and runtime library. Please note
  34   // that __asan_version_mismatch_check is a macro that is replaced with
  35   // __asan_version_mismatch_check_vXXX at compile-time.
  36   SANITIZER_INTERFACE_ATTRIBUTE void __asan_version_mismatch_check();
  37
  38   // This structure is used to describe the source location of a place where
  39   // global was defined.
  40   struct __asan_global_source_location {
  41     const char *filename;
  42     int line_no;
  43     int column_no;
  44   };
  45
  46   // This structure describes an instrumented global variable.
  47   struct __asan_global {
  48     uptr beg;                // The address of the global.
  49     uptr size;               // The original size of the global.
  50     uptr size_with_redzone;  // The size with the redzone.
  51     const char *name;        // Name as a C string.
  52     const char *module_name; // Module name as a C string. This pointer is a
  53                              // unique identifier of a module.
  54     uptr has_dynamic_init;   // Non-zero if the global has dynamic initializer.
  55     __asan_global_source_location *location;  // Source location of a global,
  56                                               // or NULL if it is unknown.
  57     uptr odr_indicator;      // The address of the ODR indicator symbol.
  58   };
  59
  60   // These functions can be called on some platforms to find globals in the same
  61   // loaded image as `flag' and apply __asan_(un)register_globals to them,
  62   // filtering out redundant calls.
  63   SANITIZER_INTERFACE_ATTRIBUTE
  64   void __asan_register_image_globals(uptr *flag);
  65   SANITIZER_INTERFACE_ATTRIBUTE
  66   void __asan_unregister_image_globals(uptr *flag);
  67
  68   // These two functions should be called by the instrumented code.
  69   // 'globals' is an array of structures describing 'n' globals.
  70   SANITIZER_INTERFACE_ATTRIBUTE
  71   void __asan_register_globals(__asan_global *globals, uptr n);
  72   SANITIZER_INTERFACE_ATTRIBUTE
  73   void __asan_unregister_globals(__asan_global *globals, uptr n);
  74
  75   // These two functions should be called before and after dynamic initializers
  76   // of a single module run, respectively.
  77   SANITIZER_INTERFACE_ATTRIBUTE
  78   void __asan_before_dynamic_init(const char *module_name);
  79   SANITIZER_INTERFACE_ATTRIBUTE
  80   void __asan_after_dynamic_init();
  81
  82   // Sets bytes of the given range of the shadow memory into specific value.
  83   SANITIZER_INTERFACE_ATTRIBUTE
  84   void __asan_set_shadow_00(uptr addr, uptr size);
  85   SANITIZER_INTERFACE_ATTRIBUTE
  86   void __asan_set_shadow_f1(uptr addr, uptr size);
  87   SANITIZER_INTERFACE_ATTRIBUTE
  88   void __asan_set_shadow_f2(uptr addr, uptr size);
  89   SANITIZER_INTERFACE_ATTRIBUTE
  90   void __asan_set_shadow_f3(uptr addr, uptr size);
  91   SANITIZER_INTERFACE_ATTRIBUTE
  92   void __asan_set_shadow_f5(uptr addr, uptr size);
  93   SANITIZER_INTERFACE_ATTRIBUTE
  94   void __asan_set_shadow_f8(uptr addr, uptr size);
  95
  96   // These two functions are used by instrumented code in the
  97   // use-after-scope mode. They mark memory for local variables as
  98   // unaddressable when they leave scope and addressable before the
  99   // function exits.
 100   SANITIZER_INTERFACE_ATTRIBUTE
 101   void __asan_poison_stack_memory(uptr addr, uptr size);
 102   SANITIZER_INTERFACE_ATTRIBUTE
 103   void __asan_unpoison_stack_memory(uptr addr, uptr size);
 104
 105   // Performs cleanup before a NoReturn function. Must be called before things
 106   // like _exit and execl to avoid false positives on stack.
 107   SANITIZER_INTERFACE_ATTRIBUTE void __asan_handle_no_return();
 108
 109   SANITIZER_INTERFACE_ATTRIBUTE
 110   void __asan_poison_memory_region(void const volatile *addr, uptr size);
 111   SANITIZER_INTERFACE_ATTRIBUTE
 112   void __asan_unpoison_memory_region(void const volatile *addr, uptr size);
 113
 114   SANITIZER_INTERFACE_ATTRIBUTE
 115   int __asan_address_is_poisoned(void const volatile *addr);
 116
 117   SANITIZER_INTERFACE_ATTRIBUTE
 118   uptr __asan_region_is_poisoned(uptr beg, uptr size);
 119
 120   SANITIZER_INTERFACE_ATTRIBUTE
 121   void __asan_describe_address(uptr addr);
 122
 123   SANITIZER_INTERFACE_ATTRIBUTE
 124   int __asan_report_present();
 125
 126   SANITIZER_INTERFACE_ATTRIBUTE
 127   uptr __asan_get_report_pc();
 128   SANITIZER_INTERFACE_ATTRIBUTE
 129   uptr __asan_get_report_bp();
 130   SANITIZER_INTERFACE_ATTRIBUTE
 131   uptr __asan_get_report_sp();
 132   SANITIZER_INTERFACE_ATTRIBUTE
 133   uptr __asan_get_report_address();
 134   SANITIZER_INTERFACE_ATTRIBUTE
 135   int __asan_get_report_access_type();
 136   SANITIZER_INTERFACE_ATTRIBUTE
 137   uptr __asan_get_report_access_size();
 138   SANITIZER_INTERFACE_ATTRIBUTE
 139   const char * __asan_get_report_description();
 140
 141   SANITIZER_INTERFACE_ATTRIBUTE
 142   const char * __asan_locate_address(uptr addr, char *name, uptr name_size,
 143                                      uptr *region_address, uptr *region_size);
 144
 145   SANITIZER_INTERFACE_ATTRIBUTE
 146   uptr __asan_get_alloc_stack(uptr addr, uptr *trace, uptr size,
 147                               u32 *thread_id);
 148
 149   SANITIZER_INTERFACE_ATTRIBUTE
 150   uptr __asan_get_free_stack(uptr addr, uptr *trace, uptr size,
 151                              u32 *thread_id);
 152
 153   SANITIZER_INTERFACE_ATTRIBUTE
 154   void __asan_get_shadow_mapping(uptr *shadow_scale, uptr *shadow_offset);
 155
 156   SANITIZER_INTERFACE_ATTRIBUTE
 157   void __asan_report_error(uptr pc, uptr bp, uptr sp,
 158                            uptr addr, int is_write, uptr access_size, u32 exp);
 159
 160   SANITIZER_INTERFACE_ATTRIBUTE
 161   void __asan_set_death_callback(void (*callback)(void));
 162   SANITIZER_INTERFACE_ATTRIBUTE
 163   void __asan_set_error_report_callback(void (*callback)(const char*));
 164
 165   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 166   /* OPTIONAL */ void __asan_on_error();
 167
 168   SANITIZER_INTERFACE_ATTRIBUTE void __asan_print_accumulated_stats();
 169
 170   SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
 171   /* OPTIONAL */ const char* __asan_default_options();
 172
 173   SANITIZER_INTERFACE_ATTRIBUTE
 174   extern uptr __asan_shadow_memory_dynamic_address;
 175
 176   // Global flag, copy of ASAN_OPTIONS=detect_stack_use_after_return
 177   SANITIZER_INTERFACE_ATTRIBUTE
 178   extern int __asan_option_detect_stack_use_after_return;
 179
 180   SANITIZER_INTERFACE_ATTRIBUTE
 181   extern uptr *__asan_test_only_reported_buggy_pointer;
 182
 183   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1(uptr p);
 184   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2(uptr p);
 185   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4(uptr p);
 186   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8(uptr p);
 187   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16(uptr p);
 188   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1(uptr p);
 189   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2(uptr p);
 190   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4(uptr p);
 191   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8(uptr p);
 192   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16(uptr p);
 193   SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN(uptr p, uptr size);
 194   SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN(uptr p, uptr size);
 195
 196   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load1_noabort(uptr p);
 197   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load2_noabort(uptr p);
 198   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load4_noabort(uptr p);
 199   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load8_noabort(uptr p);
 200   SANITIZER_INTERFACE_ATTRIBUTE void __asan_load16_noabort(uptr p);
 201   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store1_noabort(uptr p);
 202   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store2_noabort(uptr p);
 203   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store4_noabort(uptr p);
 204   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store8_noabort(uptr p);
 205   SANITIZER_INTERFACE_ATTRIBUTE void __asan_store16_noabort(uptr p);
 206   SANITIZER_INTERFACE_ATTRIBUTE void __asan_loadN_noabort(uptr p, uptr size);
 207   SANITIZER_INTERFACE_ATTRIBUTE void __asan_storeN_noabort(uptr p, uptr size);
 208
 209   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load1(uptr p, u32 exp);
 210   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load2(uptr p, u32 exp);
 211   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load4(uptr p, u32 exp);
 212   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load8(uptr p, u32 exp);
 213   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_load16(uptr p, u32 exp);
 214   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store1(uptr p, u32 exp);
 215   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store2(uptr p, u32 exp);
 216   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store4(uptr p, u32 exp);
 217   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store8(uptr p, u32 exp);
 218   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_store16(uptr p, u32 exp);
 219   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_loadN(uptr p, uptr size,
 220                                                       u32 exp);
 221   SANITIZER_INTERFACE_ATTRIBUTE void __asan_exp_storeN(uptr p, uptr size,
 222                                                        u32 exp);
 223
 224   SANITIZER_INTERFACE_ATTRIBUTE
 225       void* __asan_memcpy(void *dst, const void *src, uptr size);
 226   SANITIZER_INTERFACE_ATTRIBUTE
 227       void* __asan_memset(void *s, int c, uptr n);
 228   SANITIZER_INTERFACE_ATTRIBUTE
 229       void* __asan_memmove(void* dest, const void* src, uptr n);
 230
 231   SANITIZER_INTERFACE_ATTRIBUTE
 232   void __asan_poison_cxx_array_cookie(uptr p);
 233   SANITIZER_INTERFACE_ATTRIBUTE
 234   uptr __asan_load_cxx_array_cookie(uptr *p);
 235   SANITIZER_INTERFACE_ATTRIBUTE
 236   void __asan_poison_intra_object_redzone(uptr p, uptr size);
 237   SANITIZER_INTERFACE_ATTRIBUTE
 238   void __asan_unpoison_intra_object_redzone(uptr p, uptr size);
 239   SANITIZER_INTERFACE_ATTRIBUTE
 240   void __asan_alloca_poison(uptr addr, uptr size);
 241   SANITIZER_INTERFACE_ATTRIBUTE
 242   void __asan_allocas_unpoison(uptr top, uptr bottom);
 243 }  // extern "C"
 244
 245 #endif  // ASAN_INTERFACE_INTERNAL_H