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