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"
22 CSourceHookImpl::CSourceHookImpl()
26 CSourceHookImpl::~CSourceHookImpl()
30 int CSourceHookImpl::GetIfaceVersion()
32 return SH_IFACE_VERSION;
35 int CSourceHookImpl::GetImplVersion()
37 return SH_IMPL_VERSION;
40 bool CSourceHookImpl::IsPluginInUse(Plugin plug)
42 // Iterate through all hook managers which are in this plugin
43 // Iterate through their vfnptrs, ifaces, hooks
44 // If a hook from an other plugin is found, return true
45 // Return false otherwise
46 #define TMP_CHECK_LIST(name) \
47 for (hook_iter = iface_iter->name.begin(); hook_iter != iface_iter->name.end(); ++hook_iter) \
48 if (hook_iter->plug == plug) \
51 for (HookManInfoList::iterator hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end(); ++hmil_iter)
53 if (hmil_iter->plug != plug)
55 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->vfnptrs.begin();
56 vfnptr_iter != hmil_iter->vfnptrs.end(); ++vfnptr_iter)
58 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
59 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
61 std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hook_iter;
62 TMP_CHECK_LIST(hooks_pre);
63 TMP_CHECK_LIST(hooks_post);
71 void CSourceHookImpl::UnloadPlugin(Plugin plug)
73 // 1) Manually remove all hooks by this plugin
74 std::list<RemoveHookInfo> hookstoremove;
75 HookManInfoList::iterator hmil_iter;
77 #define TMP_CHECK_LIST(name, ispost) \
78 for (hook_iter = iface_iter->name.begin(); hook_iter != iface_iter->name.end(); ++hook_iter) \
79 if (hook_iter->plug == plug) \
80 hookstoremove.push_back(RemoveHookInfo(hook_iter->plug, iface_iter->ptr, \
81 hook_iter->thisptr_offs, hmil_iter->func, hook_iter->handler, ispost))
82 for (hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end(); ++hmil_iter)
84 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->vfnptrs.begin();
85 vfnptr_iter != hmil_iter->vfnptrs.end(); ++vfnptr_iter)
87 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
88 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
90 std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hook_iter;
91 TMP_CHECK_LIST(hooks_pre, false);
92 TMP_CHECK_LIST(hooks_post, true);
98 for (std::list<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
101 // 2) Other plugins may use hook managers in this plugin.
102 // Get a list of hook managers that are in this plugin and are used by other plugins
103 // Delete all hook managers that are in this plugin
105 HookManInfoList tmphookmans;
107 for (hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end();
108 erase ? hmil_iter=m_HookMans.erase(hmil_iter) : ++hmil_iter)
110 if (hmil_iter->plug == plug)
112 if (!hmil_iter->vfnptrs.empty())
114 // All hooks by this plugin are already removed
115 // So if there is a vfnptr, it has to be used by an other plugin
116 tmphookmans.push_back(*hmil_iter);
124 // For each hook manager:
125 for (hmil_iter = tmphookmans.begin(); hmil_iter != tmphookmans.end(); ++hmil_iter)
127 // Find a suitable hook manager in an other plugin
128 HookManInfoList::iterator newHookMan = FindHookMan(m_HookMans.begin(), m_HookMans.end(),
129 hmil_iter->proto, hmil_iter->vtbl_offs, hmil_iter->vtbl_idx);
131 // This should _never_ happen.
132 // If there is a hook from an other plugin, the plugin must have provided a hook manager as well.
133 SH_ASSERT(newHookMan != m_HookMans.end(),
134 "Could not find a suitable hook manager in an other plugin!");
136 // AddHook should make sure that every plugin only has _one_ hook manager for _one_ proto/vi/vo
137 SH_ASSERT(newHookMan->plug != plug, "New hook manager from same plugin!");
139 // The first hook manager should be always used - so the new hook manager has to be empty
140 SH_ASSERT(newHookMan->vfnptrs.empty(), "New hook manager not empty!");
142 // Move the vfnptrs from the old hook manager to the new one
143 newHookMan->vfnptrs = hmil_iter->vfnptrs;
145 // Unregister the old one, register the new one
146 hmil_iter->func(HA_Unregister, NULL);
147 newHookMan->func(HA_Register, &(*newHookMan));
149 // zOMG BAIL, here is part of what you wanted:
151 // Go through all vfnptrs in this hookman and patch them to point to the new manager's handler!
153 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = newHookMan->vfnptrs.begin();
154 vfnptr_iter != newHookMan->vfnptrs.end(); ++vfnptr_iter)
156 // And DEREFERENCE newHookMan->hookfunc_vfnptr!
157 // otherwise it will be executing the vtable... had to find out the hard way
158 *reinterpret_cast<void**>(vfnptr_iter->vfnptr) = *reinterpret_cast<void**>(newHookMan->hookfunc_vfnptr);
161 // That should fix it, bail!
165 void CSourceHookImpl::CompleteShutdown()
167 std::list<RemoveHookInfo> hookstoremove;
168 #define TMP_CHECK_LIST(name, ispost) \
169 for (hook_iter = iface_iter->name.begin(); hook_iter != iface_iter->name.end(); ++hook_iter) \
170 hookstoremove.push_back(RemoveHookInfo(hook_iter->plug, iface_iter->ptr, \
171 hook_iter->thisptr_offs, hmil_iter->func, hook_iter->handler, ispost))
172 for (HookManInfoList::iterator hmil_iter = m_HookMans.begin(); hmil_iter != m_HookMans.end(); ++hmil_iter)
174 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hmil_iter->vfnptrs.begin();
175 vfnptr_iter != hmil_iter->vfnptrs.end(); ++vfnptr_iter)
177 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
178 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
180 std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hook_iter;
181 TMP_CHECK_LIST(hooks_pre, false);
182 TMP_CHECK_LIST(hooks_post, true);
186 #undef TMP_CHECK_LIST
188 for (std::list<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
194 bool CSourceHookImpl::AddHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
196 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface) + thisptr_offs);
197 // 1) Get info about the hook manager
199 if (myHookMan(HA_GetInfo, &tmp) != 0)
202 // 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
203 HookManInfoList::iterator hkmi_iter;
204 for (hkmi_iter = m_HookMans.begin(); hkmi_iter != m_HookMans.end(); ++hkmi_iter)
206 if (hkmi_iter->plug == plug && strcmp(hkmi_iter->proto, tmp.proto) == 0 &&
207 hkmi_iter->vtbl_offs == tmp.vtbl_offs && hkmi_iter->vtbl_idx == tmp.vtbl_idx)
210 if (hkmi_iter == m_HookMans.end())
212 // No such hook manager from this plugin yet, add it!
213 tmp.func = myHookMan;
215 m_HookMans.push_back(tmp);
218 // Then, search for a suitable hook manager (from the beginning)
219 HookManInfoList::iterator hookman = FindHookMan(m_HookMans.begin(), m_HookMans.end(), tmp.proto, tmp.vtbl_offs, tmp.vtbl_idx);
220 SH_ASSERT(hookman != m_HookMans.end(), "No hookman found - but if there was none, we've just added one!");
222 // Tell it to store the pointer if it's not already active
223 if (hookman->vfnptrs.empty())
224 hookman->func(HA_Register, &(*hookman));
226 void **cur_vtptr = *reinterpret_cast<void***>(
227 reinterpret_cast<char*>(adjustediface) + tmp.vtbl_offs);
228 void *cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + tmp.vtbl_idx);
230 HookManagerInfo::VfnPtrListIter vfnptr_iter = std::find(
231 hookman->vfnptrs.begin(), hookman->vfnptrs.end(), cur_vfnptr);
233 if (vfnptr_iter == hookman->vfnptrs.end())
236 HookManagerInfo::VfnPtr vfp;
237 vfp.vfnptr = cur_vfnptr;
238 vfp.orig_entry = *reinterpret_cast<void**>(cur_vfnptr);
240 // Alter vtable entry
241 if (!SetMemAccess(cur_vtptr, sizeof(void*) * (tmp.vtbl_idx + 1), SH_MEM_READ | SH_MEM_WRITE))
244 *reinterpret_cast<void**>(cur_vfnptr) = *reinterpret_cast<void**>(hookman->hookfunc_vfnptr);
246 hookman->vfnptrs.push_back(vfp);
248 // Make vfnptr_iter point to the new element
249 vfnptr_iter = hookman->vfnptrs.end();
252 // Now that it is done, check whether we have to update any callclasses
253 ApplyCallClassPatches(adjustediface, tmp.vtbl_offs, tmp.vtbl_idx, vfp.orig_entry);
256 HookManagerInfo::VfnPtr::IfaceListIter iface_iter = std::find(
257 vfnptr_iter->ifaces.begin(), vfnptr_iter->ifaces.end(), adjustediface);
258 if (iface_iter == vfnptr_iter->ifaces.end())
261 HookManagerInfo::VfnPtr::Iface ifs;
262 ifs.ptr = adjustediface;
263 vfnptr_iter->ifaces.push_back(ifs);
265 // Make iface_iter point to the new element
266 iface_iter = vfnptr_iter->ifaces.end();
271 HookManagerInfo::VfnPtr::Iface::Hook hookinfo;
272 hookinfo.handler = handler;
273 hookinfo.plug = plug;
274 hookinfo.paused = false;
275 hookinfo.thisptr_offs = thisptr_offs;
277 iface_iter->hooks_post.push_back(hookinfo);
279 iface_iter->hooks_pre.push_back(hookinfo);
285 bool CSourceHookImpl::RemoveHook(RemoveHookInfo info)
287 return RemoveHook(info.plug, info.iface, info.thisptr_offs, info.hookman, info.handler, info.post);
290 bool CSourceHookImpl::RemoveHook(Plugin plug, void *iface, int thisptr_offs, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
292 void *adjustediface = reinterpret_cast<void*>(reinterpret_cast<char*>(iface)+thisptr_offs);
294 if (myHookMan(HA_GetInfo, &tmp) != 0)
297 // Find the hook manager and the hook
298 HookManInfoList::iterator hookman = FindHookMan(m_HookMans.begin(), m_HookMans.end(),
299 tmp.proto, tmp.vtbl_offs, tmp.vtbl_idx);
300 if (hookman == m_HookMans.end())
303 if (IsBadReadPtr(reinterpret_cast<char*>(adjustediface) + tmp.vtbl_offs, sizeof(char)))
305 hookman->vfnptrs.clear();
306 hookman->func(HA_Unregister, NULL);
310 void **cur_vtptr = *reinterpret_cast<void***>(
311 reinterpret_cast<char*>(adjustediface) + tmp.vtbl_offs);
312 void *cur_vfnptr = reinterpret_cast<void*>(cur_vtptr + tmp.vtbl_idx);
314 HookManagerInfo::VfnPtrListIter vfnptr_iter = std::find(hookman->vfnptrs.begin(), hookman->vfnptrs.end(), cur_vfnptr);
315 if (vfnptr_iter == hookman->vfnptrs.end())
318 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
319 iface_iter != vfnptr_iter->ifaces.end();)
321 std::list<HookManagerInfo::VfnPtr::Iface::Hook> &hooks =
322 post ? iface_iter->hooks_post : iface_iter->hooks_pre;
325 for (std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = hooks.begin();
326 hookiter != hooks.end(); erase ? hookiter = hooks.erase(hookiter) : ++hookiter)
328 erase = hookiter->plug == plug && hookiter->handler->IsEqual(handler) &&
329 hookiter->thisptr_offs == thisptr_offs;
331 hookiter->handler->DeleteThis(); // Make the _plugin_ delete the handler object
333 if (iface_iter->hooks_post.empty() && iface_iter->hooks_pre.empty())
335 iface_iter = vfnptr_iter->ifaces.erase(iface_iter);
336 if (vfnptr_iter->ifaces.empty())
338 // Deactivate the hook
339 *reinterpret_cast<void**>(vfnptr_iter->vfnptr) = vfnptr_iter->orig_entry;
341 hookman->vfnptrs.erase(vfnptr_iter);
343 // Remove callclass patch
344 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
345 if (cciter->cc.ptr == adjustediface)
346 RemoveCallClassPatch(*cciter, tmp.vtbl_offs, tmp.vtbl_idx);
348 if (hookman->vfnptrs.empty())
350 // Unregister the hook manager
351 hookman->func(HA_Unregister, NULL);
354 // Don't try to continue looping through ifaces
355 // - the list is already invalid
365 GenericCallClass *CSourceHookImpl::GetCallClass(void *iface, size_t size)
367 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
369 if (cciter->cc.ptr == iface && cciter->cc.objsize == size)
371 ++cciter->refcounter;
379 tmp.cc.objsize = size;
381 ApplyCallClassPatches(tmp);
383 m_CallClasses.push_back(tmp);
384 return &m_CallClasses.back().cc;
387 void CSourceHookImpl::ReleaseCallClass(GenericCallClass *ptr)
389 Impl_CallClassList::iterator iter = std::find(m_CallClasses.begin(), m_CallClasses.end(), ptr);
390 if (iter == m_CallClasses.end())
393 if (iter->refcounter < 1)
394 m_CallClasses.erase(iter);
397 void CSourceHookImpl::ApplyCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx, void *orig_entry)
399 OrigFuncs &tmpvec = cc.cc.vt[vtbl_offs];
400 if (tmpvec.size() <= (size_t)vtbl_idx)
401 tmpvec.resize(vtbl_idx+1);
402 tmpvec[vtbl_idx] = orig_entry;
405 void CSourceHookImpl::ApplyCallClassPatches(CallClassInfo &cc)
407 for (HookManInfoList::iterator hookman = m_HookMans.begin(); hookman != m_HookMans.end(); ++hookman)
409 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hookman->vfnptrs.begin();
410 vfnptr_iter != hookman->vfnptrs.end(); ++vfnptr_iter)
412 for (HookManagerInfo::VfnPtr::IfaceListIter iface_iter = vfnptr_iter->ifaces.begin();
413 iface_iter != vfnptr_iter->ifaces.end(); ++iface_iter)
415 if (iface_iter->ptr >= cc.cc.ptr &&
416 iface_iter->ptr < (reinterpret_cast<char*>(cc.cc.ptr) + cc.cc.objsize))
418 ApplyCallClassPatch(cc, static_cast<int>(reinterpret_cast<char*>(iface_iter->ptr) -
419 reinterpret_cast<char*>(cc.cc.ptr)) + hookman->vtbl_offs,
420 hookman->vtbl_idx, vfnptr_iter->orig_entry);
427 void CSourceHookImpl::ApplyCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx, void *orig_entry)
429 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
432 if (ifaceptr >= cc_iter->cc.ptr &&
433 ifaceptr < (reinterpret_cast<char*>(cc_iter->cc.ptr) + cc_iter->cc.objsize))
435 ApplyCallClassPatch(*cc_iter, static_cast<int>(reinterpret_cast<char*>(ifaceptr) -
436 reinterpret_cast<char*>(cc_iter->cc.ptr)) + vtbl_offs, vtbl_idx, orig_entry);
441 void CSourceHookImpl::RemoveCallClassPatches(void *ifaceptr, int vtbl_offs, int vtbl_idx)
443 for (Impl_CallClassList::iterator cc_iter = m_CallClasses.begin(); cc_iter != m_CallClasses.end();
446 if (ifaceptr >= cc_iter->cc.ptr &&
447 ifaceptr < (reinterpret_cast<char*>(cc_iter->cc.ptr) + cc_iter->cc.objsize))
449 RemoveCallClassPatch(*cc_iter, vtbl_offs, vtbl_idx);
454 void CSourceHookImpl::RemoveCallClassPatch(CallClassInfo &cc, int vtbl_offs, int vtbl_idx)
456 OrigVTables::iterator iter = cc.cc.vt.find(vtbl_offs);
457 if (iter != cc.cc.vt.end())
459 if (iter->second.size() > (size_t)vtbl_idx)
461 iter->second[vtbl_idx] = 0;
462 // Free some memory if possible
463 OrigFuncs::reverse_iterator riter;
464 for (riter = iter->second.rbegin(); riter != iter->second.rend(); ++riter)
469 iter->second.resize(iter->second.size() - (riter - iter->second.rbegin()));
470 if (!iter->second.size())
471 cc.cc.vt.erase(iter);
476 CSourceHookImpl::HookManInfoList::iterator CSourceHookImpl::FindHookMan(HookManInfoList::iterator begin,
477 HookManInfoList::iterator end, const char *proto, int vtblofs, int vtblidx)
479 HookManInfoList::iterator hookmaniter;
480 for (hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
482 if (strcmp(hookmaniter->proto, proto) == 0 && hookmaniter->vtbl_offs == vtblofs &&
483 hookmaniter->vtbl_idx == vtblidx)
489 void CSourceHookImpl::PausePlugin(Plugin plug)
491 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to paused
492 for (HookManInfoList::iterator hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
493 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hookmaniter->vfnptrs.begin();
494 vfnptr_iter != hookmaniter->vfnptrs.end(); ++vfnptr_iter)
495 for (HookManagerInfo::VfnPtr::IfaceListIter ifaceiter = vfnptr_iter->ifaces.begin();
496 ifaceiter != vfnptr_iter->ifaces.end(); ++ifaceiter)
498 for (std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_pre.begin();
499 hookiter != ifaceiter->hooks_pre.end(); ++hookiter)
500 if (plug == hookiter->plug)
501 hookiter->paused = true;
503 for (std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_post.begin();
504 hookiter != ifaceiter->hooks_post.end(); ++hookiter)
505 if (plug == hookiter->plug)
506 hookiter->paused = true;
510 void CSourceHookImpl::UnpausePlugin(Plugin plug)
512 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to paused
513 for (HookManInfoList::iterator hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
514 for (HookManagerInfo::VfnPtrListIter vfnptr_iter = hookmaniter->vfnptrs.begin();
515 vfnptr_iter != hookmaniter->vfnptrs.end(); ++vfnptr_iter)
516 for (HookManagerInfo::VfnPtr::IfaceListIter ifaceiter = vfnptr_iter->ifaces.begin();
517 ifaceiter != vfnptr_iter->ifaces.end(); ++ifaceiter)
519 for (std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_pre.begin();
520 hookiter != ifaceiter->hooks_pre.end(); ++hookiter)
521 if (plug == hookiter->plug)
522 hookiter->paused = false;
524 for (std::list<HookManagerInfo::VfnPtr::Iface::Hook>::iterator hookiter = ifaceiter->hooks_post.begin();
525 hookiter != ifaceiter->hooks_post.end(); ++hookiter)
526 if (plug == hookiter->plug)
527 hookiter->paused = false;
531 void CSourceHookImpl::SetRes(META_RES res)
536 META_RES CSourceHookImpl::GetPrevRes()
541 META_RES CSourceHookImpl::GetStatus()
546 const void *CSourceHookImpl::GetOrigRet()
551 const void *CSourceHookImpl::GetOverrideRet()
553 return m_OverrideRet;
556 META_RES &CSourceHookImpl::GetCurResRef()
561 META_RES &CSourceHookImpl::GetPrevResRef()
566 META_RES &CSourceHookImpl::GetStatusRef()
571 void * &CSourceHookImpl::GetIfacePtrRef()
576 void CSourceHookImpl::SetOrigRet(const void *ptr)
581 void CSourceHookImpl::SetOverrideRet(const void *ptr)
586 void *CSourceHookImpl::GetIfacePtr()
592 // Windows has an implementation for this already, but Linux does not :(
593 bool IsBadReadPtr(const void *ptr, size_t len)
595 void(*prevHandler)(int sig);
596 g_BadReadCalled = true;
598 if (setjmp(g_BadReadJmpBuf))
601 prevHandler = signal(SIGSEGV, BadReadHandler);
603 volatile const char *p = reinterpret_cast<const char*>(ptr);
606 for (size_t i = 0; i < len; i++)
609 g_BadReadCalled = false;
611 signal(SIGSEGV, prevHandler);
616 void BadReadHandler(int sig)
619 longjmp(g_BadReadJmpBuf, 1);