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