Ruby 2.7.7p221 (2022-11-24 revision 168ec2b1e5ad0e4688e963d9de019557c78feed9)
debug.c
Go to the documentation of this file.
1/**********************************************************************
2
3 debug.c -
4
5 $Author$
6 created at: 04/08/25 02:31:54 JST
7
8 Copyright (C) 2004-2007 Koichi Sasada
9
10**********************************************************************/
11
12#include "ruby/ruby.h"
13#include "ruby/encoding.h"
14#include "ruby/io.h"
15#include "ruby/util.h"
16#include "vm_debug.h"
17#include "eval_intern.h"
18#include "vm_core.h"
19#include "symbol.h"
20#include "id.h"
21
22/* for gdb */
23const union {
38 enum {
39 RUBY_FMODE_READABLE = FMODE_READABLE,
40 RUBY_FMODE_WRITABLE = FMODE_WRITABLE,
41 RUBY_FMODE_READWRITE = FMODE_READWRITE,
42 RUBY_FMODE_BINMODE = FMODE_BINMODE,
43 RUBY_FMODE_SYNC = FMODE_SYNC,
44 RUBY_FMODE_TTY = FMODE_TTY,
45 RUBY_FMODE_DUPLEX = FMODE_DUPLEX,
46 RUBY_FMODE_APPEND = FMODE_APPEND,
47 RUBY_FMODE_CREATE = FMODE_CREATE,
48 RUBY_FMODE_NOREVLOOKUP = 0x00000100,
49 RUBY_FMODE_TRUNC = FMODE_TRUNC,
50 RUBY_FMODE_TEXTMODE = FMODE_TEXTMODE,
51 RUBY_FMODE_PREP = 0x00010000,
52 RUBY_FMODE_SETENC_BY_BOM = FMODE_SETENC_BY_BOM,
53 RUBY_FMODE_UNIX = 0x00200000,
54 RUBY_FMODE_INET = 0x00400000,
55 RUBY_FMODE_INET6 = 0x00800000,
56
57 RUBY_NODE_TYPESHIFT = NODE_TYPESHIFT,
58 RUBY_NODE_TYPEMASK = NODE_TYPEMASK,
59 RUBY_NODE_LSHIFT = NODE_LSHIFT,
60 RUBY_NODE_FL_NEWLINE = NODE_FL_NEWLINE
62 union {
64 enum {RUBY_IMEMO_MASK = IMEMO_MASK} mask;
65 struct RIMemo *ptr;
70
72
73int
74ruby_debug_print_indent(int level, int debug_level, int indent_level)
75{
76 if (level < debug_level) {
77 fprintf(stderr, "%*s", indent_level, "");
79 return TRUE;
80 }
81 return FALSE;
82}
83
84void
85ruby_debug_printf(const char *format, ...)
86{
87 va_list ap;
88 va_start(ap, format);
89 vfprintf(stderr, format, ap);
90 va_end(ap);
91}
92
93#include "gc.h"
94
96ruby_debug_print_value(int level, int debug_level, const char *header, VALUE obj)
97{
98 if (level < debug_level) {
99 char buff[0x100];
100 rb_raw_obj_info(buff, 0x100, obj);
101
102 fprintf(stderr, "DBG> %s: %s\n", header, buff);
103 fflush(stderr);
104 }
105 return obj;
106}
107
108void
110{
111 ruby_debug_print_value(0, 1, "", v);
112}
113
114ID
115ruby_debug_print_id(int level, int debug_level, const char *header, ID id)
116{
117 if (level < debug_level) {
118 fprintf(stderr, "DBG> %s: %s\n", header, rb_id2name(id));
119 fflush(stderr);
120 }
121 return id;
122}
123
124NODE *
125ruby_debug_print_node(int level, int debug_level, const char *header, const NODE *node)
126{
127 if (level < debug_level) {
128 fprintf(stderr, "DBG> %s: %s (%u)\n", header,
129 ruby_node_name(nd_type(node)), nd_line(node));
130 }
131 return (NODE *)node;
132}
133
134void
136{
137 /* */
138}
139
140#if defined _WIN32
141# if RUBY_MSVCRT_VERSION >= 80
142extern int ruby_w32_rtc_error;
143# endif
144#endif
145#if defined _WIN32 || defined __CYGWIN__
146#include <windows.h>
147UINT ruby_w32_codepage[2];
148#endif
149extern int ruby_rgengc_debug;
150extern int ruby_on_ci;
151
152int
153ruby_env_debug_option(const char *str, int len, void *arg)
154{
155 int ov;
156 size_t retlen;
157 unsigned long n;
158#define SET_WHEN(name, var, val) do { \
159 if (len == sizeof(name) - 1 && \
160 strncmp(str, (name), len) == 0) { \
161 (var) = (val); \
162 return 1; \
163 } \
164 } while (0)
165#define NAME_MATCH_VALUE(name) \
166 ((size_t)len >= sizeof(name)-1 && \
167 strncmp(str, (name), sizeof(name)-1) == 0 && \
168 ((len == sizeof(name)-1 && !(len = 0)) || \
169 (str[sizeof(name)-1] == '=' && \
170 (str += sizeof(name), len -= sizeof(name), 1))))
171#define SET_UINT(val) do { \
172 n = ruby_scan_digits(str, len, 10, &retlen, &ov); \
173 if (!ov && retlen) { \
174 val = (unsigned int)n; \
175 } \
176 str += retlen; \
177 len -= retlen; \
178 } while (0)
179#define SET_UINT_LIST(name, vals, num) do { \
180 int i; \
181 for (i = 0; i < (num); ++i) { \
182 SET_UINT((vals)[i]); \
183 if (!len || *str != ':') break; \
184 ++str; \
185 --len; \
186 } \
187 if (len > 0) { \
188 fprintf(stderr, "ignored "name" option: `%.*s'\n", len, str); \
189 } \
190 } while (0)
191#define SET_WHEN_UINT(name, vals, num, req) \
192 if (NAME_MATCH_VALUE(name)) SET_UINT_LIST(name, vals, num);
193
195 SET_WHEN("core", ruby_enable_coredump, 1);
196 SET_WHEN("ci", ruby_on_ci, 1);
197 if (NAME_MATCH_VALUE("rgengc")) {
198 if (!len) ruby_rgengc_debug = 1;
199 else SET_UINT_LIST("rgengc", &ruby_rgengc_debug, 1);
200 return 1;
201 }
202#if defined _WIN32
203# if RUBY_MSVCRT_VERSION >= 80
204 SET_WHEN("rtc_error", ruby_w32_rtc_error, 1);
205# endif
206#endif
207#if defined _WIN32 || defined __CYGWIN__
208 if (NAME_MATCH_VALUE("codepage")) {
209 if (!len) fprintf(stderr, "missing codepage argument");
210 else SET_UINT_LIST("codepage", ruby_w32_codepage, numberof(ruby_w32_codepage));
211 return 1;
212 }
213#endif
214 return 0;
215}
216
217static void
218set_debug_option(const char *str, int len, void *arg)
219{
221 fprintf(stderr, "unexpected debug option: %.*s\n", len, str);
222 }
223}
224
225void
227{
228 ruby_each_words(str, set_debug_option, 0);
229}
int ruby_env_debug_option(const char *str, int len, void *arg)
Definition: debug.c:153
enum ruby_rstring_flags rstring_flags
Definition: debug.c:36
enum vm_call_flag_bits vm_call_flags
Definition: debug.c:68
const union @73 ruby_dummy_gdb_enums
void ruby_debug_breakpoint(void)
Definition: debug.c:135
int ruby_debug_print_indent(int level, int debug_level, int indent_level)
Definition: debug.c:74
#define SET_WHEN(name, var, val)
enum ruby_value_type value_type
Definition: debug.c:25
#define NAME_MATCH_VALUE(name)
enum @73::@75::@76 mask
enum ruby_econv_flag_type econv_flag_types
Definition: debug.c:33
enum node_type node_type
Definition: debug.c:27
void ruby_set_debug_option(const char *str)
Definition: debug.c:226
enum ruby_special_consts special_consts
Definition: debug.c:24
enum ruby_robject_flags robject_flags
Definition: debug.c:34
enum @73::@74 various
void ruby_debug_print_v(VALUE v)
Definition: debug.c:109
void ruby_debug_printf(const char *format,...)
Definition: debug.c:85
int ruby_on_ci
Definition: vm_dump.c:44
enum ruby_method_ids method_ids
Definition: debug.c:28
ID ruby_debug_print_id(int level, int debug_level, const char *header, ID id)
Definition: debug.c:115
enum ruby_tag_type tag_type
Definition: debug.c:26
enum ruby_coderange_type enc_coderange_types
Definition: debug.c:32
enum ruby_rarray_flags rarray_flags
Definition: debug.c:37
VALUE ruby_debug_print_value(int level, int debug_level, const char *header, VALUE obj)
Definition: debug.c:96
enum ruby_id_types id_types
Definition: debug.c:29
enum ruby_fl_type fl_types
Definition: debug.c:30
struct RIMemo * ptr
Definition: debug.c:65
int ruby_rgengc_debug
Definition: gc.c:388
union @73::@75 imemo
enum imemo_type types
Definition: debug.c:63
enum ruby_encoding_consts encoding_consts
Definition: debug.c:31
const SIGNED_VALUE RUBY_NODE_LMASK
Definition: debug.c:71
enum ruby_rmodule_flags rmodule_flags
Definition: debug.c:35
struct RSymbol * symbol_ptr
Definition: debug.c:67
#define SET_UINT_LIST(name, vals, num)
NODE * ruby_debug_print_node(int level, int debug_level, const char *header, const NODE *node)
Definition: debug.c:125
ruby_coderange_type
Definition: encoding.h:66
ruby_encoding_consts
Definition: encoding.h:32
ruby_econv_flag_type
Definition: encoding.h:361
char str[HTML_ESCAPE_MAX_LEN+1]
Definition: escape.c:18
#define FMODE_READABLE
Definition: io.h:108
#define FMODE_SETENC_BY_BOM
Definition: io.h:122
#define FMODE_READWRITE
Definition: io.h:110
#define FMODE_TTY
Definition: io.h:113
#define FMODE_CREATE
Definition: io.h:116
#define FMODE_WRITABLE
Definition: io.h:109
#define FMODE_APPEND
Definition: io.h:115
#define FMODE_DUPLEX
Definition: io.h:114
#define FMODE_BINMODE
Definition: io.h:111
#define FMODE_SYNC
Definition: io.h:112
#define FMODE_TEXTMODE
Definition: io.h:120
#define FMODE_TRUNC
Definition: io.h:119
VALUE * ruby_initial_gc_stress_ptr
Definition: gc.c:905
int int int int int int vfprintf(FILE *__restrict__, const char *__restrict__, __gnuc_va_list) __attribute__((__format__(__printf__
const VALUE VALUE obj
const char * rb_raw_obj_info(char *buff, const int buff_size, VALUE obj)
Definition: gc.c:11477
#define numberof(array)
const char * rb_id2name(ID)
Definition: symbol.c:801
#define nd_line(n)
int fprintf(FILE *__restrict__, const char *__restrict__,...) __attribute__((__format__(__printf__
const char size_t n
unsigned long VALUE
#define stderr
__inline__ const void *__restrict__ size_t len
#define NODE_TYPESHIFT
#define va_end(v)
int ruby_enable_coredump
Definition: signal.c:1481
__gnuc_va_list va_list
#define NODE_TYPEMASK
int VALUE v
#define IMEMO_MASK
#define va_start(v, l)
#define TRUE
#define FALSE
const char * ruby_node_name(int node)
Definition: iseq.c:2534
#define Qtrue
#define NODE_LMASK
#define SIGNED_VALUE
#define NODE_FL_NEWLINE
#define NODE_LSHIFT
#define nd_type(n)
unsigned long ID
VALUE ID id
int fflush(FILE *)
ruby_robject_flags
Definition: ruby.h:915
ruby_rarray_flags
Definition: ruby.h:1027
ruby_rstring_flags
Definition: ruby.h:977
ruby_fl_type
Definition: ruby.h:841
ruby_rmodule_flags
Definition: ruby.h:954
Definition: symbol.h:26
void ruby_each_words(const char *, void(*)(const char *, int, void *), void *)
Definition: util.c:585