pavolmarko@58: /* ======== SourceHook ======== pavolmarko@58: * Copyright (C) 2004-2005 Metamod:Source Development Team pavolmarko@58: * No warranties of any kind pavolmarko@58: * pavolmarko@58: * License: zlib/libpng pavolmarko@58: * pavolmarko@58: * Author(s): Pavol "PM OnoTo" Marko pavolmarko@58: * ============================ pavolmarko@58: */ pavolmarko@58: pavolmarko@58: /** pavolmarko@58: * @brief This file provides a way for getting information about a member function. pavolmarko@58: * @file sh_memfuncinfo.h pavolmarko@58: */ pavolmarko@58: pavolmarko@58: #ifndef __SHINT_MEMFUNC_INFO_H__ pavolmarko@58: #define __SHINT_MEMFUNC_INFO_H__ pavolmarko@58: pavolmarko@58: namespace SourceHook pavolmarko@58: { pavolmarko@58: pavolmarko@58: // Don Clugston: pavolmarko@58: // implicit_cast< > pavolmarko@58: // I believe this was originally going to be in the C++ standard but pavolmarko@58: // was left out by accident. It's even milder than static_cast. pavolmarko@58: // I use it instead of static_cast<> to emphasize that I'm not doing pavolmarko@58: // anything nasty. pavolmarko@58: // Usage is identical to static_cast<> pavolmarko@58: template pavolmarko@58: inline OutputClass implicit_cast(InputClass input){ pavolmarko@58: return input; pavolmarko@58: } pavolmarko@58: pavolmarko@58: pavolmarko@58: struct MemFuncInfo pavolmarko@58: { pavolmarko@58: bool isVirtual; // Is the function virtual? pavolmarko@58: int thisptroffs; // The this pointer the function expects to be called with pavolmarko@58: // If -1, you need to call the GetFuncInfo_GetThisPtr function pavolmarko@58: int vtblindex; // The function's index in the vtable (0-based, 1=second entry, 2=third entry, ...) pavolmarko@58: int vtbloffs; // The vtable pointer pavolmarko@58: }; pavolmarko@58: pavolmarko@58: // Ideas by Don Clugston. pavolmarko@58: // Check out his excellent paper: http://www.codeproject.com/cpp/FastDelegate.asp pavolmarko@58: pavolmarko@58: template struct MFI_Impl pavolmarko@58: { pavolmarko@58: template static inline void GetFuncInfo(MFP *mfp, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: static char weird_memfunc_pointer_exclamation_mark_arrow_error[N-1000]; pavolmarko@58: } pavolmarko@58: }; pavolmarko@58: pavolmarko@58: # if SH_COMP == SH_COMP_GCC pavolmarko@58: pavolmarko@58: template<> struct MFI_Impl<8> // All of these have size==8 pavolmarko@58: { pavolmarko@58: struct GCC_MemFunPtr pavolmarko@58: { pavolmarko@58: union pavolmarko@58: { pavolmarko@58: void *funcadr; // always even pavolmarko@58: int vtable_index_plus1; // = vindex+1, always odd pavolmarko@58: }; pavolmarko@58: int delta; pavolmarko@58: }; pavolmarko@58: template static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: GCC_MemFunPtr *mfp_detail = (GCC_MemFunPtr*)&mfp; pavolmarko@58: out.thisptroffs = mfp_detail->delta; pavolmarko@58: if (mfp_detail->vtable_index_plus1 & 1) pavolmarko@58: { pavolmarko@58: out.vtblindex = (mfp_detail->vtable_index_plus1 - 1) / 4; pavolmarko@58: out.vtbloffs = 0; pavolmarko@58: out.isVirtual = true; pavolmarko@58: } pavolmarko@58: else pavolmarko@58: out.isVirtual = false; pavolmarko@58: } pavolmarko@58: }; pavolmarko@58: pavolmarko@58: # elif SH_COMP == SH_COMP_MSVC pavolmarko@58: pavolmarko@58: namespace pavolmarko@58: { pavolmarko@58: int MFI_GetVtblOffset(void *mfp) pavolmarko@58: { pavolmarko@58: unsigned char *addr = (unsigned char*)mfp; pavolmarko@58: if (*addr == 0xE9) // Jmp pavolmarko@58: { pavolmarko@58: // May or may not be! pavolmarko@58: // Check where it'd jump pavolmarko@58: addr += 5 /*size of the instruction*/ + *(unsigned long*)(addr + 1); pavolmarko@58: } pavolmarko@58: pavolmarko@58: // Check whether it's a virtual function call pavolmarko@58: // They look like this: pavolmarko@58: // 004125A0 8B 01 mov eax,dword ptr [ecx] pavolmarko@58: // 004125A2 FF 60 04 jmp dword ptr [eax+4] pavolmarko@58: // ==OR== pavolmarko@58: // 00411B80 8B 01 mov eax,dword ptr [ecx] pavolmarko@58: // 00411B82 FF A0 18 03 00 00 jmp dword ptr [eax+318h] pavolmarko@58: pavolmarko@58: // However, for vararg functions, they look like this: pavolmarko@58: // 0048F0B0 8B 44 24 04 mov eax,dword ptr [esp+4] pavolmarko@58: // 0048F0B4 8B 00 mov eax,dword ptr [eax] pavolmarko@58: // 0048F0B6 FF 60 08 jmp dword ptr [eax+8] pavolmarko@58: // ==OR== pavolmarko@58: // 0048F0B0 8B 44 24 04 mov eax,dword ptr [esp+4] pavolmarko@58: // 0048F0B4 8B 00 mov eax,dword ptr [eax] pavolmarko@58: // 00411B82 FF A0 18 03 00 00 jmp dword ptr [eax+318h] pavolmarko@58: pavolmarko@58: // With varargs, the this pointer is passed as if it was the first argument pavolmarko@58: pavolmarko@58: bool ok = false; pavolmarko@58: if (addr[0] == 0x8B && addr[1] == 0x44 && addr[2] == 0x24 && addr[3] == 0x04 && pavolmarko@58: addr[4] == 0x8B && addr[5] == 0x00) pavolmarko@58: { pavolmarko@58: addr += 6; pavolmarko@58: ok = true; pavolmarko@58: } pavolmarko@58: else if (addr[0] == 0x8B && addr[1] == 0x01) pavolmarko@58: { pavolmarko@58: addr += 2; pavolmarko@58: ok = true; pavolmarko@58: } pavolmarko@58: if (!ok) pavolmarko@58: return -1; pavolmarko@58: pavolmarko@58: if (*addr++ == 0xFF) pavolmarko@58: { pavolmarko@58: if (*addr == 0x60) pavolmarko@58: { pavolmarko@58: return *++addr / 4; pavolmarko@58: } pavolmarko@58: else if (*addr == 0xA0) pavolmarko@58: { pavolmarko@58: return *((unsigned int*)++addr) / 4; pavolmarko@58: } pavolmarko@58: else if (*addr == 0x20) pavolmarko@58: return 0; pavolmarko@58: else pavolmarko@58: return -1; pavolmarko@58: } pavolmarko@58: return -1; pavolmarko@58: } pavolmarko@58: } pavolmarko@58: pavolmarko@58: template<> struct MFI_Impl<4> // simple ones pavolmarko@58: { pavolmarko@58: template static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); pavolmarko@58: out.isVirtual = out.vtblindex >= 0 ? true : false; pavolmarko@58: out.thisptroffs = 0; pavolmarko@58: out.vtbloffs = 0; pavolmarko@58: } pavolmarko@58: }; pavolmarko@58: pavolmarko@58: template<> struct MFI_Impl<8> // more complicated ones! pavolmarko@58: { pavolmarko@58: struct MSVC_MemFunPtr2 pavolmarko@58: { pavolmarko@58: void *funcadr; pavolmarko@58: int delta; pavolmarko@58: }; pavolmarko@58: template static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); pavolmarko@58: out.isVirtual = out.vtblindex >= 0 ? true : false; pavolmarko@58: out.thisptroffs = reinterpret_cast(&mfp)->delta; pavolmarko@58: out.vtbloffs = 0; pavolmarko@58: } pavolmarko@58: }; pavolmarko@58: pavolmarko@58: // By Don Clugston, adapted pavolmarko@58: template<> struct MFI_Impl<12> // WOW IT"S GETTING BIGGER OMGOMOGMG pavolmarko@58: { pavolmarko@58: class __single_inheritance GenericClass; pavolmarko@58: class GenericClass {}; pavolmarko@58: pavolmarko@58: struct MicrosoftVirtualMFP { pavolmarko@58: void (GenericClass::*codeptr)(); // points to the actual member function pavolmarko@58: int delta; // #bytes to be added to the 'this' pointer pavolmarko@58: int vtable_index; // or 0 if no virtual inheritance pavolmarko@58: }; pavolmarko@58: pavolmarko@58: struct GenericVirtualClass : virtual public GenericClass pavolmarko@58: { pavolmarko@58: typedef GenericVirtualClass * (GenericVirtualClass::*ProbePtrType)(); pavolmarko@58: GenericVirtualClass * GetThis() { return this; } pavolmarko@58: }; pavolmarko@58: pavolmarko@58: template static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); pavolmarko@58: out.isVirtual = out.vtblindex >= 0 ? true : false; pavolmarko@58: // This pointer pavolmarko@58: /* pavolmarko@58: union { pavolmarko@58: MFP func; pavolmarko@58: GenericClass* (T::*ProbeFunc)(); pavolmarko@58: MicrosoftVirtualMFP s; pavolmarko@58: } u; pavolmarko@58: u.func = mfp; pavolmarko@58: union { pavolmarko@58: GenericVirtualClass::ProbePtrType virtfunc; pavolmarko@58: MicrosoftVirtualMFP s; pavolmarko@58: } u2; pavolmarko@58: pavolmarko@58: // Check that the horrible_cast<>s will work pavolmarko@58: typedef int ERROR_CantUsehorrible_cast[sizeof(mfp)==sizeof(u.s) pavolmarko@58: && sizeof(mfp)==sizeof(u.ProbeFunc) pavolmarko@58: && sizeof(u2.virtfunc)==sizeof(u2.s) ? 1 : -1]; pavolmarko@58: // Unfortunately, taking the address of a MF prevents it from being inlined, so pavolmarko@58: // this next line can't be completely optimised away by the compiler. pavolmarko@58: u2.virtfunc = &GenericVirtualClass::GetThis; pavolmarko@58: u.s.codeptr = u2.s.codeptr; pavolmarko@58: out.thisptroffs = (reinterpret_cast(NULL)->*u.ProbeFunc)(); pavolmarko@58: */ pavolmarko@58: out.thisptroffs = -1; pavolmarko@58: out.vtbloffs = 0; pavolmarko@58: } pavolmarko@58: }; pavolmarko@58: pavolmarko@58: // Don: Nasty hack for Microsoft and Intel (IA32 and Itanium) pavolmarko@58: // unknown_inheritance classes go here pavolmarko@58: // This is probably the ugliest bit of code I've ever written. Look at the casts! pavolmarko@58: // There is a compiler bug in MSVC6 which prevents it from using this code. pavolmarko@58: template<> struct MFI_Impl<16> // THE BIGGEST ONE!!!1GABEN pavolmarko@58: { pavolmarko@58: template static inline void GetFuncInfo(MFP mfp, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: out.vtblindex = MFI_GetVtblOffset(*(void**)&mfp); pavolmarko@58: out.isVirtual = out.vtblindex >= 0 ? true : false; pavolmarko@58: pavolmarko@58: // The member function pointer is 16 bytes long. We can't use a normal cast, but pavolmarko@58: // we can use a union to do the conversion. pavolmarko@58: union { pavolmarko@58: MFP func; pavolmarko@58: // In VC++ and ICL, an unknown_inheritance member pointer pavolmarko@58: // is internally defined as: pavolmarko@58: struct { pavolmarko@58: void *m_funcaddress; // points to the actual member function pavolmarko@58: int delta; // #bytes to be added to the 'this' pointer pavolmarko@58: int vtordisp; // #bytes to add to 'this' to find the vtable pavolmarko@58: int vtable_index; // or 0 if no virtual inheritance pavolmarko@58: } s; pavolmarko@58: } u; pavolmarko@58: // Check that the horrible_cast will work pavolmarko@58: typedef int ERROR_CantUsehorrible_cast[sizeof(u.func)==sizeof(u.s)? 1 : -1]; pavolmarko@58: u.func = mfp; pavolmarko@58: int virtual_delta = 0; pavolmarko@58: if (u.s.vtable_index) { // Virtual inheritance is used pavolmarko@58: /* pavolmarko@58: // First, get to the vtable. pavolmarko@58: // It is 'vtordisp' bytes from the start of the class. pavolmarko@58: int * vtable = *reinterpret_cast( pavolmarko@58: reinterpret_cast(thisptr) + u.s.vtordisp ); pavolmarko@58: pavolmarko@58: // 'vtable_index' tells us where in the table we should be looking. pavolmarko@58: virtual_delta = u.s.vtordisp + *reinterpret_cast( pavolmarko@58: reinterpret_cast(vtable) + u.s.vtable_index); pavolmarko@58: // The int at 'virtual_delta' gives us the amount to add to 'this'. pavolmarko@58: // Finally we can add the three components together. Phew! pavolmarko@58: out.thisptr = reinterpret_cast( pavolmarko@58: reinterpret_cast(thisptr) + u.s.delta + virtual_delta); pavolmarko@58: */ pavolmarko@58: out.vtbloffs = u.s.vtordisp; pavolmarko@58: out.thisptroffs = -1; pavolmarko@58: } pavolmarko@58: else pavolmarko@58: { pavolmarko@58: out.vtbloffs = out.vtblindex < 0 ? 0 : u.s.delta; pavolmarko@58: out.thisptroffs = u.s.delta; pavolmarko@58: } pavolmarko@58: }; pavolmarko@58: }; pavolmarko@58: # else pavolmarko@58: # error Unsupported compiler pavolmarko@58: # endif pavolmarko@58: pavolmarko@58: // This version does not take a this pointer pavolmarko@58: // Useful for hookdecls, as they ensure that mfp is correct through a static_cast pavolmarko@58: template inline void GetFuncInfo(X mfp, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: MFI_Impl::GetFuncInfo(mfp, out); pavolmarko@58: } pavolmarko@58: pavolmarko@58: // Versions which do take a this pavolmarko@58: @VARARGS@ pavolmarko@58: template pavolmarko@58: inline void GetFuncInfo(Y *ptr, RetType(X::*mfp)(@Param%%|, @), MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: RetType(Y::*mfp2)(@Param%%|, @) = mfp; pavolmarko@58: MFI_Impl::GetFuncInfo(mfp2, out); pavolmarko@58: } pavolmarko@58: pavolmarko@58: template pavolmarko@58: inline void GetFuncInfo(Y *ptr, RetType(X::*mfp)(@Param%%|, @) const, MemFuncInfo &out) pavolmarko@58: { pavolmarko@58: RetType(Y::*mfp2)(@Param%%|, @) const = mfp; pavolmarko@58: MFI_Impl::GetFuncInfo(mfp2, out); pavolmarko@58: } pavolmarko@58: pavolmarko@58: @ENDARGS@ pavolmarko@59: pavolmarko@59: // GCC needs this, MSVC doesn't like them pavolmarko@59: #if SH_COMP != SH_COMP_MSVC pavolmarko@59: pavolmarko@59: @VARARGS@ pavolmarko@59: template pavolmarko@59: inline void GetFuncInfo(Y *ptr, RetType(X::*mfp)(@Param%%|, @@, @...), MemFuncInfo &out) pavolmarko@59: { pavolmarko@59: RetType(Y::*mfp2)(@Param%%|, @@, @...) = mfp; pavolmarko@59: MFI_Impl::GetFuncInfo(mfp2, out); pavolmarko@59: } pavolmarko@59: pavolmarko@59: template pavolmarko@59: inline void GetFuncInfo(Y *ptr, RetType(X::*mfp)(@Param%%|, @@, @...) const, MemFuncInfo &out) pavolmarko@59: { pavolmarko@59: RetType(Y::*mfp2)(@Param%%|, @@, @...) const = mfp; pavolmarko@59: MFI_Impl::GetFuncInfo(mfp2, out); pavolmarko@59: } pavolmarko@59: pavolmarko@59: @ENDARGS@ pavolmarko@59: pavolmarko@59: #endif pavolmarko@59: pavolmarko@58: } pavolmarko@58: pavolmarko@58: #endif pavolmarko@58: