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