sourcehook/sourcehook_hookmangen.h
author Pavol Marko <pavolmarko@gmail.com>
Fri Nov 02 12:41:00 2007 +0000 (2007-11-02)
branchhookman_autogen
changeset 439 30d2be004032
parent 437 89cf494f6088
child 442 07575ad47137
permissions -rw-r--r--
Completed support for reference returns + added simple test for it
pavolmarko@432
     1
/* ======== SourceHook ========
pavolmarko@432
     2
* Copyright (C) 2004-2007 Metamod:Source Development Team
pavolmarko@432
     3
* No warranties of any kind
pavolmarko@432
     4
*
pavolmarko@432
     5
* License: zlib/libpng
pavolmarko@432
     6
*
pavolmarko@432
     7
* Author(s): Pavol "PM OnoTo" Marko
pavolmarko@432
     8
* ============================
pavolmarko@432
     9
*/
pavolmarko@432
    10
pavolmarko@432
    11
#ifndef __SOURCEHOOK_HOOKMANGEN_H__
pavolmarko@432
    12
#define __SOURCEHOOK_HOOKMANGEN_H__
pavolmarko@432
    13
pavolmarko@432
    14
#include "sourcehook_impl.h"
pavolmarko@432
    15
#include "windows.h"
pavolmarko@432
    16
pavolmarko@432
    17
namespace SourceHook
pavolmarko@432
    18
{
pavolmarko@432
    19
	namespace Impl
pavolmarko@432
    20
	{
pavolmarko@432
    21
pavolmarko@432
    22
		// Code gen stuff
pavolmarko@432
    23
#if defined HAVE_STDINT_H && !defined WIN32
pavolmarko@432
    24
#include <stdint.h>
pavolmarko@432
    25
		typedef int8_t jit_int8_t;
pavolmarko@432
    26
		typedef uint8_t jit_uint8_t;
pavolmarko@432
    27
		typedef int32_t jit_int32_t;
pavolmarko@432
    28
		typedef uint32_t jit_uint32_t;
pavolmarko@432
    29
		typedef int64_t jit_int64_t;
pavolmarko@432
    30
		typedef uint64_t jit_uint64_t;
pavolmarko@432
    31
#elif defined WIN32
pavolmarko@432
    32
		typedef __int8 jit_int8_t;
pavolmarko@432
    33
		typedef unsigned __int8 jit_uint8_t;
pavolmarko@432
    34
		typedef __int32 jit_int32_t;
pavolmarko@432
    35
		typedef unsigned __int32 jit_uint32_t;
pavolmarko@432
    36
		typedef __int64 jit_int64_t;
pavolmarko@432
    37
		typedef unsigned __int64 jit_uint64_t;
pavolmarko@432
    38
#endif
pavolmarko@432
    39
		typedef unsigned int jitoffs_t;
pavolmarko@432
    40
		typedef signed int jitrel_t;
pavolmarko@432
    41
pavolmarko@432
    42
pavolmarko@432
    43
		class GenBuffer
pavolmarko@432
    44
		{
pavolmarko@435
    45
			static CPageAlloc ms_Allocator;
pavolmarko@435
    46
pavolmarko@435
    47
			unsigned char *m_pData;
pavolmarko@435
    48
			jitoffs_t m_Size;
pavolmarko@435
    49
			jitoffs_t m_AllocatedSize;
pavolmarko@435
    50
pavolmarko@435
    51
		public:
pavolmarko@435
    52
			GenBuffer() : m_pData(NULL), m_Size(0), m_AllocatedSize(0)
pavolmarko@435
    53
			{
pavolmarko@435
    54
			}
pavolmarko@435
    55
			~GenBuffer()
pavolmarko@435
    56
			{
pavolmarko@435
    57
				clear();
pavolmarko@435
    58
			}
pavolmarko@435
    59
			jitoffs_t GetSize()
pavolmarko@435
    60
			{
pavolmarko@435
    61
				return m_Size;
pavolmarko@435
    62
			}
pavolmarko@435
    63
			unsigned char *GetData()
pavolmarko@435
    64
			{
pavolmarko@435
    65
				return m_pData;
pavolmarko@435
    66
			}
pavolmarko@435
    67
pavolmarko@435
    68
			template <class PT> void push(PT what)
pavolmarko@435
    69
			{
pavolmarko@435
    70
				push((const unsigned char *)&what, sizeof(PT));
pavolmarko@435
    71
			}
pavolmarko@435
    72
pavolmarko@435
    73
			void push(const unsigned char *data, jitoffs_t size)
pavolmarko@435
    74
			{
pavolmarko@435
    75
				jitoffs_t newSize = m_Size + size;
pavolmarko@435
    76
				if (newSize > m_AllocatedSize)
pavolmarko@435
    77
				{
pavolmarko@435
    78
					m_AllocatedSize = newSize > m_AllocatedSize*2 ? newSize : m_AllocatedSize*2;
pavolmarko@435
    79
					if (m_AllocatedSize < 64)
pavolmarko@435
    80
						m_AllocatedSize = 64;
pavolmarko@435
    81
pavolmarko@435
    82
					unsigned char *newBuf;
pavolmarko@435
    83
					newBuf = reinterpret_cast<unsigned char*>(ms_Allocator.Alloc(m_AllocatedSize));
pavolmarko@435
    84
					ms_Allocator.SetRW(newBuf);
pavolmarko@435
    85
					if (!newBuf)
pavolmarko@435
    86
					{
pavolmarko@435
    87
						SH_ASSERT(0, ("bad_alloc: couldn't allocate 0x%08X bytes of memory\n", m_AllocatedSize));
pavolmarko@435
    88
						return;
pavolmarko@435
    89
					}
pavolmarko@436
    90
					memset((void*)newBuf, 0xCC, m_AllocatedSize);			// :TODO: remove this !
pavolmarko@435
    91
					memcpy((void*)newBuf, (const void*)m_pData, m_Size);
pavolmarko@435
    92
					if (m_pData)
pavolmarko@435
    93
						ms_Allocator.Free(reinterpret_cast<void*>(m_pData));
pavolmarko@435
    94
					m_pData = newBuf;
pavolmarko@435
    95
				}
pavolmarko@435
    96
				memcpy((void*)(m_pData + m_Size), (const void*)data, size);
pavolmarko@435
    97
				m_Size = newSize;
pavolmarko@435
    98
			}
pavolmarko@435
    99
pavolmarko@435
   100
			template <class PT> void rewrite(jitoffs_t offset, PT what)
pavolmarko@435
   101
			{
pavolmarko@435
   102
				rewrite(offset, (const unsigned char *)&what, sizeof(PT));
pavolmarko@435
   103
			}
pavolmarko@435
   104
pavolmarko@435
   105
			void rewrite(jitoffs_t offset, const unsigned char *data, jitoffs_t size)
pavolmarko@432
   106
			{
pavolmarko@432
   107
				SH_ASSERT(offset + size <= m_AllocatedSize, ("rewrite too far"));
pavolmarko@432
   108
pavolmarko@432
   109
				memcpy((void*)(m_pData + offset), (const void*)data, size);
pavolmarko@435
   110
			}
pavolmarko@435
   111
pavolmarko@435
   112
			void clear()
pavolmarko@435
   113
			{
pavolmarko@435
   114
				if (m_pData)
pavolmarko@435
   115
					ms_Allocator.Free(reinterpret_cast<void*>(m_pData));
pavolmarko@435
   116
				m_pData = NULL;
pavolmarko@435
   117
				m_Size = 0;
pavolmarko@435
   118
				m_AllocatedSize = 0;
pavolmarko@435
   119
			}
pavolmarko@435
   120
pavolmarko@435
   121
			void SetRE()
pavolmarko@435
   122
			{
pavolmarko@435
   123
				ms_Allocator.SetRE(reinterpret_cast<void*>(m_pData));
pavolmarko@432
   124
			}
pavolmarko@432
   125
pavolmarko@432
   126
			operator unsigned char *()
pavolmarko@432
   127
			{
pavolmarko@432
   128
				return GetData();
pavolmarko@432
   129
			}
pavolmarko@432
   130
pavolmarko@432
   131
			void write_ubyte(jit_uint8_t x)			{ push(x); }
pavolmarko@432
   132
			void write_byte(jit_uint8_t x)			{ push(x); }
pavolmarko@432
   133
			
pavolmarko@432
   134
			void write_ushort(unsigned short x)		{ push(x); }
pavolmarko@432
   135
			void write_short(signed short x)		{ push(x); }
pavolmarko@432
   136
pavolmarko@432
   137
			void write_uint32(jit_uint32_t x)		{ push(x); }
pavolmarko@432
   138
			void write_int32(jit_uint32_t x)		{ push(x); }
pavolmarko@432
   139
pavolmarko@432
   140
			jitoffs_t get_outputpos()
pavolmarko@432
   141
			{
pavolmarko@432
   142
				return m_Size;
pavolmarko@432
   143
			}
pavolmarko@432
   144
pavolmarko@432
   145
			void start_count(jitoffs_t &offs)
pavolmarko@432
   146
			{
pavolmarko@432
   147
				offs = get_outputpos();
pavolmarko@432
   148
			}
pavolmarko@432
   149
			void end_count(jitoffs_t &offs)
pavolmarko@432
   150
			{
pavolmarko@432
   151
				offs = get_outputpos() - offs;
pavolmarko@432
   152
			}
pavolmarko@432
   153
		};
pavolmarko@432
   154
pavolmarko@432
   155
		class GenContext
pavolmarko@432
   156
		{
pavolmarko@432
   157
			const static int SIZE_MWORD = 4;
pavolmarko@432
   158
			const static int SIZE_PTR = sizeof(void*);
pavolmarko@432
   159
pavolmarko@432
   160
			CProto m_Proto;
pavolmarko@432
   161
			int m_VtblOffs;
pavolmarko@432
   162
			int m_VtblIdx;
pavolmarko@432
   163
			ISourceHook *m_SHPtr;
pavolmarko@432
   164
pavolmarko@432
   165
			GenBuffer m_HookFunc;
pavolmarko@432
   166
			GenBuffer m_PubFunc;
pavolmarko@432
   167
pavolmarko@432
   168
			ProtoInfo *m_BuiltPI;
pavolmarko@432
   169
			PassInfo *m_BuiltPI_Params;
pavolmarko@432
   170
			PassInfo::V2Info *m_BuiltPI_Params2;
pavolmarko@432
   171
pavolmarko@432
   172
			// For hookfunc
pavolmarko@432
   173
			void **m_pHI;
pavolmarko@432
   174
			void **m_HookfuncVfnptr;
pavolmarko@432
   175
pavolmarko@432
   176
			// Level 3 - Helpers
pavolmarko@432
   177
			int m_RegCounter;
pavolmarko@432
   178
			jit_int8_t NextRegEBX_ECX_EDX();
pavolmarko@432
   179
pavolmarko@432
   180
			// size info
pavolmarko@432
   181
			jit_int32_t GetRealSize(const IntPassInfo &info);
pavolmarko@432
   182
			jit_int32_t GetStackSize(const IntPassInfo &info);
pavolmarko@432
   183
			short GetParamsStackSize();		// sum(GetStackSize(i), 0 <= i < numOfParams)
pavolmarko@432
   184
pavolmarko@437
   185
			// Helpers
pavolmarko@437
   186
			void BitwiseCopy_Setup();
pavolmarko@437
   187
			void BitwiseCopy_Do(size_t size);
pavolmarko@432
   188
pavolmarko@432
   189
			// Param push
pavolmarko@437
   190
			jit_int32_t PushParams(jit_int32_t param_base_offset, jit_int32_t save_ret_to, 
pavolmarko@437
   191
				jit_int32_t v_place_for_memret);		// save_ret_to and v_place_for_memret only used for memory returns
pavolmarko@432
   192
			jit_int32_t PushRef(jit_int32_t param_offset, const IntPassInfo &pi);
pavolmarko@432
   193
			jit_int32_t PushBasic(jit_int32_t param_offset, const IntPassInfo &pi);
pavolmarko@432
   194
			jit_int32_t PushFloat(jit_int32_t param_offset, const IntPassInfo &pi);
pavolmarko@432
   195
			jit_int32_t PushObject(jit_int32_t param_offset, const IntPassInfo &pi);
pavolmarko@432
   196
pavolmarko@432
   197
			// Ret val processing
pavolmarko@437
   198
			void SaveRetVal(jit_int32_t v_where, jit_int32_t v_place_for_memret);
pavolmarko@437
   199
			void ProcessPluginRetVal(jit_int32_t v_cur_res, jit_int32_t v_pContext, jit_int32_t v_plugin_ret);
pavolmarko@432
   200
pavolmarko@437
   201
			void PrepareReturn(jit_int32_t v_status, jit_int32_t v_pContext, jit_int32_t v_retptr);
pavolmarko@437
   202
			void DoReturn(jit_int32_t v_retptr, jit_int32_t v_memret_outaddr);
pavolmarko@437
   203
pavolmarko@437
   204
			bool MemRetWithTempObj();			// do we do a memory return AND need a temporary place for it?
pavolmarko@432
   205
pavolmarko@432
   206
			// Call hooks
pavolmarko@432
   207
			void GenerateCallHooks(int v_status, int v_prev_res, int v_cur_res, int v_iter,
pavolmarko@437
   208
				int v_pContext, int base_param_offset, int v_plugin_ret, int v_place_for_memret);
pavolmarko@432
   209
pavolmarko@432
   210
			// Call orig
pavolmarko@437
   211
			void GenerateCallOrig(int v_status, int v_pContext, int param_base_offs, int v_this,
pavolmarko@437
   212
				int v_vfnptr_origentry, int v_orig_ret, int v_override_ret, int v_place_for_memret);
pavolmarko@432
   213
pavolmarko@432
   214
			// Hook loop
pavolmarko@432
   215
			void CallSetupHookLoop(int v_orig_ret, int v_override_ret, 
pavolmarko@432
   216
				int v_cur_res, int v_prev_res, int v_status, int v_vnfptr_origentry,
pavolmarko@432
   217
				int v_this, int v_pContext);
pavolmarko@432
   218
pavolmarko@432
   219
			void CallEndContext(int v_pContext);
pavolmarko@432
   220
pavolmarko@432
   221
			// Level 2 -> called from Generate()
pavolmarko@436
   222
			void AutoDetectRetType();
pavolmarko@432
   223
			bool PassInfoSupported(const IntPassInfo &pi, bool is_ret);
pavolmarko@432
   224
			void Clear();
pavolmarko@432
   225
			void BuildProtoInfo();
pavolmarko@432
   226
			unsigned char *GenerateHookFunc();
pavolmarko@432
   227
			unsigned char *GeneratePubFunc();
pavolmarko@432
   228
		public:
pavolmarko@432
   229
			// Level 1 -> Public interface
pavolmarko@432
   230
			GenContext(const ProtoInfo *proto, int vtbl_offs, int vtbl_idx, ISourceHook *pSHPtr);
pavolmarko@432
   231
			~GenContext();
pavolmarko@432
   232
pavolmarko@432
   233
			HookManagerPubFunc Generate();
pavolmarko@432
   234
		};
pavolmarko@432
   235
	}
pavolmarko@432
   236
}
pavolmarko@432
   237
pavolmarko@432
   238
pavolmarko@432
   239
#endif