|
pavolmarko@733
|
1 |
/* ======== SourceHook ======== |
|
pavolmarko@733
|
2 |
* Copyright (C) 2004-2010 Metamod:Source Development Team |
|
pavolmarko@733
|
3 |
* No warranties of any kind |
|
pavolmarko@733
|
4 |
* |
|
pavolmarko@733
|
5 |
* License: zlib/libpng |
|
pavolmarko@733
|
6 |
* |
|
pavolmarko@733
|
7 |
* Author(s): Pavol "PM OnoTo" Marko |
|
pavolmarko@733
|
8 |
* ============================ |
|
pavolmarko@733
|
9 |
*/ |
|
pavolmarko@733
|
10 |
|
|
pavolmarko@733
|
11 |
#include "sourcehook_impl.h" |
|
pavolmarko@733
|
12 |
|
|
pavolmarko@733
|
13 |
namespace SourceHook |
|
pavolmarko@733
|
14 |
{ |
|
pavolmarko@733
|
15 |
namespace Impl |
|
pavolmarko@733
|
16 |
{ |
|
pavolmarko@733
|
17 |
CPageAlloc CVfnPtr::ms_AlignedPageAllocator(8); |
|
pavolmarko@733
|
18 |
|
|
pavolmarko@733
|
19 |
CVfnPtr::CVfnPtr(void *ptr) |
|
pavolmarko@733
|
20 |
: m_Ptr(ptr), m_OrigEntry(*reinterpret_cast<void**>(m_Ptr)), |
|
pavolmarko@733
|
21 |
m_OrigCallThunk(NULL) |
|
pavolmarko@733
|
22 |
{ |
|
pavolmarko@733
|
23 |
} |
|
pavolmarko@733
|
24 |
|
|
pavolmarko@733
|
25 |
CVfnPtr::~CVfnPtr() |
|
pavolmarko@733
|
26 |
{ |
|
pavolmarko@733
|
27 |
if (!m_HookMans.empty()) |
|
pavolmarko@733
|
28 |
m_HookMans.front()->DecrRef(this); |
|
pavolmarko@733
|
29 |
} |
|
pavolmarko@733
|
30 |
|
|
pavolmarko@733
|
31 |
bool CVfnPtr::Init() |
|
pavolmarko@733
|
32 |
{ |
|
pavolmarko@733
|
33 |
// Initalize the vfn ptr info object. |
|
pavolmarko@733
|
34 |
|
|
pavolmarko@733
|
35 |
// If we're running on GCC and the original vtable entry is odd |
|
pavolmarko@733
|
36 |
// we have a problem. |
|
pavolmarko@733
|
37 |
// The hook functions use non-virtual member function pointers to |
|
pavolmarko@733
|
38 |
// call the original function (see sourcehook.hxx, SH_SETUP_MFP and SH_CALL_ORIG) |
|
pavolmarko@733
|
39 |
// GCC has the same format for virtual and non-virtual MFPs: |
|
pavolmarko@733
|
40 |
// virtual ones have an odd value as "funcptr" where the offset into the vtable is encoded |
|
pavolmarko@733
|
41 |
// non-virtual ones have the direct function pointer as "funcptr", assuming that it is even |
|
pavolmarko@733
|
42 |
|
|
pavolmarko@733
|
43 |
// When m_OrigEntry is odd, GCC's runtime MFP calling code interpretes it as a virtual |
|
pavolmarko@733
|
44 |
// function call though we want to call the function in a non-virtual way |
|
pavolmarko@733
|
45 |
// (the original function call mechanism between the pre and post hook loop has to bypass |
|
pavolmarko@733
|
46 |
// the virtual calling mechanism in order to call the original function). |
|
pavolmarko@733
|
47 |
|
|
pavolmarko@733
|
48 |
#if SH_COMP==SH_COMP_GCC |
|
pavolmarko@733
|
49 |
if ((((ptrdiff_t)m_OrigEntry) & 1) != 0) |
|
pavolmarko@733
|
50 |
{ |
|
pavolmarko@733
|
51 |
// Odd orig entry. |
|
pavolmarko@733
|
52 |
if (SH_PTRSIZE != 4) |
|
pavolmarko@733
|
53 |
{ |
|
pavolmarko@733
|
54 |
// We only have code for IA32 atm! |
|
pavolmarko@733
|
55 |
return false; |
|
pavolmarko@733
|
56 |
} |
|
pavolmarko@733
|
57 |
|
|
pavolmarko@733
|
58 |
// Generate a new thunk |
|
pavolmarko@733
|
59 |
m_OrigCallThunk = ms_AlignedPageAllocator.Alloc(5); |
|
pavolmarko@733
|
60 |
ms_AlignedPageAllocator.SetRW(m_OrigCallThunk); |
|
pavolmarko@733
|
61 |
|
|
pavolmarko@733
|
62 |
unsigned char* thunkBase = reinterpret_cast<unsigned char*>(m_OrigCallThunk); |
|
pavolmarko@733
|
63 |
*(thunkBase + 0) = 0xE9; // offset jump, immediate operand |
|
pavolmarko@733
|
64 |
ptrdiff_t *offsetAddr = reinterpret_cast<ptrdiff_t*>(thunkBase + 1); |
|
pavolmarko@733
|
65 |
|
|
pavolmarko@733
|
66 |
// destination = src + offset + 5 |
|
pavolmarko@733
|
67 |
// <=> offset = destination - src - 5 |
|
pavolmarko@733
|
68 |
*offsetAddr = |
|
pavolmarko@733
|
69 |
(reinterpret_cast<unsigned char*>(m_OrigEntry) - thunkBase) - 5; |
|
pavolmarko@733
|
70 |
|
|
pavolmarko@733
|
71 |
ms_AlignedPageAllocator.SetRE(m_OrigCallThunk); |
|
pavolmarko@733
|
72 |
} |
|
pavolmarko@733
|
73 |
#endif |
|
pavolmarko@733
|
74 |
return true; |
|
pavolmarko@733
|
75 |
} |
|
pavolmarko@733
|
76 |
|
|
pavolmarko@733
|
77 |
class CVfnPtrOrigThunkCleanup : public ICleanupTask |
|
pavolmarko@733
|
78 |
{ |
|
pavolmarko@733
|
79 |
CPageAlloc *m_Allocator; |
|
pavolmarko@733
|
80 |
void *m_AddrToFree; |
|
pavolmarko@733
|
81 |
|
|
pavolmarko@733
|
82 |
public: |
|
pavolmarko@733
|
83 |
CVfnPtrOrigThunkCleanup(CPageAlloc *allocator, void *addrToFree) : |
|
pavolmarko@733
|
84 |
m_Allocator(allocator), m_AddrToFree(addrToFree) |
|
pavolmarko@733
|
85 |
{ |
|
pavolmarko@733
|
86 |
} |
|
pavolmarko@733
|
87 |
|
|
pavolmarko@733
|
88 |
virtual void CleanupAndDeleteThis() |
|
pavolmarko@733
|
89 |
{ |
|
pavolmarko@733
|
90 |
m_Allocator->Free(m_AddrToFree); |
|
pavolmarko@733
|
91 |
delete this; |
|
pavolmarko@733
|
92 |
} |
|
pavolmarko@733
|
93 |
}; |
|
pavolmarko@733
|
94 |
|
|
pavolmarko@733
|
95 |
ICleanupTask* CVfnPtr::GetCleanupTask() |
|
pavolmarko@733
|
96 |
{ |
|
pavolmarko@733
|
97 |
if (m_OrigCallThunk != NULL) |
|
pavolmarko@733
|
98 |
{ |
|
pavolmarko@733
|
99 |
return new CVfnPtrOrigThunkCleanup(&ms_AlignedPageAllocator, m_OrigCallThunk); |
|
pavolmarko@733
|
100 |
} |
|
pavolmarko@733
|
101 |
else |
|
pavolmarko@733
|
102 |
{ |
|
pavolmarko@733
|
103 |
return NULL; |
|
pavolmarko@733
|
104 |
} |
|
pavolmarko@733
|
105 |
} |
|
pavolmarko@733
|
106 |
|
|
pavolmarko@733
|
107 |
void* CVfnPtr::GetOrigCallAddr() const |
|
pavolmarko@733
|
108 |
{ |
|
pavolmarko@733
|
109 |
if (m_OrigCallThunk) |
|
pavolmarko@733
|
110 |
{ |
|
pavolmarko@733
|
111 |
return m_OrigCallThunk; |
|
pavolmarko@733
|
112 |
} |
|
pavolmarko@733
|
113 |
else |
|
pavolmarko@733
|
114 |
{ |
|
pavolmarko@733
|
115 |
return m_OrigEntry; |
|
pavolmarko@733
|
116 |
} |
|
pavolmarko@733
|
117 |
} |
|
pavolmarko@733
|
118 |
|
|
pavolmarko@733
|
119 |
bool CVfnPtr::Revert() |
|
pavolmarko@733
|
120 |
{ |
|
pavolmarko@733
|
121 |
// Only patch the vfnptr back if the module is still in memory |
|
pavolmarko@733
|
122 |
// If it's not, do not remove stuff like we did before |
|
pavolmarko@733
|
123 |
// First off we did it wrong (shutdown the whole hookman, uh..) and secondly applications may be |
|
pavolmarko@733
|
124 |
// confused by RemoveHook returning false then (yeah, I know, I made this one up, no one checks for RemoveHook error) |
|
pavolmarko@733
|
125 |
if (ModuleInMemory(reinterpret_cast<char*>(m_Ptr), SH_PTRSIZE)) |
|
pavolmarko@733
|
126 |
{ |
|
pavolmarko@733
|
127 |
return Patch(m_OrigEntry); |
|
pavolmarko@733
|
128 |
} |
|
pavolmarko@733
|
129 |
else |
|
pavolmarko@733
|
130 |
{ |
|
pavolmarko@733
|
131 |
return true; |
|
pavolmarko@733
|
132 |
} |
|
pavolmarko@733
|
133 |
} |
|
pavolmarko@733
|
134 |
|
|
pavolmarko@733
|
135 |
CIface *CVfnPtr::FindIface(void *iface) |
|
pavolmarko@733
|
136 |
{ |
|
pavolmarko@733
|
137 |
List<CIface>::iterator iter = m_IfaceList.find(iface); |
|
pavolmarko@733
|
138 |
if (iter == m_IfaceList.end()) |
|
pavolmarko@733
|
139 |
return NULL; |
|
pavolmarko@733
|
140 |
else |
|
pavolmarko@733
|
141 |
return &(*iter); |
|
pavolmarko@733
|
142 |
} |
|
pavolmarko@733
|
143 |
|
|
pavolmarko@733
|
144 |
void CVfnPtr::AddHookMan(CHookManager *pHookMan) |
|
pavolmarko@733
|
145 |
{ |
|
pavolmarko@733
|
146 |
List<CHookManager*>::iterator iter; |
|
pavolmarko@733
|
147 |
|
|
pavolmarko@733
|
148 |
// Don't accept invalid hook managers |
|
pavolmarko@733
|
149 |
if (!*pHookMan) |
|
pavolmarko@733
|
150 |
return; |
|
pavolmarko@733
|
151 |
|
|
pavolmarko@733
|
152 |
// Check whether this hook manager already exists; if yes, ignore. |
|
pavolmarko@733
|
153 |
iter = m_HookMans.find(pHookMan); |
|
pavolmarko@733
|
154 |
if (iter != m_HookMans.end()) |
|
pavolmarko@733
|
155 |
return; |
|
pavolmarko@733
|
156 |
|
|
pavolmarko@733
|
157 |
// It doesn't -> add it. Add it to the end of its version group. |
|
pavolmarko@733
|
158 |
for (iter = m_HookMans.begin(); iter != m_HookMans.end(); ++iter) |
|
pavolmarko@733
|
159 |
{ |
|
pavolmarko@733
|
160 |
if ((*iter)->GetVersion() < pHookMan->GetVersion()) |
|
pavolmarko@733
|
161 |
break; |
|
pavolmarko@733
|
162 |
} |
|
pavolmarko@733
|
163 |
|
|
pavolmarko@733
|
164 |
bool isBeginning = iter == m_HookMans.begin(); |
|
pavolmarko@733
|
165 |
|
|
pavolmarko@733
|
166 |
m_HookMans.insert(iter, pHookMan); |
|
pavolmarko@733
|
167 |
|
|
pavolmarko@733
|
168 |
if (isBeginning) |
|
pavolmarko@733
|
169 |
{ |
|
pavolmarko@733
|
170 |
pHookMan->IncrRef(this); |
|
pavolmarko@733
|
171 |
if (m_HookMans.size() > 1) |
|
pavolmarko@733
|
172 |
{ |
|
pavolmarko@733
|
173 |
// If another hookman was used until now but this one is better |
|
pavolmarko@733
|
174 |
// (which it is because it's the first -> it has a higher version) |
|
pavolmarko@733
|
175 |
// -> switch! |
|
pavolmarko@733
|
176 |
|
|
pavolmarko@733
|
177 |
List<CHookManager*>::iterator second = m_HookMans.begin(); |
|
pavolmarko@733
|
178 |
++second; |
|
pavolmarko@733
|
179 |
|
|
pavolmarko@733
|
180 |
(*second)->DecrRef(this); |
|
pavolmarko@733
|
181 |
} |
|
pavolmarko@733
|
182 |
|
|
pavolmarko@733
|
183 |
// Make sure that this vfnptr points at it |
|
pavolmarko@733
|
184 |
Patch(pHookMan->GetHookFunc()); |
|
pavolmarko@733
|
185 |
} |
|
pavolmarko@733
|
186 |
} |
|
pavolmarko@733
|
187 |
|
|
pavolmarko@733
|
188 |
bool CVfnPtr::HookManRemoved(CHookManager *pHookMan) |
|
pavolmarko@733
|
189 |
{ |
|
pavolmarko@733
|
190 |
// Don't accept invalid hook managers |
|
pavolmarko@733
|
191 |
if (!*pHookMan) |
|
pavolmarko@733
|
192 |
return true; |
|
pavolmarko@733
|
193 |
|
|
pavolmarko@733
|
194 |
List<CHookManager*>::iterator iter = m_HookMans.find(pHookMan); |
|
pavolmarko@733
|
195 |
if (iter == m_HookMans.end()) |
|
pavolmarko@733
|
196 |
return true; // Didn't exist here anyway |
|
pavolmarko@733
|
197 |
|
|
pavolmarko@733
|
198 |
if (iter == m_HookMans.begin()) |
|
pavolmarko@733
|
199 |
{ |
|
pavolmarko@733
|
200 |
// It is the first one! |
|
pavolmarko@733
|
201 |
pHookMan->DecrRef(this); |
|
pavolmarko@733
|
202 |
m_HookMans.erase(iter); |
|
pavolmarko@733
|
203 |
|
|
pavolmarko@733
|
204 |
if (m_HookMans.empty()) |
|
pavolmarko@733
|
205 |
return false; // No more hookmans -> let SH delete us |
|
pavolmarko@733
|
206 |
|
|
pavolmarko@733
|
207 |
// Activate second -> now first hookman |
|
pavolmarko@733
|
208 |
m_HookMans.front()->IncrRef(this); |
|
pavolmarko@733
|
209 |
Patch(m_HookMans.front()->GetHookFunc()); |
|
pavolmarko@733
|
210 |
} |
|
pavolmarko@733
|
211 |
else |
|
pavolmarko@733
|
212 |
{ |
|
pavolmarko@733
|
213 |
m_HookMans.erase(iter); |
|
pavolmarko@733
|
214 |
} |
|
pavolmarko@733
|
215 |
return true; |
|
pavolmarko@733
|
216 |
} |
|
pavolmarko@733
|
217 |
|
|
pavolmarko@733
|
218 |
bool CVfnPtr::Patch(void *newValue) |
|
pavolmarko@733
|
219 |
{ |
|
dvander@767
|
220 |
if (!MakePageWritable(m_Ptr)) |
|
pavolmarko@733
|
221 |
{ |
|
pavolmarko@733
|
222 |
return false; |
|
pavolmarko@733
|
223 |
} |
|
pavolmarko@733
|
224 |
|
|
pavolmarko@733
|
225 |
*reinterpret_cast<void**>(m_Ptr) = newValue; |
|
pavolmarko@733
|
226 |
|
|
pavolmarko@733
|
227 |
return true; |
|
pavolmarko@733
|
228 |
} |
|
pavolmarko@733
|
229 |
|
|
pavolmarko@733
|
230 |
CIface &CVfnPtr::GetIface(void *iface) |
|
pavolmarko@733
|
231 |
{ |
|
pavolmarko@733
|
232 |
List<CIface>::iterator iter = m_IfaceList.find(iface); |
|
pavolmarko@733
|
233 |
if (iter == m_IfaceList.end()) |
|
pavolmarko@733
|
234 |
{ |
|
pavolmarko@733
|
235 |
CIface newIface(iface); |
|
pavolmarko@733
|
236 |
if (iface == NULL) |
|
pavolmarko@733
|
237 |
{ |
|
pavolmarko@733
|
238 |
m_IfaceList.push_front(newIface); |
|
pavolmarko@733
|
239 |
return m_IfaceList.front(); |
|
pavolmarko@733
|
240 |
} |
|
pavolmarko@733
|
241 |
else |
|
pavolmarko@733
|
242 |
{ |
|
pavolmarko@733
|
243 |
m_IfaceList.push_back(newIface); |
|
pavolmarko@733
|
244 |
return m_IfaceList.back(); |
|
pavolmarko@733
|
245 |
} |
|
pavolmarko@733
|
246 |
} |
|
pavolmarko@733
|
247 |
else |
|
pavolmarko@733
|
248 |
{ |
|
pavolmarko@733
|
249 |
return *iter; |
|
pavolmarko@733
|
250 |
} |
|
pavolmarko@733
|
251 |
} |
|
pavolmarko@733
|
252 |
} |
|
pavolmarko@733
|
253 |
} |