Big critical hits cleanup. Cleaner, easier to maintain, uses less memory and should be much less likely to cause crashes when valve change things on me.

--HG--
extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%402317
This commit is contained in:
Matt Woodrow
2008-07-01 09:04:00 +00:00
parent b01dd0798c
commit d530d0c726
12 changed files with 1013 additions and 486 deletions
+98
View File
@@ -0,0 +1,98 @@
/**
* vim: set ts=4 :
* =============================================================================
* SourceMod SDKTools Extension
* Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved.
* =============================================================================
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 3.0, as published by the
* Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License along with
* this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, AlliedModders LLC gives you permission to link the
* code of this program (as well as its derivative works) to "Half-Life 2," the
* "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
* by the Valve Corporation. You must obey the GNU General Public License in
* all respects for all other code used. Additionally, AlliedModders LLC grants
* this exception to all derivative works. AlliedModders LLC defines further
* exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
* or <http://www.sourcemod.net/license.php>.
*
* Version: $Id$
*/
#ifndef _INCLUDE_SOURCEMOD_DETOURHELPERS_H_
#define _INCLUDE_SOURCEMOD_DETOURHELPERS_H_
#if defined PLATFORM_LINUX
#include <sys/mman.h>
#define PAGE_SIZE 4096
#define ALIGN(ar) ((long)ar & ~(PAGE_SIZE-1))
#define PAGE_EXECUTE_READWRITE PROT_READ|PROT_WRITE|PROT_EXEC
#endif
struct patch_t
{
patch_t()
{
patch[0] = 0;
bytes = 0;
}
unsigned char patch[20];
size_t bytes;
};
inline void ProtectMemory(void *addr, int length, int prot)
{
#if defined PLATFORM_LINUX
void *addr2 = (void *)ALIGN(addr);
mprotect(addr2, sysconf(_SC_PAGESIZE), prot);
#elif defined PLATFORM_WINDOWS
DWORD old_prot;
VirtualProtect(addr, length, prot, &old_prot);
#endif
}
inline void SetMemPatchable(void *address, size_t size)
{
ProtectMemory(address, (int)size, PAGE_EXECUTE_READWRITE);
}
inline void DoGatePatch(unsigned char *target, void *callback)
{
SetMemPatchable(target, 20);
target[0] = 0xFF; /* JMP */
target[1] = 0x25; /* MEM32 */
*(void **)(&target[2]) = callback;
}
inline void ApplyPatch(void *address, int offset, const patch_t *patch, patch_t *restore)
{
ProtectMemory(address, 20, PAGE_EXECUTE_READWRITE);
unsigned char *addr = (unsigned char *)address + offset;
if (restore)
{
for (size_t i=0; i<patch->bytes; i++)
{
restore->patch[i] = addr[i];
}
restore->bytes = patch->bytes;
}
for (size_t i=0; i<patch->bytes; i++)
{
addr[i] = patch->patch[i];
}
}
#endif //_INCLUDE_SOURCEMOD_DETOURHELPERS_H_
+341
View File
@@ -0,0 +1,341 @@
#include "detours.h"
#include <asm/asm.h>
ISourcePawnEngine *CDetourManager::spengine = NULL;
IGameConfig *CDetourManager::gameconf = NULL;
int CDetourManager::returnValue = 0;
void CDetourManager::Init(ISourcePawnEngine *spengine, IGameConfig *gameconf)
{
CDetourManager::spengine = spengine;
CDetourManager::gameconf = gameconf;
}
CDetour *CDetourManager::CreateDetour(void *callbackfunction, size_t paramsize, const char *signame)
{
CDetour *detour = new CDetour(callbackfunction, paramsize, signame);
if (detour)
{
if (!detour->Init(spengine, gameconf))
{
delete detour;
return NULL;
}
return detour;
}
return NULL;
}
void CDetourManager::DeleteDetour(CDetour *detour)
{
delete detour;
}
CBlocker * CDetourManager::CreateFunctionBlock( const char *signame, bool isVoid )
{
CBlocker *block = new CBlocker(signame, isVoid);
if (block)
{
if (!block->Init(spengine, gameconf))
{
delete block;
return NULL;
}
return block;
}
return NULL;
}
void CDetourManager::DeleteFunctionBlock(CBlocker *block)
{
delete block;
}
CDetour::CDetour(void *callbackfunction, size_t paramsize, const char *signame)
{
enabled = false;
detoured = false;
detour_address = NULL;
detour_callback = NULL;
this->signame = signame;
this->callbackfunction = callbackfunction;
spengine = NULL;
gameconf = NULL;
this->paramsize = paramsize;
}
CDetour::~CDetour()
{
DeleteDetour();
}
bool CDetour::Init(ISourcePawnEngine *spengine, IGameConfig *gameconf)
{
this->spengine = spengine;
this->gameconf = gameconf;
if (!CreateDetour())
{
enabled = false;
return enabled;
}
enabled = true;
return enabled;
}
bool CDetour::IsEnabled()
{
return enabled;
}
bool CDetour::CreateDetour()
{
if (!gameconf->GetMemSig(signame, &detour_address))
{
g_pSM->LogError(myself, "Could not locate %s - Disabling detour", signame);
return false;
}
if (!detour_address)
{
g_pSM->LogError(myself, "Sigscan for %s failed - Disabling detour", signame);
return false;
}
detour_restore.bytes = copy_bytes((unsigned char *)detour_address, NULL, OP_JMP_SIZE);
/* First, save restore bits */
for (size_t i=0; i<detour_restore.bytes; i++)
{
detour_restore.patch[i] = ((unsigned char *)detour_address)[i];
}
//detour_callback = spengine->ExecAlloc(100);
JitWriter wr;
JitWriter *jit = &wr;
jit_uint32_t CodeSize = 0;
wr.outbase = NULL;
wr.outptr = NULL;
jit_rewind:
/* Push all our params onto the stack */
for (size_t i=0; i<paramsize; i++)
{
#if defined PLATFORM_WINDOWS
IA32_Push_Rm_Disp8_ESP(jit, (paramsize*4));
#elif defined PLATFORM_LINUX
IA32_Push_Rm_Disp8_ESP(jit, 4 +(paramsize*4));
#endif
}
/* Push thisptr onto the stack */
#if defined PLATFORM_WINDOWS
IA32_Push_Reg(jit, REG_ECX);
#elif defined PLATFORM_LINUX
IA32_Push_Rm_Disp8_ESP(jit, 4 + (paramsize*4));
#endif
jitoffs_t call = IA32_Call_Imm32(jit, 0);
IA32_Write_Jump32_Abs(jit, call, callbackfunction);
/* Pop thisptr */
#if defined PLATFORM_LINUX
IA32_Add_Rm_Imm8(jit, REG_ESP, 4, MOD_REG); //add esp, 4
#elif defined PLATFORM_WINDOWS
IA32_Pop_Reg(jit, REG_ECX);
#endif
/* Pop params from the stack */
for (size_t i=0; i<paramsize; i++)
{
IA32_Add_Rm_Imm8(jit, REG_ESP, 4, MOD_REG);
}
//If TempDetour returns non-zero we want to load something into eax and return this value
//test eax, eax
IA32_Test_Rm_Reg(jit, REG_EAX, REG_EAX, MOD_REG);
//jnz _skip
jitoffs_t jmp = IA32_Jump_Cond_Imm8(jit, CC_NZ, 0);
/* Patch old bytes in */
if (wr.outbase != NULL)
{
copy_bytes((unsigned char *)detour_address, (unsigned char*)wr.outptr, detour_restore.bytes);
}
wr.outptr += detour_restore.bytes;
/* Return to the original function */
call = IA32_Jump_Imm32(jit, 0);
IA32_Write_Jump32_Abs(jit, call, (unsigned char *)detour_address + detour_restore.bytes);
//_skip:
//mov eax, [g_returnvalue]
//ret
IA32_Send_Jump8_Here(jit, jmp);
IA32_Mov_Eax_Mem(jit, (jit_int32_t)&CDetourManager::returnValue);
IA32_Return(jit);
if (wr.outbase == NULL)
{
CodeSize = wr.get_outputpos();
wr.outbase = (jitcode_t)spengine->AllocatePageMemory(CodeSize);
spengine->SetReadWrite(wr.outbase);
wr.outptr = wr.outbase;
detour_callback = wr.outbase;
goto jit_rewind;
}
spengine->SetReadExecute(wr.outbase);
return true;
}
void CDetour::EnableDetour()
{
if (!detoured)
{
DoGatePatch((unsigned char *)detour_address, &detour_callback);
detoured = true;
}
}
void CDetour::DeleteDetour()
{
if (detoured)
{
DisableDetour();
}
if (detour_callback)
{
/* Free the gate */
spengine->ExecFree(detour_callback);
detour_callback = NULL;
}
}
void CDetour::DisableDetour()
{
if (detoured)
{
/* Remove the patch */
/* This may screw up */
ApplyPatch(detour_address, 0, &detour_restore, NULL);
detoured = false;
}
}
CBlocker::CBlocker( const char *signame, bool isVoid )
{
this->isVoid = isVoid;
isEnabled = false;
isValid = false;
spengine = NULL;
gameconf = NULL;
block_address = NULL;
block_sig = signame;
if (isVoid)
{
/* Void functions we only patch in a 'ret' (1 byte) */
block_restore.bytes = 1;
}
else
{
/* Normal functions need an mov eax, value */
block_restore.bytes = 6;
}
}
void CBlocker::EnableBlock( int returnValue )
{
if (!isValid || isEnabled)
{
return;
}
/* First, save restore bits */
for (size_t i=0; i<block_restore.bytes; i++)
{
block_restore.patch[i] = ((unsigned char *)block_address)[i];
}
JitWriter wr;
JitWriter *jit = &wr;
wr.outbase = (jitcode_t)block_address;
wr.outptr = wr.outbase;
if (isVoid)
{
IA32_Return(jit);
}
else
{
IA32_Mov_Reg_Imm32(jit, REG_EAX, returnValue);
IA32_Return(jit);
}
isEnabled = true;
}
void CBlocker::DisableBlock()
{
if (!isValid || !isEnabled)
{
return;
}
/* First, save restore bits */
for (size_t i=0; i<block_restore.bytes; i++)
{
((unsigned char *)block_address)[i] = block_restore.patch[i];
}
isEnabled = false;
}
CBlocker::~CBlocker()
{
if (!isValid || !isEnabled)
{
return;
}
DisableBlock();
}
bool CBlocker::Init( ISourcePawnEngine *spengine, IGameConfig *gameconf )
{
this->spengine = spengine;
this->gameconf = gameconf;
if (!gameconf->GetMemSig(block_sig, &block_address))
{
g_pSM->LogError(myself, "Could not locate %s - Disabling blocker", block_sig);
isValid = false;
return false;
}
if (!block_address)
{
g_pSM->LogError(myself, "Sigscan for %s failed - Disabling blocker", block_sig);
isValid = false;
return false;
}
isValid = true;
return true;
}
+166
View File
@@ -0,0 +1,166 @@
#ifndef _INCLUDE_SOURCEMOD_DETOURS_H_
#define _INCLUDE_SOURCEMOD_DETOURS_H_
#include "extension.h"
#include <jit/jit_helpers.h>
#include <jit/x86/x86_macros.h>
#include "detourhelpers.h"
/**
* CDetours class for SourceMod Extensions by pRED*
* detourhelpers.h entirely stolen from CSS:DM and were written by BAILOPAN (I assume).
* asm.h/c from devmaster.net (thanks cybermind)
*/
class CDetourManager;
class CDetour
{
public:
bool IsEnabled();
/**
* These would be somewhat self-explanatory I hope
*/
void EnableDetour();
void DisableDetour();
friend class CDetourManager;
protected:
CDetour(void *callbackfunction, size_t paramsize, const char *signame);
~CDetour();
bool Init(ISourcePawnEngine *spengine, IGameConfig *gameconf);
private:
/* These create/delete the allocated memory */
bool CreateDetour();
void DeleteDetour();
bool enabled;
bool detoured;
patch_t detour_restore;
void *detour_address;
void *detour_callback;
const char *signame;
void *callbackfunction;
size_t paramsize;
ISourcePawnEngine *spengine;
IGameConfig *gameconf;
};
class CBlocker
{
public:
void EnableBlock(int returnValue = 0);
void DisableBlock();
friend class CDetourManager;
protected:
CBlocker(const char *signame, bool isVoid);
~CBlocker();
bool Init(ISourcePawnEngine *spengine, IGameConfig *gameconf);
private:
bool isValid;
bool isEnabled;
bool isVoid;
patch_t block_restore;
void *block_address;
const char *block_sig;
ISourcePawnEngine *spengine;
IGameConfig *gameconf;
};
class CDetourManager
{
public:
/**
* Return Types for Detours
*/
enum DetourReturn
{
DetourReturn_Ignored = 0, /** Ignore our result and let the original function run */
DetourReturn_Override = 1, /** Block the original function from running and use our return value */
};
static void Init(ISourcePawnEngine *spengine, IGameConfig *gameconf);
/**
* Creates a new detour
* @param callbackfunction Void pointer to your detour callback function. This should be a static function.
* It should have pointer to the thisptr as the first param and then the same params
* as the original function. Use void * for unknown types.
* @param paramsize This is usually the number of params the function has (not including thisptr). If the function
* passes complex types by value you need to add the sizeof() the type (aligned to 4 bytes).
* Ie: passing something of size 8 would count as 2 in the param count.
* @param signame Section name containing a signature to fetch from the gamedata file.
* @return A new CDetour pointer to control your detour.
*
* Example:
*
* CBaseServer::ConnectClient(netadr_s &, int, int, int, char const*, char const*, char const*, int)
*
* Callback:
* DetourReturn ConnectClientDetour(void *CBaseServer, void *netaddr_s, int something, int something2, int something3, char const* name, char const* pass, const char* steamcert, int len);
*
* Creation:
* CDetourManager::CreateDetour((void *)&ConnectClientDetour, 8, "ConnectClient");
*/
static CDetour *CreateDetour(void *callbackfunction, size_t paramsize, const char *signame);
/**
* Deletes a detour
*/
static void DeleteDetour(CDetour *detour);
/**
* Creates a function blocker. This is slightly faster than a detour because it avoids a call.
*
* @param signame Section name containing a signature to fetch from the gamedata file.
* @param isVoid Specifies if the function can return void.
*/
static CBlocker *CreateFunctionBlock(const char *signame, bool isVoid);
/**
* Delete a function blocker.
*/
static void DeleteFunctionBlock(CBlocker *block);
/**
* Global DetourReturn value to use for the current hook
*/
static int returnValue;
friend class CBlocker;
friend class CDetour;
private:
static ISourcePawnEngine *spengine;
static IGameConfig *gameconf;
};
typedef bool DetourReturn;
#define DETOUR_RESULT_IGNORED false
#define DETOUR_RESULT_OVERRIDE true
#define SET_DETOUR_RETURN_VALUE(value) CDetourManager::returnValue=(int)value
#define RETURN_DETOUR(result) return result
#define RETURN_DETOUR_VALUE(result,value) do { SET_DETOUR_RETURN_VALUE(value); return (result); } while(0)
#endif // _INCLUDE_SOURCEMOD_DETOURS_H_