text: //===-- asan_internal.h -----------------------------------------*- C++ -*-===//
  //
  //                     The LLVM Compiler Infrastructure
  //
  // This file is distributed under the University of Illinois Open Source
  // License. See LICENSE.TXT for details.
  //
  //===----------------------------------------------------------------------===//
  //
  // This file is a part of AddressSanitizer, an address sanity checker.
  //
  // ASan-private header which defines various general utilities.
  //===----------------------------------------------------------------------===//
  #ifndef ASAN_INTERNAL_H
  #define ASAN_INTERNAL_H
  
  #include "asan_flags.h"
  #include "asan_interface_internal.h"
  #include "sanitizer_common/sanitizer_common.h"
  #include "sanitizer_common/sanitizer_internal_defs.h"
  #include "sanitizer_common/sanitizer_stacktrace.h"
  #include "sanitizer_common/sanitizer_libc.h"
  
  #define ASAN_DEFAULT_FAILURE_EXITCODE 1
  
  #if __has_feature(address_sanitizer) || defined(__SANITIZE_ADDRESS__)
  # error "The AddressSanitizer run-time should not be"
          " instrumented by AddressSanitizer"
  #endif
  
  // Build-time configuration options.
  
  // If set, asan will install its own SEGV signal handler.
  #ifndef ASAN_NEEDS_SEGV
  # if SANITIZER_ANDROID == 1
  #  define ASAN_NEEDS_SEGV 0
  # else
  #  define ASAN_NEEDS_SEGV 1
  # endif
  #endif
  
  // If set, asan will intercept C++ exception api call(s).
  #ifndef ASAN_HAS_EXCEPTIONS
  # define ASAN_HAS_EXCEPTIONS 1
  #endif
  
  // If set, asan uses the values of SHADOW_SCALE and SHADOW_OFFSET
  // provided by the instrumented objects. Otherwise constants are used.
  #ifndef ASAN_FLEXIBLE_MAPPING_AND_OFFSET
  # define ASAN_FLEXIBLE_MAPPING_AND_OFFSET 0
  #endif
  
  // If set, values like allocator chunk size, as well as defaults for some flags
  // will be changed towards less memory overhead.
  #ifndef ASAN_LOW_MEMORY
  #if SANITIZER_WORDSIZE == 32
  #  define ASAN_LOW_MEMORY 1
  #else
  #  define ASAN_LOW_MEMORY 0
  # endif
  #endif
  
  #ifndef ASAN_USE_PREINIT_ARRAY
  # define ASAN_USE_PREINIT_ARRAY (SANITIZER_LINUX && !SANITIZER_ANDROID)
  #endif
  
  // All internal functions in asan reside inside the __asan namespace
  // to avoid namespace collisions with the user programs.
  // Seperate namespace also makes it simpler to distinguish the asan run-time
  // functions from the instrumented user code in a profile.
  namespace __asan {
  
  class AsanThread;
  using __sanitizer::StackTrace;
  
  // asan_rtl.cc
  void NORETURN ShowStatsAndAbort();
  
  void ReplaceOperatorsNewAndDelete();
  // asan_malloc_linux.cc / asan_malloc_mac.cc
  void ReplaceSystemMalloc();
  
  // asan_linux.cc / asan_mac.cc / asan_win.cc
  void *AsanDoesNotSupportStaticLinkage();
  
  void GetPcSpBp(void *context, uptr *pc, uptr *sp, uptr *bp);
  
  void MaybeReexec();
  bool AsanInterceptsSignal(int signum);
  void SetAlternateSignalStack();
  void UnsetAlternateSignalStack();
  void InstallSignalHandlers();
  void ReadContextStack(void *context, uptr *stack, uptr *ssize);
  void AsanPlatformThreadInit();
  
  // Wrapper for TLS/TSD.
  void AsanTSDInit(void (*destructor)(void *tsd));
  void *AsanTSDGet();
  void AsanTSDSet(void *tsd);
  
  void AppendToErrorMessageBuffer(const char *buffer);
  
  // Platfrom-specific options.
  #if SANITIZER_MAC
  bool PlatformHasDifferentMemcpyAndMemmove();
  # define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE \
      (PlatformHasDifferentMemcpyAndMemmove())
  #else
  # define PLATFORM_HAS_DIFFERENT_MEMCPY_AND_MEMMOVE true
  #endif  // SANITIZER_MAC
  
  // Add convenient macro for interface functions that may be represented as
  // weak hooks.
  #define ASAN_MALLOC_HOOK(ptr, size) \
    if (&__asan_malloc_hook) __asan_malloc_hook(ptr, size)
  #define ASAN_FREE_HOOK(ptr) \
    if (&__asan_free_hook) __asan_free_hook(ptr)
  #define ASAN_ON_ERROR() \
    if (&__asan_on_error) __asan_on_error()
  
  extern int asan_inited;
  // Used to avoid infinite recursion in __asan_init().
  extern bool asan_init_is_running;
  extern void (*death_callback)(void);
  
  // These magic values are written to shadow for better error reporting.
  const int kAsanHeapLeftRedzoneMagic = 0xfa;
  const int kAsanHeapRightRedzoneMagic = 0xfb;
  const int kAsanHeapFreeMagic = 0xfd;
  const int kAsanStackLeftRedzoneMagic = 0xf1;
  const int kAsanStackMidRedzoneMagic = 0xf2;
  const int kAsanStackRightRedzoneMagic = 0xf3;
  const int kAsanStackPartialRedzoneMagic = 0xf4;
  const int kAsanStackAfterReturnMagic = 0xf5;
  const int kAsanInitializationOrderMagic = 0xf6;
  const int kAsanUserPoisonedMemoryMagic = 0xf7;
  const int kAsanStackUseAfterScopeMagic = 0xf8;
  const int kAsanGlobalRedzoneMagic = 0xf9;
  const int kAsanInternalHeapMagic = 0xfe;
  
  static const uptr kCurrentStackFrameMagic = 0x41B58AB3;
  static const uptr kRetiredStackFrameMagic = 0x45E0360E;
  
  }  // namespace __asan
  
  #endif  // ASAN_INTERNAL_H
  