Uh oh!
There was an error while loading. Please reload this page.
forked from ruby/ruby
- Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathdebug.c
More file actions
Latest commit
511 lines (457 loc) · 13.9 KB
/
Copy pathdebug.c
File metadata and controls
511 lines (457 loc) · 13.9 KB
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
/**********************************************************************
debug.c -
$Author$
created at: 04/08/25 02:31:54 JST
Copyright (C) 2004-2007 Koichi Sasada
**********************************************************************/
#include"ruby/internal/config.h"
#include<stdio.h>
#include"eval_intern.h"
#include"id.h"
#include"internal/signal.h"
#include"internal/util.h"
#include"ruby/encoding.h"
#include"ruby/io.h"
#include"ruby/ruby.h"
#include"ruby/util.h"
#include"symbol.h"
#include"vm_core.h"
#include"vm_debug.h"
#include"vm_callinfo.h"
#include"ruby/thread_native.h"
#include"ractor_core.h"
/* This is the only place struct RIMemo is actually used */
structRIMemo {
VALUEflags;
VALUEv0;
VALUEv1;
VALUEv2;
VALUEv3;
};
/* for gdb */
constunion {
enumruby_special_constsspecial_consts;
enumruby_value_typevalue_type;
enumruby_tag_typetag_type;
enumnode_typenode_type;
enumruby_method_idsmethod_ids;
enumruby_id_typesid_types;
enumruby_fl_typefl_types;
enumruby_fl_ushiftfl_ushift;
enumruby_encoding_constsencoding_consts;
enumruby_coderange_typeenc_coderange_types;
enumruby_econv_flag_typeeconv_flag_types;
rb_econv_result_teconv_result;
enumruby_robject_flagsrobject_flags;
enumruby_robject_constsrobject_consts;
enumruby_rmodule_flagsrmodule_flags;
enumruby_rstring_flagsrstring_flags;
enumruby_rstring_constsrstring_consts;
enumruby_rarray_flagsrarray_flags;
enumruby_rarray_constsrarray_consts;
enum {
RUBY_FMODE_READABLE=FMODE_READABLE,
RUBY_FMODE_WRITABLE=FMODE_WRITABLE,
RUBY_FMODE_READWRITE=FMODE_READWRITE,
RUBY_FMODE_BINMODE=FMODE_BINMODE,
RUBY_FMODE_SYNC=FMODE_SYNC,
RUBY_FMODE_TTY=FMODE_TTY,
RUBY_FMODE_DUPLEX=FMODE_DUPLEX,
RUBY_FMODE_APPEND=FMODE_APPEND,
RUBY_FMODE_CREATE=FMODE_CREATE,
RUBY_FMODE_NOREVLOOKUP=0x00000100,
RUBY_FMODE_TRUNC=FMODE_TRUNC,
RUBY_FMODE_TEXTMODE=FMODE_TEXTMODE,
RUBY_FMODE_PREP=0x00010000,
RUBY_FMODE_SETENC_BY_BOM=FMODE_SETENC_BY_BOM,
RUBY_FMODE_UNIX=0x00200000,
RUBY_FMODE_INET=0x00400000,
RUBY_FMODE_INET6=0x00800000,
RUBY_NODE_TYPESHIFT=NODE_TYPESHIFT,
RUBY_NODE_TYPEMASK=NODE_TYPEMASK,
RUBY_NODE_LSHIFT=NODE_LSHIFT,
RUBY_NODE_FL_NEWLINE=NODE_FL_NEWLINE
} various;
union {
enumimemo_typetypes;
enum {RUBY_IMEMO_MASK=IMEMO_MASK} mask;
structRIMemo*ptr;
} imemo;
structRSymbol*symbol_ptr;
enumvm_call_flag_bitsvm_call_flags;
} ruby_dummy_gdb_enums;
constSIGNED_VALUERUBY_NODE_LMASK=NODE_LMASK;
int
ruby_debug_print_indent(intlevel, intdebug_level, intindent_level)
{
if (level<debug_level) {
fprintf(stderr, "%*s", indent_level, "");
fflush(stderr);
return TRUE;
}
return FALSE;
}
void
ruby_debug_printf(constchar*format, ...)
{
va_listap;
va_start(ap, format);
vfprintf(stderr, format, ap);
va_end(ap);
}
#include"gc.h"
VALUE
ruby_debug_print_value(intlevel, intdebug_level, constchar*header, VALUEobj)
{
if (level<debug_level) {
charbuff[0x100];
rb_raw_obj_info(buff, 0x100, obj);
fprintf(stderr, "DBG> %s: %s\n", header, buff);
fflush(stderr);
}
returnobj;
}
void
ruby_debug_print_v(VALUEv)
{
ruby_debug_print_value(0, 1, "", v);
}
ID
ruby_debug_print_id(intlevel, intdebug_level, constchar*header, IDid)
{
if (level<debug_level) {
fprintf(stderr, "DBG> %s: %s\n", header, rb_id2name(id));
fflush(stderr);
}
returnid;
}
NODE*
ruby_debug_print_node(intlevel, intdebug_level, constchar*header, constNODE*node)
{
if (level<debug_level) {
fprintf(stderr, "DBG> %s: %s (%u)\n", header,
ruby_node_name(nd_type(node)), nd_line(node));
}
return (NODE*)node;
}
void
ruby_debug_breakpoint(void)
{
/* */
}
#if defined _WIN32
# ifRUBY_MSVCRT_VERSION >= 80
externintruby_w32_rtc_error;
# endif
#endif
#if defined _WIN32|| defined __CYGWIN__
#include<windows.h>
UINTruby_w32_codepage[2];
#endif
externintruby_rgengc_debug;
externintruby_on_ci;
int
ruby_env_debug_option(constchar*str, intlen, void*arg)
{
intov;
size_tretlen;
unsigned longn;
#defineSET_WHEN(name, var, val) do { \
if (len == sizeof(name) - 1 && \
strncmp(str, (name), len) == 0) { \
(var) = (val); \
return 1; \
} \
} while (0)
#defineNAME_MATCH_VALUE(name) \
((size_t)len >= sizeof(name)-1 && \
strncmp(str, (name), sizeof(name)-1) == 0 && \
((len == sizeof(name)-1 && !(len = 0)) || \
(str[sizeof(name)-1] == '=' && \
(str += sizeof(name), len -= sizeof(name), 1))))
#defineSET_UINT(val) do { \
n = ruby_scan_digits(str, len, 10, &retlen, &ov); \
if (!ov && retlen) { \
val = (unsigned int)n; \
} \
str += retlen; \
len -= retlen; \
} while (0)
#defineSET_UINT_LIST(name, vals, num) do { \
int i; \
for (i = 0; i < (num); ++i) { \
SET_UINT((vals)[i]); \
if (!len || *str != ':') break; \
++str; \
--len; \
} \
if (len > 0) { \
fprintf(stderr, "ignored "name" option: `%.*s'\n", len, str); \
} \
} while (0)
#defineSET_WHEN_UINT(name, vals, num, req) \
if (NAME_MATCH_VALUE(name)) SET_UINT_LIST(name, vals, num);
SET_WHEN("gc_stress", *ruby_initial_gc_stress_ptr, Qtrue);
SET_WHEN("core", ruby_enable_coredump, 1);
SET_WHEN("ci", ruby_on_ci, 1);
if (NAME_MATCH_VALUE("rgengc")) {
if (!len) ruby_rgengc_debug=1;
elseSET_UINT_LIST("rgengc", &ruby_rgengc_debug, 1);
return1;
}
#if defined _WIN32
# ifRUBY_MSVCRT_VERSION >= 80
SET_WHEN("rtc_error", ruby_w32_rtc_error, 1);
# endif
#endif
#if defined _WIN32|| defined __CYGWIN__
if (NAME_MATCH_VALUE("codepage")) {
if (!len) fprintf(stderr, "missing codepage argument");
elseSET_UINT_LIST("codepage", ruby_w32_codepage, numberof(ruby_w32_codepage));
return1;
}
#endif
return0;
}
staticvoid
set_debug_option(constchar*str, intlen, void*arg)
{
if (!ruby_env_debug_option(str, len, arg)) {
fprintf(stderr, "unexpected debug option: %.*s\n", len, str);
}
}
#ifdefUSE_RUBY_DEBUG_LOG
STATIC_ASSERT(USE_RUBY_DEBUG_LOG, USE_RUBY_DEBUG_LOG ? RUBY_DEVEL : 1);
#endif
#ifRUBY_DEVEL
staticvoidsetup_debug_log(void);
#else
#definesetup_debug_log()
#endif
void
ruby_set_debug_option(constchar*str)
{
ruby_each_words(str, set_debug_option, 0);
setup_debug_log();
}
#ifRUBY_DEVEL
// RUBY_DEBUG_LOG features
// See vm_debug.h comments for details.
#defineMAX_DEBUG_LOG 0x1000
#defineMAX_DEBUG_LOG_MESSAGE_LEN 0x0200
#defineMAX_DEBUG_LOG_FILTER 0x0010
enumruby_debug_log_moderuby_debug_log_mode;
staticstruct {
char*mem;
unsigned intcnt;
charfilters[MAX_DEBUG_LOG_FILTER][MAX_DEBUG_LOG_FILTER];
unsigned intfilters_num;
rb_nativethread_lock_tlock;
FILE*output;
} debug_log;
staticchar*
RUBY_DEBUG_LOG_MEM_ENTRY(unsigned intindex)
{
return&debug_log.mem[MAX_DEBUG_LOG_MESSAGE_LEN*index];
}
staticvoid
setup_debug_log(void)
{
// check RUBY_DEBUG_LOG
constchar*log_config=getenv("RUBY_DEBUG_LOG");
if (log_config) {
fprintf(stderr, "RUBY_DEBUG_LOG=%s\n", log_config);
if (strcmp(log_config, "mem") ==0) {
debug_log.mem= (char*)malloc(MAX_DEBUG_LOG*MAX_DEBUG_LOG_MESSAGE_LEN);
if (debug_log.mem==NULL) {
fprintf(stderr, "setup_debug_log failed (can't allocate memory)\n");
exit(1);
}
ruby_debug_log_mode |= ruby_debug_log_memory;
}
elseif (strcmp(log_config, "stderr") ==0) {
ruby_debug_log_mode |= ruby_debug_log_stderr;
}
else {
ruby_debug_log_mode |= ruby_debug_log_file;
if ((debug_log.output=fopen(log_config, "w")) ==NULL) {
fprintf(stderr, "can not open %s for RUBY_DEBUG_LOG\n", log_config);
exit(1);
}
setvbuf(debug_log.output, NULL, _IONBF, 0);
}
rb_nativethread_lock_initialize(&debug_log.lock);
}
// check RUBY_DEBUG_LOG_FILTER
constchar*filter_config=getenv("RUBY_DEBUG_LOG_FILTER");
if (filter_config&&strlen(filter_config) >0) {
unsigned inti;
for (i=0; i<MAX_DEBUG_LOG_FILTER; i++) {
constchar*p;
if ((p=strchr(filter_config, ',')) ==NULL) {
if (strlen(filter_config) >= MAX_DEBUG_LOG_FILTER) {
fprintf(stderr, "too long: %s (max:%d)\n", filter_config, MAX_DEBUG_LOG_FILTER);
exit(1);
}
strncpy(debug_log.filters[i], filter_config, MAX_DEBUG_LOG_FILTER-1);
i++;
break;
}
else {
size_tn=p-filter_config;
if (n >= MAX_DEBUG_LOG_FILTER) {
fprintf(stderr, "too long: %s (max:%d)\n", filter_config, MAX_DEBUG_LOG_FILTER);
exit(1);
}
strncpy(debug_log.filters[i], filter_config, n);
filter_config=p+1;
}
}
debug_log.filters_num=i;
for (i=0; i<debug_log.filters_num; i++) {
fprintf(stderr, "RUBY_DEBUG_LOG_FILTER[%d]=%s\n", i, debug_log.filters[i]);
}
}
}
bool
ruby_debug_log_filter(constchar*func_name)
{
if (debug_log.filters_num>0) {
for (unsigned inti=0; i<debug_log.filters_num; i++) {
if (strstr(func_name, debug_log.filters[i]) !=NULL) {
return true;
}
}
return false;
}
else {
return true;
}
}
staticconstchar*
pretty_filename(constchar*path)
{
// basename is one idea.
constchar*s;
while ((s=strchr(path, '/')) !=NULL) {
path=s+1;
}
returnpath;
}
void
ruby_debug_log(constchar*file, intline, constchar*func_name, constchar*fmt, ...)
{
charbuff[MAX_DEBUG_LOG_MESSAGE_LEN] = {0};
intlen=0;
intr=0;
// message title
if (func_name&&len<MAX_DEBUG_LOG_MESSAGE_LEN) {
r=snprintf(buff+len, MAX_DEBUG_LOG_MESSAGE_LEN, "%s\t", func_name);
if (r<0) rb_bug("ruby_debug_log returns %d\n", r);
len+=r;
}
// message
if (fmt&&len<MAX_DEBUG_LOG_MESSAGE_LEN) {
va_listargs;
va_start(args, fmt);
r=vsnprintf(buff+len, MAX_DEBUG_LOG_MESSAGE_LEN-len, fmt, args);
va_end(args);
if (r<0) rb_bug("ruby_debug_log vsnprintf() returns %d", r);
len+=r;
}
// optional information
// C location
if (file&&len<MAX_DEBUG_LOG_MESSAGE_LEN) {
r=snprintf(buff+len, MAX_DEBUG_LOG_MESSAGE_LEN, "\t%s:%d", pretty_filename(file), line);
if (r<0) rb_bug("ruby_debug_log returns %d\n", r);
len+=r;
}
// Ruby location
intruby_line;
constchar*ruby_file=rb_source_location_cstr(&ruby_line);
if (len<MAX_DEBUG_LOG_MESSAGE_LEN) {
if (ruby_file) {
r=snprintf(buff+len, MAX_DEBUG_LOG_MESSAGE_LEN-len, "\t%s:%d", pretty_filename(ruby_file), ruby_line);
}
else {
r=snprintf(buff+len, MAX_DEBUG_LOG_MESSAGE_LEN-len, "\t");
}
if (r<0) rb_bug("ruby_debug_log returns %d\n", r);
len+=r;
}
// ractor information
if (ruby_single_main_ractor==NULL) {
rb_ractor_t*cr=GET_RACTOR();
if (r&&len<MAX_DEBUG_LOG_MESSAGE_LEN) {
r=snprintf(buff+len, MAX_DEBUG_LOG_MESSAGE_LEN-len, "\tr:#%u/%u",
(unsigned int)rb_ractor_id(cr), GET_VM()->ractor.cnt);
if (r<0) rb_bug("ruby_debug_log returns %d\n", r);
len+=r;
}
}
// thread information
if (!rb_thread_alone()) {
constrb_thread_t*th=GET_THREAD();
if (r&&len<MAX_DEBUG_LOG_MESSAGE_LEN) {
r=snprintf(buff+len, MAX_DEBUG_LOG_MESSAGE_LEN-len, "\tth:%p", (void*)th);
if (r<0) rb_bug("ruby_debug_log returns %d\n", r);
len+=r;
}
}
rb_nativethread_lock_lock(&debug_log.lock);
{
unsigned intcnt=debug_log.cnt++;
if (ruby_debug_log_mode&ruby_debug_log_memory) {
unsigned intindex=cnt % MAX_DEBUG_LOG;
char*dst=RUBY_DEBUG_LOG_MEM_ENTRY(index);
strncpy(dst, buff, MAX_DEBUG_LOG_MESSAGE_LEN);
}
if (ruby_debug_log_mode&ruby_debug_log_stderr) {
fprintf(stderr, "%4u: %s\n", cnt, buff);
}
if (ruby_debug_log_mode&ruby_debug_log_file) {
fprintf(debug_log.output, "%u\t%s\n", cnt, buff);
}
}
rb_nativethread_lock_unlock(&debug_log.lock);
}
// for debugger
staticvoid
debug_log_dump(FILE*out, unsigned intn)
{
if (ruby_debug_log_mode&ruby_debug_log_memory) {
unsigned intsize=debug_log.cnt>MAX_DEBUG_LOG ? MAX_DEBUG_LOG : debug_log.cnt;
unsigned intcurrent_index=debug_log.cnt % MAX_DEBUG_LOG;
if (n==0) n=size;
if (n>size) n=size;
for (unsigned inti=0; i<n; i++) {
intindex=current_index-size+i;
if (index<0) index+=MAX_DEBUG_LOG;
VM_ASSERT(index <= MAX_DEBUG_LOG);
constchar*mesg=RUBY_DEBUG_LOG_MEM_ENTRY(index);;
fprintf(out, "%4u: %s\n", debug_log.cnt-size+i, mesg);
}
}
else {
fprintf(stderr, "RUBY_DEBUG_LOG=mem is not specified.");
}
}
// for debuggers
void
ruby_debug_log_print(unsigned intn)
{
debug_log_dump(stderr, n);
}
void
ruby_debug_log_dump(constchar*fname, unsigned intn)
{
FILE*fp=fopen(fname, "w");
if (fp==NULL) {
fprintf(stderr, "can't open %s. give up.\n", fname);
}
else {
debug_log_dump(fp, n);
fclose(fp);
}
}
#endif// #if RUBY_DEVEL