xref: /openbsd-src/gnu/llvm/compiler-rt/lib/interception/interception_win.h (revision 3cab2bb3f667058bece8e38b12449a63a9d73c4b)
1*3cab2bb3Spatrick //===-- interception_linux.h ------------------------------------*- C++ -*-===//
2*3cab2bb3Spatrick //
3*3cab2bb3Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*3cab2bb3Spatrick // See https://llvm.org/LICENSE.txt for license information.
5*3cab2bb3Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*3cab2bb3Spatrick //
7*3cab2bb3Spatrick //===----------------------------------------------------------------------===//
8*3cab2bb3Spatrick //
9*3cab2bb3Spatrick // This file is a part of AddressSanitizer, an address sanity checker.
10*3cab2bb3Spatrick //
11*3cab2bb3Spatrick // Windows-specific interception methods.
12*3cab2bb3Spatrick //===----------------------------------------------------------------------===//
13*3cab2bb3Spatrick 
14*3cab2bb3Spatrick #if SANITIZER_WINDOWS
15*3cab2bb3Spatrick 
16*3cab2bb3Spatrick #if !defined(INCLUDED_FROM_INTERCEPTION_LIB)
17*3cab2bb3Spatrick # error "interception_win.h should be included from interception library only"
18*3cab2bb3Spatrick #endif
19*3cab2bb3Spatrick 
20*3cab2bb3Spatrick #ifndef INTERCEPTION_WIN_H
21*3cab2bb3Spatrick #define INTERCEPTION_WIN_H
22*3cab2bb3Spatrick 
23*3cab2bb3Spatrick namespace __interception {
24*3cab2bb3Spatrick // All the functions in the OverrideFunction() family return true on success,
25*3cab2bb3Spatrick // false on failure (including "couldn't find the function").
26*3cab2bb3Spatrick 
27*3cab2bb3Spatrick // Overrides a function by its address.
28*3cab2bb3Spatrick bool OverrideFunction(uptr old_func, uptr new_func, uptr *orig_old_func = 0);
29*3cab2bb3Spatrick 
30*3cab2bb3Spatrick // Overrides a function in a system DLL or DLL CRT by its exported name.
31*3cab2bb3Spatrick bool OverrideFunction(const char *name, uptr new_func, uptr *orig_old_func = 0);
32*3cab2bb3Spatrick 
33*3cab2bb3Spatrick // Windows-only replacement for GetProcAddress. Useful for some sanitizers.
34*3cab2bb3Spatrick uptr InternalGetProcAddress(void *module, const char *func_name);
35*3cab2bb3Spatrick 
36*3cab2bb3Spatrick // Overrides a function only when it is called from a specific DLL. For example,
37*3cab2bb3Spatrick // this is used to override calls to HeapAlloc/HeapFree from ucrtbase without
38*3cab2bb3Spatrick // affecting other third party libraries.
39*3cab2bb3Spatrick bool OverrideImportedFunction(const char *module_to_patch,
40*3cab2bb3Spatrick                               const char *imported_module,
41*3cab2bb3Spatrick                               const char *function_name, uptr new_function,
42*3cab2bb3Spatrick                               uptr *orig_old_func);
43*3cab2bb3Spatrick 
44*3cab2bb3Spatrick #if !SANITIZER_WINDOWS64
45*3cab2bb3Spatrick // Exposed for unittests
46*3cab2bb3Spatrick bool OverrideFunctionWithDetour(
47*3cab2bb3Spatrick     uptr old_func, uptr new_func, uptr *orig_old_func);
48*3cab2bb3Spatrick #endif
49*3cab2bb3Spatrick 
50*3cab2bb3Spatrick // Exposed for unittests
51*3cab2bb3Spatrick bool OverrideFunctionWithRedirectJump(
52*3cab2bb3Spatrick     uptr old_func, uptr new_func, uptr *orig_old_func);
53*3cab2bb3Spatrick bool OverrideFunctionWithHotPatch(
54*3cab2bb3Spatrick     uptr old_func, uptr new_func, uptr *orig_old_func);
55*3cab2bb3Spatrick bool OverrideFunctionWithTrampoline(
56*3cab2bb3Spatrick     uptr old_func, uptr new_func, uptr *orig_old_func);
57*3cab2bb3Spatrick 
58*3cab2bb3Spatrick // Exposed for unittests
59*3cab2bb3Spatrick void TestOnlyReleaseTrampolineRegions();
60*3cab2bb3Spatrick 
61*3cab2bb3Spatrick }  // namespace __interception
62*3cab2bb3Spatrick 
63*3cab2bb3Spatrick #if defined(INTERCEPTION_DYNAMIC_CRT)
64*3cab2bb3Spatrick #define INTERCEPT_FUNCTION_WIN(func)                                           \
65*3cab2bb3Spatrick   ::__interception::OverrideFunction(#func,                                    \
66*3cab2bb3Spatrick                                      (::__interception::uptr)WRAP(func),       \
67*3cab2bb3Spatrick                                      (::__interception::uptr *)&REAL(func))
68*3cab2bb3Spatrick #else
69*3cab2bb3Spatrick #define INTERCEPT_FUNCTION_WIN(func)                                           \
70*3cab2bb3Spatrick   ::__interception::OverrideFunction((::__interception::uptr)func,             \
71*3cab2bb3Spatrick                                      (::__interception::uptr)WRAP(func),       \
72*3cab2bb3Spatrick                                      (::__interception::uptr *)&REAL(func))
73*3cab2bb3Spatrick #endif
74*3cab2bb3Spatrick 
75*3cab2bb3Spatrick #define INTERCEPT_FUNCTION_VER_WIN(func, symver) INTERCEPT_FUNCTION_WIN(func)
76*3cab2bb3Spatrick 
77*3cab2bb3Spatrick #define INTERCEPT_FUNCTION_DLLIMPORT(user_dll, provider_dll, func)       \
78*3cab2bb3Spatrick   ::__interception::OverrideImportedFunction(                            \
79*3cab2bb3Spatrick       user_dll, provider_dll, #func, (::__interception::uptr)WRAP(func), \
80*3cab2bb3Spatrick       (::__interception::uptr *)&REAL(func))
81*3cab2bb3Spatrick 
82*3cab2bb3Spatrick #endif  // INTERCEPTION_WIN_H
83*3cab2bb3Spatrick #endif  // SANITIZER_WINDOWS
84