core/logic/DebugReporter.cpp
author David Anderson <dvander@alliedmods.net>
Sat Feb 16 15:57:00 2013 -0800 (2013-02-16)
changeset 3792 d8a07e40bcb6
parent 2989 core/DebugReporter.cpp@e8b0605226ce
child 3796 746d8f1b081f
permissions -rw-r--r--
Move DebugReporter from core to logic (bug 5607, r=psychonic).
dvander@592
     1
/**
ds@653
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1231
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
dvander@592
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
dvander@1231
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1231
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1231
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
dvander@592
    28
 *
dvander@592
    29
 * Version: $Id$
dvander@592
    30
 */
dvander@592
    31
dvander@3792
    32
#include <IPluginSys.h>
dvander@592
    33
#include "DebugReporter.h"
dvander@592
    34
dvander@616
    35
DebugReport g_DbgReporter;
dvander@592
    36
dvander@616
    37
void DebugReport::OnSourceModAllInitialized()
dvander@592
    38
{
dvander@592
    39
	g_pSourcePawn->SetDebugListener(this);
dvander@592
    40
}
dvander@592
    41
dvander@2226
    42
void DebugReport::OnDebugSpew(const char *msg, ...)
dvander@2226
    43
{
dvander@2226
    44
	va_list ap;
dvander@2226
    45
	char buffer[512];
dvander@2226
    46
dvander@2226
    47
	va_start(ap, msg);
dvander@3792
    48
	smcore.FormatArgs(buffer, sizeof(buffer), msg, ap);
dvander@2226
    49
	va_end(ap);
dvander@2226
    50
dvander@3792
    51
	smcore.Log("[SM] %s", buffer);
dvander@2226
    52
}
dvander@2226
    53
dvander@1269
    54
void DebugReport::GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...)
dvander@1269
    55
{
dvander@1269
    56
	va_list ap;
dvander@1269
    57
dvander@1269
    58
	va_start(ap, message);
dvander@2989
    59
	GenerateErrorVA(ctx, func_idx, err, message, ap);
dvander@2989
    60
	va_end(ap);
dvander@2989
    61
}
dvander@2989
    62
dvander@2989
    63
void DebugReport::GenerateErrorVA(IPluginContext *ctx, cell_t func_idx, int err, const char *message, va_list ap)
dvander@2989
    64
{
dvander@2989
    65
	char buffer[512];
dvander@3792
    66
	smcore.FormatArgs(buffer, sizeof(buffer), message, ap);
dvander@1269
    67
dvander@3792
    68
	const char *plname = pluginsys->FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@2193
    69
	const char *error = g_pSourcePawn2->GetErrorString(err);
dvander@1269
    70
dvander@1269
    71
	if (error)
dvander@1269
    72
	{
dvander@3792
    73
		smcore.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
dvander@1269
    74
	} else {
dvander@3792
    75
		smcore.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
dvander@1269
    76
	}
dvander@1269
    77
dvander@3792
    78
	smcore.LogError("[SM] %s", buffer);
dvander@1269
    79
dvander@1269
    80
	if (func_idx != -1)
dvander@1269
    81
	{
dvander@1269
    82
		if (func_idx & 1)
dvander@1269
    83
		{
dvander@1269
    84
			func_idx >>= 1;
dvander@1269
    85
			sp_public_t *function;
dvander@2195
    86
			if (ctx->GetRuntime()->GetPublicByIndex(func_idx, &function) == SP_ERROR_NONE)
dvander@1269
    87
			{
dvander@3792
    88
				smcore.LogError("[SM] Unable to call function \"%s\" due to above error(s).", function->name);
dvander@1269
    89
			}
dvander@1269
    90
		}
dvander@1269
    91
	}
dvander@1269
    92
}
dvander@1269
    93
dvander@1339
    94
void DebugReport::GenerateCodeError(IPluginContext *pContext, uint32_t code_addr, int err, const char *message, ...)
dvander@1339
    95
{
dvander@1339
    96
	va_list ap;
dvander@1339
    97
	char buffer[512];
dvander@1339
    98
dvander@1339
    99
	va_start(ap, message);
dvander@3792
   100
	smcore.FormatArgs(buffer, sizeof(buffer), message, ap);
dvander@1339
   101
	va_end(ap);
dvander@1339
   102
dvander@3792
   103
	const char *plname = pluginsys->FindPluginByContext(pContext->GetContext())->GetFilename();
dvander@2193
   104
	const char *error = g_pSourcePawn2->GetErrorString(err);
dvander@1339
   105
dvander@1339
   106
	if (error)
dvander@1339
   107
	{
dvander@3792
   108
		smcore.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error);
dvander@1339
   109
	} else {
dvander@3792
   110
		smcore.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err);
dvander@1339
   111
	}
dvander@1339
   112
dvander@3792
   113
	smcore.LogError("[SM] %s", buffer);
dvander@1339
   114
dvander@1339
   115
	IPluginDebugInfo *pDebug;
dvander@2195
   116
	if ((pDebug = pContext->GetRuntime()->GetDebugInfo()) == NULL)
dvander@1339
   117
	{
dvander@3792
   118
		smcore.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
dvander@3792
   119
		smcore.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
dvander@1339
   120
			_GetPluginIndex(pContext));
dvander@1339
   121
		return;
dvander@1339
   122
	}
dvander@1339
   123
dvander@1339
   124
	const char *name;
dvander@1339
   125
	if (pDebug->LookupFunction(code_addr, &name) == SP_ERROR_NONE)
dvander@1339
   126
	{
dvander@3792
   127
		smcore.LogError("[SM] Unable to call function \"%s\" due to above error(s).", name);
dvander@1339
   128
	} else {
dvander@3792
   129
		smcore.LogError("[SM] Unable to call function (name unknown, address \"%x\").", code_addr);
dvander@1339
   130
	}
dvander@1339
   131
}
dvander@1339
   132
dvander@616
   133
void DebugReport::OnContextExecuteError(IPluginContext *ctx, IContextTrace *error)
dvander@592
   134
{
dvander@592
   135
	const char *lastname;
dvander@3792
   136
	const char *plname = pluginsys->FindPluginByContext(ctx->GetContext())->GetFilename();
dvander@592
   137
	int n_err = error->GetErrorCode();
dvander@592
   138
dvander@592
   139
	if (n_err != SP_ERROR_NATIVE)
dvander@592
   140
	{
dvander@3792
   141
		smcore.LogError("[SM] Plugin encountered error %d: %s",
dvander@592
   142
			n_err,
dvander@592
   143
			error->GetErrorString());
dvander@592
   144
	}
dvander@592
   145
dvander@592
   146
	if ((lastname=error->GetLastNative(NULL)) != NULL)
dvander@592
   147
	{
dvander@592
   148
		const char *custerr;
dvander@592
   149
		if ((custerr=error->GetCustomErrorString()) != NULL)
dvander@592
   150
		{
dvander@3792
   151
			smcore.LogError("[SM] Native \"%s\" reported: %s", lastname, custerr);
dvander@592
   152
		} else {
dvander@3792
   153
			smcore.LogError("[SM] Native \"%s\" encountered a generic error.", lastname);
dvander@592
   154
		}
dvander@592
   155
	}
dvander@592
   156
dvander@592
   157
	if (!error->DebugInfoAvailable())
dvander@592
   158
	{
dvander@3792
   159
		smcore.LogError("[SM] Debug mode is not enabled for \"%s\"", plname);
dvander@3792
   160
		smcore.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on",
dvander@592
   161
			_GetPluginIndex(ctx));
dvander@592
   162
		return;
dvander@592
   163
	}
dvander@592
   164
dvander@592
   165
	CallStackInfo stk_info;
dvander@592
   166
	int i = 0;
dvander@3792
   167
	smcore.LogError("[SM] Displaying call stack trace for plugin \"%s\":", plname);
dvander@592
   168
	while (error->GetTraceInfo(&stk_info))
dvander@592
   169
	{
dvander@3792
   170
		smcore.LogError("[SM]   [%d]  Line %d, %s::%s()",
dvander@592
   171
			i++,
dvander@592
   172
			stk_info.line,
dvander@592
   173
			stk_info.filename,
dvander@592
   174
			stk_info.function);
dvander@592
   175
	}
dvander@592
   176
}
dvander@592
   177
dvander@616
   178
int DebugReport::_GetPluginIndex(IPluginContext *ctx)
dvander@592
   179
{
dvander@592
   180
	int id = 1;
dvander@3792
   181
	IPluginIterator *iter = pluginsys->GetPluginIterator();
dvander@592
   182
dvander@592
   183
	for (; iter->MorePlugins(); iter->NextPlugin(), id++)
dvander@592
   184
	{
dvander@592
   185
		IPlugin *pl = iter->GetPlugin();
dvander@592
   186
		if (pl->GetBaseContext() == ctx)
dvander@592
   187
		{
dvander@592
   188
			iter->Release();
dvander@592
   189
			return id;
dvander@592
   190
		}
dvander@592
   191
	}
dvander@592
   192
dvander@592
   193
	iter->Release();
dvander@2061
   194
dvander@2061
   195
	/* If we don't know which plugin this is, it's one being loaded.  Fake its index for now. */
dvander@2061
   196
dvander@3792
   197
	return pluginsys->GetPluginCount() + 1;
dvander@592
   198
}
dvander@592
   199