Fleshed out forward system and extensively documented its design considerations
Implemented and did basic tests on new IPluginFunction type Split function types into a separate file --HG-- extra : convert_revision : svn%3A39bc706e-5318-0410-9160-8a85361fbb7c/trunk%40182
This commit is contained in:
David Anderson
@@ -0,0 +1,272 @@
|
||||
#include <stdio.h>
|
||||
#include "PluginSys.h"
|
||||
|
||||
/********************
|
||||
* FUNCTION CALLING *
|
||||
********************/
|
||||
|
||||
void CFunction::Set(funcid_t funcid, CPlugin *plugin)
|
||||
{
|
||||
m_funcid = funcid;
|
||||
m_pPlugin = plugin;
|
||||
m_curparam = 0;
|
||||
m_errorstate = SP_ERROR_NONE;
|
||||
}
|
||||
|
||||
int CFunction::CallFunction(const cell_t *params, unsigned int num_params, cell_t *result)
|
||||
{
|
||||
IPluginContext *ctx = m_pPlugin->m_ctx_current.base;
|
||||
|
||||
while (num_params--)
|
||||
{
|
||||
ctx->PushCell(params[num_params]);
|
||||
}
|
||||
|
||||
return ctx->Execute(m_funcid, result);
|
||||
}
|
||||
|
||||
IPlugin *CFunction::GetParentPlugin()
|
||||
{
|
||||
return m_pPlugin;
|
||||
}
|
||||
|
||||
CFunction::CFunction(funcid_t funcid, CPlugin *plugin) :
|
||||
m_funcid(funcid), m_pPlugin(plugin), m_curparam(0),
|
||||
m_errorstate(SP_ERROR_NONE)
|
||||
{
|
||||
}
|
||||
|
||||
int CFunction::PushCell(cell_t cell)
|
||||
{
|
||||
if (m_curparam >= SP_MAX_EXEC_PARAMS)
|
||||
{
|
||||
return SetError(SP_ERROR_PARAMS_MAX);
|
||||
}
|
||||
|
||||
m_info[m_curparam].marked = false;
|
||||
m_params[m_curparam] = cell;
|
||||
m_curparam++;
|
||||
|
||||
return SP_ERROR_NONE;
|
||||
}
|
||||
|
||||
int CFunction::PushCellByRef(cell_t *cell, int flags)
|
||||
{
|
||||
if (m_curparam >= SP_MAX_EXEC_PARAMS)
|
||||
{
|
||||
return SetError(SP_ERROR_PARAMS_MAX);
|
||||
}
|
||||
|
||||
return PushArray(cell, 1, NULL, flags);
|
||||
}
|
||||
|
||||
int CFunction::PushFloat(float number)
|
||||
{
|
||||
cell_t val = *(cell_t *)&number;
|
||||
|
||||
return PushCell(val);
|
||||
}
|
||||
|
||||
int CFunction::PushFloatByRef(float *number, int flags)
|
||||
{
|
||||
return PushCellByRef((cell_t *)number, flags);
|
||||
}
|
||||
|
||||
int CFunction::PushCells(cell_t array[], unsigned int numcells, bool each)
|
||||
{
|
||||
if (!each)
|
||||
{
|
||||
return PushArray(array, numcells, NULL, SMFUNC_COPYBACK_NONE);
|
||||
} else {
|
||||
int err;
|
||||
for (unsigned int i=0; i<numcells; i++)
|
||||
{
|
||||
if ((err=PushCell(array[i])) != SP_ERROR_NONE)
|
||||
{
|
||||
return SetError(err);
|
||||
}
|
||||
}
|
||||
return SP_ERROR_NONE;
|
||||
}
|
||||
}
|
||||
|
||||
int CFunction::PushArray(cell_t *inarray, unsigned int cells, cell_t **phys_addr, int copyback)
|
||||
{
|
||||
if (m_curparam >= SP_MAX_EXEC_PARAMS)
|
||||
{
|
||||
return SetError(SP_ERROR_PARAMS_MAX);
|
||||
}
|
||||
|
||||
IPluginContext *ctx = m_pPlugin->m_ctx_current.base;
|
||||
ParamInfo *info = &m_info[m_curparam];
|
||||
int err;
|
||||
|
||||
if ((err=ctx->HeapAlloc(cells, &info->local_addr, &info->phys_addr)) != SP_ERROR_NONE)
|
||||
{
|
||||
return SetError(err);
|
||||
}
|
||||
|
||||
info->flags = inarray ? copyback : SMFUNC_COPYBACK_NONE;
|
||||
info->marked = true;
|
||||
info->size = cells;
|
||||
m_params[m_curparam] = info->local_addr;
|
||||
m_curparam++;
|
||||
|
||||
if (inarray)
|
||||
{
|
||||
memcpy(info->phys_addr, inarray, sizeof(cell_t) * cells);
|
||||
info->orig_addr = inarray;
|
||||
} else {
|
||||
info->orig_addr = info->phys_addr;
|
||||
}
|
||||
|
||||
if (phys_addr)
|
||||
{
|
||||
*phys_addr = info->phys_addr;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
int CFunction::PushString(const char *string)
|
||||
{
|
||||
return _PushString(string, SMFUNC_COPYBACK_NONE);
|
||||
}
|
||||
|
||||
int CFunction::PushStringByRef(char *string, int flags)
|
||||
{
|
||||
return _PushString(string, flags);
|
||||
}
|
||||
|
||||
int CFunction::_PushString(const char *string, int flags)
|
||||
{
|
||||
if (m_curparam >= SP_MAX_EXEC_PARAMS)
|
||||
{
|
||||
return SetError(SP_ERROR_PARAMS_MAX);
|
||||
}
|
||||
|
||||
IPluginContext *base = m_pPlugin->m_ctx_current.base;
|
||||
ParamInfo *info = &m_info[m_curparam];
|
||||
size_t len = strlen(string);
|
||||
size_t cells = (len + sizeof(cell_t) - 1) / sizeof(cell_t);
|
||||
int err;
|
||||
|
||||
if ((err=base->HeapAlloc(cells, &info->local_addr, &info->phys_addr)) != SP_ERROR_NONE)
|
||||
{
|
||||
return SetError(err);
|
||||
}
|
||||
|
||||
info->marked = true;
|
||||
m_params[m_curparam] = info->local_addr;
|
||||
m_curparam++; /* Prevent a leak */
|
||||
|
||||
//:TODO: Use UTF-8 version
|
||||
if ((err=base->StringToLocal(info->local_addr, len, string)) != SP_ERROR_NONE)
|
||||
{
|
||||
return SetError(err);
|
||||
}
|
||||
|
||||
info->flags = flags;
|
||||
info->orig_addr = (cell_t *)string;
|
||||
info->size = cells;
|
||||
|
||||
return SP_ERROR_NONE;
|
||||
}
|
||||
|
||||
void CFunction::Cancel()
|
||||
{
|
||||
if (!m_curparam)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
IPluginContext *base = m_pPlugin->m_ctx_current.base;
|
||||
|
||||
while (m_curparam--)
|
||||
{
|
||||
if (m_info[m_curparam].marked)
|
||||
{
|
||||
base->HeapRelease(m_info[m_curparam].local_addr);
|
||||
m_info[m_curparam].marked = false;
|
||||
}
|
||||
}
|
||||
|
||||
m_errorstate = SP_ERROR_NONE;
|
||||
}
|
||||
|
||||
int CFunction::Execute(cell_t *result, IFunctionCopybackReader *reader)
|
||||
{
|
||||
int err;
|
||||
if (m_errorstate != SP_ERROR_NONE)
|
||||
{
|
||||
err = m_errorstate;
|
||||
Cancel();
|
||||
return err;
|
||||
}
|
||||
|
||||
//This is for re-entrancy!
|
||||
cell_t temp_params[SP_MAX_EXEC_PARAMS];
|
||||
ParamInfo temp_info[SP_MAX_EXEC_PARAMS];
|
||||
unsigned int numparams = m_curparam;
|
||||
bool docopies = true;
|
||||
|
||||
if (numparams)
|
||||
{
|
||||
//Save the info locally, then reset it for re-entrant calls.
|
||||
memcpy(temp_params, m_params, numparams * sizeof(cell_t));
|
||||
memcpy(temp_info, m_info, numparams * sizeof(ParamInfo));
|
||||
}
|
||||
m_curparam = 0;
|
||||
|
||||
if ((err = CallFunction(temp_params, numparams, result)) != SP_ERROR_NONE)
|
||||
{
|
||||
docopies = false;
|
||||
}
|
||||
|
||||
IPluginContext *base = m_pPlugin->m_ctx_current.base;
|
||||
|
||||
while (numparams--)
|
||||
{
|
||||
if (!temp_info[numparams].marked)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
if (docopies && temp_info[numparams].flags)
|
||||
{
|
||||
if (reader)
|
||||
{
|
||||
if (!reader->OnCopybackArray(numparams,
|
||||
temp_info[numparams].size,
|
||||
temp_info[numparams].phys_addr,
|
||||
temp_info[numparams].orig_addr,
|
||||
temp_info[numparams].flags))
|
||||
{
|
||||
goto _skipcopy;
|
||||
}
|
||||
}
|
||||
if (temp_info[numparams].orig_addr)
|
||||
{
|
||||
memcpy(temp_info[numparams].orig_addr,
|
||||
temp_info[numparams].phys_addr,
|
||||
temp_info[numparams].size * sizeof(cell_t));
|
||||
}
|
||||
}
|
||||
_skipcopy:
|
||||
base->HeapRelease(temp_info[numparams].local_addr);
|
||||
temp_info[numparams].marked = false;
|
||||
}
|
||||
|
||||
return err;
|
||||
}
|
||||
|
||||
cell_t *CFunction::GetAddressOfPushedParam(unsigned int param)
|
||||
{
|
||||
if (m_errorstate != SP_ERROR_NONE
|
||||
|| param >= m_curparam
|
||||
|| !m_info[param].marked)
|
||||
{
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return m_info[param].phys_addr;
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
#ifndef _INCLUDE_SOURCEMOD_BASEFUNCTION_H_
|
||||
#define _INCLUDE_SOURCEMOD_BASEFUNCTION_H_
|
||||
|
||||
#include <IPluginFunction.h>
|
||||
#include "sm_globals.h"
|
||||
|
||||
struct ParamInfo
|
||||
{
|
||||
int flags; /* Copy-back flags */
|
||||
bool marked; /* Whether this is marked as being used */
|
||||
cell_t local_addr; /* Local address to free */
|
||||
cell_t *phys_addr; /* Physical address of our copy */
|
||||
cell_t *orig_addr; /* Original address to copy back to */
|
||||
ucell_t size; /* Size of array in cells */
|
||||
};
|
||||
|
||||
class CPlugin;
|
||||
|
||||
class CFunction : public IPluginFunction
|
||||
{
|
||||
public:
|
||||
CFunction(funcid_t funcid, CPlugin *plugin);
|
||||
public:
|
||||
virtual int PushCell(cell_t cell);
|
||||
virtual int PushCellByRef(cell_t *cell, int flags);
|
||||
virtual int PushFloat(float number);
|
||||
virtual int PushFloatByRef(float *number, int flags);
|
||||
virtual int PushCells(cell_t array[], unsigned int numcells, bool each);
|
||||
virtual int PushArray(cell_t *inarray, unsigned int cells, cell_t **phys_addr, int copyback);
|
||||
virtual int PushString(const char *string);
|
||||
virtual int PushStringByRef(char *string, int flags);
|
||||
virtual cell_t *GetAddressOfPushedParam(unsigned int param);
|
||||
virtual int Execute(cell_t *result, IFunctionCopybackReader *reader);
|
||||
virtual void Cancel();
|
||||
virtual int CallFunction(const cell_t *params, unsigned int num_params, cell_t *result);
|
||||
virtual IPlugin *GetParentPlugin();
|
||||
public:
|
||||
void Set(funcid_t funcid, CPlugin *plugin);
|
||||
private:
|
||||
int _PushString(const char *string, int flags);
|
||||
inline int SetError(int err)
|
||||
{
|
||||
m_errorstate = err;
|
||||
return err;
|
||||
}
|
||||
private:
|
||||
funcid_t m_funcid;
|
||||
CPlugin *m_pPlugin;
|
||||
cell_t m_params[SP_MAX_EXEC_PARAMS];
|
||||
ParamInfo m_info[SP_MAX_EXEC_PARAMS];
|
||||
unsigned int m_curparam;
|
||||
int m_errorstate;
|
||||
};
|
||||
|
||||
#endif //_INCLUDE_SOURCEMOD_BASEFUNCTION_H_
|
||||
@@ -7,34 +7,6 @@ CPluginManager::CPluginManager()
|
||||
{
|
||||
}
|
||||
|
||||
void CFunction::Set(funcid_t funcid, CPlugin *plugin)
|
||||
{
|
||||
m_funcid = funcid;
|
||||
m_pPlugin = plugin;
|
||||
}
|
||||
|
||||
int CFunction::CallFunction(const cell_t *params, unsigned int num_params, cell_t *result)
|
||||
{
|
||||
IPluginContext *ctx = m_pPlugin->m_ctx_current.base;
|
||||
|
||||
for (unsigned int i=0; i<num_params; i++)
|
||||
{
|
||||
ctx->PushCell(params[i]);
|
||||
}
|
||||
|
||||
return ctx->Execute(m_funcid, result);
|
||||
}
|
||||
|
||||
IPlugin *CFunction::GetParentPlugin()
|
||||
{
|
||||
return m_pPlugin;
|
||||
}
|
||||
|
||||
CFunction::CFunction(funcid_t funcid, CPlugin *plugin) :
|
||||
m_funcid(funcid), m_pPlugin(plugin)
|
||||
{
|
||||
}
|
||||
|
||||
CPlugin *CPlugin::CreatePlugin(const char *file,
|
||||
bool debug_default,
|
||||
PluginType type,
|
||||
@@ -355,7 +327,7 @@ bool CPluginManager::UnloadPlugin(IPlugin *plugin)
|
||||
{
|
||||
for (uint32_t i=0; i<pPlugin->m_plugin->info.publics_num; i++)
|
||||
{
|
||||
delete pPlugin->m_pub_funcs[i];
|
||||
g_PluginMngr.ReleaseFunctionToPool(pPlugin->m_pub_funcs[i]);
|
||||
}
|
||||
delete [] pPlugin->m_pub_funcs;
|
||||
pPlugin->m_pub_funcs = NULL;
|
||||
@@ -365,7 +337,7 @@ bool CPluginManager::UnloadPlugin(IPlugin *plugin)
|
||||
{
|
||||
for (unsigned int i=0; i<pPlugin->m_funcsnum; i++)
|
||||
{
|
||||
delete pPlugin->m_priv_funcs[i];
|
||||
g_PluginMngr.ReleaseFunctionToPool(pPlugin->m_priv_funcs[i]);
|
||||
}
|
||||
delete [] pPlugin->m_priv_funcs;
|
||||
pPlugin->m_priv_funcs = NULL;
|
||||
@@ -435,6 +407,11 @@ void CPluginManager::ReleaseIterator(CPluginIterator *iter)
|
||||
|
||||
void CPluginManager::ReleaseFunctionToPool(CFunction *func)
|
||||
{
|
||||
if (!func)
|
||||
{
|
||||
return;
|
||||
}
|
||||
func->Cancel();
|
||||
m_funcpool.push(func);
|
||||
}
|
||||
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
#include <sh_list.h>
|
||||
#include <sh_stack.h>
|
||||
#include "sm_globals.h"
|
||||
#include "CFunction.h"
|
||||
|
||||
using namespace SourceHook;
|
||||
|
||||
@@ -19,22 +20,6 @@ struct ContextPair
|
||||
sp_context_t *ctx;
|
||||
};
|
||||
|
||||
class CPlugin;
|
||||
|
||||
class CFunction : public IPluginFunction
|
||||
{
|
||||
public:
|
||||
CFunction(funcid_t funcid, CPlugin *plugin);
|
||||
public:
|
||||
virtual int CallFunction(const cell_t *params, unsigned int num_params, cell_t *result);
|
||||
virtual IPlugin *GetParentPlugin();
|
||||
public:
|
||||
void Set(funcid_t funcid, CPlugin *plugin);
|
||||
private:
|
||||
funcid_t m_funcid;
|
||||
CPlugin *m_pPlugin;
|
||||
};
|
||||
|
||||
class CPlugin : public IPlugin
|
||||
{
|
||||
friend class CPluginManager;
|
||||
|
||||
Reference in New Issue
Block a user