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