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 * ============================
12 * @file sourcehook.cpp
13 * @brief Contains the implementation of the SourceHook API
17 #include "sourcehook_impl.h"
19 #if SH_SYS == SH_SYS_WIN32
21 #elif SH_SYS == SH_SYS_LINUX
22 # include <sys/mman.h>
26 # define PAGESIZE 4096
30 #if SH_RUNTIME_CODEGEN == 1
31 # if SH_COMP == SH_COMP_GCC
32 # define SH_CCC_CODESIZE 15
34 //void SH_CCC_MakeGate(void *origthisptr, unsigned char* &ptr, void *origvtable, int i)
37 # elif SH_COMP == SH_COMP_MSVC
38 # define SH_CCC_CODESIZE 19
39 void SH_CCC_MakeGate(void *origthisptr, void *ccthisptr, unsigned char* ptr, void *origfunc)
41 // --Subtract old this pointer to get the offset
42 // 00417EDF 81 E9 A1 7B 33 01 sub ecx,1337BA1h
45 *reinterpret_cast<void**>(ptr) = ccthisptr;
47 // --Add it to the new this pointer
48 // 00417EE5 81 C1 37 13 37 13 add ecx,13371337h
51 *reinterpret_cast<void**>(ptr) = origthisptr;
54 // 00417EEB B8 EF BE AD DE mov eax,0DEADBEEFh
56 *reinterpret_cast<void**>(ptr) = origfunc;
59 // 00417EF0 FF E0 jmp eax
69 CSourceHookImpl::CSourceHookImpl()
72 #if SH_SYS == SH_SYS_WIN32
74 GetSystemInfo(&sysinfo);
75 m_PageSize = sysinfo.dwPageSize;
76 #elif SH_SYS == SH_SYS_LINUX
77 m_PageSize = PAGESIZE;
79 # error Unsupported system
83 CSourceHookImpl::~CSourceHookImpl()
88 bool CSourceHookImpl::IsPluginInUse(Plugin plug)
90 // Iterate through all hook managers which are in this plugin
91 // Iterate through their hooks
92 // If a hook from an other plugin is found, return true
93 // Return false otherwise
94 #define TMP_CHECK_LIST(name) \
95 for (iter3 = iter2->name.begin(); iter3 != iter2->name.end(); ++iter3) \
96 if (iter3->plug == plug) \
99 for (HookManInfoList::iterator iter = m_HookMans.begin(); iter != m_HookMans.end(); ++iter)
101 if (iter->plug == plug && !iter->ifaces.empty())
103 for (std::list<HookManagerInfo::Iface>::iterator iter2 = iter->ifaces.begin(); iter2 != iter->ifaces.end(); ++iter2)
105 std::list<HookManagerInfo::Iface::Hook>::iterator iter3;
106 TMP_CHECK_LIST(hooks_pre);
107 TMP_CHECK_LIST(hooks_post);
111 #undef TMP_CHECK_LIST
115 void CSourceHookImpl::UnloadPlugin(Plugin plug)
117 // 1) Manually remove all hooks by this plugin
118 std::list<RemoveHookInfo> hookstoremove;
120 for (HookManInfoList::iterator iter = m_HookMans.begin(); iter != m_HookMans.end(); ++iter)
122 for (std::list<HookManagerInfo::Iface>::iterator iter2 = iter->ifaces.begin(); iter2 != iter->ifaces.end();
125 for (std::list<HookManagerInfo::Iface::Hook>::iterator iter3 = iter2->hooks_pre.begin(); iter3 != iter2->hooks_pre.end(); ++iter3)
126 if (iter3->plug == plug)
127 hookstoremove.push_back(RemoveHookInfo(iter3->plug, iter2->ptr, iter->func, iter3->handler, false));
129 for (std::list<HookManagerInfo::Iface::Hook>::iterator iter3 = iter2->hooks_post.begin(); iter3 != iter2->hooks_post.end(); ++iter3)
130 if (iter3->plug == plug)
131 hookstoremove.push_back(RemoveHookInfo(iter3->plug, iter2->ptr, iter->func, iter3->handler, true));
135 for (std::list<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
136 RemoveHook(rmiter->plug, rmiter->iface, rmiter->hpf, rmiter->handler, rmiter->post);
138 // 2) Other plugins may use hook managers in this plugin.
139 // Get a list of hook managers that are in this plugin and are used by other plugins
140 // Delete all hook managers that are in this plugin
142 HookManInfoList tmphookmans;
144 for (HookManInfoList::iterator iter = m_HookMans.begin(); iter != m_HookMans.end();
145 erase ? iter=m_HookMans.erase(iter) : ++iter)
147 if (iter->plug == plug)
149 if (!iter->ifaces.empty())
151 // All hooks by this plugin are already removed
152 // So if there is an iface, it has to be used by an other plugin
153 tmphookmans.push_back(*iter);
161 // For each hook manager:
162 for (HookManInfoList::iterator iter = tmphookmans.begin(); iter != tmphookmans.end(); ++iter)
164 // Find a suitable hook manager in an other plugin
165 HookManInfoList::iterator newHookMan = FindHookMan(m_HookMans.begin(), m_HookMans.end(),
166 iter->proto, iter->vtbl_offs, iter->vtbl_idx, iter->thisptr_offs);
167 if (newHookMan == m_HookMans.end())
169 // This should _never_ happen.
170 // If there is a hook from an other plugin, the plugin must have provided a hook manager as well.
174 // AddHook should make sure that every plugin only has _one_ hook manager for _one_ proto/vi/vo/thisptroffs
175 SH_ASSERT(newHookMan->plug != plug);
177 // The first hooker should be always used - so the new hook manager has to be empty
178 SH_ASSERT(newHookMan->ifaces.empty());
180 // Move the ifaces from the old hook manager to the new one
181 newHookMan->ifaces = iter->ifaces;
183 // Unregister the old one, register the new one
184 iter->func(HA_Unregister, NULL);
185 newHookMan->func(HA_Register, &(*newHookMan));
189 void CSourceHookImpl::CompleteShutdown()
191 std::list<RemoveHookInfo> hookstoremove;
193 for (HookManInfoList::iterator iter = m_HookMans.begin(); iter != m_HookMans.end(); ++iter)
195 for (std::list<HookManagerInfo::Iface>::iterator iter2 = iter->ifaces.begin(); iter2 != iter->ifaces.end();
198 for (std::list<HookManagerInfo::Iface::Hook>::iterator iter3 = iter2->hooks_pre.begin(); iter3 != iter2->hooks_pre.end(); ++iter3)
199 hookstoremove.push_back(RemoveHookInfo(iter3->plug, iter2->ptr, iter->func, iter3->handler, false));
201 for (std::list<HookManagerInfo::Iface::Hook>::iterator iter3 = iter2->hooks_post.begin(); iter3 != iter2->hooks_post.end(); ++iter3)
202 hookstoremove.push_back(RemoveHookInfo(iter3->plug, iter2->ptr, iter->func, iter3->handler, true));
206 for (std::list<RemoveHookInfo>::iterator rmiter = hookstoremove.begin(); rmiter != hookstoremove.end(); ++rmiter)
207 RemoveHook(rmiter->plug, rmiter->iface, rmiter->hpf, rmiter->handler, rmiter->post);
212 bool CSourceHookImpl::AddHook(Plugin plug, void *iface, int ifacesize, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
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 hookmaniter;
221 for (hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
223 if (hookmaniter->plug == plug && strcmp(hookmaniter->proto, tmp.proto) == 0 &&
224 hookmaniter->vtbl_offs == tmp.vtbl_offs && hookmaniter->vtbl_idx == tmp.vtbl_idx &&
225 hookmaniter->thisptr_offs == tmp.thisptr_offs)
228 if (hookmaniter == m_HookMans.end())
230 // No such hook manager from this plugin yet, add it!
231 tmp.func = myHookMan;
233 m_HookMans.push_back(tmp);
236 // Then, search for a suitable hook manager (from the beginning)
237 HookManInfoList::iterator hookman = FindHookMan(m_HookMans.begin(), m_HookMans.end(), tmp.proto, tmp.vtbl_offs, tmp.vtbl_idx, tmp.thisptr_offs);
238 SH_ASSERT(hookman != m_HookMans.end());
240 // Tell it to store the pointer if it's not already active
241 if (hookman->ifaces.empty())
242 hookman->func(HA_Register, &(*hookman));
244 std::list<HookManagerInfo::Iface>::iterator ifsiter = std::find(hookman->ifaces.begin(), hookman->ifaces.end(), iface);
246 if (ifsiter == hookman->ifaces.end())
248 HookManagerInfo::Iface ifs;
250 ifs.callclass = GetCallClass(iface, ifacesize);
251 void *vtableptr = *reinterpret_cast<void**>(reinterpret_cast<char*>(iface) + hookman->vtbl_offs);
252 SetMemAccess(vtableptr, sizeof(void*) * hookman->vtbl_idx, SH_MEM_READ | SH_MEM_WRITE);
253 ifs.orig_entry = (*reinterpret_cast<void***>(reinterpret_cast<char*>(iface) + hookman->vtbl_offs))[hookman->vtbl_idx];
254 (*reinterpret_cast<void***>(reinterpret_cast<char*>(iface) + hookman->vtbl_offs))[hookman->vtbl_idx] =
255 (*reinterpret_cast<void***>(reinterpret_cast<char*>(hookman->hookfunc_inst) + hookman->hookfunc_vtbl_offs))[hookman->hookfunc_vtbl_idx];
256 hookman->ifaces.push_back(ifs);
257 ifsiter = hookman->ifaces.end();
260 HookManagerInfo::Iface::Hook hookinfo;
261 hookinfo.handler = handler;
262 hookinfo.plug = plug;
263 hookinfo.paused = false;
265 ifsiter->hooks_post.push_back(hookinfo);
267 ifsiter->hooks_pre.push_back(hookinfo);
270 // Now that it is done, check whether we have to update any callclasses
271 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
273 if (cciter->iface == iface)
275 ApplyCallClassPatch(*cciter, tmp.vtbl_offs, tmp.vtbl_idx, ifsiter->orig_entry);
277 // We can assume that there is no more callclass with the same iface
285 bool CSourceHookImpl::RemoveHook(Plugin plug, void *iface, HookManagerPubFunc myHookMan, ISHDelegate *handler, bool post)
288 if (myHookMan(HA_GetInfo, &tmp) != 0)
291 // Find the hook manager and the hook
292 HookManInfoList::iterator hookman = FindHookMan(m_HookMans.begin(), m_HookMans.end(),
293 tmp.proto, tmp.vtbl_offs, tmp.vtbl_idx, tmp.thisptr_offs);
294 if (hookman == m_HookMans.end())
297 for (std::list<HookManagerInfo::Iface>::iterator ifaceiter = hookman->ifaces.begin(); ifaceiter != hookman->ifaces.end(); ++ifaceiter)
299 if (ifaceiter->ptr == iface)
301 std::list<HookManagerInfo::Iface::Hook> &hooks = post ? ifaceiter->hooks_post : ifaceiter->hooks_pre;
303 for (std::list<HookManagerInfo::Iface::Hook>::iterator hookiter = hooks.begin();
304 hookiter != hooks.end(); erase ? hookiter = hooks.erase(hookiter) : ++hookiter)
306 erase = hookiter->plug == plug && hookiter->handler->IsEqual(handler);
308 hookiter->handler->DeleteThis(); // Make the _plugin_ delete the handler object
310 if (ifaceiter->hooks_post.empty() && ifaceiter->hooks_pre.empty())
312 // Deactivate the hook
313 (*reinterpret_cast<void***>(reinterpret_cast<char*>(ifaceiter->ptr) +
314 hookman->vtbl_offs))[hookman->vtbl_idx]= ifaceiter->orig_entry;
316 // Release the callclass
317 ReleaseCallClass(ifaceiter->callclass);
319 // Remove the iface info
320 hookman->ifaces.erase(ifaceiter);
322 if (hookman->ifaces.empty())
323 hookman->func(HA_Unregister, NULL);
325 // :TODO: Better return value? Or none?
332 void *CSourceHookImpl::GetCallClass(void *iface, size_t size)
334 for (Impl_CallClassList::iterator cciter = m_CallClasses.begin(); cciter != m_CallClasses.end(); ++cciter)
336 if (cciter->iface == iface)
338 ++cciter->refcounter;
343 // The layout of callclasses is:
344 // Copy of the class; vtable entries pointing to gates
345 // Pointer to the corresponding CallClass object
346 // Copy of the class; vtable entries pointing to original functions
349 char *ptr = new char[size * 2 + sizeof(void*)];
350 tmp.ptr = reinterpret_cast<void*>(ptr);
351 memcpy(reinterpret_cast<void*>(ptr), iface, size);
352 memcpy(reinterpret_cast<void*>(ptr + size + sizeof(void*)), iface, size);
357 // Go through _all_ hooks and apply any needed patches
358 for (HookManInfoList::iterator hookman = m_HookMans.begin(); hookman != m_HookMans.end(); ++hookman)
360 for (std::list<HookManagerInfo::Iface>::iterator ifaceiter = hookman->ifaces.begin(); ifaceiter != hookman->ifaces.end(); ++ifaceiter)
362 if (ifaceiter->ptr == iface)
364 if (!ApplyCallClassPatch(tmp, hookman->vtbl_offs, hookman->vtbl_idx, ifaceiter->orig_entry))
372 m_CallClasses.push_back(tmp);
373 // The object has to be followed by the pointer to the vtable info object
374 *reinterpret_cast<void**>(ptr + size) = &m_CallClasses.back();
378 void CSourceHookImpl::ReleaseCallClass(void *ptr)
380 Impl_CallClassList::iterator iter = std::find(m_CallClasses.begin(), m_CallClasses.end(), ptr);
381 if (iter == m_CallClasses.end())
384 if (iter->refcounter < 1)
386 FreeCallClass(*iter);
387 m_CallClasses.erase(iter);
391 void CSourceHookImpl::FreeCallClass(CallClass &cc)
393 for (CallClass::VTableList::iterator vtbliter = cc.vtables.begin(); vtbliter != cc.vtables.end(); ++vtbliter)
395 #if SH_RUNTIME_CODEGEN == 1
396 // Delete generated callgates
397 for (std::list<int>::iterator cgiter = vtbliter->patches.begin(); cgiter != vtbliter->patches.end(); ++cgiter)
399 char *cgptr = reinterpret_cast<char**>(vtbliter->ptr)[*cgiter];
403 delete [] reinterpret_cast<char*>(vtbliter->ptr);
405 delete [] reinterpret_cast<char*>(cc.ptr);
408 bool CSourceHookImpl::ApplyCallClassPatch(CallClass &cc, int vtbl_offs, int vtbl_idx, void *orig_entry)
410 char *ptr = reinterpret_cast<char*>(cc.ptr);
411 void *vtable = *reinterpret_cast<void**>(ptr + vtbl_offs);
413 // Check whether we already know that vtable
414 CallClass::VTableList::iterator vtbliter = std::find(cc.vtables.begin(),
415 cc.vtables.end(), reinterpret_cast<void*>(vtable));
416 int actvtablesize=MAX_VTABLE_LEN;
417 if (vtbliter == cc.vtables.end())
419 CallClass::VTable newvtableinfo;
420 int pagesnum = (MAX_VTABLE_LEN % m_PageSize == 0) ? MAX_VTABLE_LEN / m_PageSize : MAX_VTABLE_LEN / m_PageSize + 1;
421 // Set all pages in the range to readwrite
423 char *pagebegin = reinterpret_cast<char*>(vtable) - (reinterpret_cast<int>(vtable) % m_PageSize);
424 for (int ipage = 0; ipage < pagesnum; ++ipage)
426 if (!SetMemAccess(reinterpret_cast<void*>(pagebegin + ipage * m_PageSize), 1,
427 SH_MEM_READ | SH_MEM_WRITE))
429 // We can't go here anymore
430 actvtablesize = static_cast<int>((pagebegin + ipage * m_PageSize) - reinterpret_cast<char*>(vtable));
434 if (actvtablesize < 1)
436 // We can't access the vtable -> Quit
439 // Create a new vtable
440 newvtableinfo.ptr = reinterpret_cast<void*>(new char[actvtablesize]);
441 // Fill it with the information from the old vtable
442 memcpy(newvtableinfo.ptr, vtable, actvtablesize);
443 newvtableinfo.actsize = actvtablesize;
444 // Set the pointer in the object and add it to the list of already known vtables
445 *reinterpret_cast<void**>(ptr + vtbl_offs) = newvtableinfo.ptr;
446 cc.vtables.push_back(newvtableinfo);
448 vtbliter = cc.vtables.end();
450 // :TODO: When not codegen, patch the other vtable?
453 // Check whether we already have this patch
454 if (std::find(vtbliter->patches.begin(), vtbliter->patches.end(), vtbl_idx) == vtbliter->patches.end())
459 void *callgate = NULL;
460 #if SH_RUNTIME_CODEGEN == 1
461 unsigned char *cggen = new unsigned char[SH_CCC_CODESIZE];
462 //SH_CCC_MakeGate(cc.iface, cc.ptr, cggen, orig_entry);
463 callgate = (void*)cggen;
464 SetMemAccess(callgate, SH_CCC_CODESIZE, SH_MEM_READ | SH_MEM_WRITE | SH_MEM_EXEC);
467 #error Not supported yet!
469 vtbliter->patches.push_back(vtbl_idx);
470 reinterpret_cast<void**>(vtbliter->ptr)[vtbl_idx] = callgate;
476 CSourceHookImpl::HookManInfoList::iterator CSourceHookImpl::FindHookMan(HookManInfoList::iterator begin,
477 HookManInfoList::iterator end, const char *proto, int vtblofs, int vtblidx, int thisptrofs)
479 for (HookManInfoList::iterator hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
481 if (strcmp(hookmaniter->proto, proto) == 0 && hookmaniter->vtbl_offs == vtblofs && hookmaniter->vtbl_idx == vtblidx &&
482 hookmaniter->thisptr_offs == thisptrofs)
488 void CSourceHookImpl::PausePlugin(Plugin plug)
490 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to paused
491 for (HookManInfoList::iterator hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
492 for (std::list<HookManagerInfo::Iface>::iterator ifaceiter = hookmaniter->ifaces.begin();
493 ifaceiter != hookmaniter->ifaces.end(); ++ifaceiter)
495 for (std::list<HookManagerInfo::Iface::Hook>::iterator hookiter = ifaceiter->hooks_pre.begin();
496 hookiter != ifaceiter->hooks_pre.end(); ++hookiter)
497 if (plug == hookiter->plug)
498 hookiter->paused = true;
500 for (std::list<HookManagerInfo::Iface::Hook>::iterator hookiter = ifaceiter->hooks_post.begin();
501 hookiter != ifaceiter->hooks_post.end(); ++hookiter)
502 if (plug == hookiter->plug)
503 hookiter->paused = true;
507 void CSourceHookImpl::UnpausePlugin(Plugin plug)
509 // Go through all hook managers, all interfaces, and set the status of all hooks of this plugin to normal
510 for (HookManInfoList::iterator hookmaniter = m_HookMans.begin(); hookmaniter != m_HookMans.end(); ++hookmaniter)
511 for (std::list<HookManagerInfo::Iface>::iterator ifaceiter = hookmaniter->ifaces.begin();
512 ifaceiter != hookmaniter->ifaces.end(); ++ifaceiter)
514 for (std::list<HookManagerInfo::Iface::Hook>::iterator hookiter = ifaceiter->hooks_pre.begin();
515 hookiter != ifaceiter->hooks_pre.end(); ++hookiter)
516 if (plug == hookiter->plug)
517 hookiter->paused = false;
519 for (std::list<HookManagerInfo::Iface::Hook>::iterator hookiter = ifaceiter->hooks_post.begin();
520 hookiter != ifaceiter->hooks_post.end(); ++hookiter)
521 if (plug == hookiter->plug)
522 hookiter->paused = false;
526 void CSourceHookImpl::SetRes(META_RES res)
531 META_RES CSourceHookImpl::GetPrevRes()
536 META_RES CSourceHookImpl::GetStatus()
541 const void *CSourceHookImpl::GetOrigRet()
546 const void *CSourceHookImpl::GetOverrideRet()
548 return m_OverrideRet;
551 META_RES &CSourceHookImpl::GetCurResRef()
556 META_RES &CSourceHookImpl::GetPrevResRef()
561 META_RES &CSourceHookImpl::GetStatusRef()
566 void CSourceHookImpl::SetOrigRet(const void *ptr)
571 void CSourceHookImpl::SetOverrideRet(const void *ptr)
576 void CSourceHookImpl::SetIfacePtr(void *ptr)
580 void *CSourceHookImpl::GetIfacePtr()