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
18 #include "sourcehook_impl.h"
19 #include "sh_tinyhash.h"
24 int SourceHook::HashFunction<int>(const int & k)
29 int SourceHook::Compare<int>(const int & k1, const int & k2)
39 CSourceHookImpl::CSourceHookImpl()
43 CSourceHookImpl::~CSourceHookImpl()
47 int CSourceHookImpl::GetIfaceVersion()
49 return SH_IFACE_VERSION;
52 int CSourceHookImpl::GetImplVersion()
54 return SH_IMPL_VERSION;
57 bool CSourceHookImpl::IsPluginInUse(Plugin plug)
59 // Iterate through all hook managers which are in this plugin
60 // Iterate through their vfnptrs, ifaces, hooks
61 // If a hook from an other plugin is found, return true
62 // Return false otherwise
63 #define TMP_CHECK_LIST(name) \
64 for (hook_iter = iface_iter->name.begin(); hook_iter != iface_iter->name.end(); ++hook_iter) \
65 if (hook_iter->plug == plug) \
68 for (HookManInfoList::iterator hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end(); ++hmil_iter)
70 if (hmil_iter->plug != plug)
72 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->vfnptrs.begin();
73 vfnptr_iter != hmil_iter->vfnptrs.end(); ++vfnptr_iter)
75 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
76 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
78 List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hook_iter;
79 TMP_CHECK_LIST(hooks_pre);
80 TMP_CHECK_LIST(hooks_post);
88 void CSourceHookImpl::UnloadPlugin(Plugin plug)
90 // 1) Manually remove all hooks by this plugin
91 List<RemoveHookInfo> hookstoremove;
92 HookManInfoList::iterator hmil_iter;
94 #define TMP_CHECK_LIST(name, ispost) \
95 for (hook_iter = iface_iter->name.begin(); hook_iter != iface_iter->name.end(); ++hook_iter) \
96 if (hook_iter->plug == plug) \
97 hookstoremove.push_back(RemoveHookInfo(hook_iter->plug, iface_iter->ptr, \
98 hook_iter->thisptr_offs, hmil_iter->func, hook_iter->handler, ispost))
99 for (hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end(); ++hmil_iter)
101 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->vfnptrs.begin();
102 vfnptr_iter != hmil_iter->vfnptrs.end(); ++vfnptr_iter)
104 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
105 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
107 List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hook_iter;
108 TMP_CHECK_LIST(hooks_pre, false);
109 TMP_CHECK_LIST(hooks_post, true);
113 #undef TMP_CHECK_LIST
115 for (List<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
118 // 2) Other plugins may use hook managers in this plugin.
119 // Get a list of hook managers that are in this plugin and are used by other plugins
120 // Delete all hook managers that are in this plugin
122 HookManInfoList tmphookmans;
124 for (hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end();
125 erase ? hmil_iter=m_HookMans.erase(hmil_iter) : ++hmil_iter)
127 if (hmil_iter->plug == plug)
129 if (!hmil_iter->vfnptrs.empty())
131 // All hooks by this plugin are already removed
132 // So if there is a vfnptr, it has to be used by an other plugin
133 tmphookmans.push_back(*hmil_iter);
141 // For each hook manager:
142 for (hmil_iter = tmphookmans.begin(); hmil_iter != tmphookmans.end(); ++hmil_iter)
144 // Find a suitable hook manager in an other plugin
145 HookManInfoList::iterator newHookMan = FindHookMan(m_HookMans.begin(), m_HookMans.end(),
146 hmil_iter->proto, hmil_iter->vtbl_offs, hmil_iter->vtbl_idx);
148 // This should _never_ happen.
149 // If there is a hook from an other plugin, the plugin must have provided a hook manager as well.
150 SH_ASSERT(newHookMan != m_HookMans.end(),
151 "Could not find a suitable hook manager in an other plugin!");
153 // AddHook should make sure that every plugin only has _one_ hook manager for _one_ proto/vi/vo
154 SH_ASSERT(newHookMan->plug != plug, "New hook manager from same plugin!");
156 // The first hook manager should be always used - so the new hook manager has to be empty
157 SH_ASSERT(newHookMan->vfnptrs.empty(), "New hook manager not empty!");
159 // Move the vfnptrs from the old hook manager to the new one
160 newHookMan->vfnptrs = hmil_iter->vfnptrs;
162 // Unregister the old one, register the new one
163 hmil_iter->func(HA_Unregister, NULL);
164 newHookMan->func(HA_Register, &(*newHookMan));
166 // zOMG BAIL, here is part of what you wanted:
168 // Go through all vfnptrs in this hookman and patch them to point to the new manager's handler!
170 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = newHookMan->vfnptrs.begin();
171 vfnptr_iter != newHookMan->vfnptrs.end(); ++vfnptr_iter)
173 // And DEREFERENCE newHookMan->hookfunc_vfnptr!
174 // otherwise it will be executing the vtable... had to find out the hard way
175 *reinterpret_cast<void**>(vfnptr_iter->vfnptr) = *reinterpret_cast<void**>(newHookMan->hookfunc_vfnptr);
178 // That should fix it, bail!
182 void CSourceHookImpl::CompleteShutdown()
184 List<RemoveHookInfo> hookstoremove;
185 #define TMP_CHECK_LIST(name, ispost) \
186 for (hook_iter = iface_iter->name.begin(); hook_iter != iface_iter->name.end(); ++hook_iter) \
187 hookstoremove.push_back(RemoveHookInfo(hook_iter->plug, iface_iter->ptr, \
188 hook_iter->thisptr_offs, hmil_iter->func, hook_iter->handler, ispost))
189 for (HookManInfoList::iterator hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end(); ++hmil_iter)
191 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->vfnptrs.begin();
192 vfnptr_iter != hmil_iter->vfnptrs.end(); ++vfnptr_iter)
194 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
195 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
197 List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hook_iter;
198 TMP_CHECK_LIST(hooks_pre, false);
199 TMP_CHECK_LIST(hooks_post, true);
203 #undef TMP_CHECK_LIST
205 for (List<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
211 bool CSourceHookImpl::AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
213 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface) + thisptr_offs);
214 // 1) Get info about the hook manager
216 if (myHookMan(HA_GetInfo, &tmp) != 0)
219 // Add the proposed hook manager to the _end_ of the list if the plugin doesn't have a hook manager with this proto/vo/vi registered
220 HookManInfoList::iterator hkmi_iter;
221 for (hkmi_iter = m_HookMans.begin(); hkmi_iter != m_HookMans.end(); ++hkmi_iter)
223 if (hkmi_iter->plug == plug && strcmp(hkmi_iter->proto, tmp.proto) == 0 &&
224 hkmi_iter->vtbl_offs == tmp.vtbl_offs && hkmi_iter->vtbl_idx == tmp.vtbl_idx)
227 if (hkmi_iter == m_HookMans.end())
229 // No such hook manager from this plugin yet, add it!
230 tmp.func = myHookMan;
232 m_HookMans.push_back(tmp);
235 // Then, search for a suitable hook manager (from the beginning)
236 HookManInfoList::iterator hookman = FindHookMan(m_HookMans.begin(), m_HookMans.end(), tmp.proto, tmp.vtbl_offs, tmp.vtbl_idx);
237 SH_ASSERT(hookman != m_HookMans.end(), "No hookman found - but if there was none, we've just added one!");
239 // Tell it to store the pointer if it's not already active
240 if (hookman->vfnptrs.empty())
241 hookman->func(HA_Register, &(*hookman));
243 void **cur_vtptr = *reinterpret_cast<void***>(
244 reinterpret_cast<char*>(adjustediface) + tmp.vtbl_offs);
245 void *cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + tmp.vtbl_idx);
247 HookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->vfnptrs.find(cur_vfnptr);
249 if (vfnptr_iter == hookman->vfnptrs.end())
252 HookManagerInfo::VfnPtr vfp;
253 vfp.vfnptr = cur_vfnptr;
254 vfp.orig_entry = *reinterpret_cast<void**>(cur_vfnptr);
256 // Alter vtable entry
257 if (!SetMemAccess(cur_vtptr, sizeof(void*) * (tmp.vtbl_idx + 1), SH_MEM_READ | SH_MEM_WRITE))
260 *reinterpret_cast<void**>(cur_vfnptr) = *reinterpret_cast<void**>(hookman->hookfunc_vfnptr);
262 hookman->vfnptrs.push_back(vfp);
264 // Make vfnptr_iter point to the new element
265 vfnptr_iter = hookman->vfnptrs.end();
268 // Now that it is done, check whether we have to update any callclasses
269 ApplyCallClassPatches(adjustediface, tmp.vtbl_offs, tmp.vtbl_idx, vfp.orig_entry);
272 HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.find(adjustediface);
273 if (iface_iter == vfnptr_iter->ifaces.end())
276 HookManagerInfo::VfnPtr::Iface ifs;
277 ifs.ptr = adjustediface;
278 vfnptr_iter->ifaces.push_back(ifs);
280 // Make iface_iter point to the new element
281 iface_iter = vfnptr_iter->ifaces.end();
286 HookManagerInfo::VfnPtr::Iface::Hook hookinfo;
287 hookinfo.handler = handler;
288 hookinfo.plug = plug;
289 hookinfo.paused = false;
290 hookinfo.thisptr_offs = thisptr_offs;
292 iface_iter->hooks_post.push_back(hookinfo);
294 iface_iter->hooks_pre.push_back(hookinfo);
300 bool CSourceHookImpl::RemoveHook(RemoveHookInfo info)
302 return RemoveHook(info.plug, info.iface, info.thisptr_offs, info.hookman, info.handler, info.post);
305 bool CSourceHookImpl::RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
307 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface)+thisptr_offs);
309 if (myHookMan(HA_GetInfo, &tmp) != 0)
312 // Find the hook manager and the hook
313 HookManInfoList::iterator hookman = FindHookMan(m_HookMans.begin(), m_HookMans.end(),
314 tmp.proto, tmp.vtbl_offs, tmp.vtbl_idx);
315 if (hookman == m_HookMans.end())
318 if (IsBadReadPtr(reinterpret_cast<char*>(adjustediface) + tmp.vtbl_offs, sizeof(char)))
320 hookman->vfnptrs.clear();
321 hookman->func(HA_Unregister, NULL);
325 void **cur_vtptr = *reinterpret_cast<void***>(
326 reinterpret_cast<char*>(adjustediface) + tmp.vtbl_offs);
327 void *cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + tmp.vtbl_idx);
329 HookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->vfnptrs.find(cur_vfnptr);
331 if (vfnptr_iter == hookman->vfnptrs.end())
334 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
335 iface_iter != vfnptr_iter->ifaces.end();)
337 List<HookManagerInfo::VfnPtr::Iface::Hook> &hooks =
338 post ? iface_iter->hooks_post : iface_iter->hooks_pre;
341 for (List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = hooks.begin();
342 hookiter != hooks.end(); erase ? hookiter = hooks.erase(hookiter) : ++hookiter)
344 erase = hookiter->plug == plug && hookiter->handler->IsEqual(handler) &&
345 hookiter->thisptr_offs == thisptr_offs;
347 hookiter->handler->DeleteThis(); // Make the _plugin_ delete the handler object
349 if (iface_iter->hooks_post.empty() && iface_iter->hooks_pre.empty())
351 iface_iter = vfnptr_iter->ifaces.erase(iface_iter);
352 if (vfnptr_iter->ifaces.empty())
354 // Deactivate the hook
355 *reinterpret_cast<void**>(vfnptr_iter->vfnptr) = vfnptr_iter->orig_entry;
357 hookman->vfnptrs.erase(vfnptr_iter);
359 // Remove callclass patch
360 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
361 if (cciter->cc.ptr == adjustediface)
362 RemoveCallClassPatch(*cciter, tmp.vtbl_offs, tmp.vtbl_idx);
364 if (hookman->vfnptrs.empty())
366 // Unregister the hook manager
367 hookman->func(HA_Unregister, NULL);
370 // Don't try to continue looping through ifaces
371 // - the list is already invalid
381 GenericCallClass *CSourceHookImpl::GetCallClass(void *iface, size_t size)
383 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
385 if (cciter->cc.ptr == iface && cciter->cc.objsize == size)
387 ++cciter->refcounter;
395 tmp.cc.objsize = size;
397 ApplyCallClassPatches(tmp);
399 m_CallClasses.push_back(tmp);
400 return &m_CallClasses.back().cc;
403 void CSourceHookImpl::ReleaseCallClass(GenericCallClass *ptr)
405 Impl_CallClassList::iterator iter = m_CallClasses.find(ptr);
406 if (iter == m_CallClasses.end())
409 if (iter->refcounter < 1)
410 m_CallClasses.erase(iter);
413 void CSourceHookImpl::ApplyCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx, void *orig_entry)
415 OrigFuncs &tmpvec = cc.cc.vt[vtbl_offs];
416 if (tmpvec.size() <= (size_t)vtbl_idx)
417 tmpvec.resize(vtbl_idx+1);
418 tmpvec[vtbl_idx] = orig_entry;
421 void CSourceHookImpl::ApplyCallClassPatches(CallClassInfo &cc)
423 for (HookManInfoList::iterator hookman = m_HookMans.begin(); hookman != m_HookMans.end(); ++hookman)
425 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->vfnptrs.begin();
426 vfnptr_iter != hookman->vfnptrs.end(); ++vfnptr_iter)
428 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
429 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
431 if (iface_iter->ptr >= cc.cc.ptr &&
432 iface_iter->ptr < (reinterpret_cast<char*>(cc.cc.ptr) + cc.cc.objsize))
434 ApplyCallClassPatch(cc, static_cast<int>(reinterpret_cast<char*>(iface_iter->ptr) -
435 reinterpret_cast<char*>(cc.cc.ptr)) + hookman->vtbl_offs,
436 hookman->vtbl_idx, vfnptr_iter->orig_entry);
443 void CSourceHookImpl::ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry)
445 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
448 if (ifaceptr >= cc_iter->cc.ptr &&
449 ifaceptr < (reinterpret_cast<char*>(cc_iter->cc.ptr) + cc_iter->cc.objsize))
451 ApplyCallClassPatch(*cc_iter, static_cast<int>(reinterpret_cast<char*>(ifaceptr) -
452 reinterpret_cast<char*>(cc_iter->cc.ptr)) + vtbl_offs, vtbl_idx, orig_entry);
457 void CSourceHookImpl::RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx)
459 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
462 if (ifaceptr >= cc_iter->cc.ptr &&
463 ifaceptr < (reinterpret_cast<char*>(cc_iter->cc.ptr) + cc_iter->cc.objsize))
465 RemoveCallClassPatch(*cc_iter, vtbl_offs, vtbl_idx);
470 void CSourceHookImpl::RemoveCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx)
472 OrigVTables::iterator iter = cc.cc.vt.find(vtbl_offs);
473 if (iter != cc.cc.vt.end())
475 if (iter->val.size() > (size_t)vtbl_idx)
477 iter->val[vtbl_idx] = 0;
478 // Free some memory if possible
479 // :TODO: add this back in!
481 OrigFuncs::reverse_iterator riter;
482 for (riter = iter->second.rbegin(); riter != iter->second.rend(); ++riter)
487 iter->second.resize(iter->second.size() - (riter - iter->second.rbegin()));
488 if (!iter->second.size())
489 cc.cc.vt.erase(iter);*/
494 CSourceHookImpl::HookManInfoList::iterator CSourceHookImpl::FindHookMan(HookManInfoList::iterator begin,
495 HookManInfoList::iterator end, const char *proto, int vtblofs, int vtblidx)
497 HookManInfoList::iterator hookmaniter;
498 for (hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
500 if (strcmp(hookmaniter->proto, proto) == 0 && hookmaniter->vtbl_offs == vtblofs &&
501 hookmaniter->vtbl_idx == vtblidx)
507 void CSourceHookImpl::PausePlugin(Plugin plug)
509 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to paused
510 for (HookManInfoList::iterator hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
511 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hookmaniter->vfnptrs.begin();
512 vfnptr_iter != hookmaniter->vfnptrs.end(); ++vfnptr_iter)
513 for (HookManagerInfo::VfnPtr::IfaceListIter ifaceiter = vfnptr_iter->ifaces.begin();
514 ifaceiter != vfnptr_iter->ifaces.end(); ++ifaceiter)
516 for (List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_pre.begin();
517 hookiter != ifaceiter->hooks_pre.end(); ++hookiter)
518 if (plug == hookiter->plug)
519 hookiter->paused = true;
521 for (List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_post.begin();
522 hookiter != ifaceiter->hooks_post.end(); ++hookiter)
523 if (plug == hookiter->plug)
524 hookiter->paused = true;
528 void CSourceHookImpl::UnpausePlugin(Plugin plug)
530 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to paused
531 for (HookManInfoList::iterator hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
532 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hookmaniter->vfnptrs.begin();
533 vfnptr_iter != hookmaniter->vfnptrs.end(); ++vfnptr_iter)
534 for (HookManagerInfo::VfnPtr::IfaceListIter ifaceiter = vfnptr_iter->ifaces.begin();
535 ifaceiter != vfnptr_iter->ifaces.end(); ++ifaceiter)
537 for (List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_pre.begin();
538 hookiter != ifaceiter->hooks_pre.end(); ++hookiter)
539 if (plug == hookiter->plug)
540 hookiter->paused = false;
542 for (List<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_post.begin();
543 hookiter != ifaceiter->hooks_post.end(); ++hookiter)
544 if (plug == hookiter->plug)
545 hookiter->paused = false;
549 void CSourceHookImpl::SetRes(META_RES res)
554 META_RES CSourceHookImpl::GetPrevRes()
559 META_RES CSourceHookImpl::GetStatus()
564 const void *CSourceHookImpl::GetOrigRet()
569 const void *CSourceHookImpl::GetOverrideRet()
571 return m_OverrideRet;
574 META_RES &CSourceHookImpl::GetCurResRef()
579 META_RES &CSourceHookImpl::GetPrevResRef()
584 META_RES &CSourceHookImpl::GetStatusRef()
589 void * &CSourceHookImpl::GetIfacePtrRef()
594 void CSourceHookImpl::SetOrigRet(const void *ptr)
599 void CSourceHookImpl::SetOverrideRet(const void *ptr)
604 void *CSourceHookImpl::GetIfacePtr()
610 bool g_BadReadCalled;
611 jmp_buf g_BadReadJmpBuf;
613 // Windows has an implementation for this already, but Linux does not :(
614 bool IsBadReadPtr(const void *ptr, size_t len)
616 void(*prevHandler)(int sig);
617 g_BadReadCalled = true;
619 if (setjmp(g_BadReadJmpBuf))
622 prevHandler = signal(SIGSEGV, BadReadHandler);
624 volatile const char *p = reinterpret_cast<const char*>(ptr);
627 for (size_t i = 0; i < len; i++)
630 g_BadReadCalled = false;
632 signal(SIGSEGV, prevHandler);
637 void BadReadHandler(int sig)
640 longjmp(g_BadReadJmpBuf, 1);