sourcehook/sourcehook_impl.h
author David Anderson <dvander@alliedmods.net>
Fri Aug 12 17:33:31 2005 +0000 (2005-08-12)
changeset 96 e023f17b7b73
parent 93 ba222649327d
child 117 e322da4af2d2
permissions -rw-r--r--
Initial step towards no STL - added replacement for std::list
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@1
    15
ds@86
    16
#ifdef __linux__
ds@86
    17
#include <signal.h>
ds@86
    18
#include <setjmp.h>
ds@86
    19
#endif
ds@86
    20
pavolmarko@1
    21
// Set this to 1 to enable runtime code generation (faster)
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@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@6
    51
		/**
pavolmarko@6
    52
		*	@brief A list of HookManagerInfo structures
pavolmarko@6
    53
		*/
dvander@96
    54
		typedef List<HookManagerInfo> HookManInfoList;
pavolmarko@1
    55
pavolmarko@41
    56
		struct CallClassInfo
pavolmarko@41
    57
		{
pavolmarko@41
    58
			GenericCallClass cc;
pavolmarko@41
    59
			int refcounter;
pavolmarko@41
    60
			bool operator==(void *other)
pavolmarko@41
    61
			{
pavolmarko@41
    62
				return cc.ptr == other;
pavolmarko@41
    63
			}
pavolmarko@41
    64
		};
pavolmarko@1
    65
		/**
pavolmarko@41
    66
		*	@brief A list of CallClass structures
pavolmarko@1
    67
		*/
dvander@96
    68
		typedef List<CallClassInfo> Impl_CallClassList;
pavolmarko@1
    69
pavolmarko@1
    70
		Impl_CallClassList m_CallClasses;			//!< A list of already generated callclasses
pavolmarko@6
    71
		HookManInfoList m_HookMans;					//!< A list of hook managers
pavolmarko@1
    72
pavolmarko@1
    73
		/**
pavolmarko@6
    74
		*	@brief Finds a hook manager for a function based on a text-prototype, a vtable offset and a vtable index
pavolmarko@1
    75
		*/
pavolmarko@6
    76
		HookManInfoList::iterator FindHookMan(HookManInfoList::iterator begin, HookManInfoList::iterator end, 
pavolmarko@41
    77
			const char *proto, int vtblofs, int vtblidx);
pavolmarko@1
    78
pavolmarko@41
    79
		void ApplyCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@58
    80
		void ApplyCallClassPatches(CallClassInfo &cc);
pavolmarko@58
    81
		void ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry);
pavolmarko@42
    82
		void RemoveCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx);
pavolmarko@58
    83
		void RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx);
pavolmarko@1
    84
pavolmarko@1
    85
		META_RES m_Status, m_PrevRes, m_CurRes;
pavolmarko@1
    86
		const void *m_OrigRet;
pavolmarko@1
    87
		const void *m_OverrideRet;
pavolmarko@1
    88
		void *m_IfacePtr;
pavolmarko@1
    89
	public:
pavolmarko@1
    90
		CSourceHookImpl();
pavolmarko@1
    91
		~CSourceHookImpl();
pavolmarko@1
    92
pavolmarko@1
    93
		/**
pavolmarko@58
    94
		*	@brief Returns the interface version
pavolmarko@58
    95
		*/
pavolmarko@58
    96
		int GetIfaceVersion();
pavolmarko@58
    97
pavolmarko@58
    98
		/**
pavolmarko@58
    99
		*	@brief Returns the implemnetation version
pavolmarko@58
   100
		*/
pavolmarko@58
   101
		int GetImplVersion();
pavolmarko@58
   102
pavolmarko@58
   103
		/**
pavolmarko@6
   104
		*	@brief Make sure that a plugin is not used by any other plugins anymore, and unregister all its hook managers
pavolmarko@1
   105
		*/
pavolmarko@1
   106
		void UnloadPlugin(Plugin plug);
pavolmarko@1
   107
pavolmarko@1
   108
		/**
pavolmarko@6
   109
		*	@brief Shut down the whole system, unregister all hook managers
pavolmarko@1
   110
		*/
pavolmarko@1
   111
		void CompleteShutdown();
pavolmarko@1
   112
pavolmarko@1
   113
		/**
pavolmarko@1
   114
		*	@brief Add a hook.
pavolmarko@1
   115
		*
pavolmarko@1
   116
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   117
		*
pavolmarko@1
   118
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   119
		*	@param iface The interface pointer
pavolmarko@6
   120
		*	@param ifacesize The size of the class iface points to
pavolmarko@6
   121
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@1
   122
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@1
   123
		*	@param post Set to true if you want a post handler
pavolmarko@1
   124
		*/
pavolmarko@41
   125
		bool AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@1
   126
pavolmarko@1
   127
		/**
pavolmarko@1
   128
		*	@brief Removes a hook.
pavolmarko@1
   129
		*
pavolmarko@1
   130
		*	@return True if the function succeeded, false otherwise
pavolmarko@1
   131
		*
pavolmarko@1
   132
		*	@param plug The unique identifier of the plugin that calls this function
pavolmarko@1
   133
		*	@param iface The interface pointer
pavolmarko@41
   134
		*	@param thisptr_offs This pointer adjuster
pavolmarko@41
   135
		*	@param myHookMan A hook manager function that should be capable of handling the function
pavolmarko@41
   136
		*	@param handler A pointer to a FastDelegate containing the hook handler
pavolmarko@41
   137
		*	@param post Set to true if you want a post handler
pavolmarko@41
   138
		*/
pavolmarko@41
   139
		bool RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post);
pavolmarko@41
   140
pavolmarko@41
   141
		/**
pavolmarko@41
   142
		*	@brief Removes a hook.
pavolmarko@41
   143
		*
pavolmarko@41
   144
		*	@ return True if the function succeeded, false otherwise
pavolmarko@41
   145
		*
pavolmarko@41
   146
		*	@param info A RemoveHookInfo structure, describing the hook
pavolmarko@41
   147
		*/
pavolmarko@41
   148
		bool RemoveHook(RemoveHookInfo info);
pavolmarko@41
   149
pavolmarko@41
   150
		/**
pavolmarko@6
   151
		*	@brief Checks whether a plugin has (a) hook manager(s) that is/are currently used by other plugins
pavolmarko@1
   152
		*
pavolmarko@1
   153
		*	@param plug The unique identifier of the plugin in question
pavolmarko@1
   154
		*/
pavolmarko@1
   155
		bool IsPluginInUse(Plugin plug);
pavolmarko@1
   156
pavolmarko@1
   157
		/**
pavolmarko@8
   158
		*	@brief Pauses all hooks of a plugin
pavolmarko@8
   159
		*
pavolmarko@8
   160
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   161
		*/
pavolmarko@8
   162
		void PausePlugin(Plugin plug);
pavolmarko@8
   163
pavolmarko@8
   164
		/**
pavolmarko@8
   165
		*	@brief Unpauses all hooks of a plugin
pavolmarko@8
   166
		*
pavolmarko@8
   167
		*	@param plug The unique identifier of the plugin
pavolmarko@8
   168
		*/
pavolmarko@8
   169
		void UnpausePlugin(Plugin plug);
pavolmarko@8
   170
pavolmarko@8
   171
		/**
pavolmarko@1
   172
		*	@brief Return a pointer to a callclass. Generate a new one if required.
pavolmarko@1
   173
		*
pavolmarko@1
   174
		*	@param iface The interface pointer
pavolmarko@58
   175
		*	@param size Size of the class instance
pavolmarko@1
   176
		*/
pavolmarko@58
   177
		GenericCallClass *GetCallClass(void *iface, size_t size);
pavolmarko@1
   178
pavolmarko@1
   179
		/**
pavolmarko@1
   180
		*	@brief Release a callclass
pavolmarko@1
   181
		*
pavolmarko@1
   182
		*	@param ptr Pointer to the callclass
pavolmarko@1
   183
		*/
pavolmarko@41
   184
		virtual void ReleaseCallClass(GenericCallClass *ptr);
pavolmarko@1
   185
pavolmarko@1
   186
		virtual void SetRes(META_RES res);				//!< Sets the meta result
pavolmarko@1
   187
		virtual META_RES GetPrevRes();					//!< Gets the meta result of the previously called handler
pavolmarko@1
   188
		virtual META_RES GetStatus();					//!< Gets the highest meta result
pavolmarko@1
   189
		virtual const void *GetOrigRet();				//!< Gets the original result. If not in post function, undefined
pavolmarko@1
   190
		virtual const void *GetOverrideRet();			//!< Gets the override result. If none is specified, NULL
pavolmarko@1
   191
		virtual void *GetIfacePtr();					//!< Gets the interface pointer
pavolmarko@1
   192
pavolmarko@1
   193
		//////////////////////////////////////////////////////////////////////////
pavolmarko@6
   194
		// For hook managers
pavolmarko@58
   195
		virtual META_RES &GetCurResRef();				//!< Gets the reference to the current meta result
pavolmarko@58
   196
		virtual META_RES &GetPrevResRef();				//!< Gets the reference to the previous meta result
pavolmarko@58
   197
		virtual META_RES &GetStatusRef();				//!< Gets the reference to the status variable
pavolmarko@58
   198
		virtual void* &GetIfacePtrRef();				//!< Gets the reference to the iface ptr
pavolmarko@1
   199
		virtual void SetOrigRet(const void *ptr);		//!< Sets the original return pointer
pavolmarko@1
   200
		virtual void SetOverrideRet(const void *ptr);	//!< Sets the override result pointer
pavolmarko@1
   201
	};
ds@90
   202
ds@90
   203
#ifdef __linux__
ds@90
   204
	/**
ds@90
   205
	*	@brief Checks to see if a memory value can be read from a given pointer.
ds@90
   206
	*
ds@90
   207
	*	@return True if the value can be read and false if it cannot.
ds@90
   208
	*
ds@90
   209
	*	@param ptr The pointer to the memory value.
ds@90
   210
	*	@param len The length of the memory value to be read from the pointer.
ds@90
   211
	*/
ds@90
   212
	bool IsBadReadPtr(const void *ptr, size_t len);
ds@90
   213
	void BadReadHandler(int sig);
ds@90
   214
#endif
pavolmarko@1
   215
}
pavolmarko@1
   216
dvander@34
   217
#endif
dvander@34
   218