Ruby 3.5.0dev (2025-02-22 revision d6f44535c6482e895483c0c28c9a35bcf5e4fd88)
vm_dump.c (d6f44535c6482e895483c0c28c9a35bcf5e4fd88)
1/**********************************************************************
2
3 vm_dump.c -
4
5 $Author$
6
7 Copyright (C) 2004-2007 Koichi Sasada
8
9**********************************************************************/
10
11#include "ruby/internal/config.h"
12#include "ruby/fiber/scheduler.h"
13
14#ifdef HAVE_UCONTEXT_H
15# include <ucontext.h>
16#endif
17
18#ifdef __APPLE__
19# ifdef HAVE_LIBPROC_H
20# include <libproc.h>
21# endif
22# include <mach/vm_map.h>
23# include <mach/mach_init.h>
24# ifdef __LP64__
25# define vm_region_recurse vm_region_recurse_64
26# endif
27/* that is defined in sys/queue.h, and conflicts with
28 * ccan/list/list.h */
29# undef LIST_HEAD
30#endif
31
32#include "addr2line.h"
33#include "internal.h"
34#include "internal/gc.h"
35#include "internal/variable.h"
36#include "internal/vm.h"
37#include "iseq.h"
38#include "vm_core.h"
39#include "ractor_core.h"
40
41#define MAX_POSBUF 128
42
43#define VM_CFP_CNT(ec, cfp) \
44 ((rb_control_frame_t *)((ec)->vm_stack + (ec)->vm_stack_size) - \
45 (rb_control_frame_t *)(cfp))
46
47const char *rb_method_type_name(rb_method_type_t type);
48int ruby_on_ci;
49
50#define kprintf(...) if (fprintf(errout, __VA_ARGS__) < 0) goto error
51#define kputs(s) if (fputs(s, errout) < 0) goto error
52
53static bool
54control_frame_dump(const rb_execution_context_t *ec, const rb_control_frame_t *cfp, FILE *errout)
55{
56 ptrdiff_t pc = -1;
57 ptrdiff_t ep = cfp->ep - ec->vm_stack;
58 char ep_in_heap = ' ';
59 char posbuf[MAX_POSBUF+1];
60 int line = 0;
61 const char *magic, *iseq_name = "-", *selfstr = "-", *biseq_name = "-";
62 VALUE tmp;
63 const rb_iseq_t *iseq = NULL;
64 const rb_callable_method_entry_t *me = rb_vm_frame_method_entry(cfp);
65
66 if (ep < 0 || (size_t)ep > ec->vm_stack_size) {
67 ep = (ptrdiff_t)cfp->ep;
68 ep_in_heap = 'p';
69 }
70
71 switch (VM_FRAME_TYPE(cfp)) {
72 case VM_FRAME_MAGIC_TOP:
73 magic = "TOP";
74 break;
75 case VM_FRAME_MAGIC_METHOD:
76 magic = "METHOD";
77 break;
78 case VM_FRAME_MAGIC_CLASS:
79 magic = "CLASS";
80 break;
81 case VM_FRAME_MAGIC_BLOCK:
82 magic = "BLOCK";
83 break;
84 case VM_FRAME_MAGIC_CFUNC:
85 magic = "CFUNC";
86 break;
87 case VM_FRAME_MAGIC_IFUNC:
88 magic = "IFUNC";
89 break;
90 case VM_FRAME_MAGIC_EVAL:
91 magic = "EVAL";
92 break;
93 case VM_FRAME_MAGIC_RESCUE:
94 magic = "RESCUE";
95 break;
96 case VM_FRAME_MAGIC_DUMMY:
97 magic = "DUMMY";
98 break;
99 case 0:
100 magic = "------";
101 break;
102 default:
103 magic = "(none)";
104 break;
105 }
106
107 if (0) {
108 tmp = rb_inspect(cfp->self);
109 selfstr = StringValueCStr(tmp);
110 }
111 else {
112 selfstr = "";
113 }
114
115 if (cfp->iseq != 0) {
116#define RUBY_VM_IFUNC_P(ptr) IMEMO_TYPE_P(ptr, imemo_ifunc)
117 if (RUBY_VM_IFUNC_P(cfp->iseq)) {
118 iseq_name = "<ifunc>";
119 }
120 else if (SYMBOL_P((VALUE)cfp->iseq)) {
121 tmp = rb_sym2str((VALUE)cfp->iseq);
122 iseq_name = RSTRING_PTR(tmp);
123 snprintf(posbuf, MAX_POSBUF, ":%s", iseq_name);
124 line = -1;
125 }
126 else {
127 if (cfp->pc) {
128 iseq = cfp->iseq;
129 pc = cfp->pc - ISEQ_BODY(iseq)->iseq_encoded;
130 iseq_name = RSTRING_PTR(ISEQ_BODY(iseq)->location.label);
131 line = rb_vm_get_sourceline(cfp);
132 if (line) {
133 snprintf(posbuf, MAX_POSBUF, "%s:%d", RSTRING_PTR(rb_iseq_path(iseq)), line);
134 }
135 }
136 else {
137 iseq_name = "<dummy_frame>";
138 }
139 }
140 }
141 else if (me != NULL) {
142 iseq_name = rb_id2name(me->def->original_id);
143 snprintf(posbuf, MAX_POSBUF, ":%s", iseq_name);
144 line = -1;
145 }
146
147 kprintf("c:%04"PRIdPTRDIFF" ",
148 ((rb_control_frame_t *)(ec->vm_stack + ec->vm_stack_size) - cfp));
149 if (pc == -1) {
150 kprintf("p:---- ");
151 }
152 else {
153 kprintf("p:%04"PRIdPTRDIFF" ", pc);
154 }
155 kprintf("s:%04"PRIdPTRDIFF" ", cfp->sp - ec->vm_stack);
156 kprintf(ep_in_heap == ' ' ? "e:%06"PRIdPTRDIFF" " : "E:%06"PRIxPTRDIFF" ", ep % 10000);
157 kprintf("%-6s", magic);
158 if (line) {
159 kprintf(" %s", posbuf);
160 }
161 if (VM_FRAME_FINISHED_P(cfp)) {
162 kprintf(" [FINISH]");
163 }
164 if (0) {
165 kprintf(" \t");
166 kprintf("iseq: %-24s ", iseq_name);
167 kprintf("self: %-24s ", selfstr);
168 kprintf("%-1s ", biseq_name);
169 }
170 kprintf("\n");
171
172 // additional information for CI machines
173 if (ruby_on_ci) {
174 char buff[0x100];
175
176 if (me) {
177 if (IMEMO_TYPE_P(me, imemo_ment)) {
178 kprintf(" me:\n");
179 kprintf(" called_id: %s, type: %s\n", rb_id2name(me->called_id), rb_method_type_name(me->def->type));
180 kprintf(" owner class: %s\n", rb_raw_obj_info(buff, 0x100, me->owner));
181 if (me->owner != me->defined_class) {
182 kprintf(" defined_class: %s\n", rb_raw_obj_info(buff, 0x100, me->defined_class));
183 }
184 }
185 else {
186 kprintf(" me is corrupted (%s)\n", rb_raw_obj_info(buff, 0x100, (VALUE)me));
187 }
188 }
189
190 kprintf(" self: %s\n", rb_raw_obj_info(buff, 0x100, cfp->self));
191
192 if (iseq) {
193 if (ISEQ_BODY(iseq)->local_table_size > 0) {
194 kprintf(" lvars:\n");
195 for (unsigned int i=0; i<ISEQ_BODY(iseq)->local_table_size; i++) {
196 const VALUE *argv = cfp->ep - ISEQ_BODY(cfp->iseq)->local_table_size - VM_ENV_DATA_SIZE + 1;
197 kprintf(" %s: %s\n",
198 rb_id2name(ISEQ_BODY(iseq)->local_table[i]),
199 rb_raw_obj_info(buff, 0x100, argv[i]));
200 }
201 }
202 }
203 }
204 return true;
205 error:
206 return false;
207}
208
209bool
210rb_vmdebug_stack_dump_raw(const rb_execution_context_t *ec, const rb_control_frame_t *cfp, FILE *errout)
211{
212#if 0
213 VALUE *sp = cfp->sp;
214 const VALUE *ep = cfp->ep;
215 VALUE *p, *st, *t;
216
217 kprintf("-- stack frame ------------\n");
218 for (p = st = ec->vm_stack; p < sp; p++) {
219 kprintf("%04ld (%p): %08"PRIxVALUE, (long)(p - st), p, *p);
220
221 t = (VALUE *)*p;
222 if (ec->vm_stack <= t && t < sp) {
223 kprintf(" (= %ld)", (long)((VALUE *)GC_GUARDED_PTR_REF((VALUE)t) - ec->vm_stack));
224 }
225
226 if (p == ep)
227 kprintf(" <- ep");
228
229 kprintf("\n");
230 }
231#endif
232
233 kprintf("-- Control frame information "
234 "-----------------------------------------------\n");
235 while ((void *)cfp < (void *)(ec->vm_stack + ec->vm_stack_size)) {
236 control_frame_dump(ec, cfp, errout);
237 cfp++;
238 }
239 kprintf("\n");
240 return true;
241
242 error:
243 return false;
244}
245
246bool
247rb_vmdebug_stack_dump_raw_current(void)
248{
249 const rb_execution_context_t *ec = GET_EC();
250 return rb_vmdebug_stack_dump_raw(ec, ec->cfp, stderr);
251}
252
253bool
254rb_vmdebug_env_dump_raw(const rb_env_t *env, const VALUE *ep, FILE *errout)
255{
256 unsigned int i;
257 kprintf("-- env --------------------\n");
258
259 while (env) {
260 kprintf("--\n");
261 for (i = 0; i < env->env_size; i++) {
262 kprintf("%04d: %08"PRIxVALUE" (%p)", i, env->env[i], (void *)&env->env[i]);
263 if (&env->env[i] == ep) kprintf(" <- ep");
264 kprintf("\n");
265 }
266
267 env = rb_vm_env_prev_env(env);
268 }
269 kprintf("---------------------------\n");
270 return true;
271
272 error:
273 return false;
274}
275
276bool
277rb_vmdebug_proc_dump_raw(rb_proc_t *proc, FILE *errout)
278{
279 const rb_env_t *env;
280 char *selfstr;
281 VALUE val = rb_inspect(vm_block_self(&proc->block));
282 selfstr = StringValueCStr(val);
283
284 kprintf("-- proc -------------------\n");
285 kprintf("self: %s\n", selfstr);
286 env = VM_ENV_ENVVAL_PTR(vm_block_ep(&proc->block));
287 rb_vmdebug_env_dump_raw(env, vm_block_ep(&proc->block), errout);
288 return true;
289
290 error:
291 return false;
292}
293
294bool
295rb_vmdebug_stack_dump_th(VALUE thval, FILE *errout)
296{
297 rb_thread_t *target_th = rb_thread_ptr(thval);
298 return rb_vmdebug_stack_dump_raw(target_th->ec, target_th->ec->cfp, errout);
299}
300
301#if VMDEBUG > 2
302
303/* copy from vm_insnhelper.c */
304static const VALUE *
305vm_base_ptr(const rb_control_frame_t *cfp)
306{
307 const rb_control_frame_t *prev_cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
308 const VALUE *bp = prev_cfp->sp + ISEQ_BODY(cfp->iseq)->local_table_size + VM_ENV_DATA_SIZE;
309
310 if (ISEQ_BODY(cfp->iseq)->type == ISEQ_TYPE_METHOD || VM_FRAME_BMETHOD_P(cfp)) {
311 bp += 1;
312 }
313 return bp;
314}
315
316static void
317vm_stack_dump_each(const rb_execution_context_t *ec, const rb_control_frame_t *cfp, FILE *errout)
318{
319 int i, argc = 0, local_table_size = 0;
320 VALUE rstr;
321 VALUE *sp = cfp->sp;
322 const VALUE *ep = cfp->ep;
323
324 if (VM_FRAME_RUBYFRAME_P(cfp)) {
325 const rb_iseq_t *iseq = cfp->iseq;
326 argc = ISEQ_BODY(iseq)->param.lead_num;
327 local_table_size = ISEQ_BODY(iseq)->local_table_size;
328 }
329
330 /* stack trace header */
331
332 if (VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_METHOD||
333 VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_TOP ||
334 VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_BLOCK ||
335 VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CLASS ||
336 VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_CFUNC ||
337 VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_IFUNC ||
338 VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_EVAL ||
339 VM_FRAME_TYPE(cfp) == VM_FRAME_MAGIC_RESCUE)
340 {
341 const VALUE *ptr = ep - local_table_size;
342
343 control_frame_dump(ec, cfp, errout);
344
345 for (i = 0; i < argc; i++) {
346 rstr = rb_inspect(*ptr);
347 kprintf(" arg %2d: %8s (%p)\n", i, StringValueCStr(rstr),
348 (void *)ptr++);
349 }
350 for (; i < local_table_size - 1; i++) {
351 rstr = rb_inspect(*ptr);
352 kprintf(" local %2d: %8s (%p)\n", i, StringValueCStr(rstr),
353 (void *)ptr++);
354 }
355
356 ptr = vm_base_ptr(cfp);
357 for (; ptr < sp; ptr++, i++) {
358 switch (TYPE(*ptr)) {
359 case T_UNDEF:
360 rstr = rb_str_new2("undef");
361 break;
362 case T_IMEMO:
363 rstr = rb_str_new2("imemo"); /* TODO: can put mode detail information */
364 break;
365 default:
366 rstr = rb_inspect(*ptr);
367 break;
368 }
369 kprintf(" stack %2d: %8s (%"PRIdPTRDIFF")\n", i, StringValueCStr(rstr),
370 (ptr - ec->vm_stack));
371 }
372 }
373 else if (VM_FRAME_FINISHED_P(cfp)) {
374 if (ec->vm_stack + ec->vm_stack_size > (VALUE *)(cfp + 1)) {
375 vm_stack_dump_each(ec, cfp + 1, errout);
376 }
377 else {
378 /* SDR(); */
379 }
380 }
381 else {
382 rb_bug("unsupported frame type: %08lx", VM_FRAME_TYPE(cfp));
383 }
384}
385#endif
386
387bool
388rb_vmdebug_debug_print_register(const rb_execution_context_t *ec, FILE *errout)
389{
390 rb_control_frame_t *cfp = ec->cfp;
391 ptrdiff_t pc = -1;
392 ptrdiff_t ep = cfp->ep - ec->vm_stack;
393 ptrdiff_t cfpi;
394
395 if (VM_FRAME_RUBYFRAME_P(cfp)) {
396 pc = cfp->pc - ISEQ_BODY(cfp->iseq)->iseq_encoded;
397 }
398
399 if (ep < 0 || (size_t)ep > ec->vm_stack_size) {
400 ep = -1;
401 }
402
403 cfpi = ((rb_control_frame_t *)(ec->vm_stack + ec->vm_stack_size)) - cfp;
404 kprintf(" [PC] %04"PRIdPTRDIFF", [SP] %04"PRIdPTRDIFF", [EP] %04"PRIdPTRDIFF", [CFP] %04"PRIdPTRDIFF"\n",
405 pc, (cfp->sp - ec->vm_stack), ep, cfpi);
406 return true;
407
408 error:
409 return false;
410}
411
412bool
413rb_vmdebug_thread_dump_regs(VALUE thval, FILE *errout)
414{
415 return rb_vmdebug_debug_print_register(rb_thread_ptr(thval)->ec, errout);
416}
417
418bool
419rb_vmdebug_debug_print_pre(const rb_execution_context_t *ec, const rb_control_frame_t *cfp, const VALUE *_pc, FILE *errout)
420{
421 const rb_iseq_t *iseq = cfp->iseq;
422
423 if (iseq != 0) {
424 ptrdiff_t pc = _pc - ISEQ_BODY(iseq)->iseq_encoded;
425 int i;
426
427 for (i=0; i<(int)VM_CFP_CNT(ec, cfp); i++) {
428 kprintf(" ");
429 }
430 kprintf("| ");
431 if(0) kprintf("[%03ld] ", (long)(cfp->sp - ec->vm_stack));
432
433 /* printf("%3"PRIdPTRDIFF" ", VM_CFP_CNT(ec, cfp)); */
434 if (pc >= 0) {
435 const VALUE *iseq_original = rb_iseq_original_iseq((rb_iseq_t *)iseq);
436
437 rb_iseq_disasm_insn(0, iseq_original, (size_t)pc, iseq, 0);
438 }
439 }
440
441#if VMDEBUG > 3
442 kprintf(" (1)");
443 rb_vmdebug_debug_print_register(errout, ec);
444#endif
445 return true;
446
447 error:
448 return false;
449}
450
451bool
452rb_vmdebug_debug_print_post(const rb_execution_context_t *ec, const rb_control_frame_t *cfp, FILE *errout)
453{
454#if VMDEBUG > 9
455 if (!rb_vmdebug_stack_dump_raw(ec, cfp, errout)) goto errout;
456#endif
457
458#if VMDEBUG > 3
459 kprintf(" (2)");
460 rb_vmdebug_debug_print_register(errout, ec);
461#endif
462 /* stack_dump_raw(ec, cfp); */
463
464#if VMDEBUG > 2
465 /* stack_dump_thobj(ec); */
466 vm_stack_dump_each(ec, ec->cfp, errout);
467
468 kprintf
469 ("--------------------------------------------------------------\n");
470#endif
471 return true;
472
473#if VMDEBUG > 2
474 error:
475 return false;
476#endif
477}
478
479VALUE
480rb_vmdebug_thread_dump_state(FILE *errout, VALUE self)
481{
482 rb_thread_t *th = rb_thread_ptr(self);
483 rb_control_frame_t *cfp = th->ec->cfp;
484
485 kprintf("Thread state dump:\n");
486 kprintf("pc : %p, sp : %p\n", (void *)cfp->pc, (void *)cfp->sp);
487 kprintf("cfp: %p, ep : %p\n", (void *)cfp, (void *)cfp->ep);
488
489 error:
490 return Qnil;
491}
492
493#if defined __APPLE__
494# include <AvailabilityMacros.h>
495# if defined(MAC_OS_X_VERSION_10_5) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_5
496# define MCTX_SS_REG(reg) __ss.__##reg
497# else
498# define MCTX_SS_REG(reg) ss.reg
499# endif
500#endif
501
502#if defined(HAVE_BACKTRACE)
503# define USE_BACKTRACE 1
504# ifdef HAVE_LIBUNWIND
505# undef backtrace
506# define backtrace unw_backtrace
507# elif defined(__APPLE__) && defined(HAVE_LIBUNWIND_H) \
508 && defined(MAC_OS_X_VERSION_10_6) && MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_6
509# define UNW_LOCAL_ONLY
510# include <libunwind.h>
511# include <sys/mman.h>
512# undef backtrace
513
514static bool
515is_coroutine_start(unw_word_t ip)
516{
517 struct coroutine_context;
518 extern void ruby_coroutine_start(struct coroutine_context *, struct coroutine_context *);
519 return ((void *)(ip) == (void *)ruby_coroutine_start);
520}
521
522int
523backtrace(void **trace, int size)
524{
525 unw_cursor_t cursor; unw_context_t uc;
526 unw_word_t ip;
527 int n = 0;
528
529 unw_getcontext(&uc);
530 unw_init_local(&cursor, &uc);
531# if defined(__x86_64__)
532 while (unw_step(&cursor) > 0) {
533 unw_get_reg(&cursor, UNW_REG_IP, &ip);
534 trace[n++] = (void *)ip;
535 {
536 char buf[256];
537 unw_get_proc_name(&cursor, buf, 256, &ip);
538 if (strncmp("_sigtramp", buf, sizeof("_sigtramp")) == 0) {
539 goto darwin_sigtramp;
540 }
541 }
542 }
543 return n;
544darwin_sigtramp:
545 /* darwin's bundled libunwind doesn't support signal trampoline */
546 {
547 ucontext_t *uctx;
548 char vec[1];
549 int r;
550 /* get previous frame information from %rbx at _sigtramp and set values to cursor
551 * https://www.opensource.apple.com/source/Libc/Libc-825.25/i386/sys/_sigtramp.s
552 * https://www.opensource.apple.com/source/libunwind/libunwind-35.1/src/unw_getcontext.s
553 */
554 unw_get_reg(&cursor, UNW_X86_64_RBX, &ip);
555 uctx = (ucontext_t *)ip;
556 unw_set_reg(&cursor, UNW_X86_64_RAX, uctx->uc_mcontext->MCTX_SS_REG(rax));
557 unw_set_reg(&cursor, UNW_X86_64_RBX, uctx->uc_mcontext->MCTX_SS_REG(rbx));
558 unw_set_reg(&cursor, UNW_X86_64_RCX, uctx->uc_mcontext->MCTX_SS_REG(rcx));
559 unw_set_reg(&cursor, UNW_X86_64_RDX, uctx->uc_mcontext->MCTX_SS_REG(rdx));
560 unw_set_reg(&cursor, UNW_X86_64_RDI, uctx->uc_mcontext->MCTX_SS_REG(rdi));
561 unw_set_reg(&cursor, UNW_X86_64_RSI, uctx->uc_mcontext->MCTX_SS_REG(rsi));
562 unw_set_reg(&cursor, UNW_X86_64_RBP, uctx->uc_mcontext->MCTX_SS_REG(rbp));
563 unw_set_reg(&cursor, UNW_X86_64_RSP, 8+(uctx->uc_mcontext->MCTX_SS_REG(rsp)));
564 unw_set_reg(&cursor, UNW_X86_64_R8, uctx->uc_mcontext->MCTX_SS_REG(r8));
565 unw_set_reg(&cursor, UNW_X86_64_R9, uctx->uc_mcontext->MCTX_SS_REG(r9));
566 unw_set_reg(&cursor, UNW_X86_64_R10, uctx->uc_mcontext->MCTX_SS_REG(r10));
567 unw_set_reg(&cursor, UNW_X86_64_R11, uctx->uc_mcontext->MCTX_SS_REG(r11));
568 unw_set_reg(&cursor, UNW_X86_64_R12, uctx->uc_mcontext->MCTX_SS_REG(r12));
569 unw_set_reg(&cursor, UNW_X86_64_R13, uctx->uc_mcontext->MCTX_SS_REG(r13));
570 unw_set_reg(&cursor, UNW_X86_64_R14, uctx->uc_mcontext->MCTX_SS_REG(r14));
571 unw_set_reg(&cursor, UNW_X86_64_R15, uctx->uc_mcontext->MCTX_SS_REG(r15));
572 ip = uctx->uc_mcontext->MCTX_SS_REG(rip);
573
574 /* There are 4 cases for SEGV:
575 * (1) called invalid address
576 * (2) read or write invalid address
577 * (3) received signal
578 *
579 * Detail:
580 * (1) called invalid address
581 * In this case, saved ip is invalid address.
582 * It needs to just save the address for the information,
583 * skip the frame, and restore the frame calling the
584 * invalid address from %rsp.
585 * The problem is how to check whether the ip is valid or not.
586 * This code uses mincore(2) and assume the address's page is
587 * incore/referenced or not reflects the problem.
588 * Note that High Sierra's mincore(2) may return -128.
589 * (2) read or write invalid address
590 * saved ip is valid. just restart backtracing.
591 * (3) received signal in user space
592 * Same as (2).
593 * (4) received signal in kernel
594 * In this case saved ip points just after syscall, but registers are
595 * already overwritten by kernel. To fix register consistency,
596 * skip libc's kernel wrapper.
597 * To detect this case, just previous two bytes of ip is "\x0f\x05",
598 * syscall instruction of x86_64.
599 */
600 r = mincore((const void *)ip, 1, vec);
601 if (r || vec[0] <= 0 || memcmp((const char *)ip-2, "\x0f\x05", 2) == 0) {
602 /* if segv is caused by invalid call or signal received in syscall */
603 /* the frame is invalid; skip */
604 trace[n++] = (void *)ip;
605 ip = *(unw_word_t*)uctx->uc_mcontext->MCTX_SS_REG(rsp);
606 }
607
608 trace[n++] = (void *)ip;
609 unw_set_reg(&cursor, UNW_REG_IP, ip);
610 }
611 while (unw_step(&cursor) > 0) {
612 unw_get_reg(&cursor, UNW_REG_IP, &ip);
613 trace[n++] = (void *)ip;
614 }
615 return n;
616
617# else /* defined(__arm64__) */
618 /* Since Darwin arm64's _sigtramp is implemented as normal function,
619 * unwind can unwind frames without special code.
620 * https://github.com/apple/darwin-libplatform/blob/215b09856ab5765b7462a91be7076183076600df/src/setjmp/generic/sigtramp.c
621 */
622 while (unw_step(&cursor) > 0) {
623 unw_get_reg(&cursor, UNW_REG_IP, &ip);
624 // Strip Arm64's pointer authentication.
625 // https://developer.apple.com/documentation/security/preparing_your_app_to_work_with_pointer_authentication
626 // I wish I could use "ptrauth_strip()" but I get an error:
627 // "this target does not support pointer authentication"
628 trace[n++] = (void *)(ip & 0x7fffffffffffull);
629
630 // Apple's libunwind can't handle our coroutine switching code
631 if (is_coroutine_start(ip)) break;
632 }
633 return n;
634# endif
635}
636# elif defined(BROKEN_BACKTRACE)
637# undef USE_BACKTRACE
638# define USE_BACKTRACE 0
639# endif
640#else
641# define USE_BACKTRACE 0
642#endif
643
644#if USE_BACKTRACE
645# include <execinfo.h>
646#elif defined(_WIN32)
647# include <imagehlp.h>
648# ifndef SYMOPT_DEBUG
649# define SYMOPT_DEBUG 0x80000000
650# endif
651# ifndef MAX_SYM_NAME
652# define MAX_SYM_NAME 2000
653typedef struct {
654 DWORD64 Offset;
655 WORD Segment;
656 ADDRESS_MODE Mode;
657} ADDRESS64;
658typedef struct {
659 DWORD64 Thread;
660 DWORD ThCallbackStack;
661 DWORD ThCallbackBStore;
662 DWORD NextCallback;
663 DWORD FramePointer;
664 DWORD64 KiCallUserMode;
665 DWORD64 KeUserCallbackDispatcher;
666 DWORD64 SystemRangeStart;
667 DWORD64 KiUserExceptionDispatcher;
668 DWORD64 StackBase;
669 DWORD64 StackLimit;
670 DWORD64 Reserved[5];
671} KDHELP64;
672typedef struct {
673 ADDRESS64 AddrPC;
674 ADDRESS64 AddrReturn;
675 ADDRESS64 AddrFrame;
676 ADDRESS64 AddrStack;
677 ADDRESS64 AddrBStore;
678 void *FuncTableEntry;
679 DWORD64 Params[4];
680 BOOL Far;
681 BOOL Virtual;
682 DWORD64 Reserved[3];
683 KDHELP64 KdHelp;
684} STACKFRAME64;
685typedef struct {
686 ULONG SizeOfStruct;
687 ULONG TypeIndex;
688 ULONG64 Reserved[2];
689 ULONG Index;
690 ULONG Size;
691 ULONG64 ModBase;
692 ULONG Flags;
693 ULONG64 Value;
694 ULONG64 Address;
695 ULONG Register;
696 ULONG Scope;
697 ULONG Tag;
698 ULONG NameLen;
699 ULONG MaxNameLen;
700 char Name[1];
701} SYMBOL_INFO;
702typedef struct {
703 DWORD SizeOfStruct;
704 void *Key;
705 DWORD LineNumber;
706 char *FileName;
707 DWORD64 Address;
708} IMAGEHLP_LINE64;
709typedef void *PREAD_PROCESS_MEMORY_ROUTINE64;
710typedef void *PFUNCTION_TABLE_ACCESS_ROUTINE64;
711typedef void *PGET_MODULE_BASE_ROUTINE64;
712typedef void *PTRANSLATE_ADDRESS_ROUTINE64;
713# endif
714
715struct dump_thead_arg {
716 DWORD tid;
717 FILE *errout;
718};
719
720static void
721dump_thread(void *arg)
722{
723 HANDLE dbghelp;
724 BOOL (WINAPI *pSymInitialize)(HANDLE, const char *, BOOL);
725 BOOL (WINAPI *pSymCleanup)(HANDLE);
726 BOOL (WINAPI *pStackWalk64)(DWORD, HANDLE, HANDLE, STACKFRAME64 *, void *, PREAD_PROCESS_MEMORY_ROUTINE64, PFUNCTION_TABLE_ACCESS_ROUTINE64, PGET_MODULE_BASE_ROUTINE64, PTRANSLATE_ADDRESS_ROUTINE64);
727 DWORD64 (WINAPI *pSymGetModuleBase64)(HANDLE, DWORD64);
728 BOOL (WINAPI *pSymFromAddr)(HANDLE, DWORD64, DWORD64 *, SYMBOL_INFO *);
729 BOOL (WINAPI *pSymGetLineFromAddr64)(HANDLE, DWORD64, DWORD *, IMAGEHLP_LINE64 *);
730 HANDLE (WINAPI *pOpenThread)(DWORD, BOOL, DWORD);
731 DWORD tid = ((struct dump_thead_arg *)arg)->tid;
732 FILE *errout = ((struct dump_thead_arg *)arg)->errout;
733 HANDLE ph;
734 HANDLE th;
735
736 dbghelp = LoadLibrary("dbghelp.dll");
737 if (!dbghelp) return;
738 pSymInitialize = (BOOL (WINAPI *)(HANDLE, const char *, BOOL))GetProcAddress(dbghelp, "SymInitialize");
739 pSymCleanup = (BOOL (WINAPI *)(HANDLE))GetProcAddress(dbghelp, "SymCleanup");
740 pStackWalk64 = (BOOL (WINAPI *)(DWORD, HANDLE, HANDLE, STACKFRAME64 *, void *, PREAD_PROCESS_MEMORY_ROUTINE64, PFUNCTION_TABLE_ACCESS_ROUTINE64, PGET_MODULE_BASE_ROUTINE64, PTRANSLATE_ADDRESS_ROUTINE64))GetProcAddress(dbghelp, "StackWalk64");
741 pSymGetModuleBase64 = (DWORD64 (WINAPI *)(HANDLE, DWORD64))GetProcAddress(dbghelp, "SymGetModuleBase64");
742 pSymFromAddr = (BOOL (WINAPI *)(HANDLE, DWORD64, DWORD64 *, SYMBOL_INFO *))GetProcAddress(dbghelp, "SymFromAddr");
743 pSymGetLineFromAddr64 = (BOOL (WINAPI *)(HANDLE, DWORD64, DWORD *, IMAGEHLP_LINE64 *))GetProcAddress(dbghelp, "SymGetLineFromAddr64");
744 pOpenThread = (HANDLE (WINAPI *)(DWORD, BOOL, DWORD))GetProcAddress(GetModuleHandle("kernel32.dll"), "OpenThread");
745 if (pSymInitialize && pSymCleanup && pStackWalk64 && pSymGetModuleBase64 &&
746 pSymFromAddr && pSymGetLineFromAddr64 && pOpenThread) {
747 SymSetOptions(SYMOPT_UNDNAME | SYMOPT_DEFERRED_LOADS | SYMOPT_DEBUG | SYMOPT_LOAD_LINES);
748 ph = GetCurrentProcess();
749 pSymInitialize(ph, NULL, TRUE);
750 th = pOpenThread(THREAD_SUSPEND_RESUME|THREAD_GET_CONTEXT, FALSE, tid);
751 if (th) {
752 if (SuspendThread(th) != (DWORD)-1) {
753 CONTEXT context;
754 memset(&context, 0, sizeof(context));
755 context.ContextFlags = CONTEXT_FULL;
756 if (GetThreadContext(th, &context)) {
757 char libpath[MAX_PATH];
758 char buf[sizeof(SYMBOL_INFO) + MAX_SYM_NAME];
759 SYMBOL_INFO *info = (SYMBOL_INFO *)buf;
760 DWORD mac;
761 STACKFRAME64 frame;
762 memset(&frame, 0, sizeof(frame));
763#if defined(_M_AMD64) || defined(__x86_64__)
764 mac = IMAGE_FILE_MACHINE_AMD64;
765 frame.AddrPC.Mode = AddrModeFlat;
766 frame.AddrPC.Offset = context.Rip;
767 frame.AddrFrame.Mode = AddrModeFlat;
768 frame.AddrFrame.Offset = context.Rbp;
769 frame.AddrStack.Mode = AddrModeFlat;
770 frame.AddrStack.Offset = context.Rsp;
771#elif defined(_M_ARM64) || defined(__aarch64__)
772 mac = IMAGE_FILE_MACHINE_ARM64;
773 frame.AddrPC.Mode = AddrModeFlat;
774 frame.AddrPC.Offset = context.Pc;
775 frame.AddrFrame.Mode = AddrModeFlat;
776 frame.AddrFrame.Offset = context.Fp;
777 frame.AddrStack.Mode = AddrModeFlat;
778 frame.AddrStack.Offset = context.Sp;
779#else /* i386 */
780 mac = IMAGE_FILE_MACHINE_I386;
781 frame.AddrPC.Mode = AddrModeFlat;
782 frame.AddrPC.Offset = context.Eip;
783 frame.AddrFrame.Mode = AddrModeFlat;
784 frame.AddrFrame.Offset = context.Ebp;
785 frame.AddrStack.Mode = AddrModeFlat;
786 frame.AddrStack.Offset = context.Esp;
787#endif
788
789 while (pStackWalk64(mac, ph, th, &frame, &context, NULL,
790 NULL, NULL, NULL)) {
791 DWORD64 addr = frame.AddrPC.Offset;
792 IMAGEHLP_LINE64 line;
793 DWORD64 displacement;
794 DWORD tmp;
795
796 if (addr == frame.AddrReturn.Offset || addr == 0 ||
797 frame.AddrReturn.Offset == 0)
798 break;
799
800 memset(buf, 0, sizeof(buf));
801 info->SizeOfStruct = sizeof(SYMBOL_INFO);
802 info->MaxNameLen = MAX_SYM_NAME;
803 if (pSymFromAddr(ph, addr, &displacement, info)) {
804 if (GetModuleFileName((HANDLE)(uintptr_t)pSymGetModuleBase64(ph, addr), libpath, sizeof(libpath)))
805 kprintf("%s", libpath);
806 kprintf("(%s+0x%"PRI_64_PREFIX"x)",
807 info->Name, displacement);
808 }
809 kprintf(" [0x%p]", (void *)(VALUE)addr);
810 memset(&line, 0, sizeof(line));
811 line.SizeOfStruct = sizeof(line);
812 if (pSymGetLineFromAddr64(ph, addr, &tmp, &line))
813 kprintf(" %s:%lu", line.FileName, line.LineNumber);
814 kprintf("\n");
815 }
816 }
817
818 error:
819 ResumeThread(th);
820 }
821 CloseHandle(th);
822 }
823 pSymCleanup(ph);
824 }
825 FreeLibrary(dbghelp);
826}
827#endif
828
829void
830rb_print_backtrace(FILE *errout)
831{
832#if USE_BACKTRACE
833#define MAX_NATIVE_TRACE 1024
834 static void *trace[MAX_NATIVE_TRACE];
835 int n = (int)backtrace(trace, MAX_NATIVE_TRACE);
836#if (defined(USE_ELF) || defined(HAVE_MACH_O_LOADER_H)) && defined(HAVE_DLADDR) && !defined(__sparc)
837 rb_dump_backtrace_with_lines(n, trace, errout);
838#else
839 char **syms = backtrace_symbols(trace, n);
840 if (syms) {
841 int i;
842 for (i=0; i<n; i++) {
843 kprintf("%s\n", syms[i]);
844 }
845 free(syms);
846 }
847 error:
848 /* ignore errors at writing */;
849#endif
850#elif defined(_WIN32)
851 struct dump_thead_arg arg = {
852 .tid = GetCurrentThreadId(),
853 .errout = errout,
854 };
855 HANDLE th = (HANDLE)_beginthread(dump_thread, 0, &arg);
856 if (th != (HANDLE)-1)
857 WaitForSingleObject(th, INFINITE);
858#endif
859}
860
861#ifdef HAVE_LIBPROCSTAT
862struct procstat;
863struct kinfo_proc;
864static void procstat_vm(struct procstat *, struct kinfo_proc *, FILE *);
865#include "missing/procstat_vm.c"
866#endif
867
868#if defined __linux__
869# if defined(__x86_64__) || defined(__i386__)
870# define dump_machine_register(reg) (col_count = print_machine_register(errout, mctx->gregs[REG_##reg], #reg, col_count, 80))
871# elif defined(__aarch64__) || defined(__arm__) || defined(__riscv) || defined(__loongarch64)
872# define dump_machine_register(reg, regstr) (col_count = print_machine_register(errout, reg, regstr, col_count, 80))
873# endif
874#elif defined __APPLE__
875# if defined(__aarch64__)
876# define dump_machine_register(reg, regstr) (col_count = print_machine_register(errout, mctx->MCTX_SS_REG(reg), regstr, col_count, 80))
877# else
878# define dump_machine_register(reg) (col_count = print_machine_register(errout, mctx->MCTX_SS_REG(reg), #reg, col_count, 80))
879# endif
880#endif
881
882#ifdef dump_machine_register
883static int
884print_machine_register(FILE *errout, size_t reg, const char *reg_name, int col_count, int max_col)
885{
886 int ret;
887 char buf[64];
888 static const int size_width = sizeof(size_t) * CHAR_BIT / 4;
889
890 ret = snprintf(buf, sizeof(buf), " %3.3s: 0x%.*" PRIxSIZE, reg_name, size_width, reg);
891 if (col_count + ret > max_col) {
892 kputs("\n");
893 col_count = 0;
894 }
895 col_count += ret;
896 kputs(buf);
897 return col_count;
898
899 error:
900 return -1;
901}
902
903static bool
904rb_dump_machine_register(FILE *errout, const ucontext_t *ctx)
905{
906 int col_count = 0;
907 if (!ctx) return true;
908
909 kprintf("-- Machine register context "
910 "------------------------------------------------\n");
911
912# if defined __linux__
913 {
914 const mcontext_t *const mctx = &ctx->uc_mcontext;
915# if defined __x86_64__
916 dump_machine_register(RIP);
917 dump_machine_register(RBP);
918 dump_machine_register(RSP);
919 dump_machine_register(RAX);
920 dump_machine_register(RBX);
921 dump_machine_register(RCX);
922 dump_machine_register(RDX);
923 dump_machine_register(RDI);
924 dump_machine_register(RSI);
925 dump_machine_register(R8);
926 dump_machine_register(R9);
927 dump_machine_register(R10);
928 dump_machine_register(R11);
929 dump_machine_register(R12);
930 dump_machine_register(R13);
931 dump_machine_register(R14);
932 dump_machine_register(R15);
933 dump_machine_register(EFL);
934# elif defined __i386__
935 dump_machine_register(GS);
936 dump_machine_register(FS);
937 dump_machine_register(ES);
938 dump_machine_register(DS);
939 dump_machine_register(EDI);
940 dump_machine_register(ESI);
941 dump_machine_register(EBP);
942 dump_machine_register(ESP);
943 dump_machine_register(EBX);
944 dump_machine_register(EDX);
945 dump_machine_register(ECX);
946 dump_machine_register(EAX);
947 dump_machine_register(TRAPNO);
948 dump_machine_register(ERR);
949 dump_machine_register(EIP);
950 dump_machine_register(CS);
951 dump_machine_register(EFL);
952 dump_machine_register(UESP);
953 dump_machine_register(SS);
954# elif defined __aarch64__
955 dump_machine_register(mctx->regs[0], "x0");
956 dump_machine_register(mctx->regs[1], "x1");
957 dump_machine_register(mctx->regs[2], "x2");
958 dump_machine_register(mctx->regs[3], "x3");
959 dump_machine_register(mctx->regs[4], "x4");
960 dump_machine_register(mctx->regs[5], "x5");
961 dump_machine_register(mctx->regs[6], "x6");
962 dump_machine_register(mctx->regs[7], "x7");
963 dump_machine_register(mctx->regs[18], "x18");
964 dump_machine_register(mctx->regs[19], "x19");
965 dump_machine_register(mctx->regs[20], "x20");
966 dump_machine_register(mctx->regs[21], "x21");
967 dump_machine_register(mctx->regs[22], "x22");
968 dump_machine_register(mctx->regs[23], "x23");
969 dump_machine_register(mctx->regs[24], "x24");
970 dump_machine_register(mctx->regs[25], "x25");
971 dump_machine_register(mctx->regs[26], "x26");
972 dump_machine_register(mctx->regs[27], "x27");
973 dump_machine_register(mctx->regs[28], "x28");
974 dump_machine_register(mctx->regs[29], "x29");
975 dump_machine_register(mctx->sp, "sp");
976 dump_machine_register(mctx->fault_address, "fault_address");
977# elif defined __arm__
978 dump_machine_register(mctx->arm_r0, "r0");
979 dump_machine_register(mctx->arm_r1, "r1");
980 dump_machine_register(mctx->arm_r2, "r2");
981 dump_machine_register(mctx->arm_r3, "r3");
982 dump_machine_register(mctx->arm_r4, "r4");
983 dump_machine_register(mctx->arm_r5, "r5");
984 dump_machine_register(mctx->arm_r6, "r6");
985 dump_machine_register(mctx->arm_r7, "r7");
986 dump_machine_register(mctx->arm_r8, "r8");
987 dump_machine_register(mctx->arm_r9, "r9");
988 dump_machine_register(mctx->arm_r10, "r10");
989 dump_machine_register(mctx->arm_sp, "sp");
990 dump_machine_register(mctx->fault_address, "fault_address");
991# elif defined __riscv
992 dump_machine_register(mctx->__gregs[REG_SP], "sp");
993 dump_machine_register(mctx->__gregs[REG_S0], "s0");
994 dump_machine_register(mctx->__gregs[REG_S1], "s1");
995 dump_machine_register(mctx->__gregs[REG_A0], "a0");
996 dump_machine_register(mctx->__gregs[REG_A0+1], "a1");
997 dump_machine_register(mctx->__gregs[REG_A0+2], "a2");
998 dump_machine_register(mctx->__gregs[REG_A0+3], "a3");
999 dump_machine_register(mctx->__gregs[REG_A0+4], "a4");
1000 dump_machine_register(mctx->__gregs[REG_A0+5], "a5");
1001 dump_machine_register(mctx->__gregs[REG_A0+6], "a6");
1002 dump_machine_register(mctx->__gregs[REG_A0+7], "a7");
1003 dump_machine_register(mctx->__gregs[REG_S2], "s2");
1004 dump_machine_register(mctx->__gregs[REG_S2+1], "s3");
1005 dump_machine_register(mctx->__gregs[REG_S2+2], "s4");
1006 dump_machine_register(mctx->__gregs[REG_S2+3], "s5");
1007 dump_machine_register(mctx->__gregs[REG_S2+4], "s6");
1008 dump_machine_register(mctx->__gregs[REG_S2+5], "s7");
1009 dump_machine_register(mctx->__gregs[REG_S2+6], "s8");
1010 dump_machine_register(mctx->__gregs[REG_S2+7], "s9");
1011 dump_machine_register(mctx->__gregs[REG_S2+8], "s10");
1012 dump_machine_register(mctx->__gregs[REG_S2+9], "s11");
1013# elif defined __loongarch64
1014 dump_machine_register(mctx->__gregs[LARCH_REG_SP], "sp");
1015 dump_machine_register(mctx->__gregs[LARCH_REG_A0], "a0");
1016 dump_machine_register(mctx->__gregs[LARCH_REG_A0+1], "a1");
1017 dump_machine_register(mctx->__gregs[LARCH_REG_A0+2], "a2");
1018 dump_machine_register(mctx->__gregs[LARCH_REG_A0+3], "a3");
1019 dump_machine_register(mctx->__gregs[LARCH_REG_A0+4], "a4");
1020 dump_machine_register(mctx->__gregs[LARCH_REG_A0+5], "a5");
1021 dump_machine_register(mctx->__gregs[LARCH_REG_A0+6], "a6");
1022 dump_machine_register(mctx->__gregs[LARCH_REG_A0+7], "a7");
1023 dump_machine_register(mctx->__gregs[LARCH_REG_A0+8], "fp");
1024 dump_machine_register(mctx->__gregs[LARCH_REG_S0], "s0");
1025 dump_machine_register(mctx->__gregs[LARCH_REG_S1], "s1");
1026 dump_machine_register(mctx->__gregs[LARCH_REG_S2], "s2");
1027 dump_machine_register(mctx->__gregs[LARCH_REG_S0+3], "s3");
1028 dump_machine_register(mctx->__gregs[LARCH_REG_S0+4], "s4");
1029 dump_machine_register(mctx->__gregs[LARCH_REG_S0+5], "s5");
1030 dump_machine_register(mctx->__gregs[LARCH_REG_S0+6], "s6");
1031 dump_machine_register(mctx->__gregs[LARCH_REG_S0+7], "s7");
1032 dump_machine_register(mctx->__gregs[LARCH_REG_S0+8], "s8");
1033# endif
1034 }
1035# elif defined __APPLE__
1036 {
1037 const mcontext_t mctx = ctx->uc_mcontext;
1038# if defined __x86_64__
1039 dump_machine_register(rax);
1040 dump_machine_register(rbx);
1041 dump_machine_register(rcx);
1042 dump_machine_register(rdx);
1043 dump_machine_register(rdi);
1044 dump_machine_register(rsi);
1045 dump_machine_register(rbp);
1046 dump_machine_register(rsp);
1047 dump_machine_register(r8);
1048 dump_machine_register(r9);
1049 dump_machine_register(r10);
1050 dump_machine_register(r11);
1051 dump_machine_register(r12);
1052 dump_machine_register(r13);
1053 dump_machine_register(r14);
1054 dump_machine_register(r15);
1055 dump_machine_register(rip);
1056 dump_machine_register(rflags);
1057# elif defined __i386__
1058 dump_machine_register(eax);
1059 dump_machine_register(ebx);
1060 dump_machine_register(ecx);
1061 dump_machine_register(edx);
1062 dump_machine_register(edi);
1063 dump_machine_register(esi);
1064 dump_machine_register(ebp);
1065 dump_machine_register(esp);
1066 dump_machine_register(ss);
1067 dump_machine_register(eflags);
1068 dump_machine_register(eip);
1069 dump_machine_register(cs);
1070 dump_machine_register(ds);
1071 dump_machine_register(es);
1072 dump_machine_register(fs);
1073 dump_machine_register(gs);
1074# elif defined __aarch64__
1075 dump_machine_register(x[0], "x0");
1076 dump_machine_register(x[1], "x1");
1077 dump_machine_register(x[2], "x2");
1078 dump_machine_register(x[3], "x3");
1079 dump_machine_register(x[4], "x4");
1080 dump_machine_register(x[5], "x5");
1081 dump_machine_register(x[6], "x6");
1082 dump_machine_register(x[7], "x7");
1083 dump_machine_register(x[18], "x18");
1084 dump_machine_register(x[19], "x19");
1085 dump_machine_register(x[20], "x20");
1086 dump_machine_register(x[21], "x21");
1087 dump_machine_register(x[22], "x22");
1088 dump_machine_register(x[23], "x23");
1089 dump_machine_register(x[24], "x24");
1090 dump_machine_register(x[25], "x25");
1091 dump_machine_register(x[26], "x26");
1092 dump_machine_register(x[27], "x27");
1093 dump_machine_register(x[28], "x28");
1094 dump_machine_register(lr, "lr");
1095 dump_machine_register(fp, "fp");
1096 dump_machine_register(sp, "sp");
1097# endif
1098 }
1099# endif
1100 kprintf("\n\n");
1101 return true;
1102
1103 error:
1104 return false;
1105}
1106#else
1107# define rb_dump_machine_register(errout, ctx) ((void)0)
1108#endif /* dump_machine_register */
1109
1110bool
1111rb_vm_bugreport(const void *ctx, FILE *errout)
1112{
1113 const char *cmd = getenv("RUBY_ON_BUG");
1114 if (cmd) {
1115 char buf[0x100];
1116 snprintf(buf, sizeof(buf), "%s %"PRI_PIDT_PREFIX"d", cmd, getpid());
1117 int r = system(buf);
1118 if (r == -1) {
1119 snprintf(buf, sizeof(buf), "Launching RUBY_ON_BUG command failed.");
1120 }
1121 }
1122
1123 // Thread unsafe best effort attempt to stop printing the bug report in an
1124 // infinite loop. Can happen with corrupt Ruby stack.
1125 {
1126 static bool crashing = false;
1127 if (crashing) {
1128 kprintf("Crashed while printing bug report\n");
1129 return true;
1130 }
1131 crashing = true;
1132 }
1133
1134#ifdef __linux__
1135# define PROC_MAPS_NAME "/proc/self/maps"
1136#endif
1137#ifdef PROC_MAPS_NAME
1138 enum {other_runtime_info = 1};
1139#else
1140 enum {other_runtime_info = 0};
1141#endif
1142 const rb_vm_t *const vm = GET_VM();
1143 const rb_execution_context_t *ec = rb_current_execution_context(false);
1144
1145 if (vm && ec) {
1146 rb_vmdebug_stack_dump_raw(ec, ec->cfp, errout);
1147 rb_backtrace_print_as_bugreport(errout);
1148 kputs("\n");
1149 // If we get here, hopefully things are intact enough that
1150 // we can read these two numbers. It is an estimate because
1151 // we are reading without synchronization.
1152 kprintf("-- Threading information "
1153 "---------------------------------------------------\n");
1154 kprintf("Total ractor count: %u\n", vm->ractor.cnt);
1155 kprintf("Ruby thread count for this ractor: %u\n", rb_ec_ractor_ptr(ec)->threads.cnt);
1156 if (rb_fiber_scheduler_get() != Qnil) {
1157 kprintf("Note that the Fiber scheduler is enabled\n");
1158 }
1159 kputs("\n");
1160 }
1161
1162 rb_dump_machine_register(errout, ctx);
1163
1164#if USE_BACKTRACE || defined(_WIN32)
1165 kprintf("-- C level backtrace information "
1166 "-------------------------------------------\n");
1167 rb_print_backtrace(errout);
1168
1169
1170 kprintf("\n");
1171#endif /* USE_BACKTRACE */
1172
1173 if (other_runtime_info || vm) {
1174 kprintf("-- Other runtime information "
1175 "-----------------------------------------------\n\n");
1176 }
1177 if (vm && !rb_during_gc()) {
1178 int i;
1179 VALUE name;
1180 long len;
1181 const int max_name_length = 1024;
1182# define LIMITED_NAME_LENGTH(s) \
1183 (((len = RSTRING_LEN(s)) > max_name_length) ? max_name_length : (int)len)
1184
1185 name = vm->progname;
1186 if (name) {
1187 kprintf("* Loaded script: %.*s\n",
1188 LIMITED_NAME_LENGTH(name), RSTRING_PTR(name));
1189 kprintf("\n");
1190 }
1191 if (vm->loaded_features) {
1192 kprintf("* Loaded features:\n\n");
1193 for (i=0; i<RARRAY_LEN(vm->loaded_features); i++) {
1194 name = RARRAY_AREF(vm->loaded_features, i);
1195 if (RB_TYPE_P(name, T_STRING)) {
1196 kprintf(" %4d %.*s\n", i,
1197 LIMITED_NAME_LENGTH(name), RSTRING_PTR(name));
1198 }
1199 else if (RB_TYPE_P(name, T_CLASS) || RB_TYPE_P(name, T_MODULE)) {
1200 const char *const type = RB_TYPE_P(name, T_CLASS) ?
1201 "class" : "module";
1202 name = rb_search_class_path(rb_class_real(name));
1203 if (!RB_TYPE_P(name, T_STRING)) {
1204 kprintf(" %4d %s:<unnamed>\n", i, type);
1205 continue;
1206 }
1207 kprintf(" %4d %s:%.*s\n", i, type,
1208 LIMITED_NAME_LENGTH(name), RSTRING_PTR(name));
1209 }
1210 else {
1211 VALUE klass = rb_search_class_path(rb_obj_class(name));
1212 if (!RB_TYPE_P(klass, T_STRING)) {
1213 kprintf(" %4d #<%p:%p>\n", i,
1214 (void *)CLASS_OF(name), (void *)name);
1215 continue;
1216 }
1217 kprintf(" %4d #<%.*s:%p>\n", i,
1218 LIMITED_NAME_LENGTH(klass), RSTRING_PTR(klass),
1219 (void *)name);
1220 }
1221 }
1222 }
1223 kprintf("\n");
1224 }
1225
1226 {
1227#ifndef RUBY_ASAN_ENABLED
1228# ifdef PROC_MAPS_NAME
1229 {
1230 FILE *fp = fopen(PROC_MAPS_NAME, "r");
1231 if (fp) {
1232 kprintf("* Process memory map:\n\n");
1233
1234 while (!feof(fp)) {
1235 char buff[0x100];
1236 size_t rn = fread(buff, 1, 0x100, fp);
1237 if (fwrite(buff, 1, rn, errout) != rn)
1238 break;
1239 }
1240
1241 fclose(fp);
1242 kprintf("\n\n");
1243 }
1244 }
1245# endif /* __linux__ */
1246# ifdef HAVE_LIBPROCSTAT
1247# define MIB_KERN_PROC_PID_LEN 4
1248 int mib[MIB_KERN_PROC_PID_LEN];
1249 struct kinfo_proc kp;
1250 size_t len = sizeof(struct kinfo_proc);
1251 mib[0] = CTL_KERN;
1252 mib[1] = KERN_PROC;
1253 mib[2] = KERN_PROC_PID;
1254 mib[3] = getpid();
1255 if (sysctl(mib, MIB_KERN_PROC_PID_LEN, &kp, &len, NULL, 0) == -1) {
1256 kprintf("sysctl: %s\n", strerror(errno));
1257 }
1258 else {
1259 struct procstat *prstat = procstat_open_sysctl();
1260 kprintf("* Process memory map:\n\n");
1261 procstat_vm(prstat, &kp, errout);
1262 procstat_close(prstat);
1263 kprintf("\n");
1264 }
1265# endif /* __FreeBSD__ */
1266# ifdef __APPLE__
1267 vm_address_t addr = 0;
1268 vm_size_t size = 0;
1269 struct vm_region_submap_info map;
1270 mach_msg_type_number_t count = VM_REGION_SUBMAP_INFO_COUNT;
1271 natural_t depth = 0;
1272
1273 kprintf("* Process memory map:\n\n");
1274 while (1) {
1275 if (vm_region_recurse(mach_task_self(), &addr, &size, &depth,
1276 (vm_region_recurse_info_t)&map, &count) != KERN_SUCCESS) {
1277 break;
1278 }
1279
1280 if (map.is_submap) {
1281 // We only look at main addresses
1282 depth++;
1283 }
1284 else {
1285 kprintf("%lx-%lx %s%s%s", addr, (addr+size),
1286 ((map.protection & VM_PROT_READ) != 0 ? "r" : "-"),
1287 ((map.protection & VM_PROT_WRITE) != 0 ? "w" : "-"),
1288 ((map.protection & VM_PROT_EXECUTE) != 0 ? "x" : "-"));
1289# ifdef HAVE_LIBPROC_H
1290 char buff[PATH_MAX];
1291 if (proc_regionfilename(getpid(), addr, buff, sizeof(buff)) > 0) {
1292 kprintf(" %s", buff);
1293 }
1294# endif
1295 kprintf("\n");
1296 }
1297
1298 addr += size;
1299 size = 0;
1300 }
1301# endif
1302#endif
1303 }
1304 return true;
1305
1306 error:
1307 return false;
1308}
1309
1310bool
1311rb_vmdebug_stack_dump_all_threads(void)
1312{
1313 rb_thread_t *th = NULL;
1314 rb_ractor_t *r = GET_RACTOR();
1315 FILE *errout = stderr;
1316
1317 // TODO: now it only shows current ractor
1318 ccan_list_for_each(&r->threads.set, th, lt_node) {
1319#ifdef NON_SCALAR_THREAD_ID
1320 kprintf("th: %p, native_id: N/A\n", th);
1321#else
1322 kprintf("th: %p, native_id: %p\n", (void *)th, (void *)(uintptr_t)th->nt->thread_id);
1323#endif
1324 if (!rb_vmdebug_stack_dump_raw(th->ec, th->ec->cfp, errout)) goto error;
1325 }
1326 return true;
1327
1328 error:
1329 return false;
1330}
rb_str_new2
#define rb_str_new2
Old name of rb_str_new_cstr.
Definition string.h:1675
TYPE
#define TYPE(_)
Old name of rb_type.
Definition value_type.h:108
T_STRING
#define T_STRING
Old name of RUBY_T_STRING.
Definition value_type.h:78
T_IMEMO
#define T_IMEMO
Old name of RUBY_T_IMEMO.
Definition value_type.h:67
CLASS_OF
#define CLASS_OF
Old name of rb_class_of.
Definition globals.h:203
T_MODULE
#define T_MODULE
Old name of RUBY_T_MODULE.
Definition value_type.h:70
T_UNDEF
#define T_UNDEF
Old name of RUBY_T_UNDEF.
Definition value_type.h:82
Qnil
#define Qnil
Old name of RUBY_Qnil.
Definition special_consts.h:60
T_CLASS
#define T_CLASS
Old name of RUBY_T_CLASS.
Definition value_type.h:58
SYMBOL_P
#define SYMBOL_P
Old name of RB_SYMBOL_P.
Definition value_type.h:88
rb_obj_class
VALUE rb_obj_class(VALUE obj)
Queries the class of an object.
Definition object.c:247
rb_inspect
VALUE rb_inspect(VALUE obj)
Generates a human-readable textual representation of the given object.
Definition object.c:680
rb_class_real
VALUE rb_class_real(VALUE klass)
Finds a "real" class.
Definition object.c:237
rb_sym2str
VALUE rb_sym2str(VALUE symbol)
Obtain a frozen string representation of a symbol (not including the leading colon).
Definition symbol.c:986
len
int len
Length of the buffer.
Definition io.h:8
ruby::backward::cxxanyargs::type
VALUE type(ANYARGS)
ANYARGS-ed function type.
Definition cxxanyargs.hpp:56
PRI_PIDT_PREFIX
#define PRI_PIDT_PREFIX
A rb_sprintf() format prefix to be used for a pid_t parameter.
Definition pid_t.h:38
RARRAY_LEN
#define RARRAY_LEN
Just another name of rb_array_len.
Definition rarray.h:51
RARRAY_AREF
#define RARRAY_AREF(a, i)
Definition rarray.h:403
StringValueCStr
#define StringValueCStr(v)
Identical to StringValuePtr, except it additionally checks for the contents for viability as a C stri...
Definition rstring.h:89
errno
#define errno
Ractor-aware version of errno.
Definition ruby.h:388
scheduler.h
Scheduler APIs.
rb_fiber_scheduler_get
VALUE rb_fiber_scheduler_get(void)
Queries the current scheduler of the current thread that is calling this function.
Definition scheduler.c:143
__sFILE
Definition vsnprintf.c:160
coroutine_context
Definition Context.h:36
rb_callable_method_entry_struct
Definition method.h:62
rb_control_frame_struct
Definition vm_core.h:893
rb_env_t
Definition vm_core.h:1274
rb_execution_context_struct
Definition vm_core.h:1015
rb_iseq_struct
Definition vm_core.h:561
rb_proc_t
Definition vm_core.h:1261
rb_ractor_struct
Definition ractor_core.h:151
rb_thread_struct
Definition vm_core.h:1101
rb_vm_struct
Definition vm_core.h:659
VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40
RB_TYPE_P
static bool RB_TYPE_P(VALUE obj, enum ruby_value_type t)
Queries if the given object is of given type.
Definition value_type.h:376
Generated by doxygen 1.9.8