contrib/compiler-rt/lib/interception/interception_win.h

   1 //===-- interception_linux.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 // Windows-specific interception methods.
  13 //===----------------------------------------------------------------------===//
  14
  15 #if SANITIZER_WINDOWS
  16
  17 #if !defined(INCLUDED_FROM_INTERCEPTION_LIB)
  18 # error "interception_win.h should be included from interception library only"
  19 #endif
  20
  21 #ifndef INTERCEPTION_WIN_H
  22 #define INTERCEPTION_WIN_H
  23
  24 namespace __interception {
  25 // All the functions in the OverrideFunction() family return true on success,
  26 // false on failure (including "couldn't find the function").
  27
  28 // Overrides a function by its address.
  29 bool OverrideFunction(uptr old_func, uptr new_func, uptr *orig_old_func = 0);
  30
  31 // Overrides a function in a system DLL or DLL CRT by its exported name.
  32 bool OverrideFunction(const char *name, uptr new_func, uptr *orig_old_func = 0);
  33
  34 // Windows-only replacement for GetProcAddress. Useful for some sanitizers.
  35 uptr InternalGetProcAddress(void *module, const char *func_name);
  36
  37 // Overrides a function only when it is called from a specific DLL. For example,
  38 // this is used to override calls to HeapAlloc/HeapFree from ucrtbase without
  39 // affecting other third party libraries.
  40 bool OverrideImportedFunction(const char *module_to_patch,
  41                               const char *imported_module,
  42                               const char *function_name, uptr new_function,
  43                               uptr *orig_old_func);
  44
  45 #if !SANITIZER_WINDOWS64
  46 // Exposed for unittests
  47 bool OverrideFunctionWithDetour(
  48     uptr old_func, uptr new_func, uptr *orig_old_func);
  49 #endif
  50
  51 // Exposed for unittests
  52 bool OverrideFunctionWithRedirectJump(
  53     uptr old_func, uptr new_func, uptr *orig_old_func);
  54 bool OverrideFunctionWithHotPatch(
  55     uptr old_func, uptr new_func, uptr *orig_old_func);
  56 bool OverrideFunctionWithTrampoline(
  57     uptr old_func, uptr new_func, uptr *orig_old_func);
  58
  59 // Exposed for unittests
  60 void TestOnlyReleaseTrampolineRegions();
  61
  62 }  // namespace __interception
  63
  64 #if defined(INTERCEPTION_DYNAMIC_CRT)
  65 #define INTERCEPT_FUNCTION_WIN(func)                                           \
  66   ::__interception::OverrideFunction(#func,                                    \
  67                                      (::__interception::uptr)WRAP(func),       \
  68                                      (::__interception::uptr *)&REAL(func))
  69 #else
  70 #define INTERCEPT_FUNCTION_WIN(func)                                           \
  71   ::__interception::OverrideFunction((::__interception::uptr)func,             \
  72                                      (::__interception::uptr)WRAP(func),       \
  73                                      (::__interception::uptr *)&REAL(func))
  74 #endif
  75
  76 #define INTERCEPT_FUNCTION_VER_WIN(func, symver) INTERCEPT_FUNCTION_WIN(func)
  77
  78 #define INTERCEPT_FUNCTION_DLLIMPORT(user_dll, provider_dll, func)       \
  79   ::__interception::OverrideImportedFunction(                            \
  80       user_dll, provider_dll, #func, (::__interception::uptr)WRAP(func), \
  81       (::__interception::uptr *)&REAL(func))
  82
  83 #endif  // INTERCEPTION_WIN_H
  84 #endif  // SANITIZER_WINDOWS