libsanitizer/asan/asan_interceptors.h

   1 //===-- asan_interceptors.h -------------------------------------*- C++ -*-===//
   2 //
   3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
   4 // See https://llvm.org/LICENSE.txt for license information.
   5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
   6 //
   7 //===----------------------------------------------------------------------===//
   8 //
   9 // This file is a part of AddressSanitizer, an address sanity checker.
  10 //
  11 // ASan-private header for asan_interceptors.cpp
  12 //===----------------------------------------------------------------------===//
  13 #ifndef ASAN_INTERCEPTORS_H
  14 #define ASAN_INTERCEPTORS_H
  15
  16 #include "asan_interceptors_memintrinsics.h"
  17 #include "asan_internal.h"
  18 #include "interception/interception.h"
  19 #include "sanitizer_common/sanitizer_platform.h"
  20 #include "sanitizer_common/sanitizer_platform_interceptors.h"
  21
  22 namespace __asan {
  23
  24 void InitializeAsanInterceptors();
  25 void InitializePlatformInterceptors();
  26
  27 #define ENSURE_ASAN_INITED()       \
  28   do {                             \
  29     CHECK(!AsanInitIsRunning());   \
  30     if (UNLIKELY(!AsanInited())) { \
  31       AsanInitFromRtl();           \
  32     }                              \
  33   } while (0)
  34
  35 }  // namespace __asan
  36
  37 // There is no general interception at all on Fuchsia.
  38 // Only the functions in asan_interceptors_memintrinsics.h are
  39 // really defined to replace libc functions.
  40 #if !SANITIZER_FUCHSIA
  41
  42 // Use macro to describe if specific function should be
  43 // intercepted on a given platform.
  44 #if !SANITIZER_WINDOWS
  45 # define ASAN_INTERCEPT__LONGJMP 1
  46 # define ASAN_INTERCEPT_INDEX 1
  47 # define ASAN_INTERCEPT_PTHREAD_CREATE 1
  48 #else
  49 # define ASAN_INTERCEPT__LONGJMP 0
  50 # define ASAN_INTERCEPT_INDEX 0
  51 # define ASAN_INTERCEPT_PTHREAD_CREATE 0
  52 #endif
  53
  54 #if SANITIZER_FREEBSD || SANITIZER_LINUX || SANITIZER_NETBSD || \
  55     SANITIZER_SOLARIS
  56 # define ASAN_USE_ALIAS_ATTRIBUTE_FOR_INDEX 1
  57 #else
  58 # define ASAN_USE_ALIAS_ATTRIBUTE_FOR_INDEX 0
  59 #endif
  60
  61 #if SANITIZER_GLIBC || SANITIZER_SOLARIS
  62 # define ASAN_INTERCEPT_SWAPCONTEXT 1
  63 #else
  64 # define ASAN_INTERCEPT_SWAPCONTEXT 0
  65 #endif
  66
  67 #if !SANITIZER_WINDOWS
  68 # define ASAN_INTERCEPT_SIGLONGJMP 1
  69 #else
  70 # define ASAN_INTERCEPT_SIGLONGJMP 0
  71 #endif
  72
  73 #if SANITIZER_GLIBC
  74 # define ASAN_INTERCEPT___LONGJMP_CHK 1
  75 #else
  76 # define ASAN_INTERCEPT___LONGJMP_CHK 0
  77 #endif
  78
  79 #if ASAN_HAS_EXCEPTIONS && !SANITIZER_SOLARIS && !SANITIZER_NETBSD && \
  80     (!SANITIZER_WINDOWS || (defined(__MINGW32__) && defined(__i386__)))
  81 # define ASAN_INTERCEPT___CXA_THROW 1
  82 # if ! defined(ASAN_HAS_CXA_RETHROW_PRIMARY_EXCEPTION) \
  83      || ASAN_HAS_CXA_RETHROW_PRIMARY_EXCEPTION
  84 #   define ASAN_INTERCEPT___CXA_RETHROW_PRIMARY_EXCEPTION 1
  85 # else
  86 #   define ASAN_INTERCEPT___CXA_RETHROW_PRIMARY_EXCEPTION 0
  87 # endif
  88 # if defined(_GLIBCXX_SJLJ_EXCEPTIONS) || (SANITIZER_IOS && defined(__arm__))
  89 #  define ASAN_INTERCEPT__UNWIND_SJLJ_RAISEEXCEPTION 1
  90 # else
  91 #  define ASAN_INTERCEPT__UNWIND_RAISEEXCEPTION 1
  92 # endif
  93 #else
  94 # define ASAN_INTERCEPT___CXA_THROW 0
  95 # define ASAN_INTERCEPT___CXA_RETHROW_PRIMARY_EXCEPTION 0
  96 # define ASAN_INTERCEPT__UNWIND_RAISEEXCEPTION 0
  97 # define ASAN_INTERCEPT__UNWIND_SJLJ_RAISEEXCEPTION 0
  98 #endif
  99
 100 #if !SANITIZER_WINDOWS
 101 # define ASAN_INTERCEPT___CXA_ATEXIT 1
 102 #else
 103 # define ASAN_INTERCEPT___CXA_ATEXIT 0
 104 #endif
 105
 106 #if SANITIZER_NETBSD
 107 # define ASAN_INTERCEPT_ATEXIT 1
 108 #else
 109 # define ASAN_INTERCEPT_ATEXIT 0
 110 #endif
 111
 112 #if SANITIZER_GLIBC
 113 # define ASAN_INTERCEPT___STRDUP 1
 114 #else
 115 # define ASAN_INTERCEPT___STRDUP 0
 116 #endif
 117
 118 #if SANITIZER_GLIBC && ASAN_INTERCEPT_PTHREAD_CREATE
 119 # define ASAN_INTERCEPT_TIMEDJOIN 1
 120 # define ASAN_INTERCEPT_TRYJOIN 1
 121 #else
 122 # define ASAN_INTERCEPT_TIMEDJOIN 0
 123 # define ASAN_INTERCEPT_TRYJOIN 0
 124 #endif
 125
 126 #if SANITIZER_LINUX &&                                                \
 127     (defined(__arm__) || defined(__aarch64__) || defined(__i386__) || \
 128      defined(__x86_64__) || SANITIZER_RISCV64 || SANITIZER_LOONGARCH64)
 129 # define ASAN_INTERCEPT_VFORK 1
 130 #else
 131 # define ASAN_INTERCEPT_VFORK 0
 132 #endif
 133
 134 #if SANITIZER_NETBSD
 135 # define ASAN_INTERCEPT_PTHREAD_ATFORK 1
 136 #else
 137 # define ASAN_INTERCEPT_PTHREAD_ATFORK 0
 138 #endif
 139
 140 DECLARE_REAL(int, memcmp, const void *a1, const void *a2, uptr size)
 141 DECLARE_REAL(char*, strchr, const char *str, int c)
 142 DECLARE_REAL(SIZE_T, strlen, const char *s)
 143 DECLARE_REAL(char*, strncpy, char *to, const char *from, uptr size)
 144 DECLARE_REAL(uptr, strnlen, const char *s, uptr maxlen)
 145 DECLARE_REAL(char*, strstr, const char *s1, const char *s2)
 146
 147 #  if !SANITIZER_APPLE
 148 #    define ASAN_INTERCEPT_FUNC(name)                                        \
 149       do {                                                                   \
 150         if (!INTERCEPT_FUNCTION(name))                                       \
 151           VReport(1, "AddressSanitizer: failed to intercept '%s'\n", #name); \
 152       } while (0)
 153 #    define ASAN_INTERCEPT_FUNC_VER(name, ver)                           \
 154       do {                                                               \
 155         if (!INTERCEPT_FUNCTION_VER(name, ver))                          \
 156           VReport(1, "AddressSanitizer: failed to intercept '%s@@%s'\n", \
 157                   #name, ver);                                           \
 158       } while (0)
 159 #    define ASAN_INTERCEPT_FUNC_VER_UNVERSIONED_FALLBACK(name, ver)           \
 160       do {                                                                    \
 161         if (!INTERCEPT_FUNCTION_VER(name, ver) && !INTERCEPT_FUNCTION(name))  \
 162           VReport(1,                                                          \
 163                   "AddressSanitizer: failed to intercept '%s@@%s' or '%s'\n", \
 164                   #name, ver, #name);                                         \
 165       } while (0)
 166
 167 #  else
 168 // OS X interceptors don't need to be initialized with INTERCEPT_FUNCTION.
 169 #    define ASAN_INTERCEPT_FUNC(name)
 170 #  endif  // SANITIZER_APPLE
 171
 172 #define ASAN_INTERCEPTOR_ENTER(ctx, func)                                      \
 173   AsanInterceptorContext _ctx = {#func};                                       \
 174   ctx = (void *)&_ctx;                                                         \
 175   (void) ctx;
 176 #define COMMON_INTERCEPT_FUNCTION(name) ASAN_INTERCEPT_FUNC(name)
 177
 178 #endif  // !SANITIZER_FUCHSIA
 179
 180 #endif  // ASAN_INTERCEPTORS_H