core/sourcehook/sourcehook_impl_cvfnptr.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@380
     1
/* ======== SourceHook ========
ds@523
     2
* Copyright (C) 2004-2008 Metamod:Source Development Team
pavolmarko@380
     3
* No warranties of any kind
pavolmarko@380
     4
*
pavolmarko@380
     5
* License: zlib/libpng
pavolmarko@380
     6
*
pavolmarko@380
     7
* Author(s): Pavol "PM OnoTo" Marko
pavolmarko@380
     8
* ============================
pavolmarko@380
     9
*/
pavolmarko@380
    10
pavolmarko@380
    11
#ifndef __SOURCEHOOK_IMPL_CVFNPTR_H__
pavolmarko@380
    12
#define __SOURCEHOOK_IMPL_CVFNPTR_H__
pavolmarko@380
    13
pavolmarko@380
    14
#include "sh_list.h"
pavolmarko@418
    15
#include "sh_memory.h"
pavolmarko@380
    16
pavolmarko@380
    17
namespace SourceHook
pavolmarko@380
    18
{
pavolmarko@380
    19
	namespace Impl
pavolmarko@380
    20
	{
pavolmarko@380
    21
		class CVfnPtr
pavolmarko@380
    22
		{
pavolmarko@380
    23
			// *** Data ***
pavolmarko@380
    24
			void *m_Ptr;
pavolmarko@380
    25
			void *m_OrigEntry;
pavolmarko@380
    26
pavolmarko@418
    27
			List<CHookManager*> m_HookMans;
pavolmarko@380
    28
			List<CIface> m_IfaceList;
pavolmarko@380
    29
		public:
pavolmarko@380
    30
			// *** Descriptor ***
pavolmarko@380
    31
			typedef void* Descriptor;
pavolmarko@380
    32
pavolmarko@380
    33
			// *** Interface ***
pavolmarko@380
    34
			inline CVfnPtr(void *ptr);
pavolmarko@418
    35
			inline ~CVfnPtr();
pavolmarko@380
    36
			inline bool operator==(const Descriptor &other);
pavolmarko@380
    37
			inline void *GetPtr() const;
pavolmarko@380
    38
			inline void *GetOrigEntry() const;
pavolmarko@380
    39
			inline List<CIface> &GetIfaceList();
pavolmarko@380
    40
			inline const List<CIface> &GetIfaceList() const;
pavolmarko@380
    41
			inline CIface *FindIface(void *iface);
pavolmarko@380
    42
			CIface &GetIface(void *iface);
pavolmarko@380
    43
			bool Patch(void *newValue);
pavolmarko@380
    44
			inline bool Revert();
pavolmarko@418
    45
pavolmarko@418
    46
			void AddHookMan(CHookManager *pHookMan);
pavolmarko@418
    47
			// If this returns false, it means that there is no hook manager left
pavolmarko@418
    48
			// to use and that this vfnptr should be removed.
pavolmarko@418
    49
			bool HookManRemoved(CHookManager *pHookMan);
pavolmarko@380
    50
		};
pavolmarko@380
    51
pavolmarko@380
    52
		// *** Implementation ***
pavolmarko@380
    53
		inline CVfnPtr::CVfnPtr(void *ptr)
pavolmarko@380
    54
			: m_Ptr(ptr), m_OrigEntry(*reinterpret_cast<void**>(m_Ptr))
pavolmarko@380
    55
		{
pavolmarko@380
    56
		}
pavolmarko@380
    57
pavolmarko@418
    58
		inline CVfnPtr::~CVfnPtr()
pavolmarko@418
    59
		{
pavolmarko@418
    60
			if (!m_HookMans.empty())
pavolmarko@418
    61
				m_HookMans.front()->DecrRef(this);
pavolmarko@418
    62
		}
pavolmarko@418
    63
pavolmarko@380
    64
		inline bool CVfnPtr::operator==(const Descriptor &other)
pavolmarko@380
    65
		{
pavolmarko@380
    66
			return m_Ptr == other;
pavolmarko@380
    67
		}
pavolmarko@380
    68
pavolmarko@380
    69
		inline void *CVfnPtr::GetPtr() const
pavolmarko@380
    70
		{
pavolmarko@380
    71
			return m_Ptr;
pavolmarko@380
    72
		}
pavolmarko@380
    73
pavolmarko@380
    74
		inline void *CVfnPtr::GetOrigEntry() const
pavolmarko@380
    75
		{
pavolmarko@380
    76
			return m_OrigEntry;
pavolmarko@380
    77
		}
pavolmarko@380
    78
pavolmarko@380
    79
		inline List<CIface> &CVfnPtr::GetIfaceList()
pavolmarko@380
    80
		{
pavolmarko@380
    81
			return m_IfaceList;
pavolmarko@380
    82
		}
pavolmarko@380
    83
pavolmarko@380
    84
		inline const List<CIface> &CVfnPtr::GetIfaceList() const
pavolmarko@380
    85
		{
pavolmarko@380
    86
			return m_IfaceList;
pavolmarko@380
    87
		}
pavolmarko@380
    88
pavolmarko@380
    89
		inline bool CVfnPtr::Revert()
pavolmarko@380
    90
		{
pavolmarko@418
    91
			// Only patch the vfnptr back if the module is still in memory
pavolmarko@418
    92
			// If it's not, do not remove stuff like we did before
pavolmarko@418
    93
			// First off we did it wrong (shutdown the whole hookman, uh..) and secondly applications may be
pavolmarko@418
    94
			// confused by RemoveHook returning false then (yeah, I know, I made this one up, no one checks for RemoveHook error)
pavolmarko@418
    95
			if (ModuleInMemory(reinterpret_cast<char*>(m_Ptr), SH_PTRSIZE))
pavolmarko@418
    96
			{
pavolmarko@418
    97
				return Patch(m_OrigEntry);
pavolmarko@418
    98
			}
pavolmarko@418
    99
			else
pavolmarko@418
   100
			{
pavolmarko@418
   101
				return true;
pavolmarko@418
   102
			}
pavolmarko@380
   103
		}
pavolmarko@380
   104
pavolmarko@380
   105
		inline CIface *CVfnPtr::FindIface(void *iface)
pavolmarko@380
   106
		{
pavolmarko@380
   107
			List<CIface>::iterator iter = m_IfaceList.find(iface);
pavolmarko@380
   108
			if (iter == m_IfaceList.end())
pavolmarko@380
   109
				return NULL;
pavolmarko@380
   110
			else
pavolmarko@380
   111
				return &(*iter);
pavolmarko@380
   112
		}
pavolmarko@380
   113
	}
pavolmarko@380
   114
}
pavolmarko@380
   115
pavolmarko@381
   116
#endif
pavolmarko@381
   117