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