1 /* ======== SourceHook ========
2 * Copyright (C) 2004-2007 Metamod:Source Development Team
3 * No warranties of any kind
7 * Author(s): Pavol "PM OnoTo" Marko
8 * Contributors: Scott "Damaged Soul" Ehlert
9 * ============================
13 * @file sourcehook.cpp
14 * @brief Contains the implementation of the SourceHook API
21 #include "sourcehook_impl.h"
22 #include "sh_memory.h"
27 int HashFunction<int>(const int & k)
32 int Compare<int>(const int & k1, const int & k2)
42 CSourceHookImpl::CSourceHookImpl()
45 CSourceHookImpl::~CSourceHookImpl()
49 int CSourceHookImpl::GetIfaceVersion()
51 return SH_IFACE_VERSION;
54 int CSourceHookImpl::GetImplVersion()
56 return SH_IMPL_VERSION;
59 bool CSourceHookImpl::IsPluginInUse(Plugin plug)
61 // Iterate through all hook managers which are in this plugin
62 // Iterate through their vfnptrs, ifaces, hooks
63 // If a hook from an other plugin is found, return true
64 // Return false otherwise
65 #define TMP_CHECK_LIST(name) \
66 for (hook_iter = iface_iter->name.m_List.begin(); hook_iter != iface_iter->name.m_List.end(); ++hook_iter) \
67 if (hook_iter->plug == plug) \
70 for (HookManContList::iterator hmcl_iter = m_HookMans.begin();
71 hmcl_iter != m_HookMans.end(); ++hmcl_iter)
73 for (CHookManagerContainer::iterator hmil_iter = hmcl_iter->begin();
74 hmil_iter != hmcl_iter->end(); ++hmil_iter)
76 if (hmil_iter->m_Plug != plug)
78 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->m_VfnPtrs.begin();
79 vfnptr_iter != hmil_iter->m_VfnPtrs.end(); ++vfnptr_iter)
81 for (CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.begin();
82 iface_iter != vfnptr_iter->m_Ifaces.end(); ++iface_iter)
84 List<HookInfo>::iterator hook_iter;
85 TMP_CHECK_LIST(m_PreHooks);
86 TMP_CHECK_LIST(m_PostHooks);
96 void CSourceHookImpl::UnloadPlugin(Plugin plug)
98 // 1) Manually remove all hooks by this plugin
99 // 2) Manually remove all hook mans by this plugin
101 List<RemoveHookInfo> hookstoremove;
102 List<RemoveHookManInfo> hookmanstoremove;
103 HookManInfoList::iterator hmil_iter;
105 #define TMP_CHECK_LIST(name, ispost) \
106 for (hook_iter = iface_iter->name.m_List.begin(); hook_iter != iface_iter->name.m_List.end(); ++hook_iter) \
107 if (hook_iter->plug == plug) \
108 hookstoremove.push_back(RemoveHookInfo(hook_iter->plug, iface_iter->m_Ptr, \
109 hook_iter->thisptr_offs, hmil_iter->m_Func, hook_iter->handler, ispost)); \
111 for (HookManContList::iterator hmcl_iter = m_HookMans.begin();
112 hmcl_iter != m_HookMans.end(); ++hmcl_iter)
114 for (CHookManagerContainer::iterator hmil_iter = hmcl_iter->begin();
115 hmil_iter != hmcl_iter->end(); ++hmil_iter)
117 if (hmil_iter->m_Plug == plug)
118 hookmanstoremove.push_back(RemoveHookManInfo(plug, hmil_iter->m_Func));
120 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->m_VfnPtrs.begin();
121 vfnptr_iter != hmil_iter->m_VfnPtrs.end(); ++vfnptr_iter)
123 for (CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.begin();
124 iface_iter != vfnptr_iter->m_Ifaces.end(); ++iface_iter)
126 List<HookInfo>::iterator hook_iter;
127 TMP_CHECK_LIST(m_PreHooks, false);
128 TMP_CHECK_LIST(m_PostHooks, true);
133 #undef TMP_CHECK_LIST
135 for (List<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
138 for (List<RemoveHookManInfo>::iterator rmiter = hookmanstoremove.begin(); rmiter != hookmanstoremove.end(); ++rmiter)
139 RemoveHookManager(*rmiter);
142 void CSourceHookImpl::RemoveHookManager(Plugin plug, HookManagerPubFunc pubFunc)
146 CHookManagerInfo tmp;
147 if (pubFunc(HA_GetInfo, &tmp) != 0)
151 HookManContList::iterator hmcl_iter = m_HookMans.find(
152 CHookManagerContainer::HMCI(tmp.m_Proto, tmp.m_VtblOffs, tmp.m_VtblIdx));
154 if (hmcl_iter == m_HookMans.end())
160 CHookManagerContainer::iterator hmil_iter = hmcl_iter->find(
161 CHookManagerInfo::Descriptor(plug, pubFunc));
163 if (hmil_iter == hmcl_iter->end())
169 bool stillInUse = false;
170 List<RemoveHookInfo> hookstoremove;
172 // Iterate through all of the hook manager's hooks. Remove all hooks from the hookman's plugin.
173 #define TMP_CHECK_LIST(name, ispost) \
174 for (hook_iter = iface_iter->name.m_List.begin(); hook_iter != iface_iter->name.m_List.end(); ++hook_iter) \
175 if (hook_iter->plug == plug) \
176 hookstoremove.push_back(RemoveHookInfo(hook_iter->plug, iface_iter->m_Ptr, \
177 hook_iter->thisptr_offs, hmil_iter->m_Func, hook_iter->handler, ispost)); \
181 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->m_VfnPtrs.begin();
182 vfnptr_iter != hmil_iter->m_VfnPtrs.end(); ++vfnptr_iter)
184 for (CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.begin();
185 iface_iter != vfnptr_iter->m_Ifaces.end(); ++iface_iter)
187 List<HookInfo>::iterator hook_iter;
188 TMP_CHECK_LIST(m_PreHooks, false);
189 TMP_CHECK_LIST(m_PostHooks, true);
192 #undef TMP_CHECK_LIST
194 for (List<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
197 CHookManagerInfo info = *hmil_iter;
199 // Unlink the hook manager from the list
200 hmcl_iter->erase(hmil_iter);
202 // If there were any hooks from other plugins, find a new suitable hook manager.
205 // Find a suitable hook manager in an other plugin
206 hmil_iter = hmcl_iter->begin();
208 // This should _never_ happen.
209 // If there is a hook from an other plugin, the plugin must have provided a hook manager as well.
210 SH_ASSERT(hmil_iter != hmcl_iter->end(),
211 ("Could not find a suitable hook manager in an other plugin!"));
213 // AddHook should make sure that every plugin only has _one_ hook manager for _one_ proto/vi/vo
214 SH_ASSERT(hmil_iter->m_Plug != plug, ("New hook manager from same plugin!"));
216 // The first hook manager should be always used - so the new hook manager has to be empty
217 SH_ASSERT(hmil_iter->m_VfnPtrs.empty(), ("New hook manager not empty!"));
219 // Move the vfnptrs from the old hook manager to the new one
220 hmil_iter->m_VfnPtrs = info.m_VfnPtrs;
222 // Unregister the old one, register the new one
223 info.m_Func(HA_Unregister, NULL);
224 hmil_iter->m_Func(HA_Register, &(*hmil_iter));
226 // Go through all vfnptrs in this hookman and patch them to point to the new manager's handler!
228 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->m_VfnPtrs.begin();
229 vfnptr_iter != hmil_iter->m_VfnPtrs.end(); ++vfnptr_iter)
231 // And DEREFERENCE newHookMan->m_HookfuncVfnptr!
232 // otherwise it will be executing the vtable... had to find out the hard way
233 *reinterpret_cast<void**>(vfnptr_iter->m_Ptr) = *reinterpret_cast<void**>(hmil_iter->m_HookfuncVfnptr);
238 void CSourceHookImpl::RemoveHookManager(RemoveHookManInfo info)
240 RemoveHookManager(info.plug, info.hookman);
243 void CSourceHookImpl::CompleteShutdown()
247 List<RemoveHookInfo> hookstoremove;
249 #define TMP_CHECK_LIST(name, ispost) \
250 for (hook_iter = iface_iter->name.m_List.begin(); hook_iter != iface_iter->name.m_List.end(); ++hook_iter) \
251 hookstoremove.push_back(RemoveHookInfo(hook_iter->plug, iface_iter->m_Ptr, \
252 hook_iter->thisptr_offs, hmil_iter->m_Func, hook_iter->handler, ispost))
253 for (HookManContList::iterator hmcl_iter = m_HookMans.begin();
254 hmcl_iter != m_HookMans.end(); ++hmcl_iter)
256 for (CHookManagerContainer::iterator hmil_iter = hmcl_iter->begin();
257 hmil_iter != hmcl_iter->end(); ++hmil_iter)
259 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->m_VfnPtrs.begin();
260 vfnptr_iter != hmil_iter->m_VfnPtrs.end(); ++vfnptr_iter)
262 for (CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.begin();
263 iface_iter != vfnptr_iter->m_Ifaces.end(); ++iface_iter)
265 List<HookInfo>::iterator hook_iter;
266 TMP_CHECK_LIST(m_PreHooks, false);
267 TMP_CHECK_LIST(m_PostHooks, true);
272 #undef TMP_CHECK_LIST
274 for (List<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
281 bool CSourceHookImpl::AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
283 return AddHookNew(plug, Hook_Normal, iface, thisptr_offs, myHookMan, handler, post) != 0 ? true : false;
286 int CSourceHookImpl::AddHookNew(Plugin plug, AddHookMode mode, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan,
287 ISHDelegate *handler, bool post)
289 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface) + thisptr_offs);
291 // 1) Get info about the hook manager
292 CHookManagerInfo tmp;
293 if (myHookMan(HA_GetInfo, &tmp) != 0)
296 tmp.m_Func = myHookMan;
299 CHookManagerContainer::HMCI hmci(tmp.m_Proto, tmp.m_VtblOffs, tmp.m_VtblIdx);
301 void **cur_vtptr = *reinterpret_cast<void***>(
302 reinterpret_cast<char*>(adjustediface) + tmp.m_VtblOffs);
303 void *cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + tmp.m_VtblIdx);
305 // Add the container if not already added
306 HookManContList::iterator hmcl_iter = m_HookMans.find(hmci);
307 if (hmcl_iter == m_HookMans.end())
309 m_HookMans.push_back(CHookManagerContainer(hmci));
310 hmcl_iter = m_HookMans.end();
314 hmcl_iter->AddHookManager(plug, tmp);
316 CHookManagerContainer::iterator hookman = hmcl_iter->begin();
317 SH_ASSERT(hookman != hmcl_iter->end(), ("No hookman found - but we've just added one!"));
319 // Check whether any other container holds a hook manager which holds this vfnptr
320 // If yes, it means that the two are incompatible, so return false.
321 for (HookManContList::iterator hmcl_iter2 = m_HookMans.begin();
322 hmcl_iter2 != m_HookMans.end(); ++hmcl_iter2)
324 if (hmcl_iter2 != hmcl_iter)
326 for (CHookManagerContainer::iterator hmil_iter = hmcl_iter2->begin();
327 hmil_iter != hmcl_iter2->end(); ++hmil_iter)
329 if (hmil_iter->m_VfnPtrs.find(cur_vfnptr) != hmil_iter->m_VfnPtrs.end())
335 // Tell it to store the pointer if it's not already active
336 if (hookman->m_VfnPtrs.empty())
337 hookman->m_Func(HA_Register, &(*hookman));
339 CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->m_VfnPtrs.find(cur_vfnptr);
341 if (vfnptr_iter == hookman->m_VfnPtrs.end())
344 CVfnPtr vfp(cur_vfnptr);
346 // Alter vtable entry
347 if (!SetMemAccess(cur_vtptr, sizeof(void*) * (tmp.m_VtblIdx + 1), SH_MEM_READ | SH_MEM_WRITE))
350 *reinterpret_cast<void**>(cur_vfnptr) = *reinterpret_cast<void**>(hookman->m_HookfuncVfnptr);
352 hookman->m_VfnPtrs.push_back(vfp);
354 // Make vfnptr_iter point to the new element
355 vfnptr_iter = hookman->m_VfnPtrs.end();
358 // Now that it is done, check whether we have to update any callclasses
359 ApplyCallClassPatches(adjustediface, tmp.m_VtblOffs, tmp.m_VtblIdx, vfp.m_OrigEntry);
362 // If it's a VP hook, set adjustediface to NULL now ( see the comments at the beginning of sourcehook_impl.h )
364 adjustediface = NULL;
366 CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.find(adjustediface);
367 if (iface_iter == vfnptr_iter->m_Ifaces.end())
370 vfnptr_iter->m_Ifaces.push_back(CIface(adjustediface));
372 // Make iface_iter point to the new element
373 iface_iter = vfnptr_iter->m_Ifaces.end();
376 // If this is a VP-Hook-NULL interface, go through all other interfaces of this vfnptr and tell them!
377 if (adjustediface == NULL)
379 for (CVfnPtr::IfaceListIter iface_iter2 = vfnptr_iter->m_Ifaces.begin();
380 iface_iter2 != vfnptr_iter->m_Ifaces.end(); ++iface_iter2)
382 if (*iface_iter2 != NULL)
384 iface_iter2->m_PreHooks.SetVPList(&iface_iter->m_PreHooks.m_List);
385 iface_iter2->m_PostHooks.SetVPList(&iface_iter->m_PostHooks.m_List);
391 // If this is a new non-VP-Hook-NULL interface, look for a non-VP-Hook-NULL interface!
392 for (CVfnPtr::IfaceListIter iface_iter2 = vfnptr_iter->m_Ifaces.begin();
393 iface_iter2 != vfnptr_iter->m_Ifaces.end(); ++iface_iter2)
395 if (*iface_iter2 == NULL)
397 iface_iter->m_PreHooks.SetVPList(&iface_iter2->m_PreHooks.m_List);
398 iface_iter->m_PostHooks.SetVPList(&iface_iter2->m_PostHooks.m_List);
399 break; // There can only be one!
407 hookinfo.handler = handler;
408 hookinfo.plug = plug;
409 hookinfo.paused = false;
410 hookinfo.thisptr_offs = thisptr_offs;
411 hookinfo.hookid = m_HookIDMan.New(tmp.m_Proto, tmp.m_VtblOffs, tmp.m_VtblIdx, cur_vfnptr,
412 adjustediface, plug, thisptr_offs, handler, post);
415 iface_iter->m_PostHooks.m_List.push_back(hookinfo);
417 iface_iter->m_PreHooks.m_List.push_back(hookinfo);
419 return hookinfo.hookid;
422 bool CSourceHookImpl::RemoveHookByID(Plugin plug, int hookid)
424 const CHookIDManager::Entry *hentry;
426 hentry = m_HookIDMan.QueryHook(hookid);
429 // hookid doesn't exist !
433 HookManContList::iterator hmcl_iter = m_HookMans.find(
434 CHookManagerContainer::HMCI(hentry->proto.GetProto(), hentry->vtbl_offs, hentry->vtbl_idx));
435 if (hmcl_iter == m_HookMans.end() || hmcl_iter->empty())
437 CHookManagerContainer::iterator hookman = hmcl_iter->begin();
440 CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->m_VfnPtrs.find(hentry->vfnptr);
441 if (vfnptr_iter == hookman->m_VfnPtrs.end())
445 CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.find(hentry->adjustediface);
446 if (iface_iter == vfnptr_iter->m_Ifaces.end())
450 List<HookInfo> &hooks = hentry->post ? iface_iter->m_PostHooks.m_List : iface_iter->m_PreHooks.m_List;
452 List<HookInfo>::iterator hookiter = hooks.find(hookid);
453 if (hookiter == hooks.end())
456 hookiter->handler->DeleteThis();
458 // Move all iterators pointing at this
459 List<HookInfo>::iterator oldhookiter = hookiter;
460 hookiter = hooks.erase(hookiter);
461 List<HookInfo>::iterator newhookiter = hookiter;
462 --newhookiter; // The hook loop will ++ it then
463 CHookList::CIter *pItIter;
465 for (pItIter = iface_iter->m_PreHooks.m_UsedIters; pItIter; pItIter = pItIter->m_pNext)
466 if (pItIter->m_Iter == oldhookiter)
467 pItIter->m_Iter = newhookiter;
469 // If this is VP-Hook-NULL interface, also check all other interfaces of this vfnptr
470 if (*iface_iter == NULL)
472 for (CVfnPtr::IfaceListIter iface_iter2 = vfnptr_iter->m_Ifaces.begin();
473 iface_iter2 != vfnptr_iter->m_Ifaces.end(); ++iface_iter2)
475 if (*iface_iter2 != NULL)
477 for (pItIter = iface_iter2->m_PreHooks.m_UsedIters; pItIter; pItIter = pItIter->m_pNext)
478 if (pItIter->m_Iter == oldhookiter)
479 pItIter->m_Iter = newhookiter;
484 if (iface_iter->m_PostHooks.m_List.empty() && iface_iter->m_PreHooks.m_List.empty())
486 // If this is a VP-Hook-NULL interface, go through all other interfaces of this vfnptr and tell them!
487 if (*iface_iter == NULL)
489 for (CVfnPtr::IfaceListIter iface_iter2 = vfnptr_iter->m_Ifaces.begin();
490 iface_iter2 != vfnptr_iter->m_Ifaces.end(); ++iface_iter2)
492 if (iface_iter2->m_Ptr != NULL)
494 iface_iter2->m_PreHooks.ClearVPList();
495 iface_iter2->m_PostHooks.ClearVPList();
501 // There are no hooks on this iface anymore...
502 for (HookLoopInfoStack::iterator hli_iter = m_HLIStack.begin();
503 hli_iter != m_HLIStack.end(); ++hli_iter)
505 if (hli_iter->pCurIface == static_cast<IIface*>(&(*iface_iter)))
506 hli_iter->shouldContinue = false;
509 iface_iter = vfnptr_iter->m_Ifaces.erase(iface_iter);
510 if (vfnptr_iter->m_Ifaces.empty())
512 // No ifaces at all -> Deactivate the hook
514 // Only patch the vfnptr back if the module is still in memory
515 // If it's not, do not remove stuff like we did before
516 // First off we did it wrong (shutdown the whole hookman, uh..) and secondly applications may be
517 // confused by RemoveHook returning false then (yeah, I know, I made this one up, no one checks for RemoveHook error)
518 if (ModuleInMemory(reinterpret_cast<char*>(vfnptr_iter->m_Ptr), SH_PTRSIZE))
520 *reinterpret_cast<void**>(vfnptr_iter->m_Ptr) = vfnptr_iter->m_OrigEntry;
523 hookman->m_VfnPtrs.erase(vfnptr_iter);
525 // Remove callclass patch
526 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
527 if (cciter->m_Ptr == hentry->adjustediface)
528 cciter->RemoveCallClassPatch(hentry->vtbl_offs, hentry->vtbl_idx);
530 if (hookman->m_VfnPtrs.empty())
532 // Unregister the hook manager
533 hookman->m_Func(HA_Unregister, NULL);
538 // Don't forget to remove the hookid from m_HookIDMan
539 m_HookIDMan.Remove(hookid);
544 bool CSourceHookImpl::RemoveHook(RemoveHookInfo info)
546 return RemoveHook(info.plug, info.iface, info.thisptr_offs, info.hookman, info.handler, info.post);
549 bool CSourceHookImpl::RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
551 // Get info about hook manager and compute adjustediface
552 CHookManagerInfo tmp;
553 if (myHookMan(HA_GetInfo, &tmp) != 0)
556 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface)+thisptr_offs);
558 // Loop through all hooks and remove those which match:
559 // hookman, vfnptr, iface, plug, adjusted iface, this ptr offs, handler, post
560 CVector<int> removehooks;
561 m_HookIDMan.FindAllHooks(removehooks, tmp.m_Proto, tmp.m_VtblOffs, tmp.m_VtblIdx, adjustediface, plug, thisptr_offs, handler, post);
563 if (removehooks.empty())
568 for (CVector<int>::iterator iter = removehooks.begin(); iter != removehooks.end(); ++iter)
570 if (RemoveHookByID(plug, *iter))
576 GenericCallClass *CSourceHookImpl::GetCallClass(void *iface, size_t size)
578 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
580 if (cciter->m_Ptr == iface && cciter->m_ObjSize == size)
582 ++cciter->m_RefCounter;
589 CCallClassImpl tmp(iface, size);
590 ApplyCallClassPatches(tmp);
591 m_CallClasses.push_back(tmp);
592 return &m_CallClasses.back();
595 void CSourceHookImpl::ReleaseCallClass(GenericCallClass *ptr)
597 Impl_CallClassList::iterator iter = m_CallClasses.find(ptr);
598 if (iter == m_CallClasses.end())
600 --iter->m_RefCounter;
601 if (iter->m_RefCounter < 1)
602 m_CallClasses.erase(iter);
605 void CSourceHookImpl::ApplyCallClassPatches(CCallClassImpl &cc)
607 for (HookManContList::iterator hmcl_iter = m_HookMans.begin();
608 hmcl_iter != m_HookMans.end(); ++hmcl_iter)
610 for (CHookManagerContainer::iterator hookman = hmcl_iter->begin();
611 hookman != hmcl_iter->end(); ++hookman)
613 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->m_VfnPtrs.begin();
614 vfnptr_iter != hookman->m_VfnPtrs.end(); ++vfnptr_iter)
616 for (CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.begin();
617 iface_iter != vfnptr_iter->m_Ifaces.end(); ++iface_iter)
619 if (iface_iter->m_Ptr >= cc.m_Ptr &&
620 iface_iter->m_Ptr < (reinterpret_cast<char*>(cc.m_Ptr) + cc.m_ObjSize))
622 cc.ApplyCallClassPatch(static_cast<int>(reinterpret_cast<char*>(iface_iter->m_Ptr) -
623 reinterpret_cast<char*>(cc.m_Ptr)) + hookman->m_VtblOffs,
624 hookman->m_VtblIdx, vfnptr_iter->m_OrigEntry);
632 void CSourceHookImpl::ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry)
634 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
637 if (ifaceptr >= cc_iter->m_Ptr &&
638 ifaceptr < (reinterpret_cast<char*>(cc_iter->m_Ptr) + cc_iter->m_ObjSize))
640 cc_iter->ApplyCallClassPatch(static_cast<int>(reinterpret_cast<char*>(ifaceptr) -
641 reinterpret_cast<char*>(cc_iter->m_Ptr)) + vtbl_offs, vtbl_idx, orig_entry);
646 void CSourceHookImpl::RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx)
648 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
651 if (ifaceptr >= cc_iter->m_Ptr &&
652 ifaceptr < (reinterpret_cast<char*>(cc_iter->m_Ptr) + cc_iter->m_ObjSize))
654 cc_iter->RemoveCallClassPatch(vtbl_offs, vtbl_idx);
659 void CSourceHookImpl::SetPluginPaused(Plugin plug, bool paused)
661 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to paused
662 for (HookManContList::iterator hmcl_iter = m_HookMans.begin();
663 hmcl_iter != m_HookMans.end(); ++hmcl_iter)
665 for (CHookManagerContainer::iterator hookmaniter = hmcl_iter->begin();
666 hookmaniter != hmcl_iter->end(); ++hookmaniter)
668 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookmaniter->m_VfnPtrs.begin();
669 vfnptr_iter != hookmaniter->m_VfnPtrs.end(); ++vfnptr_iter)
671 for (CVfnPtr::IfaceListIter ifaceiter = vfnptr_iter->m_Ifaces.begin();
672 ifaceiter != vfnptr_iter->m_Ifaces.end(); ++ifaceiter)
674 for (List<HookInfo>::iterator hookiter = ifaceiter->m_PreHooks.m_List.begin();
675 hookiter != ifaceiter->m_PreHooks.m_List.end(); ++hookiter)
676 if (plug == hookiter->plug)
677 hookiter->paused = paused;
679 for (List<HookInfo>::iterator hookiter = ifaceiter->m_PostHooks.m_List.begin();
680 hookiter != ifaceiter->m_PostHooks.m_List.end(); ++hookiter)
681 if (plug == hookiter->plug)
682 hookiter->paused = paused;
688 void CSourceHookImpl::PausePlugin(Plugin plug)
690 SetPluginPaused(plug, true);
693 void CSourceHookImpl::UnpausePlugin(Plugin plug)
695 SetPluginPaused(plug, false);
698 void CSourceHookImpl::HookLoopBegin(IIface *pIface)
700 HookLoopInfo hli = {0};
701 hli.pCurIface = pIface;
702 hli.shouldContinue = true;
703 hli.recall = HookLoopInfo::Recall_No;
705 static_cast<CIface*>(pIface)->m_PreHooks.RQFlagReset();
706 static_cast<CIface*>(pIface)->m_PostHooks.RQFlagReset();
708 m_HLIStack.push(hli);
711 void CSourceHookImpl::HookLoopEnd()
713 // When in a post recall... make sure status is high enough so that it returns the orig ret.
714 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall == HookLoopInfo::Recall_Post2)
715 *m_HLIStack.front().pStatus = MRES_SUPERCEDE; // THAT'LL TEACH THEM!
719 void CSourceHookImpl::SetRes(META_RES res)
721 *m_HLIStack.front().pCurRes = res;
724 META_RES CSourceHookImpl::GetPrevRes()
726 return *m_HLIStack.front().pPrevRes;
729 META_RES CSourceHookImpl::GetStatus()
731 return *m_HLIStack.front().pStatus;
734 const void *CSourceHookImpl::GetOrigRet()
736 // When in a post recall... return the orig ret of the previous hookloop.
737 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall == HookLoopInfo::Recall_Post2)
738 return m_HLIStack.second().pOrigRet;
740 return m_HLIStack.front().pOrigRet;
743 const void *CSourceHookImpl::GetOverrideRet()
745 // pOverrideRet is always set since recalls were introduced
746 // GetOverrideRetPtr was added; a function which always returns pOverrideRet
747 // so that RETURN_META_VALUE_NEWPARAMS can provide an override result
749 // This means that we have to filter GetOverrideRet:
750 // If the status variable is < MRES_OVERRIDE, return NULL.
752 return (*m_HLIStack.front().pStatus < MRES_OVERRIDE) ?
753 NULL : m_HLIStack.front().pOverrideRet;
756 void *CSourceHookImpl::GetOverrideRetPtr()
758 // As described in the comment above: always return pOverrideRet
759 return m_HLIStack.front().pOverrideRet;
762 void *CSourceHookImpl::GetIfacePtr()
764 return *m_HLIStack.front().pIfacePtrPtr;
767 void CSourceHookImpl::SetCurResPtr(META_RES *mres)
769 m_HLIStack.front().pCurRes = mres;
772 void CSourceHookImpl::SetPrevResPtr(META_RES *mres)
774 m_HLIStack.front().pPrevRes = mres;
776 // If we're recalling, drag the previous mres value to the new hookfunc
777 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall)
778 *mres = *m_HLIStack.second().pPrevRes;
781 void CSourceHookImpl::SetStatusPtr(META_RES *mres)
783 m_HLIStack.front().pStatus = mres;
785 // If we're recalling, drag the previous mres value to the new hookfunc
786 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall)
787 *mres = *m_HLIStack.second().pStatus;
790 void CSourceHookImpl::SetIfacePtrPtr(void **pp)
792 m_HLIStack.front().pIfacePtrPtr = pp;
795 void CSourceHookImpl::SetOrigRetPtr(const void *ptr)
797 m_HLIStack.front().pOrigRet = ptr;
799 void CSourceHookImpl::SetOverrideRetPtr(void *ptr)
801 m_HLIStack.front().pOverrideRet = ptr;
804 // New function which does all of the above + more :)
805 void *CSourceHookImpl::SetupHookLoop(META_RES *statusPtr, META_RES *prevResPtr, META_RES *curResPtr,
806 void **ifacePtrPtr, const void *origRetPtr, void *overrideRetPtr)
808 HookLoopInfo &hli = m_HLIStack.front();
809 hli.pStatus = statusPtr;
810 hli.pPrevRes = prevResPtr;
811 hli.pCurRes = curResPtr;
812 hli.pIfacePtrPtr = ifacePtrPtr;
813 hli.pOrigRet = origRetPtr;
815 // Handle some recall stuff
816 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall)
818 HookLoopInfo &other = m_HLIStack.second();
819 *statusPtr = *other.pStatus;
820 *prevResPtr = *other.pStatus;
822 // When the status is low so there's no override return value and we're in a post recall,
823 // give it the orig return value as override return value.
824 if (*statusPtr < MRES_OVERRIDE && other.recall == HookLoopInfo::Recall_Post1)
825 hli.pOverrideRet = const_cast<void*>(other.pOrigRet);
826 else // Otherwise, transfer override ret normally
827 hli.pOverrideRet = other.pOverrideRet;
830 hli.pOverrideRet = overrideRetPtr;
832 // Tell the hook func which override ret ptr to use
833 return hli.pOverrideRet;
836 bool CSourceHookImpl::ShouldContinue()
838 // If recall is true, we shall not continue either.
839 // This is because, if it's true and ShouldContinue is called, it suggests that the
840 // actual recall is done and that we are back in the original handler which shall return
844 // The second element on the stack has recall set to Recall_Post1.
845 // This means that we want to skip this part and the original function calling thing, so
846 // we store the status mres value, set status to MRES_SUPERCEDE, and return false.
847 // We also set the recall flag to Recall_Post2, so the next time the thing calls us, we
848 // can return true (so that the thing goes into post hooks).
849 if (m_HLIStack.size() > 1)
851 if (m_HLIStack.second().recall == HookLoopInfo::Recall_Post1)
853 m_HLIStack.front().temporaryStatus = *m_HLIStack.front().pStatus;
854 *m_HLIStack.front().pStatus = MRES_SUPERCEDE;
855 m_HLIStack.second().recall = HookLoopInfo::Recall_Post2;
858 else if (m_HLIStack.second().recall == HookLoopInfo::Recall_Post2)
860 *m_HLIStack.front().pStatus = m_HLIStack.front().temporaryStatus;
861 return m_HLIStack.front().shouldContinue;
864 return m_HLIStack.front().shouldContinue && !m_HLIStack.front().recall;
867 void CSourceHookImpl::DoRecall()
869 if (!m_HLIStack.empty())
871 // Also watch out for post recalls! Described at the beginning of sourcehook_impl.h
872 m_HLIStack.front().recall =
873 static_cast<CIface*>(m_HLIStack.front().pCurIface)->m_PostHooks.RQFlagGet() ?
874 HookLoopInfo::Recall_Post1 : HookLoopInfo::Recall_Pre;
876 CHookList *mlist = static_cast<CHookList*>(m_HLIStack.front().recall == HookLoopInfo::Recall_Pre ?
877 m_HLIStack.front().pCurIface->GetPreHooks() : m_HLIStack.front().pCurIface->GetPostHooks());
878 mlist->m_Recall = true;
880 // The hookfunc usually does this, but it won't have a chance to see it,
881 // so for recalls, we update status here if it's required
882 if (*m_HLIStack.front().pCurRes > *m_HLIStack.front().pStatus)
883 *m_HLIStack.front().pStatus = *m_HLIStack.front().pCurRes;
888 ////////////////////////////
890 ////////////////////////////
891 CSourceHookImpl::CCallClassImpl::CCallClassImpl(void *ptr, size_t size)
892 : m_Ptr(ptr), m_ObjSize(size), m_RefCounter(1)
895 CSourceHookImpl::CCallClassImpl::~CCallClassImpl()
899 void *CSourceHookImpl::CCallClassImpl::GetThisPtr()
903 void *CSourceHookImpl::CCallClassImpl::GetOrigFunc(int vtbloffs, int vtblidx)
905 OrigVTables::iterator iter = m_VT.find(vtbloffs);
906 if (iter != m_VT.end() && iter->val.size() > (size_t)vtblidx)
908 return iter->val[vtblidx];
913 void CSourceHookImpl::CCallClassImpl::ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry)
915 OrigFuncs &tmpvec = m_VT[vtbl_offs];
916 if (tmpvec.size() <= (size_t)vtbl_idx)
917 tmpvec.resize(vtbl_idx+1, NULL);
918 tmpvec[vtbl_idx] = orig_entry;
920 void CSourceHookImpl::CCallClassImpl::RemoveCallClassPatch(int vtbl_offs, int vtbl_idx)
922 OrigVTables::iterator iter = m_VT.find(vtbl_offs);
923 if (iter != m_VT.end())
925 if (iter->val.size() > (size_t)vtbl_idx)
927 iter->val[vtbl_idx] = 0;
929 OrigFuncs &of = iter->val;
930 OrigFuncs::iterator lastused = of.end();
931 for (OrigFuncs::iterator viter = of.begin(); viter != of.end(); ++viter)
936 if (lastused == of.end())
938 // No used element => Remove the whole vector
942 of.resize(lastused - of.begin() + 1);
947 ////////////////////////////
949 ////////////////////////////
950 CSourceHookImpl::CHookManagerInfo::CHookManagerInfo() : m_HookManVersion(0)
953 CSourceHookImpl::CHookManagerInfo::~CHookManagerInfo()
957 IVfnPtr *CSourceHookImpl::CHookManagerInfo::FindVfnPtr(void *vfnptr)
959 VfnPtrListIter iter = m_VfnPtrs.find(vfnptr);
960 return iter == m_VfnPtrs.end() ? NULL : &(*iter);
962 void CSourceHookImpl::CHookManagerInfo::SetInfo(int vtbl_offs, int vtbl_idx, const char *proto)
964 m_VtblOffs = vtbl_offs;
965 m_VtblIdx = vtbl_idx;
968 void CSourceHookImpl::CHookManagerInfo::SetHookfuncVfnptr(void *hookfunc_vfnptr)
970 m_HookfuncVfnptr = hookfunc_vfnptr;
972 void CSourceHookImpl::CHookManagerInfo::SetVersion(int version)
974 m_HookManVersion = version;
976 ////////////////////////////
978 ////////////////////////////
981 // If you get a crash here, the ptr passed is invalid
982 // This usually means a SH_DECL_MANUALHOOK* with wrong thisptroffs/vtbloffs/vtblidx
983 CSourceHookImpl::CVfnPtr::CVfnPtr(void *ptr) : m_Ptr(ptr), m_OrigEntry(*reinterpret_cast<void**>(ptr))
986 CSourceHookImpl::CVfnPtr::~CVfnPtr()
990 void *CSourceHookImpl::CVfnPtr::GetVfnPtr()
995 void *CSourceHookImpl::CVfnPtr::GetOrigEntry()
1000 IIface *CSourceHookImpl::CVfnPtr::FindIface(void *ptr)
1002 IfaceListIter iter = m_Ifaces.find(ptr);
1004 // If nothing is found, check for a NULL-interface (VP hooks only)
1005 if (iter == m_Ifaces.end())
1007 iter = m_Ifaces.find((void*)0);
1008 return iter == m_Ifaces.end() ? NULL : &(*iter);
1016 ////////////////////////////
1018 ////////////////////////////
1019 CSourceHookImpl::CIface::CIface(void *ptr) : m_Ptr(ptr)
1022 CSourceHookImpl::CIface::~CIface()
1026 void *CSourceHookImpl::CIface::GetPtr()
1031 IHookList *CSourceHookImpl::CIface::GetPreHooks()
1035 IHookList *CSourceHookImpl::CIface::GetPostHooks()
1037 return &m_PostHooks;
1040 ////////////////////////////
1042 ////////////////////////////
1044 CSourceHookImpl::CHookList::CHookList() : m_VPList(NULL), m_FreeIters(NULL), m_UsedIters(NULL),
1048 CSourceHookImpl::CHookList::CHookList(const CHookList &other) : m_VPList(other.m_VPList), m_List(other.m_List),
1049 m_FreeIters(NULL), m_UsedIters(NULL), m_Recall(false)
1053 CSourceHookImpl::CHookList::~CHookList()
1057 CIter *iter = m_FreeIters->m_pNext;
1063 CIter *iter = m_UsedIters->m_pNext;
1068 IHookList::IIter *CSourceHookImpl::CHookList::GetIter()
1076 m_FreeIters = ret->m_pNext;
1081 ret = new CIter(this);
1084 // Muuuh, if we're recalling, it shall be a copy of the last iterator, incremented by one
1085 if (m_Recall && m_UsedIters)
1087 ret->Set(m_UsedIters); // m_UsedIters is the last returned and not released iterator
1088 ret->Next(); // Use next instead of directly incrementing its m_Iter:
1089 // skips paused plugins
1092 ret->m_pNext = m_UsedIters;
1093 ret->m_pPrev = NULL;
1095 m_UsedIters->m_pPrev = ret;
1102 void CSourceHookImpl::CHookList::ReleaseIter(IIter *pIter)
1104 CIter *pIter2 = static_cast<CIter*>(pIter);
1106 // Unlink from m_UsedIters
1108 if (pIter2->m_pNext)
1109 pIter2->m_pNext->m_pPrev = pIter2->m_pPrev;
1110 if (pIter2->m_pPrev)
1111 pIter2->m_pPrev->m_pNext = pIter2->m_pNext;
1112 if (pIter2 == m_UsedIters)
1115 // Link to m_FreeIters
1117 pIter2->m_pNext = m_FreeIters;
1119 m_FreeIters = pIter2;
1121 // Reset recall state.
1125 void CSourceHookImpl::CHookList::SetVPList(List<HookInfo> *newList)
1129 // Update cached CIter objects
1135 pTmp->m_Iter.SetListLeft(m_VPList);
1136 pTmp = pTmp->m_pNext;
1142 pTmp->m_Iter.SetListLeft(m_VPList);
1143 pTmp = pTmp->m_pNext;
1147 void CSourceHookImpl::CHookList::ClearVPList()
1152 CSourceHookImpl::CHookList::CIter::CIter(CHookList *pList) : m_pList(pList),
1153 m_Iter(pList->m_VPList, &m_pList->m_List), m_pNext(NULL)
1156 CSourceHookImpl::CHookList::CIter::~CIter()
1160 void CSourceHookImpl::CHookList::CIter::Set(CIter *pOther)
1162 m_Iter = pOther->m_Iter;
1165 void CSourceHookImpl::CHookList::CIter::GoToBegin()
1171 bool CSourceHookImpl::CHookList::CIter::End()
1175 return m_Iter.End();;
1177 void CSourceHookImpl::CHookList::CIter::Next()
1184 void CSourceHookImpl::CHookList::CIter::Clear()
1188 void CSourceHookImpl::CHookList::CIter::SkipPaused()
1190 while (!m_Iter.End() && m_Iter->paused)
1194 ISHDelegate *CSourceHookImpl::CHookList::CIter::Handler()
1196 return m_Iter->handler;
1198 int CSourceHookImpl::CHookList::CIter::ThisPtrOffs()
1200 return m_Iter->thisptr_offs;
1203 //////////////////////////////////////////////////////////////////////////
1205 //////////////////////////////////////////////////////////////////////////
1206 char *CSourceHookImpl::CProto::DupProto(const char *p)
1214 size_t len = strlen(p);
1215 newproto = new char[len+1];
1216 memcpy(newproto, p, len+1);
1218 const ProtoInfo *pi1 = reinterpret_cast<const ProtoInfo *>(p);
1219 int *ar_copy = new int[pi1->numOfParams + 1];
1220 for (int i = 0; i <= pi1->numOfParams; i++)
1221 ar_copy[i] = pi1->params[i];
1222 ProtoInfo *copy = new ProtoInfo(pi1->retTypeSize, pi1->numOfParams, ar_copy);
1223 newproto = reinterpret_cast<char *>(copy);
1229 void CSourceHookImpl::CProto::FreeProto(char *prot)
1238 ProtoInfo *pi = reinterpret_cast<ProtoInfo *>(prot);
1239 delete [] pi->params;
1244 bool CSourceHookImpl::CProto::Equal(const char *p1, const char *p2)
1249 if (*p1 && *p2) // Case1: Both old
1251 // As in old versions
1252 return strcmp(p1, p2) == 0;
1254 else if (!*p1 && !*p2) // Case2: Both new
1256 const ProtoInfo *pi1 = reinterpret_cast<const ProtoInfo*>(p1);
1257 const ProtoInfo *pi2 = reinterpret_cast<const ProtoInfo*>(p2);
1259 if (pi1->retTypeSize == pi2->retTypeSize &&
1260 pi1->numOfParams == pi2->numOfParams)
1262 // params[0] is 0 for "normal" functions and -1 for vararg functions
1263 // params[1] is size of first parameter
1264 // params[2] is size of second parameter ...
1265 for (int i = 0; i <= pi1->numOfParams; ++i)
1267 if (pi1->params[i] != pi2->params[i])
1277 else // Case3: Mixed old/new
1285 //////////////////////////////////////////////////////////////////////////
1286 // CHookManagerContainer
1287 //////////////////////////////////////////////////////////////////////////
1288 void CSourceHookImpl::CHookManagerContainer::AddHookManager(Plugin plug, const CHookManagerInfo &hookman)
1291 // Check whether such a hook manager already exists; if yes, ignore.
1292 for (iter = begin(); iter != end(); ++iter)
1294 if (iter->m_Plug == plug && iter->m_Func == hookman.m_Func)
1298 // It doesn't -> add it. Add it to the end of its version group.
1299 for (iter = begin(); iter != end(); ++iter)
1301 if (iter->m_HookManVersion < hookman.m_HookManVersion)
1305 bool isBeginning = iter == begin();
1307 insert(iter, hookman);
1309 // If we inserted it at the beginning and if the dam breaks open many years too soon
1310 // and if there is more than one hookman and if the second one isn't empty, transfer
1311 // hooks from second to first
1313 if (isBeginning && size() > 1)
1316 iterator second = iter;
1319 if (!second->m_VfnPtrs.empty())
1321 // Move the vfnptrs from the old hook manager to the new one
1322 iter->m_VfnPtrs = second->m_VfnPtrs;
1323 second->m_VfnPtrs.clear();
1325 // Unregister the old one, register the new one
1326 second->m_Func(HA_Unregister, NULL);
1327 iter->m_Func(HA_Register, &(*iter));
1329 // Go through all vfnptrs in this hookman and patch them to point to the new manager's handler!
1331 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = iter->m_VfnPtrs.begin();
1332 vfnptr_iter != iter->m_VfnPtrs.end(); ++vfnptr_iter)
1334 // And DEREFERENCE newHookMan->m_HookfuncVfnptr!
1335 // otherwise it will be executing the vtable... had to find out the hard way
1336 *reinterpret_cast<void**>(vfnptr_iter->m_Ptr) = *reinterpret_cast<void**>(iter->m_HookfuncVfnptr);
1342 //////////////////////////////////////////////////////////////////////////
1344 //////////////////////////////////////////////////////////////////////////
1345 CSourceHookImpl::CHookIDManager::CHookIDManager()
1349 int CSourceHookImpl::CHookIDManager::New(const CProto &proto, int vtbl_offs, int vtbl_idx, void *vfnptr,
1350 void *adjustediface, Plugin plug, int thisptr_offs, ISHDelegate *handler, bool post)
1352 Entry tmp(proto, vtbl_offs, vtbl_idx, vfnptr, adjustediface, plug, thisptr_offs, handler, post);
1354 size_t cursize = m_Entries.size();
1355 for (size_t i = 0; i < cursize; ++i)
1357 if (m_Entries[i].isfree)
1360 return static_cast<int>(i) + 1;
1364 m_Entries.push_back(tmp);
1365 return static_cast<int>(m_Entries.size()); // return size() because hookid = id+1 anyway
1368 bool CSourceHookImpl::CHookIDManager::Remove(int hookid)
1370 int realid = hookid - 1;
1371 if (realid < 0 || realid >= static_cast<int>(m_Entries.size()) || m_Entries[realid].isfree)
1374 m_Entries[realid].isfree = true;
1376 // :TODO: remove free ids from back sometimes ??
1381 const CSourceHookImpl::CHookIDManager::Entry * CSourceHookImpl::CHookIDManager::QueryHook(int hookid)
1383 int realid = hookid - 1;
1384 if (realid < 0 || realid >= static_cast<int>(m_Entries.size()) || m_Entries[realid].isfree)
1387 return &m_Entries[realid];
1390 void CSourceHookImpl::CHookIDManager::FindAllHooks(CVector<int> &output, const CProto &proto, int vtbl_offs,
1391 int vtbl_idx, void *adjustediface, Plugin plug, int thisptr_offs, ISHDelegate *handler, bool post)
1393 // oh my god, a lot of parameters...
1394 size_t cursize = m_Entries.size();
1395 for (size_t i = 0; i < cursize; ++i)
1397 if (!m_Entries[i].isfree && m_Entries[i].proto == proto && m_Entries[i].vtbl_offs == vtbl_offs &&
1398 m_Entries[i].vtbl_idx == vtbl_idx && m_Entries[i].adjustediface == adjustediface && m_Entries[i].plug == plug &&
1399 m_Entries[i].thisptr_offs == thisptr_offs && m_Entries[i].handler->IsEqual(handler) && m_Entries[i].post == post)
1401 output.push_back(static_cast<int>(i) + 1);