sourcehook/sourcehook_impl.h
author Pavol Marko <pavolmarko@gmail.com>
Wed Oct 12 20:25:15 2005 +0000 (2005-10-12)
changeset 128 63f95eed16b6
parent 123 53e819ac032a
child 137 edafdaacae96
permissions -rw-r--r--
Untested reentrancy support; TODO: Test sh_stack and reentrancy extensively!
pavolmarko@1
     1
/* ======== SourceHook ========
dvander@10
     2
* Copyright (C) 2004-2005 Metamod:Source Development Team
pavolmarko@1
     3
* No warranties of any kind
pavolmarko@1
     4
*
dvander@10
     5
* License: zlib/libpng
dvander@10
     6
*
dvander@10
     7
* Author(s): Pavol "PM OnoTo" Marko
pavolmarko@1
     8
* ============================
pavolmarko@1
     9
*/
pavolmarko@1
    10
pavolmarko@1
    11
#ifndef __SOURCEHOOK_IMPL_H__
pavolmarko@1
    12
#define __SOURCEHOOK_IMPL_H__
pavolmarko@1
    13
pavolmarko@1
    14
#include "sourcehook.h"
pavolmarko@117
    15
#include "sh_list.h"
pavolmarko@117
    16
#include "sh_vector.h"
pavolmarko@117
    17
#include "sh_tinyhash.h"
pavolmarko@128
    18
#include "sh_stack.h"
ds@86
    19
pavolmarko@1
    20
// Set this to 1 to enable runtime code generation (faster)
pavolmarko@117
    21
//  (unused at the moment, but may come back, so I'm leaving it in here!)
pavolmarko@1
    22
#define SH_RUNTIME_CODEGEN 1
pavolmarko@1
    23
pavolmarko@1
    24
namespace SourceHook
pavolmarko@1
    25
{
pavolmarko@1
    26
	/**
pavolmarko@1
    27
	*	@brief The SourceHook implementation class
pavolmarko@1
    28
	*/
pavolmarko@1
    29
	class CSourceHookImpl : public ISourceHook
pavolmarko@1
    30
	{
pavolmarko@117
    31
	private:
pavolmarko@1
    32
		/**
pavolmarko@6
    33
		*	@brief A hook can be removed if you have this information
pavolmarko@1
    34
		*/
pavolmarko@6
    35
		struct RemoveHookInfo
pavolmarko@6
    36
		{
pavolmarko@58
    37
			RemoveHookInfo(Plugin pplug, void *piface, int tpo, HookManagerPubFunc phookman,
pavolmarko@41
    38
				ISHDelegate *phandler, bool ppost)
pavolmarko@58
    39
				: plug(pplug), iface(piface), thisptr_offs(tpo),
pavolmarko@58
    40
				hookman(phookman), handler(phandler), post(ppost)
pavolmarko@6
    41
			{
pavolmarko@6
    42
			}
pavolmarko@6
    43
pavolmarko@6
    44
			Plugin plug;
pavolmarko@6
    45
			void *iface;
pavolmarko@58
    46
			int thisptr_offs;
pavolmarko@41
    47
			HookManagerPubFunc hookman;
pavolmarko@6
    48
			ISHDelegate *handler;
pavolmarko@6
    49
			bool post;
pavolmarko@6
    50
		};
pavolmarko@6
    51
pavolmarko@117
    52
		struct HookInfo
pavolmarko@117
    53
		{
pavolmarko@117
    54
			ISHDelegate *handler;			//!< Pointer to the handler
pavolmarko@117
    55
			bool paused;					//!< If true, the hook should not be executed
pavolmarko@117
    56
			Plugin plug;					//!< The owner plugin
pavolmarko@117
    57
			int thisptr_offs;				//!< This pointer offset
pavolmarko@117
    58
		};
pavolmarko@117
    59
pavolmarko@117
    60
		class CHookList : public IHookList
pavolmarko@117
    61
		{
pavolmarko@117
    62
		public:
pavolmarko@117
    63
			List<HookInfo> m_List;
pavolmarko@117
    64
pavolmarko@117
    65
			friend class CIter;
pavolmarko@117
    66
pavolmarko@117
    67
			class CIter : public IHookList::IIter
pavolmarko@117
    68
			{
pavolmarko@117
    69
				friend class CHookList;
pavolmarko@117
    70
pavolmarko@117
    71
				CHookList *m_pList;
pavolmarko@117
    72
pavolmarko@117
    73
				void SkipPaused();
pavolmarko@117
    74
			public:
pavolmarko@121
    75
pavolmarko@121
    76
				List<HookInfo>::iterator m_Iter;
pavolmarko@121
    77
pavolmarko@117
    78
				CIter(CHookList *pList);
pavolmarko@117
    79
pavolmarko@117
    80
				virtual ~CIter();
pavolmarko@117
    81
pavolmarko@117
    82
				void GoToBegin();
pavolmarko@117
    83
pavolmarko@117
    84
				bool End();
pavolmarko@117
    85
				void Next();
pavolmarko@117
    86
				ISHDelegate *Handler();
pavolmarko@117
    87
				int ThisPtrOffs();
pavolmarko@117
    88
pavolmarko@121
    89
				void Clear();
pavolmarko@121
    90
pavolmarko@121
    91
				CIter *m_pNext;		// When stored in m_FreeIters and m_UsedIters
pavolmarko@121
    92
				CIter *m_pPrev;		// Only used when stored in m_UsedIters
pavolmarko@117
    93
			};
pavolmarko@117
    94
pavolmarko@117
    95
			CIter *m_FreeIters;
pavolmarko@121
    96
			CIter *m_UsedIters;
pavolmarko@117
    97
pavolmarko@117
    98
			CHookList();
pavolmarko@117
    99
			CHookList(const CHookList &other);
pavolmarko@117
   100
			virtual ~CHookList();
pavolmarko@117
   101
pavolmarko@117
   102
			void operator=(const CHookList &other);
pavolmarko@117
   103
pavolmarko@117
   104
			IIter *GetIter();
pavolmarko@117
   105
			void ReleaseIter(IIter *pIter);
pavolmarko@117
   106
		};
pavolmarko@117
   107
pavolmarko@117
   108
		// I know, data hiding... But I'm a lazy bastard!
pavolmarko@117
   109
pavolmarko@117
   110
		class CIface : public IIface
pavolmarko@117
   111
		{
pavolmarko@117
   112
		public:
pavolmarko@117
   113
			void *m_Ptr;
pavolmarko@117
   114
			CHookList m_PreHooks;
pavolmarko@117
   115
			CHookList m_PostHooks;
pavolmarko@117
   116
		public:
pavolmarko@117
   117
			CIface(void *ptr);
pavolmarko@117
   118
			virtual ~CIface();
pavolmarko@117
   119
pavolmarko@117
   120
			void *GetPtr();
pavolmarko@117
   121
			IHookList *GetPreHooks();
pavolmarko@117
   122
			IHookList *GetPostHooks();
pavolmarko@117
   123
pavolmarko@117
   124
			bool operator==(void *ptr)
pavolmarko@117
   125
			{
pavolmarko@117
   126
				return m_Ptr == ptr;
pavolmarko@117
   127
			}
pavolmarko@117
   128
		};
pavolmarko@1
   129
pavolmarko@117
   130
		class CVfnPtr : public IVfnPtr
pavolmarko@117
   131
		{
pavolmarko@117
   132
		public:
pavolmarko@117
   133
			typedef List<CIface> IfaceList;
pavolmarko@117
   134
			typedef IfaceList::iterator IfaceListIter;
pavolmarko@117
   135
pavolmarko@117
   136
			void *m_Ptr;
pavolmarko@117
   137
			void *m_OrigEntry;
pavolmarko@117
   138
pavolmarko@117
   139
			IfaceList m_Ifaces;
pavolmarko@117
   140
pavolmarko@117
   141
		public:
pavolmarko@117
   142
			CVfnPtr(void *ptr);
pavolmarko@117
   143
			virtual ~CVfnPtr();
pavolmarko@117
   144
pavolmarko@117
   145
			void *GetVfnPtr();
pavolmarko@117
   146
			void *GetOrigEntry();
pavolmarko@117
   147
pavolmarko@117
   148
			virtual IIface *FindIface(void *ptr);
pavolmarko@117
   149
pavolmarko@117
   150
			bool operator==(void *ptr)
pavolmarko@117
   151
			{
pavolmarko@117
   152
				return m_Ptr == ptr;
pavolmarko@117
   153
			}
pavolmarko@117
   154
		};
pavolmarko@117
   155
pavolmarko@117
   156
		class CHookManagerInfo : public IHookManagerInfo
pavolmarko@41
   157
		{
pavolmarko@117
   158
		public:
pavolmarko@117
   159
			typedef List<CVfnPtr> VfnPtrList;
pavolmarko@117
   160
			typedef VfnPtrList::iterator VfnPtrListIter;
pavolmarko@117
   161
pavolmarko@117
   162
			Plugin m_Plug;
pavolmarko@117
   163
			HookManagerPubFunc m_Func;
pavolmarko@117
   164
pavolmarko@117
   165
			int m_VtblOffs;
pavolmarko@117
   166
			int m_VtblIdx;
pavolmarko@117
   167
			const char *m_Proto;
pavolmarko@117
   168
			void *m_HookfuncVfnptr;
pavolmarko@117
   169
pavolmarko@117
   170
			VfnPtrList m_VfnPtrs;
pavolmarko@117
   171
pavolmarko@117
   172
		public:
pavolmarko@117
   173
			virtual ~CHookManagerInfo();
pavolmarko@117
   174
pavolmarko@117
   175
			IVfnPtr *FindVfnPtr(void *vfnptr);
pavolmarko@117
   176
pavolmarko@117
   177
			void SetInfo(int vtbl_offs, int vtbl_idx, const char *proto);
pavolmarko@117
   178
			void SetHookfuncVfnptr(void *hookfunc_vfnptr);
pavolmarko@117
   179
		};
pavolmarko@117
   180
		/**
pavolmarko@117
   181
		*	@brief A list of CHookManagerInfo classes
pavolmarko@117
   182
		*/
pavolmarko@117
   183
		typedef List<CHookManagerInfo> HookManInfoList;
pavolmarko@117
   184
pavolmarko@117
   185
		class CCallClassImpl : public GenericCallClass
pavolmarko@117
   186
		{
pavolmarko@117
   187
		public:
pavolmarko@117
   188
pavolmarko@117
   189
			typedef SourceHook::CVector<void*> OrigFuncs;
pavolmarko@117
   190
			typedef SourceHook::THash<int, OrigFuncs> OrigVTables;
pavolmarko@117
   191
pavolmarko@117
   192
			void *m_Ptr;			//!< Pointer to the actual object
pavolmarko@117
   193
			size_t m_ObjSize;		//!< Size of the instance
pavolmarko@117
   194
			OrigVTables m_VT;		//!< Info about vtables & functions
pavolmarko@117
   195
pavolmarko@117
   196
			int m_RefCounter;
pavolmarko@117
   197
pavolmarko@117
   198
			CCallClassImpl(void *ptr, size_t size);
pavolmarko@117
   199
			virtual ~CCallClassImpl();
pavolmarko@117
   200
pavolmarko@41
   201
			bool operator==(void *other)
pavolmarko@41
   202
			{
pavolmarko@117
   203
				return m_Ptr == other;
pavolmarko@41
   204
			}
pavolmarko@117
   205
pavolmarko@117
   206
			void *GetThisPtr();
pavolmarko@117
   207
			void *GetOrigFunc(int vtbloffs, int vtblidx);
pavolmarko@117
   208
pavolmarko@117
   209
			void ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@117
   210
			void RemoveCallClassPatch(int vtbl_offs, int vtbl_idx);
pavolmarko@41
   211
		};
pavolmarko@117
   212
pavolmarko@1
   213
		/**
pavolmarko@41
   214
		*	@brief A list of CallClass structures
pavolmarko@1
   215
		*/
pavolmarko@117
   216
		typedef List<CCallClassImpl> Impl_CallClassList;
pavolmarko@1
   217
pavolmarko@1
   218
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@6
   219
		HookManInfoList m_HookMans;					//!< A list of hook managers
pavolmarko@1
   220
pavolmarko@128
   221
		struct HookLoopInfo
pavolmarko@128
   222
		{
pavolmarko@128
   223
			META_RES *pStatus;
pavolmarko@128
   224
			META_RES *pPrevRes;
pavolmarko@128
   225
			META_RES *pCurRes;
pavolmarko@128
   226
pavolmarko@128
   227
			bool shouldContinue;
pavolmarko@128
   228
pavolmarko@128
   229
			IIface *pCurIface;
pavolmarko@128
   230
			const void *pOrigRet;
pavolmarko@128
   231
			const void *pOverrideRet;
pavolmarko@128
   232
			void **pIfacePtrPtr;
pavolmarko@128
   233
		};
pavolmarko@128
   234
		typedef CStack<HookLoopInfo> HookLoopInfoStack;
pavolmarko@128
   235
pavolmarko@1
   236
		/**
pavolmarko@6
   237
		*	@brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index
pavolmarko@1
   238
		*/
pavolmarko@117
   239
		HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end,
pavolmarko@41
   240
			const char *proto, int vtblofs, int vtblidx);
pavolmarko@1
   241
pavolmarko@117
   242
		void ApplyCallClassPatches(CCallClassImpl &cc);
pavolmarko@58
   243
		void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@58
   244
		void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx);
pavolmarko@1
   245
pavolmarko@117
   246
		void SetPluginPaused(Plugin plug, bool paused);
pavolmarko@117
   247
pavolmarko@128
   248
		HookLoopInfoStack m_HLIStack;
pavolmarko@1
   249
	public:
pavolmarko@1
   250
		CSourceHookImpl();
pavolmarko@117
   251
		virtual ~CSourceHookImpl();
pavolmarko@1
   252
pavolmarko@1
   253
		/**
pavolmarko@58
   254
		*	@brief Returns the interface version
pavolmarko@58
   255
		*/
pavolmarko@58
   256
		int GetIfaceVersion();
pavolmarko@58
   257
pavolmarko@58
   258
		/**
pavolmarko@58
   259
		*	@brief Returns the implemnetation version
pavolmarko@58
   260
		*/
pavolmarko@58
   261
		int GetImplVersion();
pavolmarko@58
   262
pavolmarko@58
   263
		/**
pavolmarko@6
   264
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
pavolmarko@1
   265
		*/
pavolmarko@1
   266
		void UnloadPlugin(Plugin plug);
pavolmarko@1
   267
pavolmarko@1
   268
		/**
pavolmarko@6
   269
		*	@brief Shut down the whole system, unregister all hook managers
pavolmarko@1
   270
		*/
pavolmarko@1
   271
		void CompleteShutdown();
pavolmarko@1
   272
pavolmarko@1
   273
		/**
pavolmarko@1
   274
		*	@brief Add a hook.
pavolmarko@1
   275
		*
pavolmarko@1
   276
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   277
		*
pavolmarko@1
   278
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   279
		*	@param iface The interface pointer
pavolmarko@6
   280
		*	@param ifacesize The size of the class iface points to
pavolmarko@6
   281
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
   282
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
   283
		*	@param post Set to true if you want a post handler
pavolmarko@1
   284
		*/
pavolmarko@41
   285
		bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   286
pavolmarko@1
   287
		/**
pavolmarko@1
   288
		*	@brief Removes a hook.
pavolmarko@1
   289
		*
pavolmarko@1
   290
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   291
		*
pavolmarko@1
   292
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   293
		*	@param iface The interface pointer
pavolmarko@41
   294
		*	@param thisptr_offs This pointer adjuster
pavolmarko@41
   295
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@41
   296
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@41
   297
		*	@param post Set to true if you want a post handler
pavolmarko@41
   298
		*/
pavolmarko@41
   299
		bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@41
   300
pavolmarko@41
   301
		/**
pavolmarko@41
   302
		*	@brief Removes a hook.
pavolmarko@41
   303
		*
pavolmarko@41
   304
		*	@ return True if the function succeeded, false otherwise
pavolmarko@41
   305
		*
pavolmarko@41
   306
		*	@param info A RemoveHookInfo structure, describing the hook
pavolmarko@41
   307
		*/
pavolmarko@41
   308
		bool RemoveHook(RemoveHookInfo info);
pavolmarko@41
   309
pavolmarko@41
   310
		/**
pavolmarko@6
   311
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
pavolmarko@1
   312
		*
pavolmarko@1
   313
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   314
		*/
pavolmarko@1
   315
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   316
pavolmarko@1
   317
		/**
pavolmarko@8
   318
		*	@brief Pauses all hooks of a plugin
pavolmarko@8
   319
		*
pavolmarko@8
   320
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   321
		*/
pavolmarko@8
   322
		void PausePlugin(Plugin plug);
pavolmarko@8
   323
pavolmarko@8
   324
		/**
pavolmarko@8
   325
		*	@brief Unpauses all hooks of a plugin
pavolmarko@8
   326
		*
pavolmarko@8
   327
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   328
		*/
pavolmarko@8
   329
		void UnpausePlugin(Plugin plug);
pavolmarko@8
   330
pavolmarko@8
   331
		/**
pavolmarko@1
   332
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   333
		*
pavolmarko@1
   334
		*	@param iface The interface pointer
pavolmarko@58
   335
		*	@param size Size of the class instance
pavolmarko@1
   336
		*/
pavolmarko@58
   337
		GenericCallClass *GetCallClass(void *iface, size_t size);
pavolmarko@1
   338
pavolmarko@1
   339
		/**
pavolmarko@1
   340
		*	@brief Release a callclass
pavolmarko@1
   341
		*
pavolmarko@1
   342
		*	@param ptr Pointer to the callclass
pavolmarko@1
   343
		*/
pavolmarko@41
   344
		virtual void ReleaseCallClass(GenericCallClass *ptr);
pavolmarko@1
   345
pavolmarko@1
   346
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   347
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   348
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   349
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   350
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   351
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   352
pavolmarko@1
   353
		//////////////////////////////////////////////////////////////////////////
pavolmarko@6
   354
		// For hook managers
pavolmarko@128
   355
		void HookLoopBegin(IIface *pIface);			//!< Should be called when a hook loop begins
pavolmarko@128
   356
		void HookLoopEnd();							//!< Should be called when a hook loop exits
pavolmarko@128
   357
		void SetCurResPtr(META_RES *mres);			//!< Sets pointer to the current meta result
pavolmarko@128
   358
		void SetPrevResPtr(META_RES *mres);			//!< Sets pointer to previous meta result
pavolmarko@128
   359
		void SetStatusPtr(META_RES *mres);			//!< Sets pointer to the status variable
pavolmarko@128
   360
		void SetIfacePtrPtr(void **pp);				//!< Sets pointer to the interface this pointer
pavolmarko@128
   361
		void SetOrigRetPtr(const void *ptr);		//!< Sets the original return pointer
pavolmarko@128
   362
		void SetOverrideRetPtr(const void *ptr);	//!< Sets the override result pointer
pavolmarko@128
   363
		bool ShouldContinue();						//!< Returns false if the hook loop should exit
pavolmarko@1
   364
	};
pavolmarko@1
   365
}
pavolmarko@1
   366
dvander@34
   367
#endif
dvander@34
   368