Added insert(iterator where, const T &what) to sh_list and simplified it on the occasion, hook managers now have (optional) version numbers, everything somehow works! Also changed _NEWPARAMS macro syntax a bit
1 /* ======== SourceHook ========
2 * Copyright (C) 2004-2005 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 SourceHook::HashFunction<int>(const int & k)
32 int SourceHook::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)
280 bool CSourceHookImpl::AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
282 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface) + thisptr_offs);
284 // 1) Get info about the hook manager
285 CHookManagerInfo tmp;
286 if (myHookMan(HA_GetInfo, &tmp) != 0)
289 tmp.m_Func = myHookMan;
292 CHookManagerContainer::HMCI hmci(tmp.m_Proto, tmp.m_VtblOffs, tmp.m_VtblIdx);
294 void **cur_vtptr = *reinterpret_cast<void***>(
295 reinterpret_cast<char*>(adjustediface) + tmp.m_VtblOffs);
296 void *cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + tmp.m_VtblIdx);
298 // Add the container if not already added
299 HookManContList::iterator hmcl_iter = m_HookMans.find(hmci);
300 if (hmcl_iter == m_HookMans.end())
302 m_HookMans.push_back(CHookManagerContainer(hmci));
303 hmcl_iter = m_HookMans.end();
307 hmcl_iter->AddHookManager(plug, tmp);
309 CHookManagerContainer::iterator hookman = hmcl_iter->begin();
310 SH_ASSERT(hookman != hmcl_iter->end(), ("No hookman found - but we've just added one!"));
312 // Check whether any other container holds a hook manager which holds this vfnptr
313 // If yes, it means that the two are incompatible, so return false.
314 for (HookManContList::iterator hmcl_iter2 = m_HookMans.begin();
315 hmcl_iter2 != m_HookMans.end(); ++hmcl_iter2)
317 if (hmcl_iter2 != hmcl_iter)
319 for (CHookManagerContainer::iterator hmil_iter = hmcl_iter2->begin();
320 hmil_iter != hmcl_iter2->end(); ++hmil_iter)
322 if (hmil_iter->m_VfnPtrs.find(cur_vfnptr) != hmil_iter->m_VfnPtrs.end())
328 // Tell it to store the pointer if it's not already active
329 if (hookman->m_VfnPtrs.empty())
330 hookman->m_Func(HA_Register, &(*hookman));
332 CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->m_VfnPtrs.find(cur_vfnptr);
334 if (vfnptr_iter == hookman->m_VfnPtrs.end())
337 CVfnPtr vfp(cur_vfnptr);
339 // Alter vtable entry
340 if (!SetMemAccess(cur_vtptr, sizeof(void*) * (tmp.m_VtblIdx + 1), SH_MEM_READ | SH_MEM_WRITE))
343 *reinterpret_cast<void**>(cur_vfnptr) = *reinterpret_cast<void**>(hookman->m_HookfuncVfnptr);
345 hookman->m_VfnPtrs.push_back(vfp);
347 // Make vfnptr_iter point to the new element
348 vfnptr_iter = hookman->m_VfnPtrs.end();
351 // Now that it is done, check whether we have to update any callclasses
352 ApplyCallClassPatches(adjustediface, tmp.m_VtblOffs, tmp.m_VtblIdx, vfp.m_OrigEntry);
355 CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.find(adjustediface);
356 if (iface_iter == vfnptr_iter->m_Ifaces.end())
359 vfnptr_iter->m_Ifaces.push_back(CIface(adjustediface));
361 // Make iface_iter point to the new element
362 iface_iter = vfnptr_iter->m_Ifaces.end();
368 hookinfo.handler = handler;
369 hookinfo.plug = plug;
370 hookinfo.paused = false;
371 hookinfo.thisptr_offs = thisptr_offs;
373 iface_iter->m_PostHooks.m_List.push_back(hookinfo);
375 iface_iter->m_PreHooks.m_List.push_back(hookinfo);
380 bool CSourceHookImpl::RemoveHook(RemoveHookInfo info)
382 return RemoveHook(info.plug, info.iface, info.thisptr_offs, info.hookman, info.handler, info.post);
385 bool CSourceHookImpl::RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
387 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface)+thisptr_offs);
388 CHookManagerInfo tmp;
389 if (myHookMan(HA_GetInfo, &tmp) != 0)
392 // Find the hook manager and the hook
394 HookManContList::iterator hmcl_iter = m_HookMans.find(
395 CHookManagerContainer::HMCI(tmp.m_Proto, tmp.m_VtblOffs, tmp.m_VtblIdx));
396 if (hmcl_iter == m_HookMans.end() || hmcl_iter->empty())
399 CHookManagerContainer::iterator hookman = hmcl_iter->begin();
401 if (!ModuleInMemory(reinterpret_cast<char*>(adjustediface) + tmp.m_VtblOffs,
402 sizeof(void*) * (tmp.m_VtblIdx + 1)))
404 // The module the vtable was in is already unloaded.
405 hookman->m_VfnPtrs.clear();
406 hookman->m_Func(HA_Unregister, NULL);
410 void **cur_vtptr = *reinterpret_cast<void***>(
411 reinterpret_cast<char*>(adjustediface) + tmp.m_VtblOffs);
412 void *cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + tmp.m_VtblIdx);
414 CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->m_VfnPtrs.find(cur_vfnptr);
416 if (vfnptr_iter == hookman->m_VfnPtrs.end())
419 for (CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.begin();
420 iface_iter != vfnptr_iter->m_Ifaces.end();)
422 List<HookInfo> &hooks =
423 post ? iface_iter->m_PostHooks.m_List : iface_iter->m_PreHooks.m_List;
426 for (List<HookInfo>::iterator hookiter = hooks.begin();
427 hookiter != hooks.end(); )
429 erase = hookiter->plug == plug && hookiter->handler->IsEqual(handler) &&
430 hookiter->thisptr_offs == thisptr_offs;
433 hookiter->handler->DeleteThis(); // Make the _plugin_ delete the handler object
435 // Move all iterators pointing at this
436 List<HookInfo>::iterator oldhookiter = hookiter;
437 hookiter = hooks.erase(hookiter);
438 List<HookInfo>::iterator newhookiter = hookiter;
439 --newhookiter; // The hook loop will ++ it then
440 CHookList::CIter *pItIter;
441 for (pItIter = iface_iter->m_PreHooks.m_UsedIters; pItIter; pItIter = pItIter->m_pNext)
442 if (pItIter->m_Iter == oldhookiter)
443 pItIter->m_Iter = newhookiter;
448 if (iface_iter->m_PostHooks.m_List.empty() && iface_iter->m_PreHooks.m_List.empty())
450 // There are no hooks on this iface anymore...
451 for (HookLoopInfoStack::iterator hli_iter = m_HLIStack.begin();
452 hli_iter != m_HLIStack.end(); ++hli_iter)
454 if (hli_iter->pCurIface == static_cast<IIface*>(&(*iface_iter)))
455 hli_iter->shouldContinue = false;
458 iface_iter = vfnptr_iter->m_Ifaces.erase(iface_iter);
459 if (vfnptr_iter->m_Ifaces.empty())
461 // No ifaces at all -> Deactivate the hook
462 *reinterpret_cast<void**>(vfnptr_iter->m_Ptr) = vfnptr_iter->m_OrigEntry;
464 hookman->m_VfnPtrs.erase(vfnptr_iter);
466 // Remove callclass patch
467 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
468 if (cciter->m_Ptr == adjustediface)
469 cciter->RemoveCallClassPatch(tmp.m_VtblOffs, tmp.m_VtblIdx);
471 if (hookman->m_VfnPtrs.empty())
473 // Unregister the hook manager
474 hookman->m_Func(HA_Unregister, NULL);
477 // Don't try to continue looping through ifaces
478 // - the list is already invalid
488 GenericCallClass *CSourceHookImpl::GetCallClass(void *iface, size_t size)
490 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
492 if (cciter->m_Ptr == iface && cciter->m_ObjSize == size)
494 ++cciter->m_RefCounter;
501 CCallClassImpl tmp(iface, size);
502 ApplyCallClassPatches(tmp);
503 m_CallClasses.push_back(tmp);
504 return &m_CallClasses.back();
507 void CSourceHookImpl::ReleaseCallClass(GenericCallClass *ptr)
509 Impl_CallClassList::iterator iter = m_CallClasses.find(ptr);
510 if (iter == m_CallClasses.end())
512 --iter->m_RefCounter;
513 if (iter->m_RefCounter < 1)
514 m_CallClasses.erase(iter);
517 void CSourceHookImpl::ApplyCallClassPatches(CCallClassImpl &cc)
519 for (HookManContList::iterator hmcl_iter = m_HookMans.begin();
520 hmcl_iter != m_HookMans.end(); ++hmcl_iter)
522 for (CHookManagerContainer::iterator hookman = hmcl_iter->begin();
523 hookman != hmcl_iter->end(); ++hookman)
525 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->m_VfnPtrs.begin();
526 vfnptr_iter != hookman->m_VfnPtrs.end(); ++vfnptr_iter)
528 for (CVfnPtr::IfaceListIter iface_iter = vfnptr_iter->m_Ifaces.begin();
529 iface_iter != vfnptr_iter->m_Ifaces.end(); ++iface_iter)
531 if (iface_iter->m_Ptr >= cc.m_Ptr &&
532 iface_iter->m_Ptr < (reinterpret_cast<char*>(cc.m_Ptr) + cc.m_ObjSize))
534 cc.ApplyCallClassPatch(static_cast<int>(reinterpret_cast<char*>(iface_iter->m_Ptr) -
535 reinterpret_cast<char*>(cc.m_Ptr)) + hookman->m_VtblOffs,
536 hookman->m_VtblIdx, vfnptr_iter->m_OrigEntry);
544 void CSourceHookImpl::ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry)
546 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
549 if (ifaceptr >= cc_iter->m_Ptr &&
550 ifaceptr < (reinterpret_cast<char*>(cc_iter->m_Ptr) + cc_iter->m_ObjSize))
552 cc_iter->ApplyCallClassPatch(static_cast<int>(reinterpret_cast<char*>(ifaceptr) -
553 reinterpret_cast<char*>(cc_iter->m_Ptr)) + vtbl_offs, vtbl_idx, orig_entry);
558 void CSourceHookImpl::RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx)
560 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
563 if (ifaceptr >= cc_iter->m_Ptr &&
564 ifaceptr < (reinterpret_cast<char*>(cc_iter->m_Ptr) + cc_iter->m_ObjSize))
566 cc_iter->RemoveCallClassPatch(vtbl_offs, vtbl_idx);
571 void CSourceHookImpl::SetPluginPaused(Plugin plug, bool paused)
573 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to paused
574 for (HookManContList::iterator hmcl_iter = m_HookMans.begin();
575 hmcl_iter != m_HookMans.end(); ++hmcl_iter)
577 for (CHookManagerContainer::iterator hookmaniter = hmcl_iter->begin();
578 hookmaniter != hmcl_iter->end(); ++hookmaniter)
580 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = hookmaniter->m_VfnPtrs.begin();
581 vfnptr_iter != hookmaniter->m_VfnPtrs.end(); ++vfnptr_iter)
583 for (CVfnPtr::IfaceListIter ifaceiter = vfnptr_iter->m_Ifaces.begin();
584 ifaceiter != vfnptr_iter->m_Ifaces.end(); ++ifaceiter)
586 for (List<HookInfo>::iterator hookiter = ifaceiter->m_PreHooks.m_List.begin();
587 hookiter != ifaceiter->m_PreHooks.m_List.end(); ++hookiter)
588 if (plug == hookiter->plug)
589 hookiter->paused = paused;
591 for (List<HookInfo>::iterator hookiter = ifaceiter->m_PostHooks.m_List.begin();
592 hookiter != ifaceiter->m_PostHooks.m_List.end(); ++hookiter)
593 if (plug == hookiter->plug)
594 hookiter->paused = paused;
600 void CSourceHookImpl::PausePlugin(Plugin plug)
602 SetPluginPaused(plug, true);
605 void CSourceHookImpl::UnpausePlugin(Plugin plug)
607 SetPluginPaused(plug, false);
610 void CSourceHookImpl::HookLoopBegin(IIface *pIface)
613 hli.pCurIface = pIface;
614 hli.shouldContinue = true;
616 m_HLIStack.push(hli);
619 void CSourceHookImpl::HookLoopEnd()
624 void CSourceHookImpl::SetRes(META_RES res)
626 *m_HLIStack.front().pCurRes = res;
629 META_RES CSourceHookImpl::GetPrevRes()
631 return *m_HLIStack.front().pPrevRes;
634 META_RES CSourceHookImpl::GetStatus()
636 return *m_HLIStack.front().pStatus;
639 const void *CSourceHookImpl::GetOrigRet()
641 return m_HLIStack.front().pOrigRet;
644 const void *CSourceHookImpl::GetOverrideRet()
646 // pOverrideRet is always set since recalls were introduced
647 // GetOverrideRetPtr was added; a function which always returns pOverrideRet
648 // so that RETURN_META_VALUE_NEWPARAMS can provide an override result
650 // This means that we have to filter GetOverrideRet:
651 // If the status variable is < MRES_OVERRIDE, return NULL.
653 return (*m_HLIStack.front().pStatus < MRES_OVERRIDE) ?
654 NULL : m_HLIStack.front().pOverrideRet;
657 void *CSourceHookImpl::GetOverrideRetPtr()
659 // As described in the comment above: always return pOverrideRet
660 return m_HLIStack.front().pOverrideRet;
663 void *CSourceHookImpl::GetIfacePtr()
665 return *m_HLIStack.front().pIfacePtrPtr;
668 void CSourceHookImpl::SetCurResPtr(META_RES *mres)
670 m_HLIStack.front().pCurRes = mres;
673 void CSourceHookImpl::SetPrevResPtr(META_RES *mres)
675 m_HLIStack.front().pPrevRes = mres;
677 // If we're recalling, drag the previous mres value to the new hookfunc
678 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall)
679 *mres = *m_HLIStack.second().pPrevRes;
682 void CSourceHookImpl::SetStatusPtr(META_RES *mres)
684 m_HLIStack.front().pStatus = mres;
686 // If we're recalling, drag the previous mres value to the new hookfunc
687 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall)
688 *mres = *m_HLIStack.second().pStatus;
691 void CSourceHookImpl::SetIfacePtrPtr(void **pp)
693 m_HLIStack.front().pIfacePtrPtr = pp;
696 void CSourceHookImpl::SetOrigRetPtr(const void *ptr)
698 m_HLIStack.front().pOrigRet = ptr;
700 void CSourceHookImpl::SetOverrideRetPtr(void *ptr)
702 m_HLIStack.front().pOverrideRet = ptr;
705 // New function which does all of the above + more :)
706 void *CSourceHookImpl::SetupHookLoop(META_RES *statusPtr, META_RES *prevResPtr, META_RES *curResPtr,
707 void **ifacePtrPtr, const void *origRetPtr, void *overrideRetPtr)
709 HookLoopInfo &hli = m_HLIStack.front();
710 hli.pStatus = statusPtr;
711 hli.pPrevRes = prevResPtr;
712 hli.pCurRes = curResPtr;
713 hli.pIfacePtrPtr = ifacePtrPtr;
714 hli.pOrigRet = origRetPtr;
716 // Handle some recall stuff
717 if (m_HLIStack.size() > 1 && m_HLIStack.second().recall)
719 HookLoopInfo &other = m_HLIStack.second();
720 *statusPtr = *other.pStatus;
721 *prevResPtr = *other.pStatus;
722 hli.pOverrideRet = other.pOverrideRet;
725 hli.pOverrideRet = overrideRetPtr;
727 // Tell the hook func which override ret ptr to use
728 return hli.pOverrideRet;
731 bool CSourceHookImpl::ShouldContinue()
733 // If recall is true, we shall not continue either.
734 // This is because, if it's true and ShouldContinue is called, it suggests that the
735 // actual recall is done and that we are back in the original handler which shall return
738 return m_HLIStack.front().shouldContinue && !m_HLIStack.front().recall;
741 void CSourceHookImpl::DoRecall()
743 if (!m_HLIStack.empty())
745 m_HLIStack.front().recall = true;
746 CHookList *mlist = static_cast<CHookList*>(m_HLIStack.front().pCurIface->GetPreHooks());
747 mlist->m_Recall = true;
749 // The hookfunc usually do this, but it won't have a chance to see it,
750 // so for recalls, we update status here if it's required
751 if (*m_HLIStack.front().pCurRes > *m_HLIStack.front().pStatus)
752 *m_HLIStack.front().pStatus = *m_HLIStack.front().pCurRes;
757 ////////////////////////////
759 ////////////////////////////
760 CSourceHookImpl::CCallClassImpl::CCallClassImpl(void *ptr, size_t size)
761 : m_Ptr(ptr), m_ObjSize(size), m_RefCounter(1)
764 CSourceHookImpl::CCallClassImpl::~CCallClassImpl()
768 void *CSourceHookImpl::CCallClassImpl::GetThisPtr()
772 void *CSourceHookImpl::CCallClassImpl::GetOrigFunc(int vtbloffs, int vtblidx)
774 OrigVTables::iterator iter = m_VT.find(vtbloffs);
775 if (iter != m_VT.end() && iter->val.size() > (size_t)vtblidx)
777 return iter->val[vtblidx];
782 void CSourceHookImpl::CCallClassImpl::ApplyCallClassPatch(int vtbl_offs, int vtbl_idx, void *orig_entry)
784 OrigFuncs &tmpvec = m_VT[vtbl_offs];
785 if (tmpvec.size() <= (size_t)vtbl_idx)
786 tmpvec.resize(vtbl_idx+1);
787 tmpvec[vtbl_idx] = orig_entry;
789 void CSourceHookImpl::CCallClassImpl::RemoveCallClassPatch(int vtbl_offs, int vtbl_idx)
791 OrigVTables::iterator iter = m_VT.find(vtbl_offs);
792 if (iter != m_VT.end())
794 if (iter->val.size() > (size_t)vtbl_idx)
796 iter->val[vtbl_idx] = 0;
798 OrigFuncs &of = iter->val;
799 OrigFuncs::iterator lastused = of.end();
800 for (OrigFuncs::iterator viter = of.begin(); viter != of.end(); ++viter)
805 if (lastused == of.end())
807 // No used element => Remove the whole vector
811 of.resize(lastused - of.begin() + 1);
816 ////////////////////////////
818 ////////////////////////////
819 CSourceHookImpl::CHookManagerInfo::CHookManagerInfo() : m_HookManVersion(0)
822 CSourceHookImpl::CHookManagerInfo::~CHookManagerInfo()
826 IVfnPtr *CSourceHookImpl::CHookManagerInfo::FindVfnPtr(void *vfnptr)
828 VfnPtrListIter iter = m_VfnPtrs.find(vfnptr);
829 return iter == m_VfnPtrs.end() ? NULL : &(*iter);
831 void CSourceHookImpl::CHookManagerInfo::SetInfo(int vtbl_offs, int vtbl_idx, const char *proto)
833 m_VtblOffs = vtbl_offs;
834 m_VtblIdx = vtbl_idx;
837 void CSourceHookImpl::CHookManagerInfo::SetHookfuncVfnptr(void *hookfunc_vfnptr)
839 m_HookfuncVfnptr = hookfunc_vfnptr;
841 void CSourceHookImpl::CHookManagerInfo::SetVersion(int version)
843 m_HookManVersion = version;
845 ////////////////////////////
847 ////////////////////////////
850 // If you get a crash here, the ptr passed is invalid
851 // This usually means a SH_DECL_MANUALHOOK* with wrong thisptroffs/vtbloffs/vtblidx
852 CSourceHookImpl::CVfnPtr::CVfnPtr(void *ptr) : m_Ptr(ptr), m_OrigEntry(*reinterpret_cast<void**>(ptr))
855 CSourceHookImpl::CVfnPtr::~CVfnPtr()
859 void *CSourceHookImpl::CVfnPtr::GetVfnPtr()
864 void *CSourceHookImpl::CVfnPtr::GetOrigEntry()
869 IIface *CSourceHookImpl::CVfnPtr::FindIface(void *ptr)
871 IfaceListIter iter = m_Ifaces.find(ptr);
872 return iter == m_Ifaces.end() ? NULL : &(*iter);
875 ////////////////////////////
877 ////////////////////////////
878 CSourceHookImpl::CIface::CIface(void *ptr) : m_Ptr(ptr)
881 CSourceHookImpl::CIface::~CIface()
885 void *CSourceHookImpl::CIface::GetPtr()
890 IHookList *CSourceHookImpl::CIface::GetPreHooks()
894 IHookList *CSourceHookImpl::CIface::GetPostHooks()
899 ////////////////////////////
901 ////////////////////////////
903 CSourceHookImpl::CHookList::CHookList() : m_FreeIters(NULL), m_UsedIters(NULL),
907 CSourceHookImpl::CHookList::CHookList(const CHookList &other) : m_List(other.m_List),
908 m_FreeIters(NULL), m_UsedIters(NULL), m_Recall(false)
912 CSourceHookImpl::CHookList::~CHookList()
916 CIter *iter = m_FreeIters->m_pNext;
922 CIter *iter = m_UsedIters->m_pNext;
927 IHookList::IIter *CSourceHookImpl::CHookList::GetIter()
933 m_FreeIters = ret->m_pNext;
938 ret = new CIter(this);
941 // Muuuh, if we're recalling, it shall be a copy of the last iterator, incremented by one
942 if (m_Recall && m_UsedIters)
944 ret->Set(m_UsedIters); // m_UsedIters is the last returned and not released iterator
945 ret->Next(); // Use next instead of directly incrementing its m_Iter:
946 // skips paused plugins
949 ret->m_pNext = m_UsedIters;
952 m_UsedIters->m_pPrev = ret;
959 void CSourceHookImpl::CHookList::ReleaseIter(IIter *pIter)
961 CIter *pIter2 = static_cast<CIter*>(pIter);
963 // Unlink from m_UsedIters
966 pIter2->m_pNext->m_pPrev = pIter2->m_pPrev;
968 pIter2->m_pPrev->m_pNext = pIter2->m_pNext;
969 if (pIter2 == m_UsedIters)
972 // Link to m_FreeIters
974 pIter2->m_pNext = m_FreeIters;
976 m_FreeIters = pIter2;
978 // Reset recall state.
982 CSourceHookImpl::CHookList::CIter::CIter(CHookList *pList) : m_pList(pList), m_pNext(NULL)
986 CSourceHookImpl::CHookList::CIter::~CIter()
990 void CSourceHookImpl::CHookList::CIter::Set(CIter *pOther)
992 m_Iter = pOther->m_Iter;
995 void CSourceHookImpl::CHookList::CIter::GoToBegin()
997 m_Iter = m_pList->m_List.begin();
1001 bool CSourceHookImpl::CHookList::CIter::End()
1005 return m_Iter == m_pList->m_List.end();
1007 void CSourceHookImpl::CHookList::CIter::Next()
1014 void CSourceHookImpl::CHookList::CIter::Clear()
1018 void CSourceHookImpl::CHookList::CIter::SkipPaused()
1020 while (m_Iter != m_pList->m_List.end() && m_Iter->paused)
1024 ISHDelegate *CSourceHookImpl::CHookList::CIter::Handler()
1026 return m_Iter->handler;
1028 int CSourceHookImpl::CHookList::CIter::ThisPtrOffs()
1030 return m_Iter->thisptr_offs;
1033 //////////////////////////////////////////////////////////////////////////
1035 //////////////////////////////////////////////////////////////////////////
1036 bool CSourceHookImpl::CProto::Equal(const char *p1, const char *p2)
1038 if (*p1 && *p2) // Case1: Both old
1040 // As in old versions
1041 return strcmp(p1, p2) == 0;
1043 else if (!*p1 && !*p2) // Case2: Both new
1045 const ProtoInfo *pi1 = reinterpret_cast<const ProtoInfo*>(p1);
1046 const ProtoInfo *pi2 = reinterpret_cast<const ProtoInfo*>(p2);
1048 if (pi1->retTypeSize == pi2->retTypeSize &&
1049 pi1->numOfParams == pi2->numOfParams)
1051 // params[0] is 0 for "normal" functions and -1 for vararg functions
1052 // params[1] is size of first parameter
1053 // params[2] is size of second parameter ...
1054 for (int i = 0; i <= pi1->numOfParams; ++i)
1056 if (pi1->params[i] != pi2->params[i])
1066 else // Case3: Mixed old/new
1074 //////////////////////////////////////////////////////////////////////////
1075 // CHookManagerContainer
1076 //////////////////////////////////////////////////////////////////////////
1077 void CSourceHookImpl::CHookManagerContainer::AddHookManager(Plugin plug, const CHookManagerInfo &hookman)
1080 // Check whether such a hook manager already exists; if yes, ignore.
1081 for (iter = begin(); iter != end(); ++iter)
1083 if (iter->m_Plug == plug && iter->m_Func == hookman.m_Func)
1087 // It doesn't -> add it. Add it to the end of its version group.
1088 for (iter = begin(); iter != end(); ++iter)
1090 if (iter->m_HookManVersion < hookman.m_HookManVersion)
1094 bool isBeginning = iter == begin();
1096 insert(iter, hookman);
1098 // If we inserted it at the beginning and if the dam breaks open many years too soon
1099 // and if there is more than one hookman and if the second one isn't empty, transfer
1100 // hooks from second to first
1102 if (isBeginning && size() > 1)
1105 iterator second = iter;
1108 if (!second->m_VfnPtrs.empty())
1110 // Move the vfnptrs from the old hook manager to the new one
1111 iter->m_VfnPtrs = second->m_VfnPtrs;
1112 second->m_VfnPtrs.clear();
1114 // Unregister the old one, register the new one
1115 second->m_Func(HA_Unregister, NULL);
1116 iter->m_Func(HA_Register, &(*iter));
1118 // Go through all vfnptrs in this hookman and patch them to point to the new manager's handler!
1120 for (CHookManagerInfo::VfnPtrListIter vfnptr_iter = iter->m_VfnPtrs.begin();
1121 vfnptr_iter != iter->m_VfnPtrs.end(); ++vfnptr_iter)
1123 // And DEREFERENCE newHookMan->m_HookfuncVfnptr!
1124 // otherwise it will be executing the vtable... had to find out the hard way
1125 *reinterpret_cast<void**>(vfnptr_iter->m_Ptr) = *reinterpret_cast<void**>(iter->m_HookfuncVfnptr);