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