dvander@2168: /**
dvander@2168:  * vim: set ts=4 :
dvander@2168:  * =============================================================================
dvander@2168:  * SourceMod
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 "DebugReporter.h"
dvander@2168: #include "Logger.h"
dvander@2168: #include "PluginSys.h"
dvander@2168: #include "sm_stringutil.h"
dvander@2168: 
dvander@2168: DebugReport g_DbgReporter;
dvander@2168: 
dvander@2168: /* I'm really lazy.  This should probably be exported to ISourcePawnEngine someday,
dvander@2168:  * but we need to make sure the JIT will deal with the version bump.
dvander@2168:  */
dvander@2168: extern const char *GetSourcePawnErrorMessage(int error);
dvander@2168: 
dvander@2168: void DebugReport::OnSourceModAllInitialized()
dvander@2168: {
dvander@2168: 	g_pSourcePawn->SetDebugListener(this);
dvander@2168: }
dvander@2168: 
dvander@2168: void DebugReport::GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...)
dvander@2168: {
dvander@2168: 	va_list ap;
dvander@2168: 	char buffer[512];
dvander@2168: 
dvander@2168: 	va_start(ap, message);
dvander@2168: 	UTIL_FormatArgs(buffer, sizeof(buffer), message, ap);
dvander@2168: 	va_end(ap);
dvander@2168: 
dvander@2168: 	const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@2168: 	const char *error = GetSourcePawnErrorMessage(err);
dvander@2168: 
dvander@2168: 	if (error)
dvander@2168: 	{
dvander@2168: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
dvander@2168: 	} else {
dvander@2168: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	g_Logger.LogError("[SM] %s", buffer);
dvander@2168: 
dvander@2168: 	if (func_idx != -1)
dvander@2168: 	{
dvander@2168: 		if (func_idx & 1)
dvander@2168: 		{
dvander@2168: 			func_idx >>= 1;
dvander@2168: 			sp_public_t *function;
dvander@2168: 			if (ctx->GetPublicByIndex(func_idx, &function) == SP_ERROR_NONE)
dvander@2168: 			{
dvander@2168: 				g_Logger.LogError("[SM] Unable to call function \"%s\" due to above error(s).", function->name);
dvander@2168: 			}
dvander@2168: 		}
dvander@2168: 	}
dvander@2168: }
dvander@2168: 
dvander@2168: void DebugReport::GenerateCodeError(IPluginContext *pContext, uint32_t code_addr, int err, const char *message, ...)
dvander@2168: {
dvander@2168: 	va_list ap;
dvander@2168: 	char buffer[512];
dvander@2168: 
dvander@2168: 	va_start(ap, message);
dvander@2168: 	UTIL_FormatArgs(buffer, sizeof(buffer), message, ap);
dvander@2168: 	va_end(ap);
dvander@2168: 
dvander@2168: 	const char *plname = g_PluginSys.FindPluginByContext(pContext->GetContext())->GetFilename();
dvander@2168: 	const char *error = GetSourcePawnErrorMessage(err);
dvander@2168: 
dvander@2168: 	if (error)
dvander@2168: 	{
dvander@2168: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
dvander@2168: 	} else {
dvander@2168: 		g_Logger.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	g_Logger.LogError("[SM] %s", buffer);
dvander@2168: 
dvander@2168: 	IPluginDebugInfo *pDebug;
dvander@2168: 	if ((pDebug = pContext->GetDebugInfo()) == NULL)
dvander@2168: 	{
dvander@2168: 		g_Logger.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
dvander@2168: 		g_Logger.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
dvander@2168: 			_GetPluginIndex(pContext));
dvander@2168: 		return;
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	const char *name;
dvander@2168: 	if (pDebug->LookupFunction(code_addr, &name) == SP_ERROR_NONE)
dvander@2168: 	{
dvander@2168: 		g_Logger.LogError("[SM] Unable to call function \"%s\" due to above error(s).", name);
dvander@2168: 	} else {
dvander@2168: 		g_Logger.LogError("[SM] Unable to call function (name unknown, address \"%x\").", code_addr);
dvander@2168: 	}
dvander@2168: }
dvander@2168: 
dvander@2168: void DebugReport::OnContextExecuteError(IPluginContext *ctx, IContextTrace *error)
dvander@2168: {
dvander@2168: 	const char *lastname;
dvander@2168: 	const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@2168: 	int n_err = error->GetErrorCode();
dvander@2168: 
dvander@2168: 	if (n_err != SP_ERROR_NATIVE)
dvander@2168: 	{
dvander@2168: 		g_Logger.LogError("[SM] Plugin encountered error %d: %s",
dvander@2168: 			n_err,
dvander@2168: 			error->GetErrorString());
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	if ((lastname=error->GetLastNative(NULL)) != NULL)
dvander@2168: 	{
dvander@2168: 		const char *custerr;
dvander@2168: 		if ((custerr=error->GetCustomErrorString()) != NULL)
dvander@2168: 		{
dvander@2168: 			g_Logger.LogError("[SM] Native \"%s\" reported: %s", lastname, custerr);
dvander@2168: 		} else {
dvander@2168: 			g_Logger.LogError("[SM] Native \"%s\" encountered a generic error.", lastname);
dvander@2168: 		}
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	if (!error->DebugInfoAvailable())
dvander@2168: 	{
dvander@2168: 		g_Logger.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
dvander@2168: 		g_Logger.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
dvander@2168: 			_GetPluginIndex(ctx));
dvander@2168: 		return;
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	CallStackInfo stk_info;
dvander@2168: 	int i = 0;
dvander@2168: 	g_Logger.LogError("[SM] Displaying call stack trace for plugin \"%s\":", plname);
dvander@2168: 	while (error->GetTraceInfo(&stk_info))
dvander@2168: 	{
dvander@2168: 		g_Logger.LogError("[SM]   [%d]  Line %d, %s::%s()",
dvander@2168: 			i++,
dvander@2168: 			stk_info.line,
dvander@2168: 			stk_info.filename,
dvander@2168: 			stk_info.function);
dvander@2168: 	}
dvander@2168: }
dvander@2168: 
dvander@2168: int DebugReport::_GetPluginIndex(IPluginContext *ctx)
dvander@2168: {
dvander@2168: 	int id = 1;
dvander@2168: 	IPluginIterator *iter = g_PluginSys.GetPluginIterator();
dvander@2168: 
dvander@2168: 	for (; iter->MorePlugins(); iter->NextPlugin(), id++)
dvander@2168: 	{
dvander@2168: 		IPlugin *pl = iter->GetPlugin();
dvander@2168: 		if (pl->GetBaseContext() == ctx)
dvander@2168: 		{
dvander@2168: 			iter->Release();
dvander@2168: 			return id;
dvander@2168: 		}
dvander@2168: 	}
dvander@2168: 
dvander@2168: 	iter->Release();
dvander@2168: 
dvander@2168: 	/* If we don't know which plugin this is, it's one being loaded.  Fake its index for now. */
dvander@2168: 
dvander@2168: 	return g_PluginSys.GetPluginCount() + 1;
dvander@2168: }
dvander@2168: