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