1 /* ======== SourceHook ========
2 * Copyright (C) 2004-2007 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): Pavol "PM OnoTo" Marko
8 * Contributor(s): Borja "faluco" Ferav (many thanks for assitance!)
9 * David "BAILOPAN" Anderson
10 * ============================
13 // recommended literature:
14 // http://www.cs.umbc.edu/~chang/cs313.s02/stack.shtml
15 // http://www.angelcode.com/dev/callconv/callconv.html
16 // http://www.arl.wustl.edu/~lockwood/class/cs306/books/artofasm/Chapter_6/CH06-1.html
18 #include "sourcehook_impl.h"
19 #include "sourcehook_hookmangen.h"
20 #include "sourcehook_hookmangen_x86.h"
21 #include "sh_memory.h"
22 #include <stdarg.h> // we might need the address of vsnprintf
24 #if SH_COMP == SH_COMP_MSVC
26 # define MSVC_ONLY(x) x
27 #elif SH_COMP == SH_COMP_GCC
28 # define GCC_ONLY(x) x
32 // :TODO: test BIG vtable indices
38 CPageAlloc GenBuffer::ms_Allocator;
41 jit_int32_t DownCastPtr(T ptr)
43 return reinterpret_cast<jit_int32_t>(ptr);
46 jit_uint32_t DownCastSize(size_t size)
48 return static_cast<jit_uint32_t>(size);
51 GenContext::GenContext(const ProtoInfo *proto, int vtbl_offs, int vtbl_idx, ISourceHook *pSHPtr)
52 : m_GeneratedPubFunc(NULL), m_OrigProto(proto), m_Proto(proto), m_VtblOffs(vtbl_offs),
53 m_VtblIdx(vtbl_idx), m_SHPtr(pSHPtr), m_pHI(NULL), m_HookfuncVfnptr(NULL), m_RegCounter(0)
56 m_HookfuncVfnptr = new void*;
57 m_BuiltPI = new ProtoInfo;
58 m_BuiltPI_Params = NULL;
59 m_BuiltPI_Params2 = NULL;
62 GenContext::~GenContext()
66 delete m_HookfuncVfnptr;
70 void GenContext::Clear()
76 delete m_BuiltPI_Params;
77 m_BuiltPI_Params = NULL;
79 if (m_BuiltPI_Params2)
81 delete m_BuiltPI_Params2;
82 m_BuiltPI_Params2 = NULL;
86 void GenContext::BuildProtoInfo()
88 m_BuiltPI->convention = m_Proto.GetConvention();
89 m_BuiltPI->numOfParams = m_Proto.GetNumOfParams();
91 m_BuiltPI->retPassInfo.size = m_Proto.GetRet().size;
92 m_BuiltPI->retPassInfo.type = m_Proto.GetRet().type;
93 m_BuiltPI->retPassInfo.flags = m_Proto.GetRet().flags;
94 m_BuiltPI->retPassInfo2.pNormalCtor = m_Proto.GetRet().pNormalCtor;
95 m_BuiltPI->retPassInfo2.pCopyCtor = m_Proto.GetRet().pCopyCtor;
96 m_BuiltPI->retPassInfo2.pDtor = m_Proto.GetRet().pDtor;
97 m_BuiltPI->retPassInfo2.pAssignOperator = m_Proto.GetRet().pAssignOperator;
100 delete m_BuiltPI_Params;
101 m_BuiltPI_Params = new PassInfo[m_BuiltPI->numOfParams + 1];
102 if (m_BuiltPI_Params2)
103 delete m_BuiltPI_Params2;
104 m_BuiltPI_Params2 = new PassInfo::V2Info[m_BuiltPI->numOfParams + 1];
106 m_BuiltPI_Params[0].size = 1; // Version 1
107 m_BuiltPI_Params[0].type = 0;
108 m_BuiltPI_Params[0].flags = 0;
110 for (int i = 0; i < m_Proto.GetNumOfParams(); ++i)
112 m_BuiltPI_Params[i+1].size = m_Proto.GetParam(i).size;
113 m_BuiltPI_Params[i+1].type = m_Proto.GetParam(i).type;
114 m_BuiltPI_Params[i+1].flags = m_Proto.GetParam(i).flags;
116 m_BuiltPI_Params2[i+1].pNormalCtor = m_Proto.GetParam(i).pNormalCtor;
117 m_BuiltPI_Params2[i+1].pCopyCtor = m_Proto.GetParam(i).pCopyCtor;
118 m_BuiltPI_Params2[i+1].pDtor = m_Proto.GetParam(i).pDtor;
119 m_BuiltPI_Params2[i+1].pAssignOperator = m_Proto.GetParam(i).pAssignOperator;
122 m_BuiltPI->paramsPassInfo = m_BuiltPI_Params;
123 m_BuiltPI->paramsPassInfo2 = m_BuiltPI_Params2;
126 jit_int32_t GenContext::GetRealSize(const IntPassInfo &info)
128 if (info.flags & PassInfo::PassFlag_ByRef)
132 return static_cast<jit_int32_t>(info.size);
135 // Computes size on the stack
136 jit_int32_t GenContext::GetStackSize(const IntPassInfo &info)
138 // Align up to 4 byte boundaries
139 jit_int32_t rs = GetRealSize(info);
141 rs = (rs & ~(3)) + 4;
145 jit_int8_t GenContext::NextRegEBX_ECX_EDX()
147 switch ((m_RegCounter++) % 3)
160 void GenContext::BitwiseCopy_Setup()
166 IA32_Cld(&m_HookFunc);
167 IA32_Push_Reg(&m_HookFunc, REG_EDI);
168 IA32_Push_Reg(&m_HookFunc, REG_ESI);
171 void GenContext::BitwiseCopy_Do(size_t size)
173 jit_uint32_t dwords = DownCastSize(size) / 4;
174 jit_uint32_t bytes = DownCastSize(size) % 4;
187 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_ECX, dwords);
188 IA32_Rep(&m_HookFunc);
189 IA32_Movsd(&m_HookFunc);
193 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_ECX, bytes);
194 IA32_Rep(&m_HookFunc);
195 IA32_Movsb(&m_HookFunc);
197 IA32_Pop_Reg(&m_HookFunc, REG_ESI);
198 IA32_Pop_Reg(&m_HookFunc, REG_EDI);
201 short GenContext::GetParamsStackSize()
204 for (int i = 0; i < m_Proto.GetNumOfParams(); ++i)
206 acc += GetStackSize(m_Proto.GetParam(i));
209 // Memory return: address is first param
210 if (m_Proto.GetRet().flags & PassInfo::PassFlag_RetMem)
213 // :TODO: cdecl: THIS POINTER AS FIRST PARAM!!!
218 short GenContext::GetForcedByRefParamOffset(int p)
221 for (int i = 0; i < p; ++i)
223 if (m_Proto.GetParam(i).flags & PassFlag_ForcedByRef)
224 off += GetStackSize(m_Proto.GetParam(i));
229 short GenContext::GetForcedByRefParamsSize()
231 return GetForcedByRefParamOffset(m_Proto.GetNumOfParams());
234 jit_int32_t GenContext::PushRef(jit_int32_t param_offset, const IntPassInfo &pi)
236 // push [ebp+<offset>]
237 IA32_Push_Rm_DispAuto(&m_HookFunc, REG_EBP, param_offset);
242 jit_int32_t GenContext::PushBasic(jit_int32_t param_offset, const IntPassInfo &pi)
250 SH_ASSERT(0, ("Unsupported!"));
253 reg = NextRegEBX_ECX_EDX();
254 //movzx reg, BYTE PTR [ebp+<offset>]
256 IA32_Movzx_Reg32_Rm8_DispAuto(&m_HookFunc, reg, REG_EBP, param_offset);
257 IA32_Push_Reg(&m_HookFunc, reg);
261 reg = NextRegEBX_ECX_EDX();
262 //movzx reg, WORD PTR [ebp+<offset>]
264 m_HookFunc.write_ubyte(IA32_16BIT_PREFIX);
265 IA32_Movzx_Reg32_Rm16_DispAuto(&m_HookFunc, reg, REG_EBP, param_offset);
266 IA32_Push_Reg(&m_HookFunc, reg);
270 reg = NextRegEBX_ECX_EDX();
271 //mov reg, DWORD PTR [ebp+<offset>]
273 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, reg, REG_EBP, param_offset);
274 IA32_Push_Reg(&m_HookFunc, reg);
278 reg = NextRegEBX_ECX_EDX();
279 reg2 = NextRegEBX_ECX_EDX();
280 //mov reg, DWORD PTR [ebp+<offset>+4]
281 //mov reg2, DWORD PTR [ebp+<offset>]
285 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, reg, REG_EBP, param_offset+4);
286 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, reg2, REG_EBP, param_offset);
287 IA32_Push_Reg(&m_HookFunc, reg);
288 IA32_Push_Reg(&m_HookFunc, reg2);
294 jit_int32_t GenContext::PushFloat(jit_int32_t param_offset, const IntPassInfo &pi)
299 SH_ASSERT(0, ("Unsupported!"));
302 //fld DWORD PTR [ebp+<offset>]
304 //fstp DWORD PTR [esp]
305 IA32_Fld_Mem32_DispAuto(&m_HookFunc, REG_EBP, param_offset);
306 IA32_Push_Reg(&m_HookFunc, NextRegEBX_ECX_EDX());
307 IA32_Fstp_Mem32_ESP(&m_HookFunc);
310 //fld QWORD PTR [ebp+<offset>]
312 //fstp QWORD PTR [esp]
313 IA32_Fld_Mem64_DispAuto(&m_HookFunc, REG_EBP, param_offset);
314 IA32_Sub_Rm_Imm8(&m_HookFunc, REG_ESP, 8, MOD_REG);
315 IA32_Fstp_Mem64_ESP(&m_HookFunc);
320 jit_int32_t GenContext::PushObject(jit_int32_t param_offset, const IntPassInfo &pi, jit_int32_t place_fbrr)
322 if ((pi.flags & PassFlag_ForcedByRef) == 0)
324 // make room on the stack
326 IA32_Sub_Rm_ImmAuto(&m_HookFunc, REG_ESP, GetStackSize(pi), MOD_REG);
329 // if there is a copy constructor..
334 // this= target addr = forcedbyref ? ebp+place_fbrr : esp+12
335 // call copy constructor
338 IA32_Push_Reg(&m_HookFunc, REG_EAX);
340 if (pi.flags & PassFlag_ForcedByRef)
341 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, place_fbrr);
343 IA32_Lea_Reg_DispRegMultImm8(&m_HookFunc, REG_ECX, REG_NOIDX, REG_ESP, NOSCALE, 4);
345 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EAX, REG_EBP, param_offset);
346 IA32_Push_Reg(&m_HookFunc, REG_EAX);
347 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
348 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EDX, DownCastPtr(pi.pCopyCtor));
349 IA32_Call_Reg(&m_HookFunc, REG_EDX);
350 GCC_ONLY(IA32_Add_Rm_ImmAuto(&m_HookFunc, REG_ESP, 2 * SIZE_PTR, MOD_REG));
351 IA32_Pop_Reg(&m_HookFunc, REG_EAX);
361 // lea edi, [ebp_place_fbrr]
363 // lea edi, [esp+8] - bc_setup pushed two regs onto the stack!
364 //lea esi, [ebp+<offs>]
365 if (pi.flags & PassFlag_ForcedByRef)
366 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EDI, REG_EBP, place_fbrr);
368 IA32_Lea_Reg_DispRegMultImm8(&m_HookFunc, REG_EDI, REG_NOIDX, REG_ESP, NOSCALE, 8);
370 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ESI, REG_EBP, param_offset);
372 BitwiseCopy_Do(pi.size);
375 // forcedref: push reference to ebp+place_fbrr
376 if (pi.flags & PassFlag_ForcedByRef)
378 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, place_fbrr);
379 IA32_Push_Reg(&m_HookFunc, REG_ECX);
383 return DownCastSize(pi.size);
386 void GenContext::DestroyParams(jit_int32_t fbrr_base)
388 for (int i = m_Proto.GetNumOfParams() - 1; i >= 0; --i)
390 const IntPassInfo &pi = m_Proto.GetParam(i);
391 if (pi.type == PassInfo::PassType_Object && (pi.flags & PassInfo::PassFlag_ODtor) &&
392 (pi.flags & PassInfo::PassFlag_ByVal) && (pi.flags & PassFlag_ForcedByRef))
394 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, fbrr_base + GetForcedByRefParamOffset(i));
395 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(pi.pDtor));
396 IA32_Call_Reg(&m_HookFunc, REG_EAX);
401 // May not touch eax!
402 jit_int32_t GenContext::PushParams(jit_int32_t param_base_offset, jit_int32_t save_ret_to, int v_place_for_memret,
403 jit_int32_t v_place_fbrr_base)
405 jit_int32_t added_to_stack = 0;
408 // compute the offset _after_ the last parameter
409 jit_int32_t cur_offset = param_base_offset;
410 for (int i = 0; i < m_Proto.GetNumOfParams(); ++i)
412 cur_offset += GetStackSize(m_Proto.GetParam(i));
415 // push parameters in reverse order
416 for (int i = m_Proto.GetNumOfParams() - 1; i >= 0; --i)
418 const IntPassInfo &pi = m_Proto.GetParam(i);
419 cur_offset -= GetStackSize(pi);
420 if (pi.flags & PassInfo::PassFlag_ByVal)
424 case PassInfo::PassType_Basic:
425 ret = PushBasic(cur_offset, pi);
427 case PassInfo::PassType_Float:
428 ret = PushFloat(cur_offset, pi);
430 case PassInfo::PassType_Object:
431 ret = PushObject(cur_offset, pi, v_place_fbrr_base + GetForcedByRefParamOffset(i));
435 else if (pi.flags & PassInfo::PassFlag_ByRef)
437 PushRef(cur_offset, pi);
441 SH_ASSERT(0, ("Unsupported!"));
443 added_to_stack += ret;
446 return added_to_stack;
449 // It is IMPORTANT that PushMemRetPtr doesn't touch ecx and eax
450 jit_int32_t GenContext::PushMemRetPtr(jit_int32_t save_ret_to, jit_int32_t v_place_for_memret)
452 // Memory return support
453 if (m_Proto.GetRet().flags & PassInfo::PassFlag_RetMem)
455 // push address where to save it!
457 IA32_Lea_DispRegImmAuto(&m_HookFunc, reg, REG_EBP,
458 MemRetWithTempObj() ? v_place_for_memret : save_ret_to);
459 IA32_Push_Reg(&m_HookFunc, reg);
461 return (SH_COMP==SH_COMP_MSVC) ? 4 : 0; // varargs funcs on msvc might need this.
462 // gcc doesn't: callee cleans the memret ptr, caller the other params :s
467 void GenContext::SaveRetVal(int v_where, int v_place_for_memret)
469 size_t size = GetRealSize(m_Proto.GetRet());
472 // No return value -> nothing
476 if (m_Proto.GetRet().flags & PassInfo::PassFlag_ByRef)
478 // mov [ebp + v_plugin_ret], eax
479 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EAX, v_where);
486 if (m_Proto.GetRet().flags & PassInfo::PassFlag_RetMem)
488 if (MemRetWithTempObj())
490 // *v_where = *v_place_for_memret
492 // if we have an assign operator, use that
493 if (m_Proto.GetRet().pAssignOperator)
495 // lea edx, [ebp + v_place_for_memret] <-- src addr
496 // lea ecx, [ebp + v_where] <-- dest addr
502 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EDX, REG_EBP, v_place_for_memret);
503 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_where);
504 IA32_Push_Reg(&m_HookFunc, REG_EDX);
505 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
507 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pAssignOperator));
508 IA32_Call_Reg(&m_HookFunc, REG_EAX);
509 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
516 //lea edi, [evp+v_where] <-- destination
517 //lea esi, [ebp+v_place_for_memret] <-- src
518 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EDI, REG_EBP, v_where);
519 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ESI, REG_EBP, v_place_for_memret);
521 BitwiseCopy_Do(m_Proto.GetRet().size);
524 // Then: destruct *v_place_for_memret if required
525 if (m_Proto.GetRet().pDtor)
527 //lea ecx, [ebp+v_place_for_memret]
532 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_place_for_memret);
533 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
534 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pDtor));
535 IA32_Call_Reg(&m_HookFunc, REG_EAX);
536 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
541 // Already copied to correct address -> we're done
546 if (m_Proto.GetRet().type == PassInfo::PassType_Float)
549 IA32_Fstp_Mem32_DispAuto(&m_HookFunc, REG_EBP, v_where);
551 IA32_Fstp_Mem64_DispAuto(&m_HookFunc, REG_EBP, v_where);
553 else if (m_Proto.GetRet().type == PassInfo::PassType_Basic)
557 // size <= 4: return in EAX
558 // We align <4 sizes up to 4
561 // mov [ebp + v_plugin_ret], eax
562 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EAX, v_where);
566 // size <= 4: return in EAX:EDX
567 // We align 4<x<8 sizes up to 8
569 // mov [ebp + v_plugin_ret], eax
570 // mov [ebp + v_plugin_ret + 4], edx
571 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EAX, v_where);
572 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EDX, v_where + 4);
575 else if (m_Proto.GetRet().type == PassInfo::PassType_Object)
577 if (m_Proto.GetRet().flags & PassInfo::PassFlag_RetReg)
581 // size <= 4: return in EAX
582 // We align <4 sizes up to 4
584 // mov [ebp + v_plugin_ret], eax
585 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EAX, v_where);
589 // size <= 4: return in EAX:EDX
590 // We align 4<x<8 sizes up to 8
592 // mov [ebp + v_plugin_ret], eax
593 // mov [ebp + v_plugin_ret + 4], edx
594 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EAX, v_where);
595 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EDX, v_where + 4);
599 SH_ASSERT(0, ("RetReg and size > 8 !"));
605 bool GenContext::MemRetWithTempObj()
607 // Memory return AND (has destructor OR has assign operator)
608 return ((m_Proto.GetRet().flags & PassInfo::PassFlag_RetMem)
609 && (m_Proto.GetRet().flags & (PassInfo::PassFlag_ODtor | PassInfo::PassFlag_AssignOp)));
612 void GenContext::ProcessPluginRetVal(int v_cur_res, int v_pContext, int v_plugin_ret)
614 // only for non-void functions!
615 if (m_Proto.GetRet().size == 0)
618 // if (cur_res >= MRES_OVERRIDE)
619 // *reinterpret_cast<my_rettype*>(pContext->GetOverrideRetPtr()) = plugin_ret;
622 // cmp eax,MRES_OVERRIDE
624 // pContext->GetOverrideRetPtr() --> overrideretptr in eax
629 jitoffs_t tmppos, counter;
631 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EBP, v_cur_res);
633 IA32_Cmp_Rm_Imm32(&m_HookFunc, MOD_REG, REG_EAX, MRES_OVERRIDE);
634 tmppos = IA32_Jump_Cond_Imm8(&m_HookFunc, CC_NGE, 0);
635 m_HookFunc.start_count(counter);
637 // eax = pContext->GetOverrideRetPtr()
644 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_pContext);
645 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
647 // vtbloffs=0, vtblidx=1
648 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
649 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EAX, 4);
650 IA32_Call_Reg(&m_HookFunc, REG_EAX);
651 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
655 if (m_Proto.GetRet().flags & PassInfo::PassFlag_ByRef)
657 // mov ecx, [ebp+v_plugin_ret]
659 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_plugin_ret);
660 IA32_Mov_Rm_Reg(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
664 if (m_Proto.GetRet().pAssignOperator)
666 // lea edx, [ebp + v_plugin_ret]
667 // push edx <-- src addr
668 // msvc: ecx = eax <-- dest addr
669 // gcc: push eax <-- dest addr
673 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EDX, REG_EBP, v_plugin_ret);
674 IA32_Push_Reg(&m_HookFunc, REG_EDX);
675 #if SH_COMP == SH_COMP_MSVC
676 IA32_Mov_Reg_Rm(&m_HookFunc, REG_ECX, REG_EAX, MOD_REG);
677 #elif SH_COMP == SH_COMP_GCC
678 IA32_Push_Reg(&m_HookFunc, REG_EAX);
681 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pAssignOperator));
682 IA32_Call_Reg(&m_HookFunc, REG_EAX);
683 GCC_ONLY(IA32_Add_Rm_ImmAuto(&m_HookFunc, REG_ESP, 2 * SIZE_PTR, MOD_REG));
690 //mov edi, eax <-- destination
691 //lea esi, [ebp+v_plugin_ret] <-- src
692 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EDI, REG_EAX, MOD_REG);
693 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ESI, REG_EBP, v_plugin_ret);
695 BitwiseCopy_Do(m_Proto.GetRet().size);
699 m_HookFunc.end_count(counter);
700 m_HookFunc.rewrite(tmppos, static_cast<jit_uint8_t>(counter));
703 void GenContext::PrepareReturn(int v_status, int v_pContext, int v_retptr)
705 // only for non-void functions!
706 if (m_Proto.GetRet().size == 0)
709 // retptr = status >= MRES_OVERRIDE ? pContext->GetOverrideRetPtr() : pContext->GetOrigRetPtr()
711 // OverrideRetPtr: vtblidx = 1
712 // OrigRetPtr: vtbldix = 2
713 // vtblidx = (status >= MRES_OVERRIDE) ? 1 : 2
716 // eax = pContext->GetOverrideRetPtr()
720 // eax = (status < MRES_OVERRIDE) ? 1 : 0
722 // cmp [ebp + v_status], MRES_OVERRIDE
723 // setl al <-- setcc optimization for ternary operators,
726 // lea eax, [4*eax + 0x4]
735 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_pContext);
736 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
737 IA32_Xor_Reg_Rm(&m_HookFunc, REG_EAX, REG_EAX, MOD_REG);
738 IA32_Cmp_Rm_Disp8_Imm8(&m_HookFunc, REG_EBP, v_status, MRES_OVERRIDE);
739 IA32_SetCC_Rm8(&m_HookFunc, REG_EAX, CC_L);
741 IA32_Lea_Reg_RegMultImm32(&m_HookFunc, REG_EAX, REG_EAX, SCALE4, 4);
743 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EDX, REG_ECX, MOD_MEM_REG);
744 IA32_Add_Reg_Rm(&m_HookFunc, REG_EDX, REG_EAX, MOD_REG);
746 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EDX, REG_EDX, MOD_MEM_REG);
747 IA32_Call_Reg(&m_HookFunc, REG_EDX);
748 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
750 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EAX, v_retptr);
753 void GenContext::DoReturn(int v_retptr, int v_memret_outaddr)
755 size_t size = m_Proto.GetRet().size;
759 // Get real ret pointer into ecx
760 // mov ecx, [ebp + v_ret_ptr]
761 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_retptr);
763 if (m_Proto.GetRet().flags & PassInfo::PassFlag_ByRef)
766 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
771 if (m_Proto.GetRet().type == PassInfo::PassType_Float)
774 IA32_Fld_Mem32(&m_HookFunc, REG_ECX);
776 IA32_Fld_Mem64(&m_HookFunc, REG_ECX);
778 else if (m_Proto.GetRet().type == PassInfo::PassType_Basic ||
779 ((m_Proto.GetRet().type == PassInfo::PassType_Object) && (m_Proto.GetRet().flags & PassInfo::PassFlag_RetReg)) )
783 // size <= 4: return in EAX
784 // We align <4 sizes up to 4
787 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
791 // size <= 4: return in EAX:EDX
792 // We align 4<x<8 sizes up to 8
796 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
797 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_ECX, 4);
801 // size >8: return in memory
806 if (m_Proto.GetRet().flags & PassInfo::PassFlag_RetMem)
808 // *memret_outaddr = plugin_ret
809 if (m_Proto.GetRet().pCopyCtor)
811 // mov edx, ecx <-- src ( we set ecx to [ebp+v_retptr] before )
812 // push edx <-- src addr
813 // msvc: ecx = [ebp + v_memret_outaddr] <-- dest addr
814 // gcc: push [ebp + v_memret_outaddr] <-- dest addr
818 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EDX, REG_ECX, MOD_REG);
819 IA32_Push_Reg(&m_HookFunc, REG_EDX);
821 #if SH_COMP == SH_COMP_MSVC
822 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_memret_outaddr);
823 #elif SH_COMP == SH_COMP_GCC
824 IA32_Push_Rm_DispAuto(&m_HookFunc, REG_EBP, v_memret_outaddr);
827 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pCopyCtor));
828 IA32_Call_Reg(&m_HookFunc, REG_EAX);
829 GCC_ONLY(IA32_Add_Rm_ImmAuto(&m_HookFunc, REG_ESP, 2 * SIZE_PTR, MOD_REG));
836 //mov edi, [ebp+v_memret_outaddr] <-- destination
837 //mov esi, ecx <-- src ( we set ecx to [ebp+v_retptr] before )
838 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EDI, REG_EBP, v_memret_outaddr);
839 IA32_Mov_Reg_Rm(&m_HookFunc, REG_ESI, REG_ECX, MOD_REG);
841 BitwiseCopy_Do(m_Proto.GetRet().size);
844 // In both cases: return the pointer in EAX
845 // mov eax, [ebp + v_memret_outaddr]
846 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EBP, v_memret_outaddr);
850 void GenContext::GenerateCallHooks(int v_status, int v_prev_res, int v_cur_res, int v_iter,
851 int v_pContext, int base_param_offset, int v_plugin_ret, int v_place_for_memret, jit_int32_t v_place_fbrr_base, jit_int32_t v_va_buf)
853 jitoffs_t counter, tmppos;
854 jitoffs_t counter2, tmppos2;
856 jitoffs_t loop_begin_counter;
858 // prev_res = MRES_IGNORED
859 IA32_Mov_Rm_Imm32_Disp8(&m_HookFunc, REG_EBP, MRES_IGNORED, v_prev_res);
861 m_HookFunc.start_count(loop_begin_counter);
863 // eax = pContext->GetNext()
870 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_pContext);
871 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
873 // vtbloffs=0, vtblidx=0
874 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
875 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_EAX, MOD_MEM_REG);
876 IA32_Call_Reg(&m_HookFunc, REG_EAX);
877 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
882 IA32_Test_Rm_Reg(&m_HookFunc, REG_EAX, REG_EAX, MOD_REG);
883 tmppos = IA32_Jump_Cond_Imm32(&m_HookFunc, CC_Z, 0);
884 m_HookFunc.start_count(counter);
886 // prev_res = MRES_IGNORED
887 IA32_Mov_Rm_Imm32_Disp8(&m_HookFunc, REG_EBP, MRES_IGNORED, v_cur_res);
894 // eax = [eax+2*SIZE_PTR]
898 jit_int32_t gcc_clean_bytes = 0;
899 // vafmt: push va_buf
900 if (m_Proto.GetConvention() & ProtoInfo::CallConv_HasVafmt)
902 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_va_buf);
903 IA32_Push_Reg(&m_HookFunc, REG_ECX);
904 gcc_clean_bytes += SIZE_PTR;
907 gcc_clean_bytes += PushParams(base_param_offset, v_plugin_ret, v_place_for_memret, v_place_fbrr_base);
909 IA32_Mov_Reg_Rm(&m_HookFunc, REG_ECX, REG_EAX, MOD_REG);
910 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
911 gcc_clean_bytes += PushMemRetPtr(v_plugin_ret, v_place_for_memret);
912 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
913 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EAX, 2*SIZE_PTR);
914 IA32_Call_Reg(&m_HookFunc, REG_EAX);
916 DestroyParams(v_place_fbrr_base);
918 SaveRetVal(v_plugin_ret, v_place_for_memret);
921 #if SH_COMP == SH_COMP_GCC
922 IA32_Add_Rm_ImmAuto(&m_HookFunc, REG_ESP, gcc_clean_bytes + SIZE_PTR, MOD_REG);
927 // process meta return:
928 // prev_res = cur_res
929 // if (cur_res > status) status = cur_res;
939 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EBP, v_cur_res);
940 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EDX, REG_EBP, v_status);
941 IA32_Mov_Rm_Reg_Disp8(&m_HookFunc, REG_EBP, REG_EAX, v_prev_res);
943 IA32_Cmp_Reg_Rm(&m_HookFunc, REG_EAX, REG_EDX, MOD_REG);
944 tmppos2 = IA32_Jump_Cond_Imm8(&m_HookFunc, CC_NG, 0);
945 m_HookFunc.start_count(counter2);
947 IA32_Mov_Rm_Reg_Disp8(&m_HookFunc, REG_EBP, REG_EAX, v_status);
949 m_HookFunc.end_count(counter2);
950 m_HookFunc.rewrite(tmppos2, static_cast<jit_uint8_t>(counter2));
952 // process retval for non-void functions
953 ProcessPluginRetVal(v_cur_res, v_pContext, v_plugin_ret);
955 // jump back to loop begin
956 tmppos2 = IA32_Jump_Imm32(&m_HookFunc, 0);
957 m_HookFunc.end_count(loop_begin_counter);
958 m_HookFunc.rewrite(tmppos2, -static_cast<jit_int32_t>(loop_begin_counter));
960 m_HookFunc.end_count(counter);
961 m_HookFunc.rewrite(tmppos, static_cast<jit_int32_t>(counter));
964 void GenContext::GenerateCallOrig(int v_status, int v_pContext, int param_base_offs, int v_this,
965 int v_vfnptr_origentry, int v_orig_ret, int v_override_ret, int v_place_for_memret, jit_int32_t v_place_fbrr_base, jit_int32_t v_va_buf)
967 jitoffs_t counter, tmppos;
968 jitoffs_t counter2, tmppos2;
969 jitoffs_t counter3, tmppos3;
971 // if (status != MRES_SUPERCEDE && pConteext->ShouldCallOrig())
972 // *v_orig_ret = orig_call()
974 // *v_orig_ret = *v_override_ret
977 // cmp eax, MRES_SUPERCEDE
979 // call pContext->ShouldCallOrig()
980 // test al, al !! important: al, not eax! bool is only stored in the LSbyte
984 // SaveRet(v_orig_ret)
985 // jmp skip_dont_call:
988 // *v_orig_ret = *v_override_ret
991 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EBP, v_status);
992 IA32_Cmp_Rm_Imm32(&m_HookFunc, MOD_REG, REG_EAX, MRES_SUPERCEDE);
994 tmppos = IA32_Jump_Cond_Imm32(&m_HookFunc, CC_E, 0);
995 m_HookFunc.start_count(counter);
997 // eax = pContext->ShouldCallOrig()
1001 // eax = [eax + 3*SIZE_PTR]
1004 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_pContext);
1005 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1007 // vtbloffs=0, vtblidx=3
1008 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_ECX, MOD_MEM_REG);
1009 IA32_Mov_Reg_Rm_Disp8(&m_HookFunc, REG_EAX, REG_EAX, 3*SIZE_PTR);
1010 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1011 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
1013 IA32_Test_Rm_Reg8(&m_HookFunc, REG_EAX, REG_EAX, MOD_REG);
1014 tmppos2 = IA32_Jump_Cond_Imm32(&m_HookFunc, CC_Z, 0);
1015 m_HookFunc.start_count(counter2);
1017 jit_int32_t gcc_clean_bytes = 0;
1019 // vafmt: push va_buf, then "%s"
1020 if (m_Proto.GetConvention() & ProtoInfo::CallConv_HasVafmt)
1022 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_va_buf);
1023 IA32_Push_Reg(&m_HookFunc, REG_ECX);
1024 IA32_Push_Imm32(&m_HookFunc, DownCastPtr("%s"));
1025 gcc_clean_bytes += 2*SIZE_PTR;
1029 gcc_clean_bytes += PushParams(param_base_offs, v_orig_ret, v_place_for_memret, v_place_fbrr_base);
1032 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_this);
1033 #if SH_COMP == SH_COMP_GCC
1034 // on gcc/mingw, this is the first parameter
1035 IA32_Push_Reg(&m_HookFunc, REG_ECX);
1036 // on msvc, simply leave it in ecx
1038 gcc_clean_bytes += PushMemRetPtr(v_orig_ret, v_place_for_memret);
1041 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EBP, v_vfnptr_origentry);
1042 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1045 #if SH_COMP == SH_COMP_GCC
1046 IA32_Add_Rm_ImmAuto(&m_HookFunc, REG_ESP, gcc_clean_bytes + SIZE_PTR, MOD_REG);
1049 DestroyParams(v_place_fbrr_base);
1052 SaveRetVal(v_orig_ret, v_place_for_memret);
1054 // Skip don't call variant
1055 tmppos3 = IA32_Jump_Imm32(&m_HookFunc, 0);
1056 m_HookFunc.start_count(counter3);
1060 m_HookFunc.end_count(counter);
1061 m_HookFunc.rewrite(tmppos, static_cast<jit_uint32_t>(counter));
1063 m_HookFunc.end_count(counter2);
1064 m_HookFunc.rewrite(tmppos2, static_cast<jit_uint32_t>(counter2));
1066 // *v_orig_ret = *v_override_ret
1067 if (m_Proto.GetRet().flags & PassInfo::PassFlag_ByRef)
1069 // mov ecx, [ebp + v_override_ret]
1070 // mov [ebp + v_orig_ret], ecx
1072 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_override_ret);
1073 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_ECX, v_orig_ret);
1077 if (m_Proto.GetRet().pAssignOperator)
1079 // lea edx, [ebp + v_override_ret] <-- src addr
1080 // lea ecx, [ebp + v_orig_ret] <-- dest addr
1081 // push edx <-- src addr
1086 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EDX, REG_EBP, v_override_ret);
1087 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_orig_ret);
1088 IA32_Push_Reg(&m_HookFunc, REG_EDX);
1089 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1091 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pAssignOperator));
1092 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1093 GCC_ONLY(IA32_Add_Rm_ImmAuto(&m_HookFunc, REG_ESP, 2*SIZE_PTR, MOD_REG));
1098 BitwiseCopy_Setup();
1100 //lea edi, [ebp+v_orig_ret] <-- destination
1101 //lea esi, [ebp+v_override_ret] <-- src
1102 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EDI, REG_EBP, v_orig_ret);
1103 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ESI, REG_EBP, v_override_ret);
1105 BitwiseCopy_Do(m_Proto.GetRet().size);
1109 // skip don't call label target:
1110 m_HookFunc.end_count(counter3);
1111 m_HookFunc.rewrite(tmppos3, static_cast<jit_uint32_t>(counter3));
1114 // Sets *v_pContext to return value
1115 void GenContext::CallSetupHookLoop(int v_orig_ret, int v_override_ret,
1116 int v_cur_res, int v_prev_res, int v_status, int v_vfnptr_origentry,
1117 int v_this, int v_pContext)
1119 // call shptr->SetupHookLoop(ms_HI, ourvfnptr, reinterpret_cast<void*>(this),
1120 // &vfnptr_origentry, &status, &prev_res, &cur_res, &orig_ret, &override_ret);
1121 // The last two params are null for void funcs.
1123 if (m_Proto.GetRet().size == 0)
1126 IA32_Push_Imm8(&m_HookFunc, 0); // orig_ret
1127 IA32_Push_Imm8(&m_HookFunc, 0); // override_ret
1131 // orig_ret and override_ret
1132 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EAX, REG_EBP, v_override_ret);
1133 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EDX, REG_EBP, v_orig_ret);
1134 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1135 IA32_Push_Reg(&m_HookFunc, REG_EDX);
1138 // cur_res and prev_res
1139 IA32_Lea_DispRegImm8(&m_HookFunc, REG_EAX, REG_EBP, v_cur_res);
1140 IA32_Lea_DispRegImm8(&m_HookFunc, REG_EDX, REG_EBP, v_prev_res);
1141 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1142 IA32_Push_Reg(&m_HookFunc, REG_EDX);
1144 // status and vfnptr_origentry
1145 IA32_Lea_DispRegImm8(&m_HookFunc, REG_EAX, REG_EBP, v_status);
1146 IA32_Lea_DispRegImm8(&m_HookFunc, REG_EDX, REG_EBP, v_vfnptr_origentry);
1147 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1148 IA32_Push_Reg(&m_HookFunc, REG_EDX);
1151 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EBP, v_this);
1152 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1155 // *(this + vtbloffs) + SIZE_PTR*vtblidx
1156 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_ECX, REG_EBP, v_this); // get this into ecx (gcc!)
1157 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_ECX, m_VtblOffs);
1158 IA32_Add_Rm_ImmAuto(&m_HookFunc, REG_EAX, m_VtblIdx * SIZE_PTR, MOD_REG);
1159 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1162 IA32_Mov_Rm_Imm32(&m_HookFunc, REG_EDX, DownCastPtr(m_pHI), MOD_REG);
1163 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EAX, REG_EDX, MOD_MEM_REG);
1164 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1167 #if SH_COMP == SH_COMP_GCC
1168 // on gcc/mingw, this is the first parameter
1169 GCC_ONLY(IA32_Push_Imm32(&m_HookFunc, DownCastPtr(m_SHPtr)));
1170 #elif SH_COMP == SH_COMP_MSVC
1171 // on msvc, it's ecx
1172 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_ECX, DownCastPtr(m_SHPtr));
1175 // call the function. vtbloffs = 0, vtblidx = 19
1176 // get vtptr into edx -- we know shptr on jit time -> dereference it here!
1177 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX,
1178 (*reinterpret_cast<jit_uint32_t**>(m_SHPtr))[19]);
1180 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1182 // on gcc/mingw, we have to clean up after the call
1183 // 9 params + hidden thisptr param
1184 GCC_ONLY(IA32_Add_Rm_Imm8(&m_HookFunc, REG_ESP, 10*SIZE_PTR, MOD_REG));
1186 // store return value
1187 IA32_Mov_Rm_Reg_Disp8(&m_HookFunc, REG_EBP, REG_EAX, v_pContext);
1190 void GenContext::CallEndContext(int v_pContext)
1193 // shptr->EndContext(pContex)
1194 IA32_Mov_Reg_Rm_DispAuto(&m_HookFunc, REG_EAX, REG_EBP, v_pContext);
1195 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1198 #if SH_COMP == SH_COMP_GCC
1199 // on gcc/mingw, this is the first parameter
1200 IA32_Push_Imm32(&m_HookFunc, DownCastPtr(m_SHPtr));
1201 #elif SH_COMP == SH_COMP_MSVC
1202 // on msvc, it's ecx
1203 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_ECX, DownCastPtr(m_SHPtr));
1206 // get vtptr into edx -- we know shptr on jit time -> dereference it here!
1207 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX,
1208 (*reinterpret_cast<jit_uint32_t**>(m_SHPtr))[20]);
1210 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1212 // on gcc/mingw, we have to clean up after the call
1213 // 1 param + hidden thisptr param
1214 GCC_ONLY(IA32_Add_Rm_Imm8(&m_HookFunc, REG_ESP, 2*SIZE_PTR, MOD_REG));
1217 void GenContext::ResetFrame(jit_int32_t startOffset)
1219 m_HookFunc_FrameOffset = startOffset;
1220 m_HookFunc_FrameVarsSize = 0;
1223 jit_int32_t GenContext::AddVarToFrame(jit_int32_t size)
1225 m_HookFunc_FrameOffset -= size;
1226 m_HookFunc_FrameVarsSize += size;
1227 return m_HookFunc_FrameOffset;
1230 jit_int32_t GenContext::ComputeVarsSize()
1232 return m_HookFunc_FrameVarsSize;
1235 void * GenContext::GenerateHookFunc()
1238 IA32_Push_Reg(&m_HookFunc, REG_EBP);
1239 IA32_Push_Reg(&m_HookFunc, REG_EBX);
1240 IA32_Mov_Reg_Rm(&m_HookFunc, REG_EBP, REG_ESP, MOD_REG);
1243 // on msvc, save thisptr
1244 #if SH_COMP == SH_COMP_MSVC
1245 jit_int32_t v_this = -4;
1246 IA32_Push_Reg(&m_HookFunc, REG_ECX);
1247 #elif SH_COMP == SH_COMP_GCC
1248 jit_int32_t v_this = 12; // first param
1252 (SH_COMP==SH_COMP_MSVC) ? -4 : 0
1253 ); // on msvc, start on offset -4 because there already is the thisptr variable
1255 // ********************** stack frame **********************
1257 // second param (gcc: first real param) ebp + 16
1258 // first param (gcc: thisptr) ebp + 12
1259 // ret address: ebp + 8
1260 // caller's ebp ebp + 4
1262 // MSVC ONLY: current this ebp - 4
1263 // void *vfnptr_origentry ebp - 4 -4
1264 // META_RES status = MRES_IGNORED ebp - 8 -4
1265 // META_RES prev_res ebp - 12 -4
1266 // META_RES cur_res ebp - 16 -4
1267 // IMyDelegate *iter ebp - 20 -4
1268 // IHookContext *pContext ebp - 24 -4
1269 // == 3 ptrs + 3 enums = 24 bytes
1272 // my_rettype *ret_ptr ebp - 28 -4
1273 // my_rettype orig_ret ebp - 28 - sizeof(my_rettype) -4
1274 // my_rettype override_ret ebp - 28 - sizeof(my_rettype)*2 -4
1275 // my_rettype plugin_ret ebp - 28 - sizeof(my_rettype)*3 -4
1276 // == + 3 * sizeof(my_rettype) bytes
1279 // my_rettype place_for_memret ebp - 28 - sizeof(my_rettype)*4 -4
1281 // gcc only: if required:
1282 // place forced byref params ebp - 28 - sizeof(my_rettype)*{4 or 5}
1286 // char va_buf[something];
1289 const jit_int8_t v_vfnptr_origentry = AddVarToFrame(SIZE_PTR);
1290 const jit_int8_t v_status = AddVarToFrame(sizeof(META_RES));
1291 const jit_int8_t v_prev_res = AddVarToFrame(sizeof(META_RES));
1292 const jit_int8_t v_cur_res = AddVarToFrame(sizeof(META_RES));
1293 const jit_int8_t v_iter = AddVarToFrame(SIZE_PTR);
1294 const jit_int8_t v_pContext = AddVarToFrame(SIZE_PTR);
1296 #if SH_COMP == SH_COMP_GCC
1297 jit_int32_t param_base_offs = 16;
1298 #elif SH_COMP == SH_COMP_MSVC
1299 jit_int32_t param_base_offs = 12;
1302 // Memory return: first param is the address
1303 jit_int32_t v_memret_addr = 0;
1304 if (m_Proto.GetRet().flags & PassInfo::PassFlag_RetMem)
1306 #if SH_COMP == SH_COMP_GCC
1307 // gcc: now: first param = mem ret addr
1308 // second param = this pointer
1309 // third param = actual first param
1312 param_base_offs += SIZE_PTR;
1313 #elif SH_COMP == SH_COMP_MSVC
1314 v_memret_addr = param_base_offs;
1315 param_base_offs += SIZE_PTR;
1319 jit_int32_t v_ret_ptr = 0;
1320 jit_int32_t v_orig_ret = 0;
1321 jit_int32_t v_override_ret = 0;
1322 jit_int32_t v_plugin_ret = 0;
1324 if (m_Proto.GetRet().size != 0)
1326 v_ret_ptr = AddVarToFrame(SIZE_PTR);
1327 v_orig_ret = AddVarToFrame(GetStackSize(m_Proto.GetRet()));
1328 v_override_ret = AddVarToFrame(GetStackSize(m_Proto.GetRet()));
1329 v_plugin_ret = AddVarToFrame(GetStackSize(m_Proto.GetRet()));
1332 jit_int32_t v_place_for_memret = 0;
1333 if (MemRetWithTempObj())
1335 v_place_for_memret = AddVarToFrame(GetStackSize(m_Proto.GetRet()));
1338 jit_int32_t v_place_fbrr_base = 0;
1339 if (SH_COMP == SH_COMP_GCC && GetForcedByRefParamsSize())
1341 v_place_fbrr_base = AddVarToFrame(GetForcedByRefParamsSize());
1344 // Only exists for varargs functions
1345 jit_int32_t v_va_argptr = 0;
1346 if (m_Proto.GetConvention() & ProtoInfo::CallConv_HasVarArgs)
1348 v_va_argptr = AddVarToFrame(SIZE_PTR);
1351 jit_int32_t v_va_buf = 0;
1352 if (m_Proto.GetConvention() & ProtoInfo::CallConv_HasVafmt)
1354 v_va_buf = AddVarToFrame(SourceHook::STRBUF_LEN);
1357 IA32_Sub_Rm_Imm32(&m_HookFunc, REG_ESP, ComputeVarsSize(), MOD_REG);
1359 // init status localvar
1360 IA32_Mov_Rm_Imm32_Disp8(&m_HookFunc, REG_EBP, MRES_IGNORED, v_status);
1362 // VarArgs: init argptr & format
1363 if (m_Proto.GetConvention() & ProtoInfo::CallConv_HasVarArgs)
1365 // argptr = first vararg param
1366 // lea eax, [ebp + param_base_offs + paramssize]
1369 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_EAX, REG_EBP, param_base_offs + GetParamsStackSize() + SIZE_PTR); // +SIZE_PTR: last const char * is not in protoinfo
1370 IA32_Mov_Rm_Reg_DispAuto(&m_HookFunc, REG_EBP, REG_EAX, v_va_argptr);
1372 if (m_Proto.GetConvention() & ProtoInfo::CallConv_HasVafmt)
1376 // push valist, fmt param, maxsize, buffer
1377 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1378 IA32_Push_Rm_DispAuto(&m_HookFunc, REG_EBP, param_base_offs + GetParamsStackSize()); // last given param (+4-4, see above)
1379 IA32_Push_Imm32(&m_HookFunc, SourceHook::STRBUF_LEN - 1);
1380 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_va_buf);
1381 IA32_Push_Reg(&m_HookFunc, REG_ECX);
1384 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(&vsnprintf));
1385 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1388 IA32_Add_Rm_Imm32(&m_HookFunc, REG_ESP, 0x10, MOD_REG);
1390 // Set trailing zero
1391 IA32_Xor_Reg_Rm(&m_HookFunc, REG_EDX, REG_EDX, MOD_REG);
1392 IA32_Mov_Rm8_Reg8_DispAuto(&m_HookFunc, REG_EBP, REG_EDX, v_va_buf + SourceHook::STRBUF_LEN - 1);
1395 // Call constructors for ret vars if required
1396 if((m_Proto.GetRet().flags & PassInfo::PassFlag_ByVal) &&
1397 m_Proto.GetRet().pNormalCtor)
1400 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_orig_ret);
1401 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1402 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pNormalCtor));
1403 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1404 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
1407 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_override_ret);
1408 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1409 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pNormalCtor));
1410 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1411 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
1414 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_plugin_ret);
1415 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1416 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pNormalCtor));
1417 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1418 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
1420 // _don't_ call a constructor for v_place_for_memret !
1423 // ********************** SetupHookLoop **********************
1424 CallSetupHookLoop(v_orig_ret, v_override_ret, v_cur_res, v_prev_res, v_status, v_vfnptr_origentry,
1425 v_this, v_pContext);
1427 // ********************** call pre hooks **********************
1428 GenerateCallHooks(v_status, v_prev_res, v_cur_res, v_iter, v_pContext, param_base_offs,
1429 v_plugin_ret, v_place_for_memret, v_place_fbrr_base, v_va_buf);
1431 // ********************** call orig func **********************
1432 GenerateCallOrig(v_status, v_pContext, param_base_offs, v_this, v_vfnptr_origentry, v_orig_ret,
1433 v_override_ret, v_place_for_memret, v_place_fbrr_base, v_va_buf);
1435 // ********************** call post hooks **********************
1436 GenerateCallHooks(v_status, v_prev_res, v_cur_res, v_iter, v_pContext, param_base_offs,
1437 v_plugin_ret, v_place_for_memret, v_place_fbrr_base, v_va_buf);
1439 // ********************** end context and return **********************
1441 PrepareReturn(v_status, v_pContext, v_ret_ptr);
1443 CallEndContext(v_pContext);
1445 // Call destructors of byval object params which have a destructor
1446 jit_int32_t cur_param_pos = param_base_offs;
1447 for (int i = 0; i < m_Proto.GetNumOfParams(); ++i)
1449 const IntPassInfo &pi = m_Proto.GetParam(i);
1450 // GCC: NOT of forced byref params. the caller destructs those.
1451 if (pi.type == PassInfo::PassType_Object && (pi.flags & PassInfo::PassFlag_ODtor) &&
1452 (pi.flags & PassInfo::PassFlag_ByVal) && !(pi.flags & PassFlag_ForcedByRef))
1454 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, cur_param_pos);
1455 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(pi.pDtor));
1456 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1458 cur_param_pos += GetStackSize(pi);
1461 DoReturn(v_ret_ptr, v_memret_addr);
1463 // Call destructors of orig_ret/ ...
1464 if((m_Proto.GetRet().flags & PassInfo::PassFlag_ByVal) &&
1465 m_Proto.GetRet().pDtor)
1467 // Preserve return value in EAX(:EDX)
1468 IA32_Push_Reg(&m_HookFunc, REG_EAX);
1469 IA32_Push_Reg(&m_HookFunc, REG_EDX);
1471 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_plugin_ret);
1472 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1473 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pDtor));
1474 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1475 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
1477 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_override_ret);
1478 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1479 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pDtor));
1480 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1481 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
1483 IA32_Lea_DispRegImmAuto(&m_HookFunc, REG_ECX, REG_EBP, v_orig_ret);
1484 GCC_ONLY(IA32_Push_Reg(&m_HookFunc, REG_ECX));
1485 IA32_Mov_Reg_Imm32(&m_HookFunc, REG_EAX, DownCastPtr(m_Proto.GetRet().pDtor));
1486 IA32_Call_Reg(&m_HookFunc, REG_EAX);
1487 GCC_ONLY(IA32_Pop_Reg(&m_HookFunc, REG_ECX));
1489 IA32_Pop_Reg(&m_HookFunc, REG_EDX);
1490 IA32_Pop_Reg(&m_HookFunc, REG_EAX);
1494 IA32_Mov_Reg_Rm(&m_HookFunc, REG_ESP, REG_EBP, MOD_REG);
1495 IA32_Pop_Reg(&m_HookFunc, REG_EBX);
1496 IA32_Pop_Reg(&m_HookFunc, REG_EBP);
1497 MSVC_ONLY(IA32_Return_Popstack(&m_HookFunc, GetParamsStackSize()));
1498 // gcc: Remove 4 bytes from stack on memory return
1499 #if SH_COMP == SH_COMP_GCC
1500 if (m_Proto.GetRet().flags & PassInfo::PassFlag_RetMem)
1501 IA32_Return_Popstack(&m_HookFunc, SIZE_PTR);
1503 IA32_Return(&m_HookFunc);
1506 // Store pointer for later use
1507 // m_HookfuncVfnPtr is a pointer to a void* because SH expects a pointer
1508 // into the hookman's vtable
1509 *m_HookfuncVfnptr = reinterpret_cast<void*>(m_HookFunc.GetData());
1513 return m_HookFunc.GetData();
1516 // Pre-condition: GenerateHookFunc() has been called!
1517 void * GenContext::GeneratePubFunc()
1519 jitoffs_t counter, tmppos;
1521 // The pubfunc is a static cdecl function.
1523 // int HookManPubFunc(
1524 // bool store, ebp + 8
1525 // IHookManagerInfo *hi ebp + 12
1531 // hi->SetInfo(HOOKMAN_VERSION, m_VtblOffs, m_VtblIdx, m_Proto.GetProto(), m_HookfuncVfnptr)
1535 IA32_Push_Reg(&m_PubFunc, REG_EBP);
1536 IA32_Mov_Reg_Rm(&m_PubFunc, REG_EBP, REG_ESP, MOD_REG);
1539 // save store in eax, hi in ecx
1540 IA32_Movzx_Reg32_Rm8_Disp8(&m_PubFunc, REG_EAX, REG_EBP, 8);
1541 IA32_Mov_Reg_Rm_DispAuto(&m_PubFunc, REG_ECX, REG_EBP, 12);
1543 // Check for store == 0
1544 IA32_Test_Rm_Reg8(&m_PubFunc, REG_EAX, REG_EAX, MOD_REG);
1545 tmppos = IA32_Jump_Cond_Imm8(&m_PubFunc, CC_Z, 0);
1546 m_PubFunc.start_count(counter);
1548 // nonzero -> store hi
1549 IA32_Mov_Rm_Imm32(&m_PubFunc, REG_EDX, DownCastPtr(m_pHI), MOD_REG);
1550 IA32_Mov_Rm_Reg(&m_PubFunc, REG_EDX, REG_ECX, MOD_MEM_REG);
1553 m_PubFunc.end_count(counter);
1554 m_PubFunc.rewrite(tmppos, static_cast<jit_uint8_t>(counter));
1556 // check for hi == 0
1557 IA32_Test_Rm_Reg(&m_PubFunc, REG_ECX, REG_ECX, MOD_REG);
1558 tmppos = IA32_Jump_Cond_Imm8(&m_PubFunc, CC_Z, 0);
1559 m_PubFunc.start_count(counter);
1561 // nonzero -> call vfunc
1562 // push params in reverse order
1563 IA32_Push_Imm32(&m_PubFunc, DownCastPtr(m_HookfuncVfnptr));
1564 IA32_Push_Imm32(&m_PubFunc, DownCastPtr(m_BuiltPI));
1565 IA32_Push_Imm32(&m_PubFunc, m_VtblIdx);
1566 IA32_Push_Imm32(&m_PubFunc, m_VtblOffs);
1567 IA32_Push_Imm32(&m_PubFunc, SH_HOOKMAN_VERSION);
1569 // hi == this is in ecx
1570 // on gcc/mingw, ecx is the first parameter
1571 #if SH_COMP == SH_COMP_GCC
1572 IA32_Push_Reg(&m_PubFunc, REG_ECX);
1575 // call the function. vtbloffs = 0, vtblidx = 0
1576 // get vtptr into edx
1577 IA32_Mov_Reg_Rm(&m_PubFunc, REG_EDX, REG_ECX, MOD_MEM_REG);
1578 // get funcptr into eax
1579 IA32_Mov_Reg_Rm(&m_PubFunc, REG_EAX, REG_EDX, MOD_MEM_REG);
1581 IA32_Call_Reg(&m_PubFunc, REG_EAX);
1583 // on gcc/mingw, we have to clean up after the call
1584 #if SH_COMP == SH_COMP_GCC
1585 // 5 params + hidden thisptr param
1586 IA32_Add_Rm_Imm8(&m_PubFunc, REG_ESP, 6*SIZE_MWORD, MOD_REG);
1590 m_PubFunc.end_count(counter);
1591 m_PubFunc.rewrite(tmppos, static_cast<jit_uint8_t>(counter));
1594 IA32_Xor_Reg_Rm(&m_PubFunc, REG_EAX, REG_EAX, MOD_REG);
1597 IA32_Mov_Reg_Rm(&m_PubFunc, REG_ESP, REG_EBP, MOD_REG);
1598 IA32_Pop_Reg(&m_PubFunc, REG_EBP);
1599 IA32_Return(&m_PubFunc);
1606 bool GenContext::PassInfoSupported(const IntPassInfo &pi, bool is_ret)
1608 // :TODO: Error returns
1609 if (pi.type != PassInfo::PassType_Basic &&
1610 pi.type != PassInfo::PassType_Float &&
1611 pi.type != PassInfo::PassType_Object)
1616 if (pi.type == PassInfo::PassType_Object &&
1617 (pi.flags & PassInfo::PassFlag_ByVal))
1619 if ((pi.flags & PassInfo::PassFlag_CCtor) && !pi.pCopyCtor)
1624 if ((pi.flags & PassInfo::PassFlag_ODtor) && !pi.pDtor)
1629 if ((pi.flags & PassInfo::PassFlag_AssignOp) && !pi.pAssignOperator)
1634 if ((pi.flags & PassInfo::PassFlag_OCtor) && !pi.pNormalCtor)
1640 if ((pi.flags & (PassInfo::PassFlag_ByVal | PassInfo::PassFlag_ByRef)) == 0)
1642 return false; // Neither byval nor byref!
1647 void GenContext::AutoDetectRetType()
1649 IntPassInfo &pi = m_Proto.GetRet();
1651 // Only relevant for byval types
1652 if (pi.flags & PassInfo::PassFlag_ByVal)
1655 if (pi.type == PassInfo::PassType_Basic ||
1656 pi.type == PassInfo::PassType_Float)
1659 // _always_ in registers, no matter what the user says
1662 pi.flags &= ~PassInfo::PassFlag_RetMem;
1663 pi.flags |= PassInfo::PassFlag_RetReg;
1667 // Does this even exist? No idea, if it does: in memory!
1668 pi.flags &= ~PassInfo::PassFlag_RetReg;
1669 pi.flags |= PassInfo::PassFlag_RetMem;
1673 else if (pi.type == PassInfo::PassType_Object)
1675 // If the user says nothing, auto-detect
1676 if ((pi.flags & (PassInfo::PassFlag_RetMem | PassInfo::PassFlag_RetReg)) == 0)
1678 #if SH_COMP == SH_COMP_MSVC
1679 // MSVC seems to return _all_ structs, classes, unions in memory
1680 pi.flags |= PassInfo::PassFlag_RetMem;
1681 #elif SH_COMP == SH_COMP_GCC
1682 // Same goes for GCC :)
1683 pi.flags |= PassInfo::PassFlag_RetMem;
1690 // byref: make sure that the flag is _not_ set
1691 pi.flags &= ~PassInfo::PassFlag_RetMem;
1692 pi.flags |= PassInfo::PassFlag_RetReg;
1696 void GenContext::AutoDetectParamFlags()
1698 #if SH_COMP == SH_COMP_GCC
1699 // On GCC, all objects are passed by reference if they have a destructor
1700 for (int i = 0; i < m_Proto.GetNumOfParams(); ++i)
1702 IntPassInfo &pi = m_Proto.GetParam(i);
1703 if (pi.type == PassInfo::PassType_Object &&
1704 (pi.flags & PassInfo::PassFlag_ODtor))
1706 pi.flags |= PassFlag_ForcedByRef;
1712 HookManagerPubFunc GenContext::Generate()
1716 // Check conditions:
1717 // -1) good proto version
1718 // 0) we don't support unknown passtypes, convention, ...
1719 // 1) we don't support functions which return objects by value or take parameters by value
1720 // that have a constructor, a destructor or an overloaded assignment op
1721 // (we wouldn't know how to call it!)
1723 if (m_Proto.GetVersion() < 1)
1728 AutoDetectRetType();
1729 AutoDetectParamFlags();
1731 // Basically, we only support ThisCall/thiscall with varargs
1732 if ((m_Proto.GetConvention() & (~ProtoInfo::CallConv_HasVafmt)) != ProtoInfo::CallConv_ThisCall)
1738 if (m_Proto.GetRet().size != 0 && !PassInfoSupported(m_Proto.GetRet(), true))
1743 for (int i = 0; i < m_Proto.GetNumOfParams(); ++i)
1745 if (!PassInfoSupported(m_Proto.GetParam(i), false))
1751 return fastdelegate::detail::horrible_cast<HookManagerPubFunc>(GeneratePubFunc());
1754 HookManagerPubFunc GenContext::GetPubFunc()
1756 if (m_GeneratedPubFunc == 0)
1757 m_GeneratedPubFunc = Generate();
1759 return m_GeneratedPubFunc;
1762 bool GenContext::Equal(const CProto &proto, int vtbl_offs, int vtbl_idx)
1764 return (m_OrigProto.ExactlyEqual(proto) && m_VtblOffs == vtbl_offs && m_VtblIdx == vtbl_idx);
1767 bool GenContext::Equal(HookManagerPubFunc other)
1769 return m_GeneratedPubFunc == other;
1772 // *********************************** class GenContextContainer
1773 CHookManagerAutoGen::CHookManagerAutoGen(ISourceHook *pSHPtr) : m_pSHPtr(pSHPtr)
1777 CHookManagerAutoGen::~CHookManagerAutoGen()
1779 for (List<StoredContext>::iterator iter = m_Contexts.begin(); iter != m_Contexts.end(); ++iter)
1781 delete iter->m_GenContext;
1785 int CHookManagerAutoGen::GetIfaceVersion()
1787 return SH_HOOKMANAUTOGEN_IFACE_VERSION;
1790 int CHookManagerAutoGen::GetImplVersion()
1792 return SH_HOOKMANAUTOGEN_IMPL_VERSION;
1795 HookManagerPubFunc CHookManagerAutoGen::MakeHookMan(const ProtoInfo *proto, int vtbl_offs, int vtbl_idx)
1797 CProto mproto(proto);
1798 for (List<StoredContext>::iterator iter = m_Contexts.begin(); iter != m_Contexts.end(); ++iter)
1800 if (iter->m_GenContext->Equal(mproto, vtbl_offs, vtbl_idx))
1803 return iter->m_GenContext->GetPubFunc();
1807 // Not found yet -> new one
1810 sctx.m_GenContext = new GenContext(proto, vtbl_offs, vtbl_idx, m_pSHPtr);
1812 if (sctx.m_GenContext->GetPubFunc() == NULL)
1818 m_Contexts.push_back(sctx);
1819 return sctx.m_GenContext->GetPubFunc();
1823 void CHookManagerAutoGen::ReleaseHookMan(HookManagerPubFunc pubFunc)
1825 for (List<StoredContext>::iterator iter = m_Contexts.begin(); iter != m_Contexts.end(); ++iter)
1827 if (iter->m_GenContext->Equal(pubFunc))
1830 if (iter->m_RefCnt == 0)
1832 delete iter->m_GenContext;
1833 m_Contexts.erase(iter);