1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
// SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
// SPDX-FileCopyrightText: 2008 litl, LLC
#include <errno.h>
#include <stdarg.h>
#include <stdio.h> // for FILE, fprintf, fflush, fopen, fputs, fseek
#include <string.h> // for strchr, strcmp
#ifdef _WIN32
# include <io.h>
# include <process.h>
# ifndef F_OK
# define F_OK 0
# endif
#else
# include <unistd.h> // for getpid
#endif
#include "util/log.h"
#include "util/misc.h"
/* prefix is allowed if it's in the ;-delimited environment variable
* GJS_DEBUG_TOPICS or if that variable is not set.
*/
static bool
is_allowed_prefix (const char *prefix)
{
static const char *topics = NULL;
static char **prefixes = NULL;
bool found = false;
int i;
if (topics == NULL) {
topics = g_getenv("GJS_DEBUG_TOPICS");
if (!topics)
return true;
/* We never really free this, should be gone when the process exits */
prefixes = g_strsplit(topics, ";", -1);
}
if (!prefixes)
return true;
for (i = 0; prefixes[i] != NULL; i++) {
if (!strcmp(prefixes[i], prefix)) {
found = true;
break;
}
}
return found;
}
#define PREFIX_LENGTH 12
static void
write_to_stream(FILE *logfp,
const char *prefix,
const char *s)
{
/* seek to end to avoid truncating in case we're using shared logfile */
(void)fseek(logfp, 0, SEEK_END);
fprintf(logfp, "%*s: %s", PREFIX_LENGTH, prefix, s);
if (!g_str_has_suffix(s, "\n"))
fputs("\n", logfp);
fflush(logfp);
}
void
gjs_debug(GjsDebugTopic topic,
const char *format,
...)
{
static FILE *logfp = NULL;
static bool debug_log_enabled = false;
static bool checked_for_timestamp = false;
static bool print_timestamp = false;
static bool checked_for_thread = false;
static bool print_thread = false;
static GTimer *timer = NULL;
const char *prefix;
va_list args;
char *s;
if (!checked_for_timestamp) {
print_timestamp = gjs_environment_variable_is_set("GJS_DEBUG_TIMESTAMP");
checked_for_timestamp = true;
}
if (!checked_for_thread) {
print_thread = gjs_environment_variable_is_set("GJS_DEBUG_THREAD");
checked_for_thread = true;
}
if (print_timestamp && !timer) {
timer = g_timer_new();
}
if (logfp == NULL) {
const char *debug_output = g_getenv("GJS_DEBUG_OUTPUT");
if (debug_output != NULL &&
strcmp(debug_output, "stderr") == 0) {
debug_log_enabled = true;
} else if (debug_output != NULL) {
const char *log_file;
char *free_me;
char *c;
/* Allow debug-%u.log for per-pid logfiles as otherwise log
* messages from multiple processes can overwrite each other.
*
* (printf below should be safe as we check '%u' is the only format
* string)
*/
c = strchr((char *) debug_output, '%');
if (c && c[1] == 'u' && !strchr(c+1, '%')) {
#if defined(__clang__) || __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
_Pragma("GCC diagnostic push")
_Pragma("GCC diagnostic ignored \"-Wformat-nonliteral\"")
#endif
free_me = g_strdup_printf(debug_output, (guint)getpid());
#if defined(__clang__) || __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
_Pragma("GCC diagnostic pop")
#endif
log_file = free_me;
} else {
log_file = debug_output;
free_me = NULL;
}
/* avoid truncating in case we're using shared logfile */
logfp = fopen(log_file, "a");
if (!logfp)
fprintf(stderr, "Failed to open log file `%s': %s\n",
log_file, g_strerror(errno));
g_free(free_me);
debug_log_enabled = true;
}
if (logfp == NULL)
logfp = stderr;
}
if (!debug_log_enabled)
return;
switch (topic) {
case GJS_DEBUG_GI_USAGE:
prefix = "JS GI USE";
break;
case GJS_DEBUG_MEMORY:
prefix = "JS MEMORY";
break;
case GJS_DEBUG_CONTEXT:
prefix = "JS CTX";
break;
case GJS_DEBUG_IMPORTER:
prefix = "JS IMPORT";
break;
case GJS_DEBUG_NATIVE:
prefix = "JS NATIVE";
break;
case GJS_DEBUG_KEEP_ALIVE:
prefix = "JS KP ALV";
break;
case GJS_DEBUG_GREPO:
prefix = "JS G REPO";
break;
case GJS_DEBUG_GNAMESPACE:
prefix = "JS G NS";
break;
case GJS_DEBUG_GOBJECT:
prefix = "JS G OBJ";
break;
case GJS_DEBUG_GFUNCTION:
prefix = "JS G FUNC";
break;
case GJS_DEBUG_GFUNDAMENTAL:
prefix = "JS G FNDMTL";
break;
case GJS_DEBUG_GCLOSURE:
prefix = "JS G CLSR";
break;
case GJS_DEBUG_GBOXED:
prefix = "JS G BXD";
break;
case GJS_DEBUG_GENUM:
prefix = "JS G ENUM";
break;
case GJS_DEBUG_GPARAM:
prefix = "JS G PRM";
break;
case GJS_DEBUG_GERROR:
prefix = "JS G ERR";
break;
case GJS_DEBUG_GINTERFACE:
prefix = "JS G IFACE";
break;
case GJS_DEBUG_GTYPE:
prefix = "JS GTYPE";
break;
default:
prefix = "???";
break;
}
if (!is_allowed_prefix(prefix))
return;
va_start (args, format);
s = g_strdup_vprintf (format, args);
va_end (args);
if (print_timestamp) {
static gdouble previous = 0.0;
gdouble total = g_timer_elapsed(timer, NULL) * 1000.0;
gdouble since = total - previous;
const char *ts_suffix;
char *s2;
if (since > 50.0) {
ts_suffix = "!! ";
} else if (since > 100.0) {
ts_suffix = "!!! ";
} else if (since > 200.0) {
ts_suffix = "!!!!";
} else {
ts_suffix = " ";
}
s2 = g_strdup_printf("%g %s%s",
total, ts_suffix, s);
g_free(s);
s = s2;
previous = total;
}
if (print_thread) {
char *s2 = g_strdup_printf("(thread %p) %s", g_thread_self(), s);
g_free(s);
s = s2;
}
write_to_stream(logfp, prefix, s);
g_free(s);
}
|
