dvander@592: /**
ds@653:  * vim: set ts=4 :
ds@1330:  * =============================================================================
dvander@1231:  * SourceMod
ds@1947:  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330:  * =============================================================================
dvander@592:  *
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@592:  *
dvander@592:  * Version: $Id$
dvander@592:  */
dvander@592: 
dvander@592: #include "DebugReporter.h"
dvander@592: #include "Logger.h"
dvander@592: #include "PluginSys.h"
dvander@1269: #include "sm_stringutil.h"
dvander@592: 
dvander@616: DebugReport g_DbgReporter;
dvander@592: 
dvander@616: void DebugReport::OnSourceModAllInitialized()
dvander@592: {
dvander@592: 	g_pSourcePawn->SetDebugListener(this);
dvander@592: }
dvander@592: 
dvander@2226: void DebugReport::OnDebugSpew(const char *msg, ...)
dvander@2226: {
dvander@2226: 	va_list ap;
dvander@2226: 	char buffer[512];
dvander@2226: 
dvander@2226: 	va_start(ap, msg);
dvander@2226: 	UTIL_FormatArgs(buffer, sizeof(buffer), msg, ap);
dvander@2226: 	va_end(ap);
dvander@2226: 
dvander@2226: 	g_Logger.LogMessage("[SM] %s", buffer);
dvander@2226: }
dvander@2226: 
dvander@1269: void DebugReport::GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...)
dvander@1269: {
dvander@1269: 	va_list ap;
dvander@1269: 
dvander@1269: 	va_start(ap, message);
dvander@2989: 	GenerateErrorVA(ctx, func_idx, err, message, ap);
dvander@2989: 	va_end(ap);
dvander@2989: }
dvander@2989: 
dvander@2989: void DebugReport::GenerateErrorVA(IPluginContext *ctx, cell_t func_idx, int err, const char *message, va_list ap)
dvander@2989: {
dvander@2989: 	char buffer[512];
dvander@1269: 	UTIL_FormatArgs(buffer, sizeof(buffer), message, ap);
dvander@1269: 
dvander@1269: 	const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@2193: 	const char *error = g_pSourcePawn2->GetErrorString(err);
dvander@1269: 
dvander@1269: 	if (error)
dvander@1269: 	{
dvander@1269: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
dvander@1269: 	} else {
dvander@1269: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
dvander@1269: 	}
dvander@1269: 
dvander@1269: 	g_Logger.LogError("[SM] %s", buffer);
dvander@1269: 
dvander@1269: 	if (func_idx != -1)
dvander@1269: 	{
dvander@1269: 		if (func_idx & 1)
dvander@1269: 		{
dvander@1269: 			func_idx >>= 1;
dvander@1269: 			sp_public_t *function;
dvander@2195: 			if (ctx->GetRuntime()->GetPublicByIndex(func_idx, &function) == SP_ERROR_NONE)
dvander@1269: 			{
dvander@1339: 				g_Logger.LogError("[SM] Unable to call function \"%s\" due to above error(s).", function->name);
dvander@1269: 			}
dvander@1269: 		}
dvander@1269: 	}
dvander@1269: }
dvander@1269: 
dvander@1339: void DebugReport::GenerateCodeError(IPluginContext *pContext, uint32_t code_addr, int err, const char *message, ...)
dvander@1339: {
dvander@1339: 	va_list ap;
dvander@1339: 	char buffer[512];
dvander@1339: 
dvander@1339: 	va_start(ap, message);
dvander@1339: 	UTIL_FormatArgs(buffer, sizeof(buffer), message, ap);
dvander@1339: 	va_end(ap);
dvander@1339: 
dvander@1339: 	const char *plname = g_PluginSys.FindPluginByContext(pContext->GetContext())->GetFilename();
dvander@2193: 	const char *error = g_pSourcePawn2->GetErrorString(err);
dvander@1339: 
dvander@1339: 	if (error)
dvander@1339: 	{
dvander@1339: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
dvander@1339: 	} else {
dvander@1339: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
dvander@1339: 	}
dvander@1339: 
dvander@1339: 	g_Logger.LogError("[SM] %s", buffer);
dvander@1339: 
dvander@1339: 	IPluginDebugInfo *pDebug;
dvander@2195: 	if ((pDebug = pContext->GetRuntime()->GetDebugInfo()) == NULL)
dvander@1339: 	{
dvander@1339: 		g_Logger.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
dvander@1339: 		g_Logger.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
dvander@1339: 			_GetPluginIndex(pContext));
dvander@1339: 		return;
dvander@1339: 	}
dvander@1339: 
dvander@1339: 	const char *name;
dvander@1339: 	if (pDebug->LookupFunction(code_addr, &name) == SP_ERROR_NONE)
dvander@1339: 	{
dvander@1339: 		g_Logger.LogError("[SM] Unable to call function \"%s\" due to above error(s).", name);
dvander@1339: 	} else {
dvander@1339: 		g_Logger.LogError("[SM] Unable to call function (name unknown, address \"%x\").", code_addr);
dvander@1339: 	}
dvander@1339: }
dvander@1339: 
dvander@616: void DebugReport::OnContextExecuteError(IPluginContext *ctx, IContextTrace *error)
dvander@592: {
dvander@592: 	const char *lastname;
dvander@592: 	const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@592: 	int n_err = error->GetErrorCode();
dvander@592: 
dvander@592: 	if (n_err != SP_ERROR_NATIVE)
dvander@592: 	{
dvander@1036: 		g_Logger.LogError("[SM] Plugin encountered error %d: %s",
dvander@592: 			n_err,
dvander@592: 			error->GetErrorString());
dvander@592: 	}
dvander@592: 
dvander@592: 	if ((lastname=error->GetLastNative(NULL)) != NULL)
dvander@592: 	{
dvander@592: 		const char *custerr;
dvander@592: 		if ((custerr=error->GetCustomErrorString()) != NULL)
dvander@592: 		{
dvander@592: 			g_Logger.LogError("[SM] Native \"%s\" reported: %s", lastname, custerr);
dvander@592: 		} else {
dvander@592: 			g_Logger.LogError("[SM] Native \"%s\" encountered a generic error.", lastname);
dvander@592: 		}
dvander@592: 	}
dvander@592: 
dvander@592: 	if (!error->DebugInfoAvailable())
dvander@592: 	{
dvander@1036: 		g_Logger.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
dvander@592: 		g_Logger.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
dvander@592: 			_GetPluginIndex(ctx));
dvander@592: 		return;
dvander@592: 	}
dvander@592: 
dvander@592: 	CallStackInfo stk_info;
dvander@592: 	int i = 0;
dvander@1340: 	g_Logger.LogError("[SM] Displaying call stack trace for plugin \"%s\":", plname);
dvander@592: 	while (error->GetTraceInfo(&stk_info))
dvander@592: 	{
dvander@592: 		g_Logger.LogError("[SM]   [%d]  Line %d, %s::%s()",
dvander@592: 			i++,
dvander@592: 			stk_info.line,
dvander@592: 			stk_info.filename,
dvander@592: 			stk_info.function);
dvander@592: 	}
dvander@592: }
dvander@592: 
dvander@616: int DebugReport::_GetPluginIndex(IPluginContext *ctx)
dvander@592: {
dvander@592: 	int id = 1;
dvander@592: 	IPluginIterator *iter = g_PluginSys.GetPluginIterator();
dvander@592: 
dvander@592: 	for (; iter->MorePlugins(); iter->NextPlugin(), id++)
dvander@592: 	{
dvander@592: 		IPlugin *pl = iter->GetPlugin();
dvander@592: 		if (pl->GetBaseContext() == ctx)
dvander@592: 		{
dvander@592: 			iter->Release();
dvander@592: 			return id;
dvander@592: 		}
dvander@592: 	}
dvander@592: 
dvander@592: 	iter->Release();
dvander@2061: 
dvander@2061: 	/* If we don't know which plugin this is, it's one being loaded.  Fake its index for now. */
dvander@2061: 
dvander@2061: 	return g_PluginSys.GetPluginCount() + 1;
dvander@592: }
dvander@592: