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@1897: #include "sp_vm_types.h"
faluco@1895: #include <sh_memory.h>
faluco@1895: /* HACK to avoid including sourcehook.h for just the SH_ASSERT definition */
faluco@1895: #if !defined  SH_ASSERT
faluco@1895: 	#define SH_ASSERT(x, info)
faluco@1895: 	#include <sh_pagealloc.h>
faluco@1895: 	#undef SH_ASSERT
faluco@1895: #else
faluco@1895: 	#include <sh_pagealloc.h>
faluco@1895: #endif
faluco@1895: 
dvander@159: #include <malloc.h>
dvander@159: #include <string.h>
dvander@240: #include <assert.h>
dvander@159: #include "sp_file_headers.h"
dvander@159: #include "sp_vm_engine.h"
dvander@159: #include "zlib/zlib.h"
dvander@159: #include "sp_vm_basecontext.h"
dvander@159: 
dvander@159: #if defined WIN32
dvander@159:  #define WIN32_LEAN_AND_MEAN
dvander@159:  #include <windows.h>
dvander@351: #elif defined __GNUC__
dvander@159:  #include <sys/mman.h>
dvander@159: #endif
dvander@159: 
dvander@240: #define INVALID_CIP			0xFFFFFFFF
dvander@240: 
dvander@159: using namespace SourcePawn;
dvander@159: 
faluco@1896: SourceHook::CPageAlloc g_ExeMemory(16);
faluco@1896: 
dvander@560: #define ERROR_MESSAGE_MAX		25
dvander@240: static const char *g_ErrorMsgTable[] = 
dvander@240: {
dvander@240: 	NULL,
dvander@240: 	"Unrecognizable file format",
dvander@240: 	"Decompressor was not found",
dvander@240: 	"Not enough space on the heap",
dvander@240: 	"Invalid parameter or parameter type",
dvander@240: 	"Invalid plugin address",
dvander@240: 	"Object or index not found",
dvander@240: 	"Invalid index or index not found",
dvander@240: 	"Not enough space on the stack",
dvander@240: 	"Debug section not found or debug not enabled",
dvander@240: 	"Invalid instruction",
dvander@240: 	"Invalid memory access",
dvander@240: 	"Stack went below stack boundary",
dvander@240: 	"Heap went below heap boundary",
dvander@240: 	"Divide by zero",
dvander@240: 	"Array index is out of bounds",
dvander@240: 	"Instruction contained invalid parameter",
dvander@240: 	"Stack memory leaked by native",
dvander@240: 	"Heap memory leaked by native",
dvander@240: 	"Dynamic array is too big",
dvander@240: 	"Tracker stack is out of bounds",
dvander@1119: 	"Native is not bound",
dvander@240: 	"Maximum number of parameters reached",
dvander@240: 	"Native detected error",
dvander@372: 	"Plugin not runnable",
dvander@560: 	"Call was aborted",
dvander@240: };
dvander@240: 
dvander@1269: const char *GetSourcePawnErrorMessage(int error)
dvander@1269: {
dvander@1269: 	if (error < 1 || error > ERROR_MESSAGE_MAX)
dvander@1269: 	{
dvander@1269: 		return NULL;
dvander@1269: 	}
dvander@1269: 
dvander@1269: 	return g_ErrorMsgTable[error];
dvander@1269: }
dvander@1269: 
faluco@1896: SourcePawnEngine::SourcePawnEngine()
dvander@240: {
dvander@240: 	m_pDebugHook = NULL;
dvander@240: 	m_CallStack = NULL;
dvander@240: 	m_FreedCalls = NULL;
dvander@240: 	m_CurChain = 0;
dvander@327: #if 0
dvander@327: 	m_pFreeFuncs = NULL;
dvander@327: #endif
dvander@240: }
dvander@240: 
dvander@240: SourcePawnEngine::~SourcePawnEngine()
dvander@240: {
dvander@240: 	TracedCall *pTemp;
dvander@240: 	while (m_FreedCalls)
dvander@240: 	{
dvander@240: 		pTemp = m_FreedCalls->next;
dvander@246: 		delete m_FreedCalls;
dvander@240: 		m_FreedCalls = pTemp;
dvander@240: 	}
dvander@327: 
dvander@327: #if 0
dvander@327: 	CFunction *pNext;
dvander@327: 	while (m_pFreeFuncs)
dvander@327: 	{
dvander@327: 		pNext = m_pFreeFuncs->m_pNext;
dvander@327: 		delete m_pFreeFuncs;
dvander@327: 		m_pFreeFuncs = pNext;
dvander@327: 	}
dvander@327: #endif
dvander@240: }
dvander@240: 
dvander@159: void *SourcePawnEngine::ExecAlloc(size_t size)
dvander@159: {
dvander@159: #if defined WIN32
dvander@159: 	return VirtualAlloc(NULL, size, MEM_COMMIT, PAGE_EXECUTE_READWRITE);
dvander@351: #elif defined __GNUC__
dvander@159: 	void *base = memalign(sysconf(_SC_PAGESIZE), size);
dvander@159: 	if (mprotect(base, size, PROT_READ|PROT_WRITE|PROT_EXEC) != 0)
dvander@159: 	{
dvander@159: 		free(base);
dvander@159: 		return NULL;
dvander@159: 	}
dvander@159: 	return base;
dvander@159: #endif
dvander@159: }
dvander@159: 
faluco@1894: void *SourcePawnEngine::AllocatePageMemory(size_t size)
faluco@1894: {
faluco@1896: 	return g_ExeMemory.Alloc(size);
faluco@1894: }
faluco@1894: 
faluco@1894: void SourcePawnEngine::SetReadExecute(void *ptr)
faluco@1894: {
faluco@1896: 	g_ExeMemory.SetRE(ptr);
faluco@1894: }
faluco@1894: 
faluco@1894: void SourcePawnEngine::SetReadWrite(void *ptr)
faluco@1894: {
faluco@1896: 	g_ExeMemory.SetRW(ptr);
faluco@1894: }
faluco@1894: 
faluco@1894: void SourcePawnEngine::FreePageMemory(void *ptr)
faluco@1894: {
faluco@1896: 	g_ExeMemory.Free(ptr);
faluco@1894: }
faluco@1894: 
dvander@159: void SourcePawnEngine::ExecFree(void *address)
dvander@159: {
dvander@159: #if defined WIN32
dvander@159: 	VirtualFree(address, 0, MEM_RELEASE);
dvander@351: #elif defined __GNUC__
dvander@159: 	free(address);
dvander@159: #endif
dvander@159: }
dvander@159: 
dvander@159: void *SourcePawnEngine::BaseAlloc(size_t size)
dvander@159: {
dvander@159: 	return malloc(size);
dvander@159: }
dvander@159: 
dvander@159: void SourcePawnEngine::BaseFree(void *memory)
dvander@159: {
dvander@159: 	free(memory);
dvander@159: }
dvander@159: 
dvander@159: IPluginContext *SourcePawnEngine::CreateBaseContext(sp_context_t *ctx)
dvander@159: {
dvander@159: 	return new BaseContext(ctx);
dvander@159: }
dvander@159: 
dvander@159: void SourcePawnEngine::FreeBaseContext(IPluginContext *ctx)
dvander@159: {
dvander@159: 	delete ctx;
dvander@159: }
dvander@159: 
dvander@159: sp_plugin_t *_ReadPlugin(sp_file_hdr_t *hdr, uint8_t *base, sp_plugin_t *plugin, int *err)
dvander@159: {
dvander@159: 	char *nameptr;
dvander@159: 	uint8_t sectnum = 0;
dvander@159: 	sp_file_section_t *secptr = (sp_file_section_t *)(base + sizeof(sp_file_hdr_t));
dvander@159: 
dvander@159: 	memset(plugin, 0, sizeof(sp_plugin_t));
dvander@159: 
dvander@159: 	plugin->base = base;
dvander@159: 
dvander@159: 	while (sectnum < hdr->sections)
dvander@159: 	{
dvander@159: 		nameptr = (char *)(base + hdr->stringtab + secptr->nameoffs);
dvander@159: 
dvander@159: 		if (!(plugin->pcode) && !strcmp(nameptr, ".code"))
dvander@159: 		{
dvander@159: 			sp_file_code_t *cod = (sp_file_code_t *)(base + secptr->dataoffs);
dvander@159: 			plugin->pcode = base + secptr->dataoffs + cod->code;
dvander@159: 			plugin->pcode_size = cod->codesize;
dvander@159: 			plugin->flags = cod->flags;
dvander@159: 		}
dvander@159: 		else if (!(plugin->data) && !strcmp(nameptr, ".data"))
dvander@159: 		{
dvander@159: 			sp_file_data_t *dat = (sp_file_data_t *)(base + secptr->dataoffs);
dvander@159: 			plugin->data = base + secptr->dataoffs + dat->data;
dvander@159: 			plugin->data_size = dat->datasize;
dvander@159: 			plugin->memory = dat->memsize;
dvander@159: 		}
dvander@159: 		else if (!(plugin->info.publics) && !strcmp(nameptr, ".publics"))
dvander@159: 		{
dvander@159: 			plugin->info.publics_num = secptr->size / sizeof(sp_file_publics_t);
dvander@159: 			plugin->info.publics = (sp_file_publics_t *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 		else if (!(plugin->info.pubvars) && !strcmp(nameptr, ".pubvars"))
dvander@159: 		{
dvander@159: 			plugin->info.pubvars_num = secptr->size / sizeof(sp_file_pubvars_t);
dvander@159: 			plugin->info.pubvars = (sp_file_pubvars_t *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 		else if (!(plugin->info.natives) && !strcmp(nameptr, ".natives"))
dvander@159: 		{
dvander@159: 			plugin->info.natives_num = secptr->size / sizeof(sp_file_natives_t);
dvander@159: 			plugin->info.natives = (sp_file_natives_t *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 		else if (!(plugin->info.stringbase) && !strcmp(nameptr, ".names"))
dvander@159: 		{
dvander@159: 			plugin->info.stringbase = (const char *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 		else if (!(plugin->debug.files) && !strcmp(nameptr, ".dbg.files"))
dvander@159: 		{
dvander@159: 			plugin->debug.files = (sp_fdbg_file_t *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 		else if (!(plugin->debug.lines) && !strcmp(nameptr, ".dbg.lines"))
dvander@159: 		{
dvander@159: 			plugin->debug.lines = (sp_fdbg_line_t *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 		else if (!(plugin->debug.symbols) && !strcmp(nameptr, ".dbg.symbols"))
dvander@159: 		{
dvander@159: 			plugin->debug.symbols = (sp_fdbg_symbol_t *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 		else if (!(plugin->debug.lines_num) && !strcmp(nameptr, ".dbg.info"))
dvander@159: 		{
dvander@159: 			sp_fdbg_info_t *inf = (sp_fdbg_info_t *)(base + secptr->dataoffs);
dvander@159: 			plugin->debug.files_num = inf->num_files;
dvander@159: 			plugin->debug.lines_num = inf->num_lines;
dvander@159: 			plugin->debug.syms_num = inf->num_syms;
dvander@159: 		}
dvander@159: 		else if (!(plugin->debug.stringbase) && !strcmp(nameptr, ".dbg.strings"))
dvander@159: 		{
dvander@159: 			plugin->debug.stringbase = (const char *)(base + secptr->dataoffs);
dvander@159: 		}
dvander@159: 
dvander@159: 		secptr++;
dvander@159: 		sectnum++;
dvander@159: 	}
dvander@159: 
dvander@159: 	if (!(plugin->pcode) || !(plugin->data) || !(plugin->info.stringbase))
dvander@159: 	{
dvander@159: 		goto return_error;
dvander@159: 	}
dvander@159: 
dvander@159: 	if ((plugin->flags & SP_FLAG_DEBUG) && (!(plugin->debug.files) || !(plugin->debug.lines) || !(plugin->debug.symbols)))
dvander@159: 	{
dvander@159: 		goto return_error;
dvander@159: 	}
dvander@159: 
dvander@159: 	if (err)
dvander@159: 	{
dvander@159: 		*err = SP_ERROR_NONE;
dvander@159: 	}
dvander@159: 
dvander@159: 	return plugin;
dvander@159: 
dvander@159: return_error:
dvander@159: 	if (err)
dvander@159: 	{
dvander@159: 		*err = SP_ERROR_FILE_FORMAT;
dvander@159: 	}
dvander@159: 
dvander@159: 	return NULL;
dvander@159: }
dvander@159: 
dvander@159: sp_plugin_t *SourcePawnEngine::LoadFromFilePointer(FILE *fp, int *err)
dvander@159: {
dvander@159: 	sp_file_hdr_t hdr;
dvander@159: 	sp_plugin_t *plugin;
dvander@159: 	uint8_t *base;
dvander@159: 	int z_result;
dvander@159: 	int error;
dvander@159: 
dvander@159: 	if (!fp)
dvander@159: 	{
dvander@159: 		error = SP_ERROR_NOT_FOUND;
dvander@159: 		goto return_error;
dvander@159: 	}
dvander@159: 
dvander@159: 	/* Rewind for safety */
dvander@159: 	rewind(fp);
dvander@159: 	fread(&hdr, sizeof(sp_file_hdr_t), 1, fp);
dvander@159: 
dvander@159: 	if (hdr.magic != SPFILE_MAGIC)
dvander@159: 	{
dvander@159: 		error = SP_ERROR_FILE_FORMAT;
dvander@159: 		goto return_error;
dvander@159: 	}
dvander@159: 
dvander@159: 	switch (hdr.compression)
dvander@159: 	{
dvander@159: 	case SPFILE_COMPRESSION_GZ:
dvander@159: 		{
dvander@159: 			uint32_t uncompsize = hdr.imagesize - hdr.dataoffs;
dvander@159: 			uint32_t compsize = hdr.disksize - hdr.dataoffs;
dvander@159: 			uint32_t sectsize = hdr.dataoffs - sizeof(sp_file_hdr_t);
dvander@159: 			uLongf destlen = uncompsize;
dvander@159: 
dvander@159: 			char *tempbuf = (char *)malloc(compsize);
dvander@159: 			void *uncompdata = malloc(uncompsize);
dvander@159: 			void *sectheader = malloc(sectsize);
dvander@159: 
dvander@159: 			fread(sectheader, sectsize, 1, fp);
dvander@159: 			fread(tempbuf, compsize, 1, fp);
dvander@159: 
dvander@159: 			z_result = uncompress((Bytef *)uncompdata, &destlen, (Bytef *)tempbuf, compsize);
dvander@159: 			free(tempbuf);
dvander@159: 			if (z_result != Z_OK)
dvander@159: 			{
dvander@159: 				free(sectheader);
dvander@159: 				free(uncompdata);
dvander@159: 				error = SP_ERROR_DECOMPRESSOR;
dvander@159: 				goto return_error;
dvander@159: 			}
dvander@159: 
dvander@159: 			base = (uint8_t *)malloc(hdr.imagesize);
dvander@159: 			memcpy(base, &hdr, sizeof(sp_file_hdr_t));
dvander@159: 			memcpy(base + sizeof(sp_file_hdr_t), sectheader, sectsize);
dvander@159: 			free(sectheader);
dvander@159: 			memcpy(base + hdr.dataoffs, uncompdata, uncompsize);
dvander@159: 			free(uncompdata);
dvander@159: 			break;
dvander@159: 		}
dvander@159: 	case SPFILE_COMPRESSION_NONE:
dvander@159: 		{
dvander@159: 			base = (uint8_t *)malloc(hdr.imagesize);
dvander@159: 			rewind(fp);
dvander@159: 			fread(base, hdr.imagesize, 1, fp);
dvander@159: 			break;
dvander@159: 		}
dvander@159: 	default:
dvander@159: 		{
dvander@159: 			error = SP_ERROR_DECOMPRESSOR;
dvander@159: 			goto return_error;
dvander@159: 		}
dvander@159: 	}
dvander@159: 
dvander@159: 	plugin = (sp_plugin_t *)malloc(sizeof(sp_plugin_t));
dvander@159: 	if (!_ReadPlugin(&hdr, base, plugin, err))
dvander@159: 	{
dvander@159: 		free(plugin);
dvander@159: 		free(base);
dvander@159: 		return NULL;
dvander@159: 	}
dvander@159: 
dvander@159: 	plugin->allocflags = 0;
dvander@159: 
dvander@159: 	return plugin;
dvander@159: 
dvander@159: return_error:
dvander@159: 	if (err)
dvander@159: 	{
dvander@159: 		*err = error;
dvander@159: 	}
dvander@159: 	return NULL;
dvander@159: }
dvander@159: 
dvander@159: sp_plugin_t *SourcePawnEngine::LoadFromMemory(void *base, sp_plugin_t *plugin, int *err)
dvander@159: {
dvander@159: 	sp_file_hdr_t hdr;
dvander@159: 	uint8_t noptr = 0;
dvander@159: 
dvander@159: 	memcpy(&hdr, base, sizeof(sp_file_hdr_t));
dvander@159: 
dvander@159: 	if (!plugin)
dvander@159: 	{
dvander@159: 		plugin = (sp_plugin_t *)malloc(sizeof(sp_plugin_t));
dvander@159: 		noptr = 1;
dvander@159: 	}
dvander@159: 
dvander@159: 	if (!_ReadPlugin(&hdr, (uint8_t *)base, plugin, err))
dvander@159: 	{
dvander@159: 		if (noptr)
dvander@159: 		{
dvander@159: 			free(plugin);
dvander@159: 		}
dvander@159: 		return NULL;
dvander@159: 	}
dvander@159: 
dvander@159: 	if (!noptr)
dvander@159: 	{
dvander@159: 		plugin->allocflags |= SP_FA_SELF_EXTERNAL;
dvander@159: 	}
dvander@159: 	plugin->allocflags |= SP_FA_BASE_EXTERNAL;
dvander@159: 
dvander@159: 	return plugin;
dvander@159: }
dvander@159: 
dvander@159: int SourcePawnEngine::FreeFromMemory(sp_plugin_t *plugin)
dvander@159: {
dvander@159: 	if (!(plugin->allocflags & SP_FA_BASE_EXTERNAL))
dvander@159: 	{
dvander@159: 		free(plugin->base);
dvander@159: 		plugin->base = NULL;
dvander@159: 	}
dvander@159: 	if (!(plugin->allocflags & SP_FA_SELF_EXTERNAL))
dvander@159: 	{
dvander@159: 		free(plugin);
dvander@159: 	}
dvander@159: 
dvander@159: 	return SP_ERROR_NONE;
dvander@159: }
dvander@240: 
dvander@327: #if 0
dvander@327: void SourcePawnEngine::ReleaseFunctionToPool(CFunction *func)
dvander@327: {
dvander@327: 	if (!func)
dvander@327: 	{
dvander@327: 		return;
dvander@327: 	}
dvander@327: 	func->Cancel();
dvander@327: 	func->m_pNext = m_pFreeFuncs;
dvander@327: 	m_pFreeFuncs = func;
dvander@327: }
dvander@327: 
dvander@327: CFunction *SourcePawnEngine::GetFunctionFromPool(funcid_t f, IPluginContext *plugin)
dvander@327: {
dvander@327: 	if (!m_pFreeFuncs)
dvander@327: 	{
dvander@327: 		return new CFunction(f, plugin);
dvander@327: 	} else {
dvander@327: 		CFunction *pFunc = m_pFreeFuncs;
dvander@327: 		m_pFreeFuncs = m_pFreeFuncs->m_pNext;
dvander@327: 		pFunc->Set(f, plugin);
dvander@327: 		return pFunc;
dvander@327: 	}
dvander@327: }
dvander@327: #endif
dvander@327: 
dvander@240: IDebugListener *SourcePawnEngine::SetDebugListener(IDebugListener *pListener)
dvander@240: {
dvander@240: 	IDebugListener *old = m_pDebugHook;
dvander@240: 
dvander@240: 	m_pDebugHook = pListener;
dvander@240: 
dvander@240: 	return old;
dvander@240: }
dvander@240: 
dvander@240: unsigned int SourcePawnEngine::GetContextCallCount()
dvander@240: {
dvander@240: 	if (!m_CallStack)
dvander@240: 	{
dvander@240: 		return 0;
dvander@240: 	}
dvander@240: 
dvander@240: 	return m_CallStack->chain;
dvander@240: }
dvander@240: 
dvander@240: TracedCall *SourcePawnEngine::MakeTracedCall(bool new_chain)
dvander@240: {
dvander@240: 	TracedCall *pCall;
dvander@240: 
dvander@240: 	if (!m_FreedCalls)
dvander@240: 	{
dvander@240: 		pCall = new TracedCall;
dvander@240: 	} else {
dvander@240: 		/* Unlink the head node from the free list */
dvander@240: 		pCall = m_FreedCalls;
dvander@240: 		m_FreedCalls = m_FreedCalls->next;
dvander@240: 	}
dvander@240: 
dvander@240: 	/* Link as the head node into the call stack */
dvander@240: 	pCall->next = m_CallStack;
dvander@240: 
dvander@240: 	if (new_chain)
dvander@240: 	{
dvander@240: 		pCall->chain = ++m_CurChain;
dvander@240: 	} else {
dvander@240: 		pCall->chain = m_CurChain;
dvander@240: 	}
dvander@240: 
dvander@240: 	m_CallStack = pCall;
dvander@240: 
dvander@240: 	return pCall;
dvander@240: }
dvander@240: 
dvander@240: void SourcePawnEngine::FreeTracedCall(TracedCall *pCall)
dvander@240: {
dvander@240: 	/* Check if this is the top of the call stack */
dvander@240: 	if (pCall == m_CallStack)
dvander@240: 	{
dvander@240: 		m_CallStack = m_CallStack->next;
dvander@240: 	}
dvander@240: 
dvander@240: 	/* Add this to our linked list of freed calls */
dvander@240: 	if (!m_FreedCalls)
dvander@240: 	{
dvander@240: 		m_FreedCalls = pCall;
dvander@240: 		m_FreedCalls->next = NULL;
dvander@240: 	} else {
dvander@240: 		pCall->next = m_FreedCalls;
dvander@240: 		m_FreedCalls = pCall;
dvander@240: 	}
dvander@240: }
dvander@240: 
dvander@240: void SourcePawnEngine::PushTracer(sp_context_t *ctx)
dvander@240: {
dvander@240: 	TracedCall *pCall = MakeTracedCall(true);
dvander@240: 
dvander@240: 	pCall->cip = INVALID_CIP;
dvander@240: 	pCall->ctx = ctx;
dvander@240: 	pCall->frm = INVALID_CIP;
dvander@240: }
dvander@240: 
dvander@240: void SourcePawnEngine::RunTracer(sp_context_t *ctx, uint32_t frame, uint32_t codeip)
dvander@240: {
dvander@240: 	assert(m_CallStack != NULL);
dvander@240: 	assert(m_CallStack->ctx == ctx);
dvander@240: 	assert(m_CallStack->chain == m_CurChain);
dvander@240: 
dvander@240: 	if (m_CallStack->cip == INVALID_CIP)
dvander@240: 	{
dvander@240: 		/* We aren't logging anything yet, so begin the trace */
dvander@240: 		m_CallStack->cip = codeip;
dvander@240: 		m_CallStack->frm = frame;
dvander@240: 	} else {
dvander@240: 		if (m_CallStack->frm > frame)
dvander@240: 		{
dvander@240: 			/* The last frame has moved down the stack, 
dvander@240: 			 * so we have to push a new call onto our list.
dvander@240: 			 */
dvander@240: 			TracedCall *pCall = MakeTracedCall(false);
dvander@246: 			pCall->ctx = ctx;
dvander@240: 			pCall->frm = frame;
dvander@240: 		} else if (m_CallStack->frm < frame) {
dvander@240: 			/* The last frame has moved up the stack,
dvander@240: 			 * so we have to pop the call from our list.
dvander@240: 			 */
dvander@240: 			FreeTracedCall(m_CallStack);
dvander@240: 		}
dvander@240: 		/* no matter where we are, update the cip */
dvander@240: 		m_CallStack->cip = codeip;
dvander@240: 	}
dvander@240: }
dvander@240: 
dvander@240: void SourcePawnEngine::PopTracer(int error, const char *msg)
dvander@240: {
dvander@240: 	assert(m_CallStack != NULL);
dvander@240: 
dvander@240: 	if (error != SP_ERROR_NONE && m_pDebugHook)
dvander@240: 	{
dvander@246: 		uint32_t native = INVALID_CIP;
dvander@246: 
dvander@246: 		if (m_CallStack->ctx->n_err)
dvander@246: 		{
dvander@246: 			native = m_CallStack->ctx->n_idx;
dvander@246: 		}
dvander@246: 
dvander@246: 		CContextTrace trace(m_CallStack, error, msg, native);
dvander@240: 		m_pDebugHook->OnContextExecuteError(m_CallStack->ctx->context, &trace);
dvander@240: 	}
dvander@240: 
dvander@240: 	/* Now pop the error chain  */
dvander@240: 	while (m_CallStack && m_CallStack->chain == m_CurChain)
dvander@240: 	{
dvander@240: 		FreeTracedCall(m_CallStack);
dvander@240: 	}
dvander@240: 
dvander@240: 	m_CurChain--;
dvander@240: }
dvander@240: 
dvander@1147: unsigned int SourcePawnEngine::GetEngineAPIVersion()
dvander@1147: {
dvander@1147: 	return SOURCEPAWN_ENGINE_API_VERSION;
dvander@1147: }
dvander@1147: 
dvander@246: CContextTrace::CContextTrace(TracedCall *pStart, int error, const char *msg, uint32_t native) : 
dvander@246:  m_Error(error), m_pMsg(msg), m_pStart(pStart), m_pIterator(pStart), m_Native(native)
dvander@240: {
dvander@240: }
dvander@240: 
dvander@240: bool CContextTrace::DebugInfoAvailable()
dvander@240: {
dvander@240: 	return ((m_pStart->ctx->flags & SP_FLAG_DEBUG) == SP_FLAG_DEBUG);
dvander@240: }
dvander@240: 
dvander@240: const char *CContextTrace::GetCustomErrorString()
dvander@240: {
dvander@240: 	return m_pMsg;
dvander@240: }
dvander@240: 
dvander@240: int CContextTrace::GetErrorCode()
dvander@240: {
dvander@240: 	return m_Error;
dvander@240: }
dvander@240: 
dvander@240: const char *CContextTrace::GetErrorString()
dvander@240: {
dvander@240: 	if (m_Error > ERROR_MESSAGE_MAX || 
dvander@240: 		m_Error < 1)
dvander@240: 	{
dvander@240: 		return "Invalid error code";
dvander@240: 	} else {
dvander@240: 		return g_ErrorMsgTable[m_Error];
dvander@240: 	}
dvander@240: }
dvander@240: 
dvander@240: void CContextTrace::ResetTrace()
dvander@240: {
dvander@240: 	m_pIterator = m_pStart;
dvander@240: }
dvander@240: 
dvander@240: bool CContextTrace::GetTraceInfo(CallStackInfo *trace)
dvander@240: {
dvander@246: 	if (!m_pIterator || (m_pIterator->chain != m_pStart->chain))
dvander@240: 	{
dvander@240: 		return false;
dvander@240: 	}
dvander@240: 
dvander@240: 	if (m_pIterator->cip == INVALID_CIP)
dvander@240: 	{
dvander@240: 		return false;
dvander@240: 	}
dvander@240: 
dvander@240: 	IPluginContext *pContext = m_pIterator->ctx->context;
dvander@240: 	IPluginDebugInfo *pInfo = pContext->GetDebugInfo();
dvander@240: 
dvander@240: 	if (!pInfo)
dvander@240: 	{
dvander@240: 		return false;
dvander@240: 	}
dvander@240: 
dvander@240: 	if (!trace)
dvander@240: 	{
dvander@246: 		m_pIterator = m_pIterator->next;
dvander@240: 		return true;
dvander@240: 	}
dvander@240: 
dvander@240: 	if (pInfo->LookupFile(m_pIterator->cip, &(trace->filename)) != SP_ERROR_NONE)
dvander@240: 	{
dvander@240: 		trace->filename = NULL;
dvander@240: 	}
dvander@240: 
dvander@240: 	if (pInfo->LookupFunction(m_pIterator->cip, &(trace->function)) != SP_ERROR_NONE)
dvander@240: 	{
dvander@240: 		trace->function = NULL;
dvander@240: 	}
dvander@240: 
dvander@240: 	if (pInfo->LookupLine(m_pIterator->cip, &(trace->line)) != SP_ERROR_NONE)
dvander@240: 	{
dvander@240: 		trace->line = 0;
dvander@240: 	}
dvander@240: 
dvander@246: 	m_pIterator = m_pIterator->next;
dvander@246: 
dvander@240: 	return true;
dvander@240: }
dvander@246: 
dvander@246: const char *CContextTrace::GetLastNative(uint32_t *index)
dvander@246: {
dvander@246: 	if (m_Native == INVALID_CIP)
dvander@246: 	{
dvander@246: 		return NULL;
dvander@246: 	}
dvander@246: 
dvander@246: 	sp_native_t *native;
dvander@246: 	if (m_pIterator->ctx->context->GetNativeByIndex(m_Native, &native) != SP_ERROR_NONE)
dvander@246: 	{
dvander@246: 		return NULL;
dvander@246: 	}
dvander@246: 
dvander@246: 	if (index)
dvander@246: 	{
dvander@246: 		*index = m_Native;
dvander@246: 	}
dvander@246: 
dvander@246: 	return native->name;
dvander@246: }