core/vm/sp_vm_engine.h
changeset 1952 b7aa2b626807
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/core/vm/sp_vm_engine.h	Sun Mar 30 07:00:22 2008 +0000
     1.3 @@ -0,0 +1,120 @@
     1.4 +/**
     1.5 + * vim: set ts=4 :
     1.6 + * =============================================================================
     1.7 + * SourcePawn
     1.8 + * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     1.9 + * =============================================================================
    1.10 + *
    1.11 + * This program is free software; you can redistribute it and/or modify it under
    1.12 + * the terms of the GNU General Public License, version 3.0, as published by the
    1.13 + * Free Software Foundation.
    1.14 + * 
    1.15 + * This program is distributed in the hope that it will be useful, but WITHOUT
    1.16 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    1.17 + * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    1.18 + * details.
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License along with
    1.21 + * this program.  If not, see <http://www.gnu.org/licenses/>.
    1.22 + *
    1.23 + * As a special exception, AlliedModders LLC gives you permission to link the
    1.24 + * code of this program (as well as its derivative works) to "Half-Life 2," the
    1.25 + * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    1.26 + * by the Valve Corporation.  You must obey the GNU General Public License in
    1.27 + * all respects for all other code used.  Additionally, AlliedModders LLC grants
    1.28 + * this exception to all derivative works.  AlliedModders LLC defines further
    1.29 + * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    1.30 + * or <http://www.sourcemod.net/license.php>.
    1.31 + *
    1.32 + * Version: $Id$
    1.33 + */
    1.34 +
    1.35 +#ifndef _INCLUDE_SOURCEPAWN_VM_ENGINE_H_
    1.36 +#define _INCLUDE_SOURCEPAWN_VM_ENGINE_H_
    1.37 +
    1.38 +#include "sp_vm_api.h"
    1.39 +#include "sp_vm_function.h"
    1.40 +
    1.41 +struct TracedCall
    1.42 +{
    1.43 +	uint32_t cip;
    1.44 +	uint32_t frm;
    1.45 +	sp_context_t *ctx;
    1.46 +	TracedCall *next;
    1.47 +	unsigned int chain;
    1.48 +};
    1.49 +
    1.50 +class CContextTrace : public IContextTrace
    1.51 +{
    1.52 +public:
    1.53 +	CContextTrace(TracedCall *pStart, int error, const char *msg, uint32_t native);
    1.54 +public:
    1.55 +	int GetErrorCode();
    1.56 +	const char *GetErrorString();
    1.57 +	bool DebugInfoAvailable();
    1.58 +	const char *GetCustomErrorString();
    1.59 +	bool GetTraceInfo(CallStackInfo *trace);
    1.60 +	void ResetTrace();
    1.61 +	const char *GetLastNative(uint32_t *index);
    1.62 +private:
    1.63 +	int m_Error;
    1.64 +	const char *m_pMsg;
    1.65 +	TracedCall *m_pStart;
    1.66 +	TracedCall *m_pIterator;
    1.67 +	uint32_t m_Native;
    1.68 +};
    1.69 +
    1.70 +class SourcePawnEngine : public ISourcePawnEngine
    1.71 +{
    1.72 +public:
    1.73 +	SourcePawnEngine();
    1.74 +	~SourcePawnEngine();
    1.75 +public: //ISourcePawnEngine
    1.76 +	sp_plugin_t *LoadFromFilePointer(FILE *fp, int *err);
    1.77 +	sp_plugin_t *LoadFromMemory(void *base, sp_plugin_t *plugin, int *err);
    1.78 +	int FreeFromMemory(sp_plugin_t *plugin);
    1.79 +	IPluginContext *CreateBaseContext(sp_context_t *ctx);
    1.80 +	void FreeBaseContext(IPluginContext *ctx);
    1.81 +	void *BaseAlloc(size_t size);
    1.82 +	void BaseFree(void *memory);
    1.83 +	void *ExecAlloc(size_t size);
    1.84 +	void ExecFree(void *address);
    1.85 +	IDebugListener *SetDebugListener(IDebugListener *pListener);
    1.86 +	unsigned int GetContextCallCount();
    1.87 +	unsigned int GetEngineAPIVersion();
    1.88 +	void *AllocatePageMemory(size_t size);
    1.89 +	void SetReadWrite(void *ptr);
    1.90 +	void SetReadExecute(void *ptr);
    1.91 +	void FreePageMemory(void *ptr);
    1.92 +public: //Debugger Stuff
    1.93 +	/**
    1.94 +	 * @brief Pushes a context onto the top of the call tracer.
    1.95 +	 * 
    1.96 +	 * @param ctx		Plugin context.
    1.97 +	 */
    1.98 +	void PushTracer(sp_context_t *ctx);
    1.99 +
   1.100 +	/**
   1.101 +	 * @brief Pops a plugin off the call tracer.
   1.102 +	 */
   1.103 +	void PopTracer(int error, const char *msg);
   1.104 +
   1.105 +	/**
   1.106 +	 * @brief Runs tracer from a debug break.
   1.107 +	 */
   1.108 +	void RunTracer(sp_context_t *ctx, uint32_t frame, uint32_t codeip);
   1.109 +public: //Plugin function stuff
   1.110 +	CFunction *GetFunctionFromPool(funcid_t f, IPluginContext  *plugin);
   1.111 +	void ReleaseFunctionToPool(CFunction *func);
   1.112 +private:
   1.113 +	TracedCall *MakeTracedCall(bool new_chain);
   1.114 +	void FreeTracedCall(TracedCall *pCall);
   1.115 +private:
   1.116 +	IDebugListener *m_pDebugHook;
   1.117 +	TracedCall *m_FreedCalls;
   1.118 +	TracedCall *m_CallStack;
   1.119 +	unsigned int m_CurChain;
   1.120 +	//CFunction *m_pFreeFuncs;
   1.121 +};
   1.122 +
   1.123 +#endif //_INCLUDE_SOURCEPAWN_VM_ENGINE_H_