dvander@371: /**
ds@653:  * vim: set ts=4 :
ds@1330:  * =============================================================================
dvander@1231:  * SourcePawn
dvander@1231:  * Copyright (C) 2004-2007 AlliedModders LLC.  All rights reserved.
ds@1330:  * =============================================================================
dvander@371:  *
ds@1330:  * This program is free software; you can redistribute it and/or modify it under
ds@1330:  * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330:  * Free Software Foundation.
dvander@1231:  * 
ds@1330:  * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330:  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330:  * details.
dvander@1231:  *
ds@1330:  * You should have received a copy of the GNU General Public License along with
ds@1330:  * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231:  *
ds@1330:  * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330:  * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330:  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330:  * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330:  * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330:  * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330:  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330:  * or <http://www.sourcemod.net/license.php>.
dvander@371:  *
dvander@371:  * Version: $Id$
dvander@371:  */
dvander@371: 
dvander@327: #include <stdio.h>
dvander@351: #include <string.h>
dvander@857: #include "sp_vm_function.h"
dvander@327: 
dvander@327: /********************
dvander@327: * FUNCTION CALLING *
dvander@327: ********************/
dvander@327: 
dvander@1339: void CFunction::Set(uint32_t code_addr, IPluginContext *plugin, funcid_t id)
dvander@327: {
dvander@348: 	m_codeaddr = code_addr;
dvander@327: 	m_pContext = plugin;
dvander@327: 	m_curparam = 0;
dvander@327: 	m_errorstate = SP_ERROR_NONE;
dvander@502: 	m_Invalid = false;
dvander@525: 	m_pCtx = plugin ? plugin->GetContext() : NULL;
dvander@1339: 	m_FnId = id;
dvander@525: }
dvander@525: 
dvander@525: bool CFunction::IsRunnable()
dvander@525: {
dvander@525: 	return ((m_pCtx->flags & SPFLAG_PLUGIN_PAUSED) != SPFLAG_PLUGIN_PAUSED);
dvander@327: }
dvander@327: 
dvander@327: int CFunction::CallFunction(const cell_t *params, unsigned int num_params, cell_t *result)
dvander@327: {
dvander@525: 	if (!IsRunnable())
dvander@525: 	{
dvander@525: 		return SP_ERROR_NOT_RUNNABLE;
dvander@525: 	}
dvander@525: 
dvander@327: 	while (num_params--)
dvander@327: 	{
dvander@327: 		m_pContext->PushCell(params[num_params]);
dvander@327: 	}
dvander@327: 
dvander@348: 	return m_pContext->Execute(m_codeaddr, result);
dvander@327: }
dvander@327: 
dvander@327: IPluginContext *CFunction::GetParentContext()
dvander@327: {
dvander@327: 	return m_pContext;
dvander@327: }
dvander@327: 
dvander@1339: CFunction::CFunction(uint32_t code_addr, IPluginContext *plugin, funcid_t id) : 
dvander@348: 	m_codeaddr(code_addr), m_pContext(plugin), m_curparam(0), 
dvander@1339: 	m_errorstate(SP_ERROR_NONE), m_FnId(id)
dvander@327: {
dvander@502: 	m_Invalid = false;
dvander@525: 	if (plugin)
dvander@525: 	{
dvander@525: 		m_pCtx = plugin->GetContext();
dvander@525: 	}
dvander@327: }
dvander@327: 
dvander@327: int CFunction::PushCell(cell_t cell)
dvander@327: {
dvander@327: 	if (m_curparam >= SP_MAX_EXEC_PARAMS)
dvander@327: 	{
dvander@327: 		return SetError(SP_ERROR_PARAMS_MAX);
dvander@327: 	}
dvander@327: 
dvander@327: 	m_info[m_curparam].marked = false;
dvander@327: 	m_params[m_curparam] = cell;
dvander@327: 	m_curparam++;
dvander@327: 
dvander@327: 	return SP_ERROR_NONE;
dvander@327: }
dvander@327: 
ds@585: int CFunction::PushCellByRef(cell_t *cell, int flags)
dvander@327: {
dvander@589: 	return PushArray(cell, 1, flags);
dvander@327: }
dvander@327: 
dvander@327: int CFunction::PushFloat(float number)
dvander@327: {
dvander@327: 	cell_t val = *(cell_t *)&number;
dvander@327: 
dvander@327: 	return PushCell(val);
dvander@327: }
dvander@327: 
ds@585: int CFunction::PushFloatByRef(float *number, int flags)
dvander@327: {
ds@585: 	return PushCellByRef((cell_t *)number, flags);
dvander@327: }
dvander@327: 
dvander@589: int CFunction::PushArray(cell_t *inarray, unsigned int cells, int copyback)
dvander@327: {
dvander@327: 	if (m_curparam >= SP_MAX_EXEC_PARAMS)
dvander@327: 	{
dvander@327: 		return SetError(SP_ERROR_PARAMS_MAX);
dvander@327: 	}
dvander@327: 
dvander@327: 	ParamInfo *info = &m_info[m_curparam];
dvander@327: 
dvander@327: 	info->flags = inarray ? copyback : 0;
dvander@327: 	info->marked = true;
dvander@589: 	info->size = cells;
dvander@589: 	info->str.is_sz = false;
dvander@589: 	info->orig_addr = inarray;
dvander@327: 
dvander@589: 	m_curparam++;
dvander@327: 
dvander@586: 	return SP_ERROR_NONE;
dvander@327: }
dvander@327: 
dvander@327: int CFunction::PushString(const char *string)
dvander@327: {
dvander@327: 	return _PushString(string, SM_PARAM_STRING_COPY, 0, strlen(string)+1);
dvander@327: }
dvander@327: 
dvander@327: int CFunction::PushStringEx(char *buffer, size_t length, int sz_flags, int cp_flags)
dvander@327: {
dvander@327: 	return _PushString(buffer, sz_flags, cp_flags, length);
dvander@327: }
dvander@327: 
dvander@327: int CFunction::_PushString(const char *string, int sz_flags, int cp_flags, size_t len)
dvander@327: {
dvander@327: 	if (m_curparam >= SP_MAX_EXEC_PARAMS)
dvander@327: 	{
dvander@327: 		return SetError(SP_ERROR_PARAMS_MAX);
dvander@327: 	}
dvander@327: 
dvander@327: 	ParamInfo *info = &m_info[m_curparam];
dvander@327: 
dvander@327: 	info->marked = true;
dvander@589: 	info->orig_addr = (cell_t *)string;
dvander@589: 	info->flags = cp_flags;
dvander@589: 	info->size = len;
dvander@589: 	info->str.sz_flags = sz_flags;
dvander@589: 	info->str.is_sz = true;
dvander@327: 
dvander@589: 	m_curparam++;
dvander@327: 
dvander@327: 	return SP_ERROR_NONE;
dvander@327: }
dvander@327: 
dvander@327: void CFunction::Cancel()
dvander@327: {
dvander@327: 	if (!m_curparam)
dvander@327: 	{
dvander@327: 		return;
dvander@327: 	}
dvander@327: 
dvander@327: 	m_errorstate = SP_ERROR_NONE;
dvander@589: 	m_curparam = 0;
dvander@327: }
dvander@327: 
dvander@327: int CFunction::Execute(cell_t *result)
dvander@327: {
dvander@589: 	int err = SP_ERROR_NONE;
dvander@525: 	if (!IsRunnable())
dvander@525: 	{
dvander@525: 		m_errorstate = SP_ERROR_NOT_RUNNABLE;
dvander@525: 	}
dvander@327: 	if (m_errorstate != SP_ERROR_NONE)
dvander@327: 	{
dvander@327: 		err = m_errorstate;
dvander@327: 		Cancel();
dvander@327: 		return err;
dvander@327: 	}
dvander@327: 
dvander@327: 	//This is for re-entrancy!
dvander@327: 	cell_t temp_params[SP_MAX_EXEC_PARAMS];
dvander@327: 	ParamInfo temp_info[SP_MAX_EXEC_PARAMS];
dvander@327: 	unsigned int numparams = m_curparam;
dvander@589: 	unsigned int i;
dvander@327: 	bool docopies = true;
dvander@327: 
dvander@327: 	if (numparams)
dvander@327: 	{
dvander@327: 		//Save the info locally, then reset it for re-entrant calls.
dvander@327: 		memcpy(temp_info, m_info, numparams * sizeof(ParamInfo));
dvander@327: 	}
dvander@327: 	m_curparam = 0;
dvander@327: 
dvander@589: 	/* Browse the parameters and build arrays */
dvander@589: 	for (i=0; i<numparams; i++)
dvander@327: 	{
dvander@589: 		/* Is this marked as an array? */
dvander@589: 		if (temp_info[i].marked)
dvander@589: 		{
dvander@589: 			if (!temp_info[i].str.is_sz)
dvander@589: 			{
dvander@589: 				/* Allocate a normal/generic array */
dvander@589: 				if ((err=m_pContext->HeapAlloc(temp_info[i].size, 
dvander@589: 											   &(temp_info[i].local_addr),
dvander@589: 											   &(temp_info[i].phys_addr)))
dvander@589: 					!= SP_ERROR_NONE)
dvander@589: 				{
dvander@589: 					break;
dvander@589: 				}
dvander@589: 				if (temp_info[i].orig_addr)
dvander@589: 				{
dvander@589: 					memcpy(temp_info[i].phys_addr, temp_info[i].orig_addr, sizeof(cell_t) * temp_info[i].size);
dvander@589: 				}
dvander@589: 			} else {
dvander@589: 				/* Calculate cells required for the string */
dvander@589: 				size_t cells = (temp_info[i].size + sizeof(cell_t) - 1) / sizeof(cell_t);
dvander@589: 
dvander@589: 				/* Allocate the buffer */
dvander@589: 				if ((err=m_pContext->HeapAlloc(cells,
dvander@589: 												&(temp_info[i].local_addr),
dvander@589: 												&(temp_info[i].phys_addr)))
dvander@589: 					!= SP_ERROR_NONE)
dvander@589: 				{
dvander@589: 					break;
dvander@589: 				}
dvander@589: 				/* Copy original string if necessary */
dvander@589: 				if ((temp_info[i].str.sz_flags & SM_PARAM_STRING_COPY) && (temp_info[i].orig_addr != NULL))
dvander@589: 				{
dvander@589: 					if (temp_info[i].str.sz_flags & SM_PARAM_STRING_UTF8)
dvander@589: 					{
dvander@589: 						if ((err=m_pContext->StringToLocalUTF8(temp_info[i].local_addr, 
dvander@589: 																temp_info[i].size, 
dvander@589: 																(const char *)temp_info[i].orig_addr,
dvander@589: 																NULL))
dvander@589: 							!= SP_ERROR_NONE)
dvander@589: 						{
dvander@589: 							break;
dvander@589: 						}
dvander@589: 					} else {
dvander@589: 						if ((err=m_pContext->StringToLocal(temp_info[i].local_addr,
dvander@589: 															temp_info[i].size,
dvander@589: 															(const char *)temp_info[i].orig_addr))
dvander@589: 							!= SP_ERROR_NONE)
dvander@589: 						{
dvander@589: 							break;
dvander@589: 						}
dvander@589: 					}
dvander@589: 				}
dvander@589: 			} /* End array/string calculation */
dvander@589: 			/* Update the pushed parameter with the byref local address */
dvander@589: 			temp_params[i] = temp_info[i].local_addr;
dvander@589: 		} else {
dvander@589: 			/* Just copy the value normally */
dvander@589: 			temp_params[i] = m_params[i];
dvander@589: 		}
dvander@589: 	}
dvander@589: 
dvander@589: 	/* Make the call if we can */
dvander@589: 	if (err == SP_ERROR_NONE)
dvander@589: 	{
dvander@589: 		if ((err = CallFunction(temp_params, numparams, result)) != SP_ERROR_NONE)
dvander@589: 		{
dvander@589: 			docopies = false;
dvander@589: 		}
dvander@589: 	} else {
dvander@327: 		docopies = false;
dvander@327: 	}
dvander@327: 
dvander@589: 	/* i should be equal to the last valid parameter + 1 */
dvander@589: 	while (i--)
dvander@327: 	{
dvander@589: 		if (!temp_info[i].marked)
dvander@327: 		{
dvander@327: 			continue;
dvander@327: 		}
dvander@589: 		if (docopies && (temp_info[i].flags & SM_PARAM_COPYBACK))
dvander@327: 		{
dvander@589: 			if (temp_info[i].orig_addr)
dvander@327: 			{
dvander@589: 				if (temp_info[i].str.is_sz)
dvander@327: 				{
dvander@589: 					memcpy(temp_info[i].orig_addr, temp_info[i].phys_addr, temp_info[i].size);
dvander@327: 				} else {
dvander@589: 					if (temp_info[i].size == 1)
dvander@589: 					{
dvander@589: 						*temp_info[i].orig_addr = *(temp_info[i].phys_addr);
dvander@589: 					} else {
dvander@589: 						memcpy(temp_info[i].orig_addr, 
dvander@589: 								temp_info[i].phys_addr, 
dvander@589: 								temp_info[i].size * sizeof(cell_t));
dvander@589: 					}
dvander@327: 				}
dvander@327: 			}
dvander@327: 		}
dvander@589: 		if ((err=m_pContext->HeapPop(temp_info[i].local_addr)) != SP_ERROR_NONE)
dvander@589: 		{
dvander@589: 			return err;
dvander@589: 		}
dvander@327: 	}
dvander@327: 
dvander@327: 	return err;
dvander@327: }
dvander@1339: 
dvander@1339: funcid_t CFunction::GetFunctionID()
dvander@1339: {
dvander@1339: 	return m_FnId;
dvander@1339: }