libsanitizer/interception/interception.h

   1 //===-- interception.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 // Machinery for providing replacements/wrappers for system functions.
  11 //===----------------------------------------------------------------------===//
  12
  13 #ifndef INTERCEPTION_H
  14 #define INTERCEPTION_H
  15
  16 #if !defined(__linux__) && !defined(__FreeBSD__) && \
  17   !defined(__APPLE__) && !defined(_WIN32)
  18 # error "Interception doesn't work on this operating system."
  19 #endif
  20
  21 #include "sanitizer_common/sanitizer_internal_defs.h"
  22
  23 // These typedefs should be used only in the interceptor definitions to replace
  24 // the standard system types (e.g. SSIZE_T instead of ssize_t)
  25 typedef __sanitizer::uptr    SIZE_T;
  26 typedef __sanitizer::sptr    SSIZE_T;
  27 typedef __sanitizer::sptr    PTRDIFF_T;
  28 typedef __sanitizer::s64     INTMAX_T;
  29 typedef __sanitizer::OFF_T   OFF_T;
  30 typedef __sanitizer::OFF64_T OFF64_T;
  31
  32 // How to add an interceptor:
  33 // Suppose you need to wrap/replace system function (generally, from libc):
  34 //      int foo(const char *bar, double baz);
  35 // You'll need to:
  36 //      1) define INTERCEPTOR(int, foo, const char *bar, double baz) { ... } in
  37 //         your source file. See the notes below for cases when
  38 //         INTERCEPTOR_WITH_SUFFIX(...) should be used instead.
  39 //      2) Call "INTERCEPT_FUNCTION(foo)" prior to the first call of "foo".
  40 //         INTERCEPT_FUNCTION(foo) evaluates to "true" iff the function was
  41 //         intercepted successfully.
  42 // You can access original function by calling REAL(foo)(bar, baz).
  43 // By default, REAL(foo) will be visible only inside your interceptor, and if
  44 // you want to use it in other parts of RTL, you'll need to:
  45 //      3a) add DECLARE_REAL(int, foo, const char*, double) to a
  46 //          header file.
  47 // However, if the call "INTERCEPT_FUNCTION(foo)" and definition for
  48 // INTERCEPTOR(..., foo, ...) are in different files, you'll instead need to:
  49 //      3b) add DECLARE_REAL_AND_INTERCEPTOR(int, foo, const char*, double)
  50 //          to a header file.
  51
  52 // Notes: 1. Things may not work properly if macro INTERCEPTOR(...) {...} or
  53 //           DECLARE_REAL(...) are located inside namespaces.
  54 //        2. On Mac you can also use: "OVERRIDE_FUNCTION(foo, zoo)" to
  55 //           effectively redirect calls from "foo" to "zoo". In this case
  56 //           you aren't required to implement
  57 //           INTERCEPTOR(int, foo, const char *bar, double baz) {...}
  58 //           but instead you'll have to add
  59 //           DECLARE_REAL(int, foo, const char *bar, double baz) in your
  60 //           source file (to define a pointer to overriden function).
  61 //        3. Some Mac functions have symbol variants discriminated by
  62 //           additional suffixes, e.g. _$UNIX2003 (see
  63 //           https://developer.apple.com/library/mac/#releasenotes/Darwin/SymbolVariantsRelNotes/index.html
  64 //           for more details). To intercept such functions you need to use the
  65 //           INTERCEPTOR_WITH_SUFFIX(...) macro.
  66
  67 // How it works:
  68 // To replace system functions on Linux we just need to declare functions
  69 // with same names in our library and then obtain the real function pointers
  70 // using dlsym().
  71 // There is one complication. A user may also intercept some of the functions
  72 // we intercept. To resolve this we declare our interceptors with __interceptor_
  73 // prefix, and then make actual interceptors weak aliases to __interceptor_
  74 // functions.
  75 //
  76 // This is not so on Mac OS, where the two-level namespace makes
  77 // our replacement functions invisible to other libraries. This may be overcomed
  78 // using the DYLD_FORCE_FLAT_NAMESPACE, but some errors loading the shared
  79 // libraries in Chromium were noticed when doing so.
  80 // Instead we create a dylib containing a __DATA,__interpose section that
  81 // associates library functions with their wrappers. When this dylib is
  82 // preloaded before an executable using DYLD_INSERT_LIBRARIES, it routes all
  83 // the calls to interposed functions done through stubs to the wrapper
  84 // functions.
  85 // As it's decided at compile time which functions are to be intercepted on Mac,
  86 // INTERCEPT_FUNCTION() is effectively a no-op on this system.
  87
  88 #if defined(__APPLE__)
  89 #include <sys/cdefs.h>  // For __DARWIN_ALIAS_C().
  90
  91 // Just a pair of pointers.
  92 struct interpose_substitution {
  93   const uptr replacement;
  94   const uptr original;
  95 };
  96
  97 // For a function foo() create a global pair of pointers { wrap_foo, foo } in
  98 // the __DATA,__interpose section.
  99 // As a result all the calls to foo() will be routed to wrap_foo() at runtime.
 100 #define INTERPOSER(func_name) __attribute__((used)) \
 101 const interpose_substitution substitution_##func_name[] \
 102     __attribute__((section("__DATA, __interpose"))) = { \
 103     { reinterpret_cast<const uptr>(WRAP(func_name)), \
 104       reinterpret_cast<const uptr>(func_name) } \
 105 }
 106
 107 // For a function foo() and a wrapper function bar() create a global pair
 108 // of pointers { bar, foo } in the __DATA,__interpose section.
 109 // As a result all the calls to foo() will be routed to bar() at runtime.
 110 #define INTERPOSER_2(func_name, wrapper_name) __attribute__((used)) \
 111 const interpose_substitution substitution_##func_name[] \
 112     __attribute__((section("__DATA, __interpose"))) = { \
 113     { reinterpret_cast<const uptr>(wrapper_name), \
 114       reinterpret_cast<const uptr>(func_name) } \
 115 }
 116
 117 # define WRAP(x) wrap_##x
 118 # define WRAPPER_NAME(x) "wrap_"#x
 119 # define INTERCEPTOR_ATTRIBUTE
 120 # define DECLARE_WRAPPER(ret_type, func, ...)
 121
 122 #elif defined(_WIN32)
 123 # if defined(_DLL)  // DLL CRT
 124 #  define WRAP(x) x
 125 #  define WRAPPER_NAME(x) #x
 126 #  define INTERCEPTOR_ATTRIBUTE
 127 # else  // Static CRT
 128 #  define WRAP(x) wrap_##x
 129 #  define WRAPPER_NAME(x) "wrap_"#x
 130 #  define INTERCEPTOR_ATTRIBUTE
 131 # endif
 132 # define DECLARE_WRAPPER(ret_type, func, ...) \
 133     extern "C" ret_type func(__VA_ARGS__);
 134 # define DECLARE_WRAPPER_WINAPI(ret_type, func, ...) \
 135     extern "C" __declspec(dllimport) ret_type __stdcall func(__VA_ARGS__);
 136 #else
 137 # define WRAP(x) __interceptor_ ## x
 138 # define WRAPPER_NAME(x) "__interceptor_" #x
 139 # define INTERCEPTOR_ATTRIBUTE __attribute__((visibility("default")))
 140 # define DECLARE_WRAPPER(ret_type, func, ...) \
 141     extern "C" ret_type func(__VA_ARGS__) \
 142     __attribute__((weak, alias("__interceptor_" #func), visibility("default")));
 143 #endif
 144
 145 #if !defined(__APPLE__)
 146 # define PTR_TO_REAL(x) real_##x
 147 # define REAL(x) __interception::PTR_TO_REAL(x)
 148 # define FUNC_TYPE(x) x##_f
 149
 150 # define DECLARE_REAL(ret_type, func, ...) \
 151     typedef ret_type (*FUNC_TYPE(func))(__VA_ARGS__); \
 152     namespace __interception { \
 153       extern FUNC_TYPE(func) PTR_TO_REAL(func); \
 154     }
 155 #else  // __APPLE__
 156 # define REAL(x) x
 157 # define DECLARE_REAL(ret_type, func, ...) \
 158     extern "C" ret_type func(__VA_ARGS__);
 159 #endif  // __APPLE__
 160
 161 #define DECLARE_REAL_AND_INTERCEPTOR(ret_type, func, ...) \
 162   DECLARE_REAL(ret_type, func, __VA_ARGS__) \
 163   extern "C" ret_type WRAP(func)(__VA_ARGS__);
 164
 165 // Generally, you don't need to use DEFINE_REAL by itself, as INTERCEPTOR
 166 // macros does its job. In exceptional cases you may need to call REAL(foo)
 167 // without defining INTERCEPTOR(..., foo, ...). For example, if you override
 168 // foo with an interceptor for other function.
 169 #if !defined(__APPLE__)
 170 # define DEFINE_REAL(ret_type, func, ...) \
 171     typedef ret_type (*FUNC_TYPE(func))(__VA_ARGS__); \
 172     namespace __interception { \
 173       FUNC_TYPE(func) PTR_TO_REAL(func); \
 174     }
 175 #else
 176 # define DEFINE_REAL(ret_type, func, ...)
 177 #endif
 178
 179 #if !defined(__APPLE__)
 180 #define INTERCEPTOR(ret_type, func, ...) \
 181   DEFINE_REAL(ret_type, func, __VA_ARGS__) \
 182   DECLARE_WRAPPER(ret_type, func, __VA_ARGS__) \
 183   extern "C" \
 184   INTERCEPTOR_ATTRIBUTE \
 185   ret_type WRAP(func)(__VA_ARGS__)
 186
 187 // We don't need INTERCEPTOR_WITH_SUFFIX on non-Darwin for now.
 188 #define INTERCEPTOR_WITH_SUFFIX(ret_type, func, ...) \
 189   INTERCEPTOR(ret_type, func, __VA_ARGS__)
 190
 191 #else  // __APPLE__
 192
 193 #define INTERCEPTOR_ZZZ(suffix, ret_type, func, ...) \
 194   extern "C" ret_type func(__VA_ARGS__) suffix; \
 195   extern "C" ret_type WRAP(func)(__VA_ARGS__); \
 196   INTERPOSER(func); \
 197   extern "C" INTERCEPTOR_ATTRIBUTE ret_type WRAP(func)(__VA_ARGS__)
 198
 199 #define INTERCEPTOR(ret_type, func, ...) \
 200   INTERCEPTOR_ZZZ(/*no symbol variants*/, ret_type, func, __VA_ARGS__)
 201
 202 #define INTERCEPTOR_WITH_SUFFIX(ret_type, func, ...) \
 203   INTERCEPTOR_ZZZ(__DARWIN_ALIAS_C(func), ret_type, func, __VA_ARGS__)
 204
 205 // Override |overridee| with |overrider|.
 206 #define OVERRIDE_FUNCTION(overridee, overrider) \
 207   INTERPOSER_2(overridee, WRAP(overrider))
 208 #endif
 209
 210 #if defined(_WIN32)
 211 # define INTERCEPTOR_WINAPI(ret_type, func, ...) \
 212     typedef ret_type (__stdcall *FUNC_TYPE(func))(__VA_ARGS__); \
 213     namespace __interception { \
 214       FUNC_TYPE(func) PTR_TO_REAL(func); \
 215     } \
 216     DECLARE_WRAPPER_WINAPI(ret_type, func, __VA_ARGS__) \
 217     extern "C" \
 218     INTERCEPTOR_ATTRIBUTE \
 219     ret_type __stdcall WRAP(func)(__VA_ARGS__)
 220 #endif
 221
 222 // ISO C++ forbids casting between pointer-to-function and pointer-to-object,
 223 // so we use casting via an integral type __interception::uptr,
 224 // assuming that system is POSIX-compliant. Using other hacks seem
 225 // challenging, as we don't even pass function type to
 226 // INTERCEPT_FUNCTION macro, only its name.
 227 namespace __interception {
 228 #if defined(_WIN64)
 229 typedef unsigned long long uptr;  // NOLINT
 230 #else
 231 typedef unsigned long uptr;  // NOLINT
 232 #endif  // _WIN64
 233 }  // namespace __interception
 234
 235 #define INCLUDED_FROM_INTERCEPTION_LIB
 236
 237 #if defined(__linux__) || defined(__FreeBSD__)
 238 # include "interception_linux.h"
 239 # define INTERCEPT_FUNCTION(func) INTERCEPT_FUNCTION_LINUX_OR_FREEBSD(func)
 240 # define INTERCEPT_FUNCTION_VER(func, symver) \
 241     INTERCEPT_FUNCTION_VER_LINUX_OR_FREEBSD(func, symver)
 242 #elif defined(__APPLE__)
 243 # include "interception_mac.h"
 244 # define INTERCEPT_FUNCTION(func) INTERCEPT_FUNCTION_MAC(func)
 245 # define INTERCEPT_FUNCTION_VER(func, symver) \
 246     INTERCEPT_FUNCTION_VER_MAC(func, symver)
 247 #else  // defined(_WIN32)
 248 # include "interception_win.h"
 249 # define INTERCEPT_FUNCTION(func) INTERCEPT_FUNCTION_WIN(func)
 250 # define INTERCEPT_FUNCTION_VER(func, symver) \
 251     INTERCEPT_FUNCTION_VER_WIN(func, symver)
 252 #endif
 253
 254 #undef INCLUDED_FROM_INTERCEPTION_LIB
 255
 256 #endif  // INTERCEPTION_H