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