sourcehook/sourcehook.cpp
author Pavol Marko <pavolmarko@gmail.com>
Mon Oct 08 14:20:51 2007 +0000 (2007-10-08)
changeset 387 093c72464b35
parent 386 08583103ba6f
child 393 24e9ac80de6e
permissions -rw-r--r--
Subtle bug fixed + tests now more resistant against compiler
optimizations
     1 /* ======== SourceHook ========
     2 * Copyright (C) 2004-2007 Metamod:Source Development Team
     3 * No warranties of any kind
     4 *
     5 * License: zlib/libpng
     6 *
     7 * Author(s): Pavol "PM OnoTo" Marko
     8 * Contributors: Scott "Damaged Soul" Ehlert
     9 * ============================
    10 */
    11 
    12 /**
    13  * @file sourcehook.cpp
    14  * @brief Contains the implementation of the SourceHook API
    15 */
    16 
    17 #if defined __GNUC__
    18 #include <stdint.h>
    19 #endif
    20 
    21 #include "sourcehook_impl.h"
    22 #include "sh_memory.h"
    23 
    24 namespace SourceHook
    25 {
    26 	template<>
    27 	int HashFunction<int>(const int & k)
    28 	{
    29 		return k;
    30 	}
    31 	template<>
    32 	int Compare<int>(const int & k1, const int & k2)
    33 	{
    34 		if (k1 == k2)
    35 			return 0;
    36 		if (k1 > k2)
    37 			return 1;
    38 		if (k1 < k2)
    39 			return -1;
    40 		return 0;
    41 	}
    42 
    43 	namespace Impl
    44 	{
    45 		//////////////////////////////////////////////////////////////////////////
    46 		// CProto
    47 		//////////////////////////////////////////////////////////////////////////
    48 		ProtoInfo *CProto::DupProto(const ProtoInfo *src)
    49 		{
    50 			if (src == NULL)
    51 				return NULL;
    52 
    53 			PassInfo *newParamsPassInfo = new PassInfo[src->numOfParams + 1];
    54 			for (int i = 0; i <= src->numOfParams; ++i)
    55 				newParamsPassInfo[i] = src->paramsPassInfo[i];
    56 
    57 			ProtoInfo *newProto = new ProtoInfo;
    58 			newProto->retPassInfo = src->retPassInfo;
    59 			newProto->paramsPassInfo = newParamsPassInfo;
    60 			newProto->numOfParams = src->numOfParams;
    61 			newProto->convention = src->convention;
    62 
    63 			return newProto;
    64 		}
    65 
    66 		void CProto::FreeProto(ProtoInfo *prot)
    67 		{
    68 			if (!prot)
    69 				return;
    70 
    71 			delete [] prot->paramsPassInfo;
    72 			delete prot;
    73 		}
    74 
    75 		bool CProto::Equal(const ProtoInfo *p1, const ProtoInfo *p2)
    76 		{
    77 			if (!p1 || !p2)
    78 				return false;
    79 
    80 			if (p1->numOfParams != p2->numOfParams)
    81 				return false;
    82 
    83 			if (p1->convention != ProtoInfo::CallConv_Unknown && p2->convention != ProtoInfo::CallConv_Unknown &&
    84 				p1->convention != p2->convention)
    85 				return false;
    86 
    87 			if (p1->retPassInfo.size != p2->retPassInfo.size)
    88 				return false;
    89 
    90 			// Skip params[0] : dummy
    91 			for (int i = 1; i <= p1->numOfParams; ++i)
    92 			{
    93 				if (p1->paramsPassInfo[i].size != p2->paramsPassInfo[i].size)
    94 					return false;
    95 				if (p1->paramsPassInfo[i].type != PassInfo::PassType_Unknown && p2->paramsPassInfo[i].type != PassInfo::PassType_Unknown)
    96 				{
    97 					if (p1->paramsPassInfo[i].type != p2->paramsPassInfo[i].type)
    98 						return false;
    99 					if (p1->paramsPassInfo[i].flags != p2->paramsPassInfo[i].flags)
   100 						return false;
   101 				}
   102 			}
   103 
   104 			return true;
   105 		}
   106 
   107 
   108 		//////////////////////////////////////////////////////////////////////////
   109 		// CHookManContainerList
   110 		//////////////////////////////////////////////////////////////////////////
   111 		CHookManagerContainer &CHookManContainerList::GetContainer(int vtbloffs, int vtblidx, const CProto &proto)
   112 		{
   113 			iterator iter = find(CHookManagerContainer::Descriptor(vtbloffs, vtblidx, proto));
   114 			if (iter == end())
   115 			{
   116 				CHookManagerContainer newCont(vtbloffs, vtblidx, proto);
   117 				push_back(newCont);
   118 				return back();
   119 			}
   120 			else
   121 			{
   122 				return *iter;
   123 			}
   124 		}
   125 
   126 		void CHookManContainerList::RemoveHookMans(Plugin plug)
   127 		{
   128 			for (iterator iter = begin(); iter != end(); ++iter)
   129 				iter->RemoveHookMans(plug);
   130 		}
   131 
   132 		void CHookManContainerList::RemoveHookMans(Plugin plug, HookManagerPubFunc pubFunc)
   133 		{
   134 			for (iterator iter = begin(); iter != end(); ++iter)
   135 				iter->RemoveHookMans(plug, pubFunc);
   136 		}
   137 
   138 		//////////////////////////////////////////////////////////////////////////
   139 		// CHookManagerContainer
   140 		//////////////////////////////////////////////////////////////////////////
   141 		
   142 		bool CHookManagerContainer::AddHookManager(const CHookManager &hookMan)
   143 		{
   144 			iterator iter;
   145 
   146 			// Don't accept invalid hook managers
   147 			if (!hookMan)
   148 				return false;
   149 
   150 			// Check whether such a hook manager already exists; if yes, ignore.
   151 			iter = find(hookMan);
   152 			if (iter != end())
   153 			{
   154 				// but make sure that it's activated (ms_HI stored)
   155 				iter->Register();
   156 				return true;
   157 			}
   158 
   159 			// It doesn't -> add it. Add it to the end of its version group.
   160 			for (iter = begin(); iter != end(); ++iter)
   161 			{
   162 				if (iter->GetVersion() < hookMan.GetVersion())
   163 					break;
   164 			}
   165 
   166 			bool isBeginning = iter == begin();
   167 
   168 			insert(iter, hookMan);
   169 
   170 			if (isBeginning)
   171 			{
   172 				iter = begin();
   173 
   174 				if (size() > 1)
   175 				{
   176 					// If the next hookman isn't empty (there were hooks before, but this hookman is better)
   177 					// transfer its vfnptrs and deactivate it
   178 
   179 					iterator second = iter;
   180 					++second;
   181 
   182 					if (!second->GetVfnPtrList().empty())
   183 					{
   184 						// Move the vfnptrs from the old hook manager to the new one
   185 						iter->GetVfnPtrList() = second->GetVfnPtrList();
   186 						second->GetVfnPtrList().clear();
   187 
   188 						// Unregister the old one, register the new one
   189 						second->Unregister();
   190 
   191 						// Go through all vfnptrs in this hookman and patch them to point to the new manager's handler!
   192 						// :TODO: change this to something like for_all :X
   193 						for (List<CVfnPtr>::iterator vfnptr_iter = iter->GetVfnPtrList().begin();
   194 							vfnptr_iter != iter->GetVfnPtrList().end(); ++vfnptr_iter)
   195 						{
   196 							vfnptr_iter->Patch(iter->GetHookFunc());
   197 						}
   198 					}
   199 				}
   200 
   201 				// activate the new active hookman
   202 				iter->Register();
   203 			}
   204 			
   205 			return true;
   206 		}
   207 
   208 		void CHookManagerContainer::RemoveHookMans(Plugin plug, HookManagerPubFunc pubFunc)
   209 		{
   210 			bool erasethis = false;
   211 
   212 			for (iterator iter = begin(); iter != end(); erasethis ? (iter = erase(iter)) : ++iter)
   213 			{
   214 				erasethis = false;
   215 				if (iter->GetOwnerPlugin() == plug
   216 					&& (pubFunc == NULL ? true : (iter->GetPubFunc() == pubFunc)))
   217 				{
   218 					if (iter == begin() && !iter->GetVfnPtrList().empty())
   219 					{
   220 						// The hook manager is active
   221 						// -> Transfer its hooks to the next hook manager (which _has_ to exist)
   222 						SH_ASSERT(size() > 1, ("No more hook managers!?"));
   223 
   224 						iterator second = iter;
   225 						++second;
   226 
   227 						SH_ASSERT(second->GetOwnerPlugin() != plug, ("New hook manager from same plugin!"));
   228 
   229 						second->GetVfnPtrList() = iter->GetVfnPtrList();
   230 						iter->GetVfnPtrList().clear();
   231 
   232 						second->Register();
   233 						iter->Unregister();
   234 
   235 						// Go through all vfnptrs in this hookman and patch them to point to the new manager's handler!
   236 						// :TODO: change this to something like for_all :X
   237 						for (List<CVfnPtr>::iterator vfnptr_iter = second->GetVfnPtrList().begin();
   238 							vfnptr_iter != second->GetVfnPtrList().end(); ++vfnptr_iter)
   239 						{
   240 							vfnptr_iter->Patch(second->GetHookFunc());
   241 						}
   242 					}
   243 					erasethis = true;
   244 				}
   245 			}
   246 		}
   247 		
   248 		//////////////////////////////////////////////////////////////////////////
   249 		// CHookManager
   250 		//////////////////////////////////////////////////////////////////////////
   251 		void CHookManager::SetInfo(int hookman_version, int vtbloffs, int vtblidx,
   252 			ProtoInfo *proto, void *hookfunc_vfnptr)
   253 		{
   254 			m_Version = hookman_version;
   255 			m_VtblOffs = vtbloffs;
   256 			m_VtblIdx = vtblidx;
   257 			m_Proto = proto;
   258 			m_HookfuncVfnptr = hookfunc_vfnptr;
   259 		}
   260 
   261 		CVfnPtr &CHookManager::GetVfnPtr(void *vfnptr)
   262 		{
   263 			List<CVfnPtr>::iterator iter = m_VfnPtrList.find(vfnptr);
   264 			if (iter == m_VfnPtrList.end())
   265 			{
   266 				CVfnPtr newVfnPtr(vfnptr);
   267 				m_VfnPtrList.push_back(newVfnPtr);
   268 
   269 				newVfnPtr.Patch(GetHookFunc());
   270 
   271 				return m_VfnPtrList.back();
   272 			}
   273 			else
   274 			{
   275 				return *iter;
   276 			}
   277 		}
   278 
   279 		//////////////////////////////////////////////////////////////////////////
   280 		// CVfnPtr
   281 		//////////////////////////////////////////////////////////////////////////
   282 		
   283 		bool CVfnPtr::Patch(void *newValue)
   284 		{
   285 			if (!SetMemAccess(m_Ptr, sizeof(void*), SH_MEM_READ | SH_MEM_WRITE))
   286 			{
   287 				return false;
   288 			}
   289 
   290 			*reinterpret_cast<void**>(m_Ptr) = newValue;
   291 
   292 			return true;
   293 		}
   294 
   295 		CIface &CVfnPtr::GetIface(void *iface)
   296 		{
   297 			List<CIface>::iterator iter = m_IfaceList.find(iface);
   298 			if (iter == m_IfaceList.end())
   299 			{
   300 				CIface newIface(iface);
   301 				if (iface == NULL)
   302 				{
   303 					m_IfaceList.push_front(newIface);
   304 					return m_IfaceList.front();
   305 				}
   306 				else
   307 				{
   308 					m_IfaceList.push_back(newIface);
   309 					return m_IfaceList.back();
   310 				}
   311 			}
   312 			else
   313 			{
   314 				return *iter;
   315 			}
   316 		}
   317 
   318 		//////////////////////////////////////////////////////////////////////////
   319 		// CHookIdManager
   320 		//////////////////////////////////////////////////////////////////////////
   321 		CHookIDManager::CHookIDManager()
   322 		{
   323 		}
   324 
   325 		int CHookIDManager::New(const CProto &proto, int vtbl_offs, int vtbl_idx, void *vfnptr,
   326 			void *adjustediface, Plugin plug, int thisptr_offs, ISHDelegate *handler, bool post)
   327 		{
   328 			Entry tmp(proto, vtbl_offs, vtbl_idx, vfnptr, adjustediface, plug, thisptr_offs, handler, post);
   329 
   330 			size_t cursize = m_Entries.size();
   331 			for (size_t i = 0; i < cursize; ++i)
   332 			{
   333 				if (m_Entries[i].isfree)
   334 				{
   335 					m_Entries[i] = tmp;
   336 					return static_cast<int>(i) + 1;
   337 				}
   338 			}
   339 
   340 			m_Entries.push_back(tmp);
   341 			return static_cast<int>(m_Entries.size());		// return size() because hookid = id+1 anyway
   342 		}
   343 
   344 		bool CHookIDManager::Remove(int hookid)
   345 		{
   346 			int realid = hookid - 1;
   347 			if (realid < 0 || realid >= static_cast<int>(m_Entries.size()) || m_Entries[realid].isfree)
   348 				return false;
   349 
   350 			m_Entries[realid].isfree = true;
   351 
   352 			// :TODO: remove free ids from back sometimes ??
   353 
   354 			return true;
   355 		}
   356 
   357 		const CHookIDManager::Entry * CHookIDManager::QueryHook(int hookid)
   358 		{
   359 			int realid = hookid - 1;
   360 			if (realid < 0 || realid >= static_cast<int>(m_Entries.size()) || m_Entries[realid].isfree)
   361 				return NULL;
   362 
   363 			return &m_Entries[realid];
   364 		}
   365 
   366 		void CHookIDManager::FindAllHooks(CVector<int> &output, const CProto &proto, int vtbl_offs,
   367 			int vtbl_idx, void *adjustediface, Plugin plug, int thisptr_offs, ISHDelegate *handler, bool post)
   368 		{
   369 			// oh my god, a lot of parameters...
   370 			size_t cursize = m_Entries.size();
   371 			for (size_t i = 0; i < cursize; ++i)
   372 			{
   373 				if (!m_Entries[i].isfree && m_Entries[i].proto == proto && m_Entries[i].vtbl_offs == vtbl_offs &&
   374 					m_Entries[i].vtbl_idx == vtbl_idx && m_Entries[i].adjustediface == adjustediface && m_Entries[i].plug == plug &&
   375 					m_Entries[i].thisptr_offs == thisptr_offs && m_Entries[i].handler->IsEqual(handler) && m_Entries[i].post == post)
   376 				{
   377 					output.push_back(static_cast<int>(i) + 1);
   378 				}
   379 			}
   380 		}
   381 
   382 		void CHookIDManager::FindAllHooks(CVector<int> &output)
   383 		{
   384 			size_t cursize = m_Entries.size();
   385 			for (size_t i = 0; i < cursize; ++i)
   386 			{
   387 				if (!m_Entries[i].isfree)
   388 					output.push_back(static_cast<int>(i) + 1);
   389 			}
   390 		}
   391 
   392 		void CHookIDManager::FindAllHooks(CVector<int> &output, Plugin plug)
   393 		{
   394 			size_t cursize = m_Entries.size();
   395 			for (size_t i = 0; i < cursize; ++i)
   396 			{
   397 				if (!m_Entries[i].isfree && m_Entries[i].plug == plug)
   398 					output.push_back(static_cast<int>(i) + 1);
   399 			}
   400 		}
   401 
   402 
   403 		//////////////////////////////////////////////////////////////////////////
   404 		// CSourceHookImpl
   405 		//////////////////////////////////////////////////////////////////////////
   406 		
   407 
   408 		CSourceHookImpl::CSourceHookImpl()
   409 		{
   410 		}
   411 		CSourceHookImpl::~CSourceHookImpl()
   412 		{
   413 		}
   414 
   415 		int CSourceHookImpl::GetIfaceVersion()
   416 		{
   417 			return SH_IFACE_VERSION;
   418 		}
   419 
   420 		int CSourceHookImpl::GetImplVersion()
   421 		{
   422 			return SH_IMPL_VERSION;
   423 		}
   424 
   425 		int CSourceHookImpl::AddHook(Plugin plug, AddHookMode mode, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan,
   426 			ISHDelegate *handler, bool post)
   427 		{
   428 			if (mode != Hook_Normal && mode != Hook_VP && mode != Hook_DVP)
   429 				return 0;
   430 
   431 			// Get info about hook manager
   432 			CHookManager hookManager(plug, myHookMan);
   433 			if (!hookManager)
   434 				return 0;
   435 
   436 			// Make sure that the container exists
   437 			CHookManagerContainer &container = m_HookManContainers.GetContainer(hookManager.GetVtblOffs(),
   438 				hookManager.GetVtblIdx(), hookManager.GetProto());
   439 
   440 			container.AddHookManager(hookManager);
   441 
   442 			if (!container)
   443 			{
   444 				// For some weird reason, the container is empty!
   445 				SH_ASSERT(0, ("No hookman found - but we've just added one!"));
   446 				return 0;
   447 			}
   448 
   449 			CHookManager &hookMan = container.GetActiveHookManager();
   450 
   451 			void *adjustediface = NULL;
   452 			void **cur_vtptr = NULL;
   453 			void *cur_vfnptr = NULL;
   454 
   455 			// find vfnptr
   456 			switch (mode)
   457 			{
   458 			case Hook_Normal:
   459 				adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface) + thisptr_offs);
   460 
   461 				cur_vtptr = *reinterpret_cast<void***>(
   462 					reinterpret_cast<char*>(adjustediface) + hookMan.GetVtblOffs());
   463 				cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + hookMan.GetVtblIdx());
   464 				break;
   465 
   466 			case Hook_VP:
   467 
   468 				adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface) + thisptr_offs);
   469 
   470 				cur_vtptr = *reinterpret_cast<void***>(
   471 					reinterpret_cast<char*>(adjustediface) + hookMan.GetVtblOffs());
   472 				cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + hookMan.GetVtblIdx());
   473 
   474 				adjustediface = NULL;
   475 				break;
   476 
   477 			case Hook_DVP:
   478 				adjustediface = NULL;
   479 
   480 				cur_vtptr = reinterpret_cast<void**>(iface);
   481 				cur_vfnptr = cur_vtptr + hookMan.GetVtblIdx();
   482 
   483 				break;
   484 			}
   485 
   486 			CVfnPtr &vfnPtr = hookMan.GetVfnPtr(cur_vfnptr);
   487 			CIface &ifaceinst = vfnPtr.GetIface(adjustediface);
   488 
   489 			// Add the hook
   490 			CHook hook(plug, thisptr_offs, handler, 
   491 
   492 				m_HookIDMan.New(hookMan.GetProto(), hookMan.GetVtblOffs(), hookMan.GetVtblIdx(),
   493 					cur_vfnptr, adjustediface, plug, thisptr_offs, handler, post)
   494 
   495 				);
   496 
   497 			if (post)
   498 				ifaceinst.GetPostHookList().push_back(hook);
   499 			else
   500 				ifaceinst.GetPreHookList().push_back(hook);
   501 
   502 			return hook.GetID();
   503 		}
   504 
   505 		bool CSourceHookImpl::RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan,
   506 			ISHDelegate *handler, bool post)
   507 		{
   508 			// Get info about hook manager and compute adjustediface
   509 			CHookManager tmpHookMan(plug, myHookMan);
   510 
   511 			void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface)+thisptr_offs);
   512 
   513 			// Loop through all hooks and remove those which match:
   514 			//  hookman, vfnptr, iface, plug, adjusted iface, this ptr offs, handler, post
   515 			CVector<int> removehooks;
   516 			m_HookIDMan.FindAllHooks(removehooks, tmpHookMan.GetProto(), tmpHookMan.GetVtblOffs(), tmpHookMan.GetVtblIdx(),
   517 				adjustediface, plug, thisptr_offs, handler, post);
   518 
   519 			if (removehooks.empty())
   520 				return false;
   521 
   522 			bool status = false;
   523 
   524 			for (CVector<int>::iterator iter = removehooks.begin(); iter != removehooks.end(); ++iter)
   525 			{
   526 				if (RemoveHookByID(*iter))
   527 					status = true;
   528 			}
   529 			return status; 
   530 		}
   531 
   532 		bool CSourceHookImpl::RemoveHookByID(int hookid)
   533 		{
   534 			const CHookIDManager::Entry *hentry;
   535 
   536 			hentry = m_HookIDMan.QueryHook(hookid);
   537 			if (!hentry)
   538 			{
   539 				// hookid doesn't exist !
   540 				return false;
   541 			}
   542 
   543 			// find hookman
   544 			CHookManContainerList::iterator hmcl_iter = m_HookManContainers.find(
   545 				CHookManagerContainer::Descriptor(hentry->vtbl_offs, hentry->vtbl_idx, hentry->proto));
   546 
   547 			if (hmcl_iter == m_HookManContainers.end() || !(*hmcl_iter))
   548 				return false;
   549 
   550 			CHookManager &hookman = hmcl_iter->GetActiveHookManager();
   551 
   552 			// find vfnptr
   553 			List<CVfnPtr>::iterator vfnptr_iter = hookman.GetVfnPtrList().find(hentry->vfnptr);
   554 			if (vfnptr_iter == hookman.GetVfnPtrList().end())
   555 				return false;
   556 
   557 			// find iface
   558 			List<CIface>::iterator iface_iter = vfnptr_iter->GetIfaceList().find(hentry->adjustediface);
   559 			if (iface_iter == vfnptr_iter->GetIfaceList().end())
   560 				return false;
   561 
   562 			// find hook
   563 			List<CHook> &hooks = hentry->post ? iface_iter->GetPostHookList() : iface_iter->GetPreHookList();
   564 			List<CHook>::iterator hook_iter = hooks.find(hookid);
   565 			if (hook_iter == hooks.end())
   566 				return false;
   567 
   568 			hook_iter->GetHandler()->DeleteThis();
   569 
   570 			// Iterator movage!
   571 			List<CHook>::iterator oldhookiter = hook_iter;
   572 			hook_iter = hooks.erase(hook_iter);
   573 
   574 			for (CStack<CHookContext>::iterator ctx_iter = m_ContextStack.begin();
   575 				ctx_iter != m_ContextStack.end(); ++ctx_iter)
   576 			{
   577 				ctx_iter->HookRemoved(oldhookiter, hook_iter);
   578 			}
   579 
   580 			if (iface_iter->GetPreHookList().empty() && iface_iter->GetPostHookList().empty())
   581 			{
   582 				// -> Kill all contexts that use it!
   583 				for (CStack<CHookContext>::iterator ctx_iter = m_ContextStack.begin();
   584 					ctx_iter != m_ContextStack.end(); ++ctx_iter)
   585 				{
   586 					ctx_iter->IfaceRemoved(&(*iface_iter));
   587 				}
   588 
   589 				// There are no hooks on this iface anymore...
   590 				iface_iter = vfnptr_iter->GetIfaceList().erase(iface_iter);
   591 
   592 				if (vfnptr_iter->GetIfaceList().empty())
   593 				{
   594 					// No ifaces at all -> Deactivate the hook
   595 
   596 					for (CStack<CHookContext>::iterator ctx_iter = m_ContextStack.begin();
   597 						ctx_iter != m_ContextStack.end(); ++ctx_iter)
   598 					{
   599 						ctx_iter->VfnPtrRemoved(&(*vfnptr_iter));
   600 					}
   601 
   602 					// Only patch the vfnptr back if the module is still in memory
   603 					// If it's not, do not remove stuff like we did before
   604 					// First off we did it wrong (shutdown the whole hookman, uh..) and secondly applications may be
   605 					// confused by RemoveHook returning false then (yeah, I know, I made this one up, no one checks for RemoveHook error)
   606 					if (ModuleInMemory(reinterpret_cast<char*>(vfnptr_iter->GetPtr()), SH_PTRSIZE))
   607 					{
   608 						vfnptr_iter->Revert();
   609 					}
   610 
   611 					hookman.GetVfnPtrList().erase(vfnptr_iter);
   612 
   613 					if (hookman.GetVfnPtrList().empty())
   614 					{
   615 						// Unregister the hook manager
   616 						hookman.Unregister();
   617 					}
   618 				}
   619 			}
   620 
   621 			m_HookIDMan.Remove(hookid);
   622 			return true;
   623 		}
   624 
   625 		void CSourceHookImpl::SetRes(META_RES res)
   626 		{
   627 			*m_ContextStack.front().pCurRes = res;
   628 		}
   629 
   630 		META_RES CSourceHookImpl::GetPrevRes()
   631 		{
   632 			return *m_ContextStack.front().pPrevRes;
   633 		}
   634 
   635 		META_RES CSourceHookImpl::GetStatus()
   636 		{
   637 			return *m_ContextStack.front().pStatus;
   638 
   639 		}
   640 
   641 		const void *CSourceHookImpl::GetOrigRet()
   642 		{
   643 			return m_ContextStack.front().pOrigRet;
   644 		}
   645 
   646 		const void *CSourceHookImpl::GetOverrideRet()
   647 		{
   648 			return (*m_ContextStack.front().pStatus < MRES_OVERRIDE) ?
   649 				NULL : m_ContextStack.front().pOverrideRet;
   650 		}
   651 
   652 		void *CSourceHookImpl::GetIfacePtr()
   653 		{
   654 			// If in recall: return last one
   655 			if (m_ContextStack.front().m_State >= CHookContext::State_Recall_Pre &&
   656 				m_ContextStack.front().m_State <= CHookContext::State_Recall_PostVP)
   657 			{
   658 				return m_ContextStack.second().pIfacePtr;
   659 			}
   660 			else
   661 			{
   662 				return m_ContextStack.front().pIfacePtr;
   663 			}
   664 		}
   665 
   666 		void *CSourceHookImpl::GetOverrideRetPtr()
   667 		{
   668 			return m_ContextStack.front().pOverrideRet;
   669 		}
   670 
   671 		void CSourceHookImpl::UnloadPlugin(Plugin plug)
   672 		{
   673 			// 1) Remove all hooks by this plugin
   674 
   675 			CVector<int> removehooks;
   676 			m_HookIDMan.FindAllHooks(removehooks, plug);
   677 
   678 			for (CVector<int>::iterator iter = removehooks.begin(); iter != removehooks.end(); ++iter)
   679 				RemoveHookByID(*iter);
   680 
   681 			// 2) Remove all hook managers
   682 			m_HookManContainers.RemoveHookMans(plug);
   683 		}
   684 
   685 		void CSourceHookImpl::RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc)
   686 		{
   687 			// 1) Remove all its hooks
   688 			CVector<int> removehooks;
   689 
   690 			// Get info about hook manager
   691 			CHookManager hookManager(plug, pubFunc);
   692 			if (!hookManager)
   693 				return;
   694 
   695 			// Make sure that the container exists
   696 			CHookManagerContainer &container = m_HookManContainers.GetContainer(hookManager.GetVtblOffs(),
   697 				hookManager.GetVtblIdx(), hookManager.GetProto());
   698 
   699 			CHookManagerContainer::iterator cont_iter = container.find(CHookManager::Descriptor(plug, pubFunc));
   700 
   701 			for (List<CVfnPtr>::iterator vfnptr_iter = cont_iter->GetVfnPtrList().begin();
   702 				vfnptr_iter != cont_iter->GetVfnPtrList().end(); ++vfnptr_iter)
   703 			{
   704 				for (List<CIface>::iterator iface_iter = vfnptr_iter->GetIfaceList().begin();
   705 					iface_iter != vfnptr_iter->GetIfaceList().end(); ++iface_iter)
   706 				{
   707 					List<CHook>::iterator hook_iter;
   708 					for (hook_iter = iface_iter->GetPreHookList().begin();
   709 						hook_iter != iface_iter->GetPreHookList().end(); ++hook_iter)
   710 						removehooks.push_back(hook_iter->GetID());
   711 
   712 					for (hook_iter = iface_iter->GetPostHookList().begin();
   713 						hook_iter != iface_iter->GetPostHookList().end(); ++hook_iter)
   714 						removehooks.push_back(hook_iter->GetID());
   715 				}
   716 			}
   717 
   718 			for (CVector<int>::iterator iter = removehooks.begin(); iter != removehooks.end(); ++iter)
   719 				RemoveHookByID(*iter);
   720 
   721 			// 2) Remove it
   722 			container.RemoveHookMans(plug, pubFunc);
   723 		}
   724 
   725 		void CSourceHookImpl::SetIgnoreHooks(void *vfnptr)
   726 		{
   727 			CHookContext ctx;
   728 			ctx.m_State = CHookContext::State_Ignore;
   729 			m_ContextStack.push(ctx);
   730 		}
   731 
   732 		void CSourceHookImpl::ResetIgnoreHooks(void *vfnptr)
   733 		{
   734 			if (!m_ContextStack.empty() && m_ContextStack.front().m_State == CHookContext::State_Ignore)
   735 				m_ContextStack.pop();
   736 		}
   737 
   738 		void *CSourceHookImpl::GetOrigVfnPtrEntry(void *vfnptr)
   739 		{
   740 			for (CHookManContainerList::iterator hmcl_iter = m_HookManContainers.begin();
   741 				hmcl_iter != m_HookManContainers.end(); ++hmcl_iter)
   742 			{
   743 				for (CHookManagerContainer::iterator hookmaniter = hmcl_iter->begin();
   744 					hookmaniter != hmcl_iter->end(); ++hookmaniter)
   745 				{
   746 					for (List<CVfnPtr>::iterator vfnptr_iter = hookmaniter->GetVfnPtrList().begin();
   747 						vfnptr_iter != hookmaniter->GetVfnPtrList().end(); ++vfnptr_iter)
   748 					{
   749 						if (vfnptr_iter->GetPtr() == vfnptr)
   750 							return vfnptr_iter->GetOrigEntry();
   751 					}
   752 				}
   753 			}
   754 			return NULL;
   755 		}
   756 
   757 		void CSourceHookImpl::DoRecall()
   758 		{
   759 			CHookContext newCtx;
   760 			CHookContext &curCtx = m_ContextStack.front();
   761 
   762 
   763 			newCtx.m_State = curCtx.m_State + (CHookContext::State_Recall_Pre - CHookContext::State_Pre);
   764 			if (newCtx.m_State == CHookContext::State_Recall_Post || newCtx.m_State == CHookContext::State_Recall_PostVP)
   765 			{
   766 				// Also save orig ret
   767 				newCtx.pOrigRet = curCtx.pOrigRet;
   768 			}
   769 
   770 			// The hookfunc usually does this, but it won't have a chance to see it, 
   771 			// so for recalls, we update status here if it's required
   772 			if (*curCtx.pCurRes > *curCtx.pStatus) 
   773 				*curCtx.pStatus = *curCtx.pCurRes;
   774 
   775 			newCtx.pStatus = curCtx.pStatus;
   776 			newCtx.pOverrideRet = curCtx.pOverrideRet;
   777 			newCtx.pPrevRes = curCtx.pPrevRes;
   778 			newCtx.m_Iter = curCtx.m_Iter;
   779 
   780 			// Take this with us!
   781 			newCtx.pCurRes = curCtx.pCurRes;
   782 
   783 			m_ContextStack.push(newCtx);
   784 			curCtx.m_State = CHookContext::State_Dead;
   785 		}
   786 
   787 		IHookContext *CSourceHookImpl::SetupHookLoop(IHookManagerInfo *hi, void *vfnptr, void *thisptr, void **origentry, META_RES *statusPtr,
   788 			META_RES *prevResPtr, META_RES *curResPtr, const void *origRetPtr, void *overrideRetPtr)
   789 		{
   790 			CHookContext *pCtx = NULL;
   791 			CHookContext *oldctx = m_ContextStack.empty() ? NULL : &m_ContextStack.front();
   792 			if (oldctx)
   793 			{
   794 				// SH_CALL
   795 				if (oldctx->m_State == CHookContext::State_Ignore)
   796 				{
   797 					*statusPtr = MRES_IGNORED;
   798 					oldctx->m_CallOrig = true;
   799 					oldctx->m_State = CHookContext::State_Dead;
   800 
   801 					List<CVfnPtr> &vfnptrList = static_cast<CHookManager*>(hi)->GetVfnPtrList();
   802 					List<CVfnPtr>::iterator vfnptr_iter = vfnptrList.find(vfnptr);
   803 					if (vfnptr_iter == vfnptrList.end())
   804 					{
   805 						// :TODO: what??
   806 					}
   807 					else
   808 					{
   809 						*origentry = vfnptr_iter->GetOrigEntry();
   810 					}
   811 
   812 					oldctx->pOrigRet = origRetPtr;
   813 					return oldctx;
   814 				}
   815 				// Recall
   816 				else if (oldctx->m_State >= CHookContext::State_Recall_Pre &&
   817 					oldctx->m_State <= CHookContext::State_Recall_PostVP)
   818 				{
   819 					pCtx = oldctx;
   820 
   821 					*statusPtr = *(oldctx->pStatus);
   822 					*prevResPtr = *(oldctx->pPrevRes);
   823 
   824 					pCtx->m_Iter = oldctx->m_Iter;
   825 
   826 					// Only have possibility of calling the orig func in pre recall mode
   827 					pCtx->m_CallOrig = (oldctx->m_State == CHookContext::State_Recall_Pre || 
   828 						oldctx->m_State == CHookContext::State_Recall_PreVP);
   829 
   830 					overrideRetPtr = pCtx->pOverrideRet;
   831 
   832 					// When the status is low so there's no override return value and we're in a post recall,
   833 					// give it the orig return value as override return value.
   834 					if (pCtx->m_State == CHookContext::State_Recall_Post ||
   835 						pCtx->m_State == CHookContext::State_Recall_PostVP)
   836 					{
   837 						origRetPtr = oldctx->pOrigRet;
   838 						if (*statusPtr < MRES_OVERRIDE)
   839 							overrideRetPtr = const_cast<void*>(pCtx->pOrigRet);
   840 					}
   841 				}
   842 			}
   843 			if (!pCtx)
   844 			{
   845 				pCtx = m_ContextStack.make_next();
   846 				pCtx->m_State = CHookContext::State_Born;
   847 				pCtx->m_CallOrig = true;
   848 			}
   849 
   850 			pCtx->pIface = NULL;
   851 
   852 			List<CVfnPtr> &vfnptrList = static_cast<CHookManager*>(hi)->GetVfnPtrList();
   853 			List<CVfnPtr>::iterator vfnptr_iter = vfnptrList.find(vfnptr);
   854 			if (vfnptr_iter == vfnptrList.end())
   855 			{
   856 				pCtx->m_State = CHookContext::State_Dead;
   857 			}
   858 			else
   859 			{
   860 				pCtx->pVfnPtr = &(*vfnptr_iter);
   861 				*origentry = vfnptr_iter->GetOrigEntry();
   862 				pCtx->pIface = vfnptr_iter->FindIface(thisptr);
   863 			}
   864 
   865 			pCtx->pStatus = statusPtr;
   866 			pCtx->pPrevRes = prevResPtr;
   867 			pCtx->pCurRes = curResPtr;
   868 			pCtx->pThisPtr = thisptr;
   869 			pCtx->pOverrideRet = overrideRetPtr;
   870 			pCtx->pOrigRet = origRetPtr;
   871 
   872 			return pCtx;
   873 		}
   874 
   875 		void CSourceHookImpl::EndContext(IHookContext *pCtx)
   876 		{
   877 			m_ContextStack.pop();
   878 		}
   879 
   880 		void CSourceHookImpl::CompleteShutdown()
   881 		{
   882 			CVector<int> removehooks;
   883 			m_HookIDMan.FindAllHooks(removehooks);
   884 
   885 			for (CVector<int>::iterator iter = removehooks.begin(); iter != removehooks.end(); ++iter)
   886 				RemoveHookByID(*iter);
   887 		}
   888 
   889 		void CSourceHookImpl::PausePlugin(Plugin plug)
   890 		{
   891 			CVector<int> pausehooks;
   892 			m_HookIDMan.FindAllHooks(pausehooks, plug);
   893 
   894 			for (CVector<int>::iterator iter = pausehooks.begin(); iter != pausehooks.end(); ++iter)
   895 				PauseHookByID(*iter);
   896 		}
   897 
   898 		void CSourceHookImpl::UnpausePlugin(Plugin plug)
   899 		{
   900 			CVector<int> unpausehooks;
   901 			m_HookIDMan.FindAllHooks(unpausehooks, plug);
   902 
   903 			for (CVector<int>::iterator iter = unpausehooks.begin(); iter != unpausehooks.end(); ++iter)
   904 				UnpauseHookByID(*iter);
   905 		}
   906 
   907 		bool CSourceHookImpl::PauseHookByID(int hookid)
   908 		{
   909 			return SetHookPaused(hookid, true);
   910 		}
   911 
   912 		bool CSourceHookImpl::UnpauseHookByID(int hookid)
   913 		{
   914 			return SetHookPaused(hookid, false);
   915 		}
   916 
   917 		bool CSourceHookImpl::SetHookPaused(int hookid, bool paused)
   918 		{
   919 			const CHookIDManager::Entry *hentry;
   920 
   921 			hentry = m_HookIDMan.QueryHook(hookid);
   922 			if (!hentry)
   923 			{
   924 				// hookid doesn't exist !
   925 				return false;
   926 			}
   927 
   928 			// find hookman
   929 			CHookManContainerList::iterator hmcl_iter = m_HookManContainers.find(
   930 				CHookManagerContainer::Descriptor(hentry->vtbl_offs, hentry->vtbl_idx, hentry->proto));
   931 
   932 			if (hmcl_iter == m_HookManContainers.end() || !(*hmcl_iter))
   933 				return false;
   934 
   935 			CHookManager &hookman = hmcl_iter->GetActiveHookManager();
   936 
   937 			// find vfnptr
   938 			List<CVfnPtr>::iterator vfnptr_iter = hookman.GetVfnPtrList().find(hentry->vfnptr);
   939 			if (vfnptr_iter == hookman.GetVfnPtrList().end())
   940 				return false;
   941 
   942 			// find iface
   943 			List<CIface>::iterator iface_iter = vfnptr_iter->GetIfaceList().find(hentry->adjustediface);
   944 			if (iface_iter == vfnptr_iter->GetIfaceList().end())
   945 				return false;
   946 
   947 			// find hook
   948 			List<CHook> &hooks = hentry->post ? iface_iter->GetPostHookList() : iface_iter->GetPreHookList();
   949 			List<CHook>::iterator hook_iter = hooks.find(hookid);
   950 			if (hook_iter == hooks.end())
   951 				return false;
   952 
   953 			hook_iter->SetPaused(paused);
   954 			return true;
   955 		}
   956 
   957 		//////////////////////////////////////////////////////////////////////////
   958 		// CHookContext
   959 		//////////////////////////////////////////////////////////////////////////
   960 		ISHDelegate *CHookContext::GetNext()
   961 		{
   962 			CIface *pVPIface;
   963 			switch (m_State)
   964 			{
   965 			case State_Dead:
   966 				return NULL;
   967 
   968 			case State_Born:
   969 				m_Iter = List<CHook>::iterator();
   970 				m_State = State_Pre;
   971 
   972 				// fall-through
   973 			case State_Recall_Pre:
   974 				m_State = State_Pre;
   975 			case State_Pre:
   976 				if (pIface)
   977 				{
   978 					if (!m_Iter)
   979 						m_Iter = pIface->GetPreHookList().begin();
   980 					else
   981 						++m_Iter;
   982 					SkipPaused(m_Iter, pIface->GetPreHookList());
   983 
   984 					if (m_Iter != pIface->GetPreHookList().end())
   985 					{
   986 						pIfacePtr = reinterpret_cast<void*>(reinterpret_cast<char*>(pThisPtr) - m_Iter->GetThisPointerOffset());
   987 						return m_Iter->GetHandler();
   988 					}
   989 				}
   990 
   991 				// end of normal hooks -> VP
   992 				
   993 				m_State = State_PreVP;
   994 				m_Iter = List<CHook>::iterator();
   995 
   996 				// fall-through
   997 			case State_Recall_PreVP:
   998 				m_State = State_PreVP;
   999 			case State_PreVP:
  1000 				pVPIface = pVfnPtr->FindIface(NULL);
  1001 				if (pVPIface)
  1002 				{
  1003 					if (!m_Iter)
  1004 						m_Iter = pVPIface->GetPreHookList().begin();
  1005 					else
  1006 						++m_Iter;
  1007 					SkipPaused(m_Iter, pVPIface->GetPreHookList());
  1008 
  1009 					if (m_Iter != pVPIface->GetPreHookList())
  1010 					{
  1011 						pIfacePtr = reinterpret_cast<void*>(reinterpret_cast<char*>(pThisPtr) - m_Iter->GetThisPointerOffset());
  1012 						return m_Iter->GetHandler();
  1013 					}
  1014 				}
  1015 
  1016 				// end VP hooks -> orig call
  1017 
  1018 				m_State = State_OrigCall;
  1019 				return NULL;
  1020 				
  1021 			case State_OrigCall:
  1022 				m_Iter = List<CHook>::iterator();
  1023 				m_State = State_Post;
  1024 
  1025 				// fall-through
  1026 			case State_Post:
  1027 				if (pIface)
  1028 				{
  1029 					if (!m_Iter)
  1030 						m_Iter = pIface->GetPostHookList().begin();
  1031 					else
  1032 						++m_Iter;
  1033 					SkipPaused(m_Iter, pIface->GetPostHookList());
  1034 
  1035 					if (m_Iter != pIface->GetPostHookList().end())
  1036 					{
  1037 						pIfacePtr = reinterpret_cast<void*>(reinterpret_cast<char*>(pThisPtr) - m_Iter->GetThisPointerOffset());
  1038 						return m_Iter->GetHandler();
  1039 					}
  1040 				}
  1041 				// end of normal hooks -> VP
  1042 
  1043 				m_State = State_PostVP;
  1044 				m_Iter = List<CHook>::iterator();
  1045 
  1046 				// fall-through
  1047 			case State_PostVP:
  1048 				pVPIface = pVfnPtr->FindIface(NULL);
  1049 				if (pVPIface)
  1050 				{
  1051 					if (!m_Iter)
  1052 						m_Iter = pVPIface->GetPostHookList().begin();
  1053 					else
  1054 						++m_Iter;
  1055 					SkipPaused(m_Iter, pVPIface->GetPostHookList());
  1056 
  1057 					if (m_Iter != pVPIface->GetPostHookList())
  1058 					{
  1059 						pIfacePtr = reinterpret_cast<void*>(reinterpret_cast<char*>(pThisPtr) - m_Iter->GetThisPointerOffset());
  1060 						return m_Iter->GetHandler();
  1061 					}
  1062 				}
  1063 
  1064 				// end VP hooks -> done
  1065 
  1066 				m_State = State_Dead;
  1067 				return NULL;
  1068 
  1069 			case State_Recall_Post:
  1070 				// Skip pre hooks _and_ orig call
  1071 				m_State = State_Post;
  1072 				return NULL;
  1073 
  1074 			case State_Recall_PostVP:
  1075 				// Skip pre hooks _and_ orig call
  1076 				m_State = State_PostVP;
  1077 				return NULL;
  1078 			}
  1079 			return NULL;
  1080 		}
  1081 
  1082 		void *CHookContext::GetOverrideRetPtr()
  1083 		{
  1084 			return pOverrideRet;
  1085 		}
  1086 
  1087 		const void *CHookContext::GetOrigRetPtr()
  1088 		{
  1089 			return pOrigRet;
  1090 		}
  1091 
  1092 		bool CHookContext::ShouldCallOrig()
  1093 		{
  1094 			return m_CallOrig;
  1095 		}
  1096 
  1097 		void CHookContext::HookRemoved(List<CHook>::iterator oldhookiter, List<CHook>::iterator nexthookiter)
  1098 		{
  1099 			if (m_Iter == oldhookiter)
  1100 			{
  1101 				m_Iter = nexthookiter;
  1102 				--m_Iter;
  1103 			}
  1104 		}
  1105 
  1106 		void CHookContext::IfaceRemoved(CIface *iface)
  1107 		{
  1108 			if (pIface == iface)
  1109 				pIface = NULL;
  1110 		}
  1111 
  1112 		void CHookContext::VfnPtrRemoved(CVfnPtr *vfnptr)
  1113 		{
  1114 			if (pVfnPtr == vfnptr)
  1115 			{
  1116 				pVfnPtr = NULL;
  1117 				m_State = State_Dead;
  1118 			}
  1119 		}
  1120 	}
  1121 }