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