|
pavolmarko@1
|
1 |
/* ======== SourceHook ======== |
|
dvander@10
|
2 |
* Copyright (C) 2004-2005 Metamod:Source Development Team |
|
pavolmarko@1
|
3 |
* No warranties of any kind |
|
pavolmarko@1
|
4 |
* |
|
dvander@10
|
5 |
* License: zlib/libpng |
|
dvander@10
|
6 |
* |
|
dvander@10
|
7 |
* Author(s): Pavol "PM OnoTo" Marko |
|
pavolmarko@1
|
8 |
* ============================ |
|
pavolmarko@1
|
9 |
*/ |
|
pavolmarko@1
|
10 |
|
|
dvander@10
|
11 |
/** |
|
dvander@10
|
12 |
* @brief This file provides a way for getting information about a member function. |
|
dvander@10
|
13 |
* @file sh_memfuncinfo.h |
|
dvander@10
|
14 |
*/ |
|
pavolmarko@1
|
15 |
|
|
pavolmarko@1
|
16 |
#ifndef __SHINT_MEMFUNC_INFO_H__ |
|
pavolmarko@1
|
17 |
#define __SHINT_MEMFUNC_INFO_H__ |
|
pavolmarko@1
|
18 |
|
|
pavolmarko@1
|
19 |
namespace SourceHook |
|
pavolmarko@1
|
20 |
{ |
|
pavolmarko@1
|
21 |
|
|
pavolmarko@1
|
22 |
// Don Clugston: |
|
pavolmarko@1
|
23 |
// implicit_cast< > |
|
pavolmarko@1
|
24 |
// I believe this was originally going to be in the C++ standard but |
|
pavolmarko@1
|
25 |
// was left out by accident. It's even milder than static_cast. |
|
pavolmarko@1
|
26 |
// I use it instead of static_cast<> to emphasize that I'm not doing |
|
pavolmarko@1
|
27 |
// anything nasty. |
|
pavolmarko@1
|
28 |
// Usage is identical to static_cast<> |
|
pavolmarko@1
|
29 |
template <class OutputClass, class InputClass> |
|
pavolmarko@1
|
30 |
inline OutputClass implicit_cast(InputClass input){ |
|
pavolmarko@1
|
31 |
return input; |
|
pavolmarko@1
|
32 |
} |
|
pavolmarko@1
|
33 |
|
|
pavolmarko@1
|
34 |
|
|
pavolmarko@1
|
35 |
struct MemFuncInfo |
|
pavolmarko@1
|
36 |
{ |
|
pavolmarko@1
|
37 |
bool isVirtual; // Is the function virtual? |
|
pavolmarko@1
|
38 |
int thisptroffs; // The this pointer the function expects to be called with |
|
pavolmarko@1
|
39 |
// If -1, you need to call the GetFuncInfo_GetThisPtr function |
|
pavolmarko@1
|
40 |
int vtblindex; // The function's index in the vtable (0-based, 1=second entry, 2=third entry, ...) |
|
pavolmarko@1
|
41 |
int vtbloffs; // The vtable pointer |
|
pavolmarko@1
|
42 |
}; |
|
pavolmarko@1
|
43 |
|
|
pavolmarko@1
|
44 |
// Ideas by Don Clugston. |
|
pavolmarko@1
|
45 |
// Check out his excellent paper: http://www.codeproject.com/cpp/FastDelegate.asp |
|
pavolmarko@1
|
46 |
|
|
pavolmarko@1
|
47 |
template<int N> struct MFI_Impl |
|
pavolmarko@1
|
48 |
{ |
|
pavolmarko@1
|
49 |
template<class MFP> static inline void GetFuncInfo(MFP *mfp, MemFuncInfo &out) |
|
pavolmarko@1
|
50 |
{ |
|
pavolmarko@1
|
51 |
static char weird_memfunc_pointer_exclamation_mark_arrow_error[N-1000]; |
|
pavolmarko@1
|
52 |
} |
|
pavolmarko@1
|
53 |
}; |
|
pavolmarko@1
|
54 |
|
|
pavolmarko@1
|
55 |
# if SH_COMP == SH_COMP_GCC |
|
pavolmarko@1
|
56 |
|
|
pavolmarko@1
|
57 |
template<> struct MFI_Impl<8> // All of these have size==8 |
|
pavolmarko@1
|
58 |
{ |
|
pavolmarko@1
|
59 |
struct GCC_MemFunPtr |
|
pavolmarko@1
|
60 |
{ |
|
pavolmarko@1
|
61 |
union |
|
pavolmarko@1
|
62 |
{ |
|
pavolmarko@1
|
63 |
void *funcadr; // always even |
|
pavolmarko@1
|
64 |
int vtable_index_plus1; // = vindex+1, always odd |
|
pavolmarko@1
|
65 |
}; |
|
pavolmarko@1
|
66 |
int delta; |
|
pavolmarko@1
|
67 |
}; |
|
dvander@37
|
68 |
template<class MFP> static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) |
|
pavolmarko@1
|
69 |
{ |
|
dvander@37
|
70 |
GCC_MemFunPtr *mfp_detail = (GCC_MemFunPtr*)&mfp; |
|
pavolmarko@1
|
71 |
out.thisptroffs = mfp_detail->delta; |
|
pavolmarko@1
|
72 |
if (mfp_detail->vtable_index_plus1 & 1) |
|
pavolmarko@1
|
73 |
{ |
|
pavolmarko@1
|
74 |
out.vtblindex = (mfp_detail->vtable_index_plus1 - 1) / 4; |
|
pavolmarko@1
|
75 |
out.vtbloffs = 0; |
|
pavolmarko@1
|
76 |
out.isVirtual = true; |
|
pavolmarko@1
|
77 |
} |
|
pavolmarko@1
|
78 |
else |
|
pavolmarko@1
|
79 |
out.isVirtual = false; |
|
pavolmarko@1
|
80 |
} |
|
pavolmarko@1
|
81 |
}; |
|
pavolmarko@1
|
82 |
|
|
pavolmarko@1
|
83 |
# elif SH_COMP == SH_COMP_MSVC |
|
pavolmarko@1
|
84 |
|
|
pavolmarko@1
|
85 |
namespace |
|
pavolmarko@1
|
86 |
{ |
|
pavolmarko@1
|
87 |
int MFI_GetVtblOffset(void *mfp) |
|
pavolmarko@1
|
88 |
{ |
|
pavolmarko@1
|
89 |
unsigned char *addr = (unsigned char*)mfp; |
|
pavolmarko@1
|
90 |
if (*addr == 0xE9) // Jmp |
|
pavolmarko@1
|
91 |
{ |
|
pavolmarko@1
|
92 |
// May or may not be! |
|
pavolmarko@1
|
93 |
// Check where it'd jump |
|
pavolmarko@1
|
94 |
addr += 5 /*size of the instruction*/ + *(unsigned long*)(addr + 1); |
|
pavolmarko@1
|
95 |
} |
|
pavolmarko@1
|
96 |
|
|
pavolmarko@1
|
97 |
// Check whether it's a virtual function call |
|
pavolmarko@1
|
98 |
// They look like this: |
|
pavolmarko@1
|
99 |
// 004125A0 8B 01 mov eax,dword ptr [ecx] |
|
pavolmarko@1
|
100 |
// 004125A2 FF 60 04 jmp dword ptr [eax+4] |
|
pavolmarko@1
|
101 |
// ==OR== |
|
pavolmarko@1
|
102 |
// 00411B80 8B 01 mov eax,dword ptr [ecx] |
|
pavolmarko@1
|
103 |
// 00411B82 FF A0 18 03 00 00 jmp dword ptr [eax+318h] |
|
pavolmarko@1
|
104 |
if (*addr++ == 0x8B && *addr++ == 0x01 && *addr++ == 0xFF) |
|
pavolmarko@1
|
105 |
{ |
|
pavolmarko@1
|
106 |
if (*addr == 0x60) |
|
pavolmarko@1
|
107 |
{ |
|
pavolmarko@1
|
108 |
return *++addr / 4; |
|
pavolmarko@1
|
109 |
} |
|
pavolmarko@1
|
110 |
else if (*addr == 0xA0) |
|
pavolmarko@1
|
111 |
{ |
|
pavolmarko@1
|
112 |
return *((unsigned int*)++addr) / 4; |
|
pavolmarko@1
|
113 |
} |
|
pavolmarko@1
|
114 |
else if (*addr == 0x20) |
|
pavolmarko@1
|
115 |
return 0; |
|
pavolmarko@1
|
116 |
else |
|
pavolmarko@1
|
117 |
return -1; |
|
pavolmarko@1
|
118 |
} |
|
pavolmarko@1
|
119 |
return -1; |
|
pavolmarko@1
|
120 |
} |
|
pavolmarko@1
|
121 |
} |
|
pavolmarko@1
|
122 |
|
|
pavolmarko@1
|
123 |
template<> struct MFI_Impl<4> // simple ones |
|
pavolmarko@1
|
124 |
{ |
|
pavolmarko@1
|
125 |
template<class MFP> static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) |
|
pavolmarko@1
|
126 |
{ |
|
pavolmarko@1
|
127 |
out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); |
|
pavolmarko@1
|
128 |
out.isVirtual = out.vtblindex >= 0 ? true : false; |
|
pavolmarko@1
|
129 |
out.thisptroffs = 0; |
|
pavolmarko@1
|
130 |
out.vtbloffs = 0; |
|
pavolmarko@1
|
131 |
} |
|
pavolmarko@1
|
132 |
}; |
|
pavolmarko@1
|
133 |
|
|
pavolmarko@1
|
134 |
template<> struct MFI_Impl<8> // more complicated ones! |
|
pavolmarko@1
|
135 |
{ |
|
pavolmarko@1
|
136 |
struct MSVC_MemFunPtr2 |
|
pavolmarko@1
|
137 |
{ |
|
pavolmarko@1
|
138 |
void *funcadr; |
|
pavolmarko@1
|
139 |
int delta; |
|
pavolmarko@1
|
140 |
}; |
|
pavolmarko@1
|
141 |
template<class MFP> static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) |
|
pavolmarko@1
|
142 |
{ |
|
pavolmarko@1
|
143 |
out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); |
|
pavolmarko@1
|
144 |
out.isVirtual = out.vtblindex >= 0 ? true : false; |
|
pavolmarko@3
|
145 |
out.thisptroffs = reinterpret_cast<MSVC_MemFunPtr2*>(&mfp)->delta; |
|
pavolmarko@1
|
146 |
out.vtbloffs = 0; |
|
pavolmarko@1
|
147 |
} |
|
pavolmarko@1
|
148 |
}; |
|
pavolmarko@1
|
149 |
|
|
pavolmarko@1
|
150 |
// By Don Clugston, adapted |
|
pavolmarko@1
|
151 |
template<> struct MFI_Impl<12> // WOW IT"S GETTING BIGGER OMGOMOGMG |
|
pavolmarko@1
|
152 |
{ |
|
pavolmarko@1
|
153 |
class __single_inheritance GenericClass; |
|
pavolmarko@1
|
154 |
class GenericClass {}; |
|
pavolmarko@1
|
155 |
|
|
pavolmarko@1
|
156 |
struct MicrosoftVirtualMFP { |
|
pavolmarko@1
|
157 |
void (GenericClass::*codeptr)(); // points to the actual member function |
|
pavolmarko@1
|
158 |
int delta; // #bytes to be added to the 'this' pointer |
|
pavolmarko@1
|
159 |
int vtable_index; // or 0 if no virtual inheritance |
|
pavolmarko@1
|
160 |
}; |
|
pavolmarko@1
|
161 |
|
|
pavolmarko@1
|
162 |
struct GenericVirtualClass : virtual public GenericClass |
|
pavolmarko@1
|
163 |
{ |
|
pavolmarko@1
|
164 |
typedef GenericVirtualClass * (GenericVirtualClass::*ProbePtrType)(); |
|
pavolmarko@1
|
165 |
GenericVirtualClass * GetThis() { return this; } |
|
pavolmarko@1
|
166 |
}; |
|
pavolmarko@1
|
167 |
|
|
pavolmarko@1
|
168 |
template<class MFP> static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) |
|
pavolmarko@1
|
169 |
{ |
|
pavolmarko@1
|
170 |
out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); |
|
pavolmarko@1
|
171 |
out.isVirtual = out.vtblindex >= 0 ? true : false; |
|
pavolmarko@1
|
172 |
// This pointer |
|
pavolmarko@3
|
173 |
/* |
|
pavolmarko@1
|
174 |
union { |
|
pavolmarko@1
|
175 |
MFP func; |
|
pavolmarko@1
|
176 |
GenericClass* (T::*ProbeFunc)(); |
|
pavolmarko@1
|
177 |
MicrosoftVirtualMFP s; |
|
pavolmarko@1
|
178 |
} u; |
|
pavolmarko@1
|
179 |
u.func = mfp; |
|
pavolmarko@1
|
180 |
union { |
|
pavolmarko@1
|
181 |
GenericVirtualClass::ProbePtrType virtfunc; |
|
pavolmarko@1
|
182 |
MicrosoftVirtualMFP s; |
|
pavolmarko@1
|
183 |
} u2; |
|
pavolmarko@1
|
184 |
|
|
pavolmarko@1
|
185 |
// Check that the horrible_cast<>s will work |
|
pavolmarko@1
|
186 |
typedef int ERROR_CantUsehorrible_cast[sizeof(mfp)==sizeof(u.s) |
|
pavolmarko@1
|
187 |
&& sizeof(mfp)==sizeof(u.ProbeFunc) |
|
pavolmarko@1
|
188 |
&& sizeof(u2.virtfunc)==sizeof(u2.s) ? 1 : -1]; |
|
pavolmarko@1
|
189 |
// Unfortunately, taking the address of a MF prevents it from being inlined, so |
|
pavolmarko@1
|
190 |
// this next line can't be completely optimised away by the compiler. |
|
pavolmarko@1
|
191 |
u2.virtfunc = &GenericVirtualClass::GetThis; |
|
pavolmarko@1
|
192 |
u.s.codeptr = u2.s.codeptr; |
|
pavolmarko@1
|
193 |
out.thisptroffs = (reinterpret_cast<T*>(NULL)->*u.ProbeFunc)(); |
|
pavolmarko@3
|
194 |
*/ |
|
pavolmarko@3
|
195 |
out.thisptroffs = -1; |
|
pavolmarko@1
|
196 |
out.vtbloffs = 0; |
|
pavolmarko@1
|
197 |
} |
|
pavolmarko@1
|
198 |
}; |
|
pavolmarko@1
|
199 |
|
|
pavolmarko@1
|
200 |
// Don: Nasty hack for Microsoft and Intel (IA32 and Itanium) |
|
pavolmarko@1
|
201 |
// unknown_inheritance classes go here |
|
pavolmarko@1
|
202 |
// This is probably the ugliest bit of code I've ever written. Look at the casts! |
|
pavolmarko@1
|
203 |
// There is a compiler bug in MSVC6 which prevents it from using this code. |
|
pavolmarko@1
|
204 |
template<> struct MFI_Impl<16> // THE BIGGEST ONE!!!1GABEN |
|
pavolmarko@1
|
205 |
{ |
|
pavolmarko@1
|
206 |
template<class MFP> static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) |
|
pavolmarko@1
|
207 |
{ |
|
pavolmarko@1
|
208 |
out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); |
|
pavolmarko@1
|
209 |
out.isVirtual = out.vtblindex >= 0 ? true : false; |
|
pavolmarko@1
|
210 |
|
|
pavolmarko@1
|
211 |
// The member function pointer is 16 bytes long. We can't use a normal cast, but |
|
pavolmarko@1
|
212 |
// we can use a union to do the conversion. |
|
pavolmarko@1
|
213 |
union { |
|
pavolmarko@1
|
214 |
MFP func; |
|
pavolmarko@1
|
215 |
// In VC++ and ICL, an unknown_inheritance member pointer |
|
pavolmarko@1
|
216 |
// is internally defined as: |
|
pavolmarko@1
|
217 |
struct { |
|
pavolmarko@1
|
218 |
void *m_funcaddress; // points to the actual member function |
|
pavolmarko@1
|
219 |
int delta; // #bytes to be added to the 'this' pointer |
|
pavolmarko@1
|
220 |
int vtordisp; // #bytes to add to 'this' to find the vtable |
|
pavolmarko@1
|
221 |
int vtable_index; // or 0 if no virtual inheritance |
|
pavolmarko@1
|
222 |
} s; |
|
pavolmarko@1
|
223 |
} u; |
|
pavolmarko@1
|
224 |
// Check that the horrible_cast will work |
|
pavolmarko@1
|
225 |
typedef int ERROR_CantUsehorrible_cast[sizeof(u.func)==sizeof(u.s)? 1 : -1]; |
|
pavolmarko@1
|
226 |
u.func = mfp; |
|
pavolmarko@1
|
227 |
int virtual_delta = 0; |
|
pavolmarko@1
|
228 |
if (u.s.vtable_index) { // Virtual inheritance is used |
|
pavolmarko@1
|
229 |
/* |
|
pavolmarko@1
|
230 |
// First, get to the vtable. |
|
pavolmarko@1
|
231 |
// It is 'vtordisp' bytes from the start of the class. |
|
pavolmarko@1
|
232 |
int * vtable = *reinterpret_cast<int **>( |
|
pavolmarko@1
|
233 |
reinterpret_cast<char *>(thisptr) + u.s.vtordisp ); |
|
pavolmarko@1
|
234 |
|
|
pavolmarko@1
|
235 |
// 'vtable_index' tells us where in the table we should be looking. |
|
pavolmarko@1
|
236 |
virtual_delta = u.s.vtordisp + *reinterpret_cast<const int *>( |
|
pavolmarko@1
|
237 |
reinterpret_cast<const char *>(vtable) + u.s.vtable_index); |
|
pavolmarko@1
|
238 |
// The int at 'virtual_delta' gives us the amount to add to 'this'. |
|
pavolmarko@1
|
239 |
// Finally we can add the three components together. Phew! |
|
pavolmarko@1
|
240 |
out.thisptr = reinterpret_cast<void *>( |
|
pavolmarko@1
|
241 |
reinterpret_cast<char *>(thisptr) + u.s.delta + virtual_delta); |
|
pavolmarko@1
|
242 |
*/ |
|
pavolmarko@1
|
243 |
out.vtbloffs = u.s.vtordisp; |
|
pavolmarko@1
|
244 |
out.thisptroffs = -1; |
|
pavolmarko@1
|
245 |
} |
|
pavolmarko@1
|
246 |
else |
|
pavolmarko@1
|
247 |
{ |
|
pavolmarko@1
|
248 |
out.vtbloffs = out.vtblindex < 0 ? 0 : u.s.delta; |
|
pavolmarko@1
|
249 |
out.thisptroffs = u.s.delta; |
|
pavolmarko@1
|
250 |
} |
|
pavolmarko@1
|
251 |
}; |
|
pavolmarko@1
|
252 |
}; |
|
pavolmarko@1
|
253 |
# else |
|
pavolmarko@1
|
254 |
# error Unsupported compiler |
|
pavolmarko@1
|
255 |
# endif |
|
pavolmarko@1
|
256 |
|
|
pavolmarko@1
|
257 |
template<class X> inline void GetFuncInfo(X mfp, MemFuncInfo &out) |
|
pavolmarko@1
|
258 |
{ |
|
pavolmarko@1
|
259 |
MFI_Impl<sizeof(mfp)>::GetFuncInfo(mfp, out); |
|
pavolmarko@1
|
260 |
} |
|
pavolmarko@1
|
261 |
|
|
pavolmarko@1
|
262 |
} |
|
pavolmarko@1
|
263 |
|
|
dvander@34
|
264 |
#endif |
|
dvander@34
|
265 |
|