|
dvander@592
|
1 |
/** |
|
ds@653
|
2 |
* vim: set ts=4 : |
|
dvander@1231
|
3 |
* ================================================================ |
|
dvander@1231
|
4 |
* SourceMod |
|
dvander@1231
|
5 |
* Copyright (C) 2004-2007 AlliedModders LLC. All rights reserved. |
|
dvander@1231
|
6 |
* ================================================================ |
|
dvander@592
|
7 |
* |
|
dvander@1231
|
8 |
* This program is free software; you can redistribute it and/or |
|
dvander@1231
|
9 |
* modify it under the terms of the GNU General Public License, |
|
dvander@1231
|
10 |
* version 3.0, as published by the Free Software Foundation. |
|
dvander@1231
|
11 |
* |
|
dvander@1231
|
12 |
* This program is distributed in the hope that it will be useful, |
|
dvander@1231
|
13 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
dvander@1231
|
14 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
dvander@1231
|
15 |
* GNU General Public License for more details. |
|
dvander@1231
|
16 |
* |
|
dvander@1231
|
17 |
* You should have received a copy of the GNU General Public License |
|
dvander@1231
|
18 |
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
dvander@1231
|
19 |
* |
|
dvander@1231
|
20 |
* As a special exception, AlliedModders LLC gives you permission to |
|
dvander@1231
|
21 |
* link the code of this program (as well as its derivative works) to |
|
dvander@1231
|
22 |
* "Half-Life 2," the "Source Engine," the "SourcePawn JIT," and any |
|
dvander@1231
|
23 |
* Game MODs that run on software by the Valve Corporation. You must |
|
dvander@1231
|
24 |
* obey the GNU General Public License in all respects for all other |
|
dvander@1231
|
25 |
* code used. Additionally, AlliedModders LLC grants this exception |
|
dvander@1231
|
26 |
* to all derivative works. AlliedModders LLC defines further |
|
dvander@1231
|
27 |
* exceptions, found in LICENSE.txt (as of this writing, version |
|
dvander@1231
|
28 |
* JULY-31-2007), or <http://www.sourcemod.net/license.php>. |
|
dvander@592
|
29 |
* |
|
dvander@592
|
30 |
* Version: $Id$ |
|
dvander@592
|
31 |
*/ |
|
dvander@592
|
32 |
|
|
dvander@592
|
33 |
#include "DebugReporter.h" |
|
dvander@592
|
34 |
#include "Logger.h" |
|
dvander@592
|
35 |
#include "PluginSys.h" |
|
dvander@1269
|
36 |
#include "sm_stringutil.h" |
|
dvander@592
|
37 |
|
|
dvander@616
|
38 |
DebugReport g_DbgReporter; |
|
dvander@592
|
39 |
|
|
dvander@1269
|
40 |
/* I'm really lazy. This should probably be exported to ISourcePawnEngine someday, |
|
dvander@1269
|
41 |
* but we need to make sure the JIT will deal with the version bump. |
|
dvander@1269
|
42 |
*/ |
|
dvander@1269
|
43 |
extern const char *GetSourcePawnErrorMessage(int error); |
|
dvander@1269
|
44 |
|
|
dvander@616
|
45 |
void DebugReport::OnSourceModAllInitialized() |
|
dvander@592
|
46 |
{ |
|
dvander@592
|
47 |
g_pSourcePawn->SetDebugListener(this); |
|
dvander@592
|
48 |
} |
|
dvander@592
|
49 |
|
|
dvander@1269
|
50 |
void DebugReport::GenerateError(IPluginContext *ctx, cell_t func_idx, int err, const char *message, ...) |
|
dvander@1269
|
51 |
{ |
|
dvander@1269
|
52 |
va_list ap; |
|
dvander@1269
|
53 |
char buffer[512]; |
|
dvander@1269
|
54 |
|
|
dvander@1269
|
55 |
va_start(ap, message); |
|
dvander@1269
|
56 |
UTIL_FormatArgs(buffer, sizeof(buffer), message, ap); |
|
dvander@1269
|
57 |
va_end(ap); |
|
dvander@1269
|
58 |
|
|
dvander@1269
|
59 |
const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename(); |
|
dvander@1269
|
60 |
const char *error = GetSourcePawnErrorMessage(err); |
|
dvander@1269
|
61 |
|
|
dvander@1269
|
62 |
if (error) |
|
dvander@1269
|
63 |
{ |
|
dvander@1269
|
64 |
g_Logger.LogError("[SM] Plugin \"%s\" encountered error %d: %s", plname, err, error); |
|
dvander@1269
|
65 |
} else { |
|
dvander@1269
|
66 |
g_Logger.LogError("[SM] Plugin \"%s\" encountered unknown error %d", plname, err); |
|
dvander@1269
|
67 |
} |
|
dvander@1269
|
68 |
|
|
dvander@1269
|
69 |
g_Logger.LogError("[SM] %s", buffer); |
|
dvander@1269
|
70 |
|
|
dvander@1269
|
71 |
if (func_idx != -1) |
|
dvander@1269
|
72 |
{ |
|
dvander@1269
|
73 |
if (func_idx & 1) |
|
dvander@1269
|
74 |
{ |
|
dvander@1269
|
75 |
func_idx >>= 1; |
|
dvander@1269
|
76 |
sp_public_t *function; |
|
dvander@1269
|
77 |
if (ctx->GetPublicByIndex(func_idx, &function) == SP_ERROR_NONE) |
|
dvander@1269
|
78 |
{ |
|
dvander@1269
|
79 |
g_Logger.LogError("[SM] Unable to call function \"%s\" due to above errors.", function->name); |
|
dvander@1269
|
80 |
} |
|
dvander@1269
|
81 |
} |
|
dvander@1269
|
82 |
} |
|
dvander@1269
|
83 |
} |
|
dvander@1269
|
84 |
|
|
dvander@616
|
85 |
void DebugReport::OnContextExecuteError(IPluginContext *ctx, IContextTrace *error) |
|
dvander@592
|
86 |
{ |
|
dvander@592
|
87 |
const char *lastname; |
|
dvander@592
|
88 |
const char *plname = g_PluginSys.FindPluginByContext(ctx->GetContext())->GetFilename(); |
|
dvander@592
|
89 |
int n_err = error->GetErrorCode(); |
|
dvander@592
|
90 |
|
|
dvander@592
|
91 |
if (n_err != SP_ERROR_NATIVE) |
|
dvander@592
|
92 |
{ |
|
dvander@1036
|
93 |
g_Logger.LogError("[SM] Plugin encountered error %d: %s", |
|
dvander@592
|
94 |
n_err, |
|
dvander@592
|
95 |
error->GetErrorString()); |
|
dvander@592
|
96 |
} |
|
dvander@592
|
97 |
|
|
dvander@592
|
98 |
if ((lastname=error->GetLastNative(NULL)) != NULL) |
|
dvander@592
|
99 |
{ |
|
dvander@592
|
100 |
const char *custerr; |
|
dvander@592
|
101 |
if ((custerr=error->GetCustomErrorString()) != NULL) |
|
dvander@592
|
102 |
{ |
|
dvander@592
|
103 |
g_Logger.LogError("[SM] Native \"%s\" reported: %s", lastname, custerr); |
|
dvander@592
|
104 |
} else { |
|
dvander@592
|
105 |
g_Logger.LogError("[SM] Native \"%s\" encountered a generic error.", lastname); |
|
dvander@592
|
106 |
} |
|
dvander@592
|
107 |
} |
|
dvander@592
|
108 |
|
|
dvander@592
|
109 |
if (!error->DebugInfoAvailable()) |
|
dvander@592
|
110 |
{ |
|
dvander@1036
|
111 |
g_Logger.LogError("[SM] Debug mode is not enabled for \"%s\"", plname); |
|
dvander@592
|
112 |
g_Logger.LogError("[SM] To enable debug mode, edit plugin_settings.cfg, or type: sm plugins debug %d on", |
|
dvander@592
|
113 |
_GetPluginIndex(ctx)); |
|
dvander@592
|
114 |
return; |
|
dvander@592
|
115 |
} |
|
dvander@592
|
116 |
|
|
dvander@592
|
117 |
CallStackInfo stk_info; |
|
dvander@592
|
118 |
int i = 0; |
|
dvander@592
|
119 |
g_Logger.LogError("[SM] Displaying call stack trace:"); |
|
dvander@592
|
120 |
while (error->GetTraceInfo(&stk_info)) |
|
dvander@592
|
121 |
{ |
|
dvander@592
|
122 |
g_Logger.LogError("[SM] [%d] Line %d, %s::%s()", |
|
dvander@592
|
123 |
i++, |
|
dvander@592
|
124 |
stk_info.line, |
|
dvander@592
|
125 |
stk_info.filename, |
|
dvander@592
|
126 |
stk_info.function); |
|
dvander@592
|
127 |
} |
|
dvander@592
|
128 |
} |
|
dvander@592
|
129 |
|
|
dvander@616
|
130 |
int DebugReport::_GetPluginIndex(IPluginContext *ctx) |
|
dvander@592
|
131 |
{ |
|
dvander@592
|
132 |
int id = 1; |
|
dvander@592
|
133 |
IPluginIterator *iter = g_PluginSys.GetPluginIterator(); |
|
dvander@592
|
134 |
|
|
dvander@592
|
135 |
for (; iter->MorePlugins(); iter->NextPlugin(), id++) |
|
dvander@592
|
136 |
{ |
|
dvander@592
|
137 |
IPlugin *pl = iter->GetPlugin(); |
|
dvander@592
|
138 |
if (pl->GetBaseContext() == ctx) |
|
dvander@592
|
139 |
{ |
|
dvander@592
|
140 |
iter->Release(); |
|
dvander@592
|
141 |
return id; |
|
dvander@592
|
142 |
} |
|
dvander@592
|
143 |
} |
|
dvander@592
|
144 |
|
|
dvander@592
|
145 |
iter->Release(); |
|
dvander@592
|
146 |
return -1; |
|
dvander@592
|
147 |
} |
|
dvander@592
|
148 |
|