Move DebugReporter from core to logic (bug 5607, r=psychonic).

--HG--
rename : core/DebugReporter.cpp => core/logic/DebugReporter.cpp
rename : core/DebugReporter.h => core/logic/DebugReporter.h

core/logic/AMBuilder

@@ -49,7 +49,8 @@ files = [
 	'smn_gameconfigs.cpp',
 	'GameConfigs.cpp',
 	'sm_crc32.cpp',
-	'smn_profiler.cpp'
+	'smn_profiler.cpp',
+	'DebugReporter.cpp'
 	]
 if AMBuild.target['platform'] == 'windows':
 	files.append('thread/WinThreads.cpp')

core/logic/DebugReporter.cpp

@@ -0,0 +1,199 @@
+/**
+ * vim: set ts=4 :
+ * =============================================================================
+ * SourceMod
+ * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
+ * =============================================================================
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 3.0, as published by the
+ * Free Software Foundation.
+ * 
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * As a special exception, AlliedModders LLC gives you permission to link the
+ * code of this program (as well as its derivative works) to "Half-Life 2," the
+ * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
+ * by the Valve Corporation.  You must obey the GNU General Public License in
+ * all respects for all other code used.  Additionally, AlliedModders LLC grants
+ * this exception to all derivative works.  AlliedModders LLC defines further
+ * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
+ * or <http://www.sourcemod.net/license.php>.
+ *
+ * Version: $Id$
+ */
+
+#include <IPluginSys.h>
+#include "DebugReporter.h"
+
+DebugReport g_DbgReporter;
+
+void DebugReport::OnSourceModAllInitialized()
+{
+	g_pSourcePawn->SetDebugListener(this);
+}
+
+void DebugReport::OnDebugSpew(const char *msg, ...)
+{
+	va_list ap;
+	char buffer[512];
+
+	va_start(ap, msg);
+	smcore.FormatArgs(buffer, sizeof(buffer), msg, ap);
+	va_end(ap);
+
+	smcore.Log("[SM] %s", buffer);
+}
+
+void DebugReport::GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...)
+{
+	va_list ap;
+
+	va_start(ap, message);
+	GenerateErrorVA(ctx, func_idx, err, message, ap);
+	va_end(ap);
+}
+
+void DebugReport::GenerateErrorVA(IPluginContext *ctx, cell_t func_idx, int err, const char *message, va_list ap)
+{
+	char buffer[512];
+	smcore.FormatArgs(buffer, sizeof(buffer), message, ap);
+
+	const char *plname = pluginsys->FindPluginByContext(ctx->GetContext())->GetFilename();
+	const char *error = g_pSourcePawn2->GetErrorString(err);
+
+	if (error)
+	{
+		smcore.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
+	} else {
+		smcore.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
+	}
+
+	smcore.LogError("[SM] %s", buffer);
+
+	if (func_idx != -1)
+	{
+		if (func_idx & 1)
+		{
+			func_idx >>= 1;
+			sp_public_t *function;
+			if (ctx->GetRuntime()->GetPublicByIndex(func_idx, &function) == SP_ERROR_NONE)
+			{
+				smcore.LogError("[SM] Unable to call function \"%s\" due to above error(s).", function->name);
+			}
+		}
+	}
+}
+
+void DebugReport::GenerateCodeError(IPluginContext *pContext, uint32_t code_addr, int err, const char *message, ...)
+{
+	va_list ap;
+	char buffer[512];
+
+	va_start(ap, message);
+	smcore.FormatArgs(buffer, sizeof(buffer), message, ap);
+	va_end(ap);
+
+	const char *plname = pluginsys->FindPluginByContext(pContext->GetContext())->GetFilename();
+	const char *error = g_pSourcePawn2->GetErrorString(err);
+
+	if (error)
+	{
+		smcore.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
+	} else {
+		smcore.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
+	}
+
+	smcore.LogError("[SM] %s", buffer);
+
+	IPluginDebugInfo *pDebug;
+	if ((pDebug = pContext->GetRuntime()->GetDebugInfo()) == NULL)
+	{
+		smcore.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
+		smcore.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
+			_GetPluginIndex(pContext));
+		return;
+	}
+
+	const char *name;
+	if (pDebug->LookupFunction(code_addr, &name) == SP_ERROR_NONE)
+	{
+		smcore.LogError("[SM] Unable to call function \"%s\" due to above error(s).", name);
+	} else {
+		smcore.LogError("[SM] Unable to call function (name unknown, address \"%x\").", code_addr);
+	}
+}
+
+void DebugReport::OnContextExecuteError(IPluginContext *ctx, IContextTrace *error)
+{
+	const char *lastname;
+	const char *plname = pluginsys->FindPluginByContext(ctx->GetContext())->GetFilename();
+	int n_err = error->GetErrorCode();
+
+	if (n_err != SP_ERROR_NATIVE)
+	{
+		smcore.LogError("[SM] Plugin encountered error %d: %s",
+			n_err,
+			error->GetErrorString());
+	}
+
+	if ((lastname=error->GetLastNative(NULL)) != NULL)
+	{
+		const char *custerr;
+		if ((custerr=error->GetCustomErrorString()) != NULL)
+		{
+			smcore.LogError("[SM] Native \"%s\" reported: %s", lastname, custerr);
+		} else {
+			smcore.LogError("[SM] Native \"%s\" encountered a generic error.", lastname);
+		}
+	}
+
+	if (!error->DebugInfoAvailable())
+	{
+		smcore.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
+		smcore.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
+			_GetPluginIndex(ctx));
+		return;
+	}
+
+	CallStackInfo stk_info;
+	int i = 0;
+	smcore.LogError("[SM] Displaying call stack trace for plugin \"%s\":", plname);
+	while (error->GetTraceInfo(&stk_info))
+	{
+		smcore.LogError("[SM]   [%d]  Line %d, %s::%s()",
+			i++,
+			stk_info.line,
+			stk_info.filename,
+			stk_info.function);
+	}
+}
+
+int DebugReport::_GetPluginIndex(IPluginContext *ctx)
+{
+	int id = 1;
+	IPluginIterator *iter = pluginsys->GetPluginIterator();
+
+	for (; iter->MorePlugins(); iter->NextPlugin(), id++)
+	{
+		IPlugin *pl = iter->GetPlugin();
+		if (pl->GetBaseContext() == ctx)
+		{
+			iter->Release();
+			return id;
+		}
+	}
+
+	iter->Release();
+
+	/* If we don't know which plugin this is, it's one being loaded.  Fake its index for now. */
+
+	return pluginsys->GetPluginCount() + 1;
+}
+

core/logic/DebugReporter.h

@@ -0,0 +1,58 @@
+/**
+ * vim: set ts=4 :
+ * =============================================================================
+ * SourceMod
+ * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
+ * =============================================================================
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 3.0, as published by the
+ * Free Software Foundation.
+ * 
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * As a special exception, AlliedModders LLC gives you permission to link the
+ * code of this program (as well as its derivative works) to "Half-Life 2," the
+ * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
+ * by the Valve Corporation.  You must obey the GNU General Public License in
+ * all respects for all other code used.  Additionally, AlliedModders LLC grants
+ * this exception to all derivative works.  AlliedModders LLC defines further
+ * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
+ * or <http://www.sourcemod.net/license.php>.
+ *
+ * Version: $Id$
+ */
+
+#ifndef _INCLUDE_SOURCEMOD_CDBGREPORTER_H_
+#define _INCLUDE_SOURCEMOD_CDBGREPORTER_H_
+
+#include "sp_vm_api.h"
+#include "common_logic.h"
+
+class DebugReport : 
+	public SMGlobalClass, 
+	public IDebugListener
+{
+public: // SMGlobalClass
+	void OnSourceModAllInitialized();
+public: // IDebugListener
+	void OnContextExecuteError(IPluginContext *ctx, IContextTrace *error);
+	void OnDebugSpew(const char *msg, ...);
+public:
+	void GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...);
+	void GenerateErrorVA(IPluginContext *ctx, cell_t func_idx, int err, const char *message, va_list ap); 
+	void GenerateCodeError(IPluginContext *ctx, uint32_t code_addr, int err, const char *message, ...);
+private:
+	int _GetPluginIndex(IPluginContext *ctx);
+};
+
+extern DebugReport g_DbgReporter;
+
+#endif // _INCLUDE_SOURCEMOD_CDBGREPORTER_H_
+

core/logic/common_logic.cpp

@@ -41,6 +41,7 @@
 #include "ThreadSupport.h"
 #include "Translator.h"
 #include "GameConfigs.h"
+#include "DebugReporter.h"
 
 sm_core_t smcore;
 IHandleSys *handlesys;
@@ -59,6 +60,8 @@ ServerGlobals serverGlobals;
 IPlayerManager *playerhelpers;
 IAdminSystem *adminsys;
 IGameHelpers *gamehelpers;
+ISourcePawnEngine *g_pSourcePawn;
+ISourcePawnEngine2 *g_pSourcePawn2;
 
 static void AddCorePhraseFile(const char *filename)
 {
@@ -73,6 +76,14 @@ static IGameConfig *GetCoreGameConfig()
 // Defined in smn_filesystem.cpp.
 extern bool OnLogPrint(const char *msg);
 
+static void GenerateError(IPluginContext *ctx, cell_t idx, int err, const char *msg, ...)
+{
+	va_list ap;
+	va_start(ap, msg);
+	g_DbgReporter.GenerateErrorVA(ctx, idx, err, msg, ap);
+	va_end(ap);
+}
+
 static sm_logic_t logic =
 {
 	NULL,
@@ -86,7 +97,9 @@ static sm_logic_t logic =
 	UTIL_ReplaceEx,
 	UTIL_DecodeHexString,
 	GetCoreGameConfig,
-	OnLogPrint
+	OnLogPrint,
+	&g_DbgReporter,
+	GenerateError
 };
 
 static void logic_init(const sm_core_t* core, sm_logic_t* _logic)
@@ -110,6 +123,8 @@ static void logic_init(const sm_core_t* core, sm_logic_t* _logic)
 	playerhelpers = core->playerhelpers;
 	adminsys = core->adminsys;
 	gamehelpers = core->gamehelpers;
+	g_pSourcePawn = core->spe1;
+	g_pSourcePawn2 = core->spe2;
 }
 
 PLATFORM_EXTERN_C ITextParsers *get_textparsers()

core/logic/intercom.h

@@ -42,7 +42,7 @@ using namespace SourceMod;
  * Add 1 to the RHS of this expression to bump the intercom file
  * This is to prevent mismatching core/logic binaries
  */
-#define SM_LOGIC_MAGIC		(0x0F47C0DE - 17)
+#define SM_LOGIC_MAGIC		(0x0F47C0DE - 18)
 
 #if defined SM_LOGIC
 class IVEngineServer
@@ -99,6 +99,8 @@ struct sm_core_t
 	IPlayerManager  *playerhelpers;
 	IAdminSystem	*adminsys;
 	IGameHelpers    *gamehelpers;
+	ISourcePawnEngine *spe1;
+	ISourcePawnEngine2 *spe2;
 	/* Functions */
 	void			(*AddNatives)(sp_nativeinfo_t* nlist);
 	ConVar *		(*FindConVar)(const char*);
@@ -111,7 +113,7 @@ struct sm_core_t
 	bool			(*FileExists)(const char *path);
 	const char *	(*GetCvarString)(ConVar*);
 	size_t			(*Format)(char*, size_t, const char*, ...);
-	void			(*GenerateError)(IPluginContext *, cell_t, int, const char *, ...);
+	size_t			(*FormatArgs)(char*, size_t, const char*,va_list ap);
 	bool			(*gnprintf)(char *, size_t, const char *, IPhraseCollection *, void **,
 	                            unsigned int, unsigned int &, size_t *, const char **);
 	size_t			(*atcprintf)(char *, size_t, const char *, IPluginContext *, const cell_t *, int *);
@@ -141,6 +143,8 @@ struct sm_logic_t
 	size_t          (*DecodeHexString)(unsigned char *, size_t, const char *);
 	IGameConfig *   (*GetCoreGameConfig)();
 	bool			(*OnLogPrint)(const char *msg);	// true to supercede
+	IDebugListener   *debugger;
+	void			(*GenerateError)(IPluginContext *, cell_t, int, const char *, ...);
 };
 
 typedef void (*LogicInitFunction)(const sm_core_t *core, sm_logic_t *logic);

core/logic/smn_timers.cpp

@@ -35,6 +35,7 @@
 #include <ITimerSystem.h>
 #include <IPluginSys.h>
 #include <sh_stack.h>
+#include "DebugReporter.h"
 
 using namespace SourceHook;
 
@@ -155,7 +156,7 @@ void TimerNatives::OnTimerEnd(ITimer *pTimer, void *pData)
 	{
 		if ((herr=handlesys->FreeHandle(usrhndl, &sec)) != HandleError_None)
 		{
-			smcore.GenerateError(pInfo->pContext, pInfo->Hook->GetFunctionID(), 
+			g_DbgReporter.GenerateError(pInfo->pContext, pInfo->Hook->GetFunctionID(), 
 							  	 SP_ERROR_NATIVE, 
 							  	 "Invalid data handle %x (error %d) passed during timer end with TIMER_DATA_HNDL_CLOSE",
 							  	 usrhndl, herr);
@@ -166,7 +167,7 @@ void TimerNatives::OnTimerEnd(ITimer *pTimer, void *pData)
 	{
 		if ((herr=handlesys->FreeHandle(pInfo->TimerHandle, &sec)) != HandleError_None)
 		{
-			smcore.GenerateError(pInfo->pContext, pInfo->Hook->GetFunctionID(), 
+			g_DbgReporter.GenerateError(pInfo->pContext, pInfo->Hook->GetFunctionID(), 
 				SP_ERROR_NATIVE, 
 				"Invalid timer handle %x (error %d) during timer end, displayed function is timer callback, not the stack trace", 
 				pInfo->TimerHandle, herr);