core/sourcehook/sourcehook_hookmangen.h
author Scott Ehlert <ds@alliedmods.net>
Thu Dec 10 00:59:50 2009 -0600 (2009-12-10)
changeset 689 4065ba5e9155
parent 539 db914129ae01
child 733 2365240861a2
permissions -rw-r--r--
Rewrote user message caching code to always use IServerGameDLL::GetUserMessageInfo (bug 4117, r=dvander).

Games where the above function can crash are handled by detouring tier0's Error() function and jumping back to our own code. So in theory this should work on all games now.
pavolmarko@480
     1
/* ======== SourceHook ========
ds@523
     2
* Copyright (C) 2004-2008 Metamod:Source Development Team
pavolmarko@480
     3
* No warranties of any kind
pavolmarko@480
     4
*
pavolmarko@480
     5
* License: zlib/libpng
pavolmarko@480
     6
*
pavolmarko@480
     7
* Author(s): Pavol "PM OnoTo" Marko
pavolmarko@480
     8
* ============================
pavolmarko@480
     9
*/
pavolmarko@480
    10
pavolmarko@480
    11
#ifndef __SOURCEHOOK_HOOKMANGEN_H__
pavolmarko@480
    12
#define __SOURCEHOOK_HOOKMANGEN_H__
pavolmarko@480
    13
pavolmarko@480
    14
#include "sh_pagealloc.h"
pavolmarko@480
    15
pavolmarko@480
    16
namespace SourceHook
pavolmarko@480
    17
{
pavolmarko@480
    18
	namespace Impl
pavolmarko@480
    19
	{
pavolmarko@480
    20
pavolmarko@480
    21
		// Code gen stuff
pavolmarko@480
    22
#if SH_COMP == SH_COMP_GCC
pavolmarko@480
    23
#include <stdint.h>
pavolmarko@480
    24
		typedef int8_t jit_int8_t;
pavolmarko@480
    25
		typedef uint8_t jit_uint8_t;
pavolmarko@480
    26
		typedef int32_t jit_int32_t;
pavolmarko@480
    27
		typedef uint32_t jit_uint32_t;
pavolmarko@480
    28
		typedef int64_t jit_int64_t;
pavolmarko@480
    29
		typedef uint64_t jit_uint64_t;
pavolmarko@480
    30
#elif SH_COMP == SH_COMP_MSVC
pavolmarko@480
    31
		typedef __int8 jit_int8_t;
pavolmarko@480
    32
		typedef unsigned __int8 jit_uint8_t;
pavolmarko@480
    33
		typedef __int32 jit_int32_t;
pavolmarko@480
    34
		typedef unsigned __int32 jit_uint32_t;
pavolmarko@480
    35
		typedef __int64 jit_int64_t;
pavolmarko@480
    36
		typedef unsigned __int64 jit_uint64_t;
pavolmarko@480
    37
#endif
pavolmarko@480
    38
		typedef unsigned int jitoffs_t;
pavolmarko@480
    39
		typedef signed int jitrel_t;
pavolmarko@480
    40
pavolmarko@480
    41
pavolmarko@480
    42
		class GenBuffer
pavolmarko@480
    43
		{
pavolmarko@480
    44
			static CPageAlloc ms_Allocator;
pavolmarko@480
    45
pavolmarko@480
    46
			unsigned char *m_pData;
pavolmarko@480
    47
			jitoffs_t m_Size;
pavolmarko@480
    48
			jitoffs_t m_AllocatedSize;
pavolmarko@480
    49
pavolmarko@480
    50
		public:
pavolmarko@480
    51
			GenBuffer() : m_pData(NULL), m_Size(0), m_AllocatedSize(0)
pavolmarko@480
    52
			{
pavolmarko@480
    53
			}
pavolmarko@480
    54
			~GenBuffer()
pavolmarko@480
    55
			{
pavolmarko@480
    56
				clear();
pavolmarko@480
    57
			}
pavolmarko@480
    58
			jitoffs_t GetSize()
pavolmarko@480
    59
			{
pavolmarko@480
    60
				return m_Size;
pavolmarko@480
    61
			}
pavolmarko@480
    62
			unsigned char *GetData()
pavolmarko@480
    63
			{
pavolmarko@480
    64
				return m_pData;
pavolmarko@480
    65
			}
pavolmarko@480
    66
pavolmarko@480
    67
			template <class PT> void push(PT what)
pavolmarko@480
    68
			{
pavolmarko@480
    69
				push((const unsigned char *)&what, sizeof(PT));
pavolmarko@480
    70
			}
pavolmarko@480
    71
pavolmarko@480
    72
			void push(const unsigned char *data, jitoffs_t size)
pavolmarko@480
    73
			{
pavolmarko@480
    74
				jitoffs_t newSize = m_Size + size;
pavolmarko@480
    75
				if (newSize > m_AllocatedSize)
pavolmarko@480
    76
				{
pavolmarko@480
    77
					m_AllocatedSize = newSize > m_AllocatedSize*2 ? newSize : m_AllocatedSize*2;
pavolmarko@480
    78
					if (m_AllocatedSize < 64)
pavolmarko@480
    79
						m_AllocatedSize = 64;
pavolmarko@480
    80
pavolmarko@480
    81
					unsigned char *newBuf;
pavolmarko@480
    82
					newBuf = reinterpret_cast<unsigned char*>(ms_Allocator.Alloc(m_AllocatedSize));
pavolmarko@480
    83
					ms_Allocator.SetRW(newBuf);
pavolmarko@480
    84
					if (!newBuf)
pavolmarko@480
    85
					{
pavolmarko@480
    86
						SH_ASSERT(0, ("bad_alloc: couldn't allocate 0x%08X bytes of memory\n", m_AllocatedSize));
pavolmarko@480
    87
						return;
pavolmarko@480
    88
					}
pavolmarko@480
    89
					memset((void*)newBuf, 0xCC, m_AllocatedSize);			// :TODO: remove this !
pavolmarko@480
    90
					memcpy((void*)newBuf, (const void*)m_pData, m_Size);
pavolmarko@480
    91
					if (m_pData)
pavolmarko@480
    92
					{
pavolmarko@480
    93
						ms_Allocator.SetRE(reinterpret_cast<void*>(m_pData));
pavolmarko@480
    94
						ms_Allocator.SetRW(newBuf);
pavolmarko@480
    95
						ms_Allocator.Free(reinterpret_cast<void*>(m_pData));
pavolmarko@480
    96
					}
pavolmarko@480
    97
					m_pData = newBuf;
pavolmarko@480
    98
				}
pavolmarko@480
    99
				memcpy((void*)(m_pData + m_Size), (const void*)data, size);
pavolmarko@480
   100
				m_Size = newSize;
pavolmarko@480
   101
			}
pavolmarko@480
   102
pavolmarko@480
   103
			template <class PT> void rewrite(jitoffs_t offset, PT what)
pavolmarko@480
   104
			{
pavolmarko@480
   105
				rewrite(offset, (const unsigned char *)&what, sizeof(PT));
pavolmarko@480
   106
			}
pavolmarko@480
   107
pavolmarko@480
   108
			void rewrite(jitoffs_t offset, const unsigned char *data, jitoffs_t size)
pavolmarko@480
   109
			{
pavolmarko@480
   110
				SH_ASSERT(offset + size <= m_AllocatedSize, ("rewrite too far"));
pavolmarko@480
   111
pavolmarko@480
   112
				memcpy((void*)(m_pData + offset), (const void*)data, size);
pavolmarko@480
   113
			}
pavolmarko@480
   114
pavolmarko@480
   115
			void clear()
pavolmarko@480
   116
			{
pavolmarko@480
   117
				if (m_pData)
pavolmarko@480
   118
					ms_Allocator.Free(reinterpret_cast<void*>(m_pData));
pavolmarko@480
   119
				m_pData = NULL;
pavolmarko@480
   120
				m_Size = 0;
pavolmarko@480
   121
				m_AllocatedSize = 0;
pavolmarko@480
   122
			}
pavolmarko@480
   123
pavolmarko@480
   124
			void SetRE()
pavolmarko@480
   125
			{
pavolmarko@480
   126
				ms_Allocator.SetRE(reinterpret_cast<void*>(m_pData));
pavolmarko@480
   127
			}
pavolmarko@480
   128
pavolmarko@480
   129
			operator void *()
pavolmarko@480
   130
			{
pavolmarko@480
   131
				return reinterpret_cast<void*>(GetData());
pavolmarko@480
   132
			}
pavolmarko@480
   133
pavolmarko@480
   134
			void write_ubyte(jit_uint8_t x)			{ push(x); }
pavolmarko@480
   135
			void write_byte(jit_uint8_t x)			{ push(x); }
pavolmarko@480
   136
			
pavolmarko@480
   137
			void write_ushort(unsigned short x)		{ push(x); }
pavolmarko@480
   138
			void write_short(signed short x)		{ push(x); }
pavolmarko@480
   139
pavolmarko@480
   140
			void write_uint32(jit_uint32_t x)		{ push(x); }
pavolmarko@480
   141
			void write_int32(jit_uint32_t x)		{ push(x); }
pavolmarko@480
   142
pavolmarko@480
   143
			jitoffs_t get_outputpos()
pavolmarko@480
   144
			{
pavolmarko@480
   145
				return m_Size;
pavolmarko@480
   146
			}
pavolmarko@480
   147
pavolmarko@480
   148
			void start_count(jitoffs_t &offs)
pavolmarko@480
   149
			{
pavolmarko@480
   150
				offs = get_outputpos();
pavolmarko@480
   151
			}
pavolmarko@480
   152
			void end_count(jitoffs_t &offs)
pavolmarko@480
   153
			{
pavolmarko@480
   154
				offs = get_outputpos() - offs;
pavolmarko@480
   155
			}
pavolmarko@480
   156
		};
pavolmarko@480
   157
pavolmarko@480
   158
		class GenContext
pavolmarko@480
   159
		{
pavolmarko@480
   160
			const static int SIZE_MWORD = 4;
pavolmarko@480
   161
			const static int SIZE_PTR = sizeof(void*);
pavolmarko@480
   162
			const static int PassFlag_ForcedByRef = (1<<30);   // ByVal in source, but actually passed by reference (GCC) -> private pass, destruct
pavolmarko@480
   163
pavolmarko@480
   164
			HookManagerPubFunc m_GeneratedPubFunc;
pavolmarko@480
   165
pavolmarko@480
   166
			CProto m_OrigProto;			// original passed-in prototype
pavolmarko@480
   167
			CProto m_Proto;
pavolmarko@480
   168
			int m_VtblOffs;
pavolmarko@480
   169
			int m_VtblIdx;
pavolmarko@480
   170
			ISourceHook *m_SHPtr;
pavolmarko@480
   171
pavolmarko@480
   172
			GenBuffer m_HookFunc;
pavolmarko@480
   173
			GenBuffer m_PubFunc;
pavolmarko@480
   174
pavolmarko@480
   175
			ProtoInfo *m_BuiltPI;
pavolmarko@480
   176
			PassInfo *m_BuiltPI_Params;
pavolmarko@480
   177
			PassInfo::V2Info *m_BuiltPI_Params2;
pavolmarko@480
   178
pavolmarko@480
   179
			// For hookfunc
pavolmarko@480
   180
			void **m_pHI;
pavolmarko@480
   181
			void **m_HookfuncVfnptr;
pavolmarko@480
   182
pavolmarko@480
   183
			// Level 3 - Helpers
pavolmarko@480
   184
			int m_RegCounter;
pavolmarko@480
   185
			jit_int8_t NextRegEBX_ECX_EDX();
pavolmarko@480
   186
pavolmarko@480
   187
			int m_BytesPushedAfterInitialAlignment;
pavolmarko@480
   188
			enum AlignStackFlags
pavolmarko@480
   189
			{
pavolmarko@480
   190
				AlignStack_GCC_ThisOnStack = 1,
pavolmarko@480
   191
				AlignStack_MSVC_ThisOnStack = 2,
pavolmarko@480
   192
				AlignStack_MemRet = 4
pavolmarko@480
   193
			};
pavolmarko@480
   194
			jit_int32_t AlignStackBeforeCall(int paramsize, int flags);
pavolmarko@480
   195
			void AlignStackAfterCall(jit_int32_t numofbytes);
pavolmarko@480
   196
			void CheckAlignmentBeforeCall();
pavolmarko@480
   197
pavolmarko@480
   198
			// size info
pavolmarko@480
   199
			jit_int32_t GetRealSize(const IntPassInfo &info);			// checks for reference
pavolmarko@480
   200
			jit_int32_t AlignSize(jit_int32_t x, jit_int32_t boundary);	// align a size
pavolmarko@480
   201
			jit_int32_t GetParamStackSize(const IntPassInfo &info);		// get the size of a param in the param stack
pavolmarko@480
   202
			short GetParamsTotalStackSize();		// sum(GetParamStackSize(param[i]), 0 <= i < numOfParams)
pavolmarko@480
   203
pavolmarko@480
   204
			// Helpers
pavolmarko@480
   205
			void BitwiseCopy_Setup();
pavolmarko@480
   206
			void BitwiseCopy_Do(size_t size);
pavolmarko@480
   207
pavolmarko@480
   208
pavolmarko@480
   209
			// HookFunc frame
pavolmarko@480
   210
			jit_int32_t m_HookFunc_FrameOffset;
pavolmarko@480
   211
			jit_int32_t m_HookFunc_FrameVarsSize;
pavolmarko@480
   212
pavolmarko@480
   213
			void ResetFrame(jit_int32_t startOffset);
pavolmarko@480
   214
			jit_int32_t AddVarToFrame(jit_int32_t size);
pavolmarko@480
   215
			jit_int32_t ComputeVarsSize();
pavolmarko@480
   216
pavolmarko@480
   217
			// Param push
pavolmarko@480
   218
			short GetForcedByRefParamsSize();		// sum(param[i] is forcedbyref ? GetStackSize(param[i]) : 0, 0 <= i < numOfParams)
pavolmarko@480
   219
			short GetForcedByRefParamOffset(int p);		// sum(param[i] is forcedbyref ? GetStackSize(param[i]) : 0, 0 <= i < p)
pavolmarko@480
   220
			jit_int32_t PushParams(jit_int32_t param_base_offset, jit_int32_t save_ret_to, 
pavolmarko@480
   221
				jit_int32_t v_place_for_memret, jit_int32_t v_place_fbrr_base);		// save_ret_to and v_place_for_memret only used for memory returns
pavolmarko@480
   222
			jit_int32_t PushRef(jit_int32_t param_offset, const IntPassInfo &pi);
pavolmarko@480
   223
			jit_int32_t PushBasic(jit_int32_t param_offset, const IntPassInfo &pi);
pavolmarko@480
   224
			jit_int32_t PushFloat(jit_int32_t param_offset, const IntPassInfo &pi);
pavolmarko@480
   225
			jit_int32_t PushObject(jit_int32_t param_offset, const IntPassInfo &pi, jit_int32_t v_place_fbrr);
pavolmarko@480
   226
			jit_int32_t PushMemRetPtr(jit_int32_t save_ret_to, jit_int32_t v_place_for_memret);
pavolmarko@480
   227
			void DestroyParams(jit_int32_t fbrr_base);
pavolmarko@480
   228
pavolmarko@480
   229
			// Ret val processing
pavolmarko@480
   230
			void SaveRetVal(jit_int32_t v_where, jit_int32_t v_place_for_memret);
pavolmarko@480
   231
			void ProcessPluginRetVal(jit_int32_t v_cur_res, jit_int32_t v_pContext, jit_int32_t v_plugin_ret);
pavolmarko@480
   232
pavolmarko@480
   233
			void PrepareReturn(jit_int32_t v_status, jit_int32_t v_pContext, jit_int32_t v_retptr);
pavolmarko@480
   234
			void DoReturn(jit_int32_t v_retptr, jit_int32_t v_memret_outaddr);
pavolmarko@480
   235
pavolmarko@480
   236
			bool MemRetWithTempObj();			// do we do a memory return AND need a temporary place for it?
pavolmarko@480
   237
pavolmarko@480
   238
			// Call hooks
pavolmarko@480
   239
			void GenerateCallHooks(int v_status, int v_prev_res, int v_cur_res, int v_iter,
pavolmarko@480
   240
				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);
pavolmarko@480
   241
pavolmarko@480
   242
			// Call orig
pavolmarko@480
   243
			void GenerateCallOrig(int v_status, int v_pContext, int param_base_offs, int v_this,
pavolmarko@480
   244
				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);
pavolmarko@480
   245
pavolmarko@480
   246
			// Hook loop
pavolmarko@480
   247
			void CallSetupHookLoop(int v_orig_ret, int v_override_ret, 
pavolmarko@480
   248
				int v_cur_res, int v_prev_res, int v_status, int v_vnfptr_origentry,
pavolmarko@480
   249
				int v_this, int v_pContext);
pavolmarko@480
   250
pavolmarko@480
   251
			void CallEndContext(int v_pContext);
pavolmarko@480
   252
pavolmarko@480
   253
			// Level 2 -> called from Generate()
pavolmarko@480
   254
			void AutoDetectRetType();
pavolmarko@480
   255
			void AutoDetectParamFlags();
pavolmarko@480
   256
			bool PassInfoSupported(const IntPassInfo &pi, bool is_ret);
pavolmarko@480
   257
			void Clear();
pavolmarko@480
   258
			void BuildProtoInfo();
pavolmarko@480
   259
			void *GenerateHookFunc();
pavolmarko@480
   260
			void *GeneratePubFunc();
pavolmarko@480
   261
			
pavolmarko@480
   262
			HookManagerPubFunc Generate();
pavolmarko@480
   263
		public:
pavolmarko@480
   264
			// Level 1 -> Public interface
pavolmarko@480
   265
			GenContext(const ProtoInfo *proto, int vtbl_offs, int vtbl_idx, ISourceHook *pSHPtr);
pavolmarko@480
   266
			~GenContext();
pavolmarko@480
   267
pavolmarko@480
   268
			bool Equal(const CProto &proto, int vtbl_offs, int vtbl_idx);
pavolmarko@480
   269
			bool Equal(HookManagerPubFunc other);
pavolmarko@480
   270
pavolmarko@480
   271
			HookManagerPubFunc GetPubFunc();
pavolmarko@480
   272
		};
pavolmarko@480
   273
pavolmarko@480
   274
		class CHookManagerAutoGen : public IHookManagerAutoGen 
pavolmarko@480
   275
		{
pavolmarko@480
   276
			struct StoredContext
pavolmarko@480
   277
			{
pavolmarko@480
   278
				int m_RefCnt;
pavolmarko@480
   279
				GenContext *m_GenContext;
pavolmarko@480
   280
			};
pavolmarko@480
   281
			List<StoredContext> m_Contexts;
pavolmarko@480
   282
			ISourceHook *m_pSHPtr;
pavolmarko@480
   283
pavolmarko@480
   284
		public:
pavolmarko@480
   285
			CHookManagerAutoGen(ISourceHook *pSHPtr);
pavolmarko@480
   286
			~CHookManagerAutoGen();
pavolmarko@480
   287
pavolmarko@480
   288
			int GetIfaceVersion();
pavolmarko@480
   289
			int GetImplVersion();
pavolmarko@480
   290
pavolmarko@480
   291
			HookManagerPubFunc MakeHookMan(const ProtoInfo *proto, int vtbl_offs, int vtbl_idx);
pavolmarko@480
   292
			void ReleaseHookMan(HookManagerPubFunc pubFunc);
pavolmarko@480
   293
		};
pavolmarko@480
   294
pavolmarko@480
   295
	}
pavolmarko@480
   296
}
pavolmarko@480
   297
pavolmarko@480
   298
pavolmarko@480
   299
#endif