diff options
| author | Chris Seaton <[email protected]> | 2022-06-14 16:08:36 +0100 |
|---|---|---|
| committer | Alan Wu <[email protected]> | 2022-06-20 17:18:29 -0400 |
| commit | 31b2cd38c5dcf4a0c51ca56ecdddf7461b8ac86c () | |
| tree | d282ecaade8561f335ea1cbb1cc0246909b897e8 | |
| parent | 5ca2335802b281f9a38b1d9b73b146b94ed0eed3 (diff) | |
Include JIT information in crash reports
Since enabling YJIT or MJIT drastically changes what could go wrong at runtime, it's good to be front and center about whether they are enabled when dumping a crash report. Previously, `RUBY_DESCRIPTION` and the description printed when crashing can be different when a JIT is on. Introduce a new internal data global, `rb_dynamic_description`, and set it to be the same as `RUBY_DESCRIPTION` during initialization; use it when crashing. * version.c: Init_ruby_description(): Initialize and use `rb_dynamic_description`. * error.c: Change crash reports to use `rb_dynamic_description`. * ruby.c: Call `Init_ruby_description()` earlier. Slightly more work for when we exit right after printing the description but that was deemed acceptable. * include/ruby/version.h: Talk about how JIT info is not in `ruby_description`. * test/-ext-/bug_reporter/test_bug_reporter.rb: Remove handling for crash description being different from `RUBY_DESCRIPTION`. * test/ruby/test_rubyoptions.rb: ditto Co-authored-by: Nobuyoshi Nakada <[email protected]> Co-authored-by: Alan Wu <[email protected]>
Notes: Merged: https://.com/ruby/ruby/pull/5872
| -rw-r--r-- | error.c | 8 | ||||
| -rw-r--r-- | include/ruby/version.h | 3 | ||||
| -rw-r--r-- | ruby.c | 6 | ||||
| -rw-r--r-- | test/-ext-/bug_reporter/test_bug_reporter.rb | 2 | ||||
| -rw-r--r-- | test/ruby/test_rubyoptions.rb | 2 | ||||
| -rw-r--r-- | version.c | 15 |
6 files changed, 16 insertions, 20 deletions
@@ -82,7 +82,7 @@ static struct { st_table *id2enum, *enum2id; } warning_categories; -extern const char ruby_description[]; static const char * rb_strerrno(int err) @@ -730,7 +730,7 @@ bug_report_begin_valist(FILE *out, const char *fmt, va_list args) fputs("[BUG] ", out); vsnprintf(buf, sizeof(buf), fmt, args); fputs(buf, out); - snprintf(buf, sizeof(buf), "\n%s\n\n", ruby_description); fputs(buf, out); preface_dump(out); } @@ -866,7 +866,7 @@ rb_async_bug_errno(const char *mesg, int errno_arg) write_or_abort(2, errno_str, strlen(errno_str)); } WRITE_CONST(2, "\n\n"); - write_or_abort(2, ruby_description, strlen(ruby_description)); abort(); } @@ -882,7 +882,7 @@ rb_assert_failure(const char *file, int line, const char *name, const char *expr FILE *out = stderr; fprintf(out, "Assertion Failed: %s:%d:", file, line); if (name) fprintf(out, "%s:", name); - fprintf(out, "%s\n%s\n\n", expr, ruby_description); preface_dump(out); rb_vm_bugreport(NULL); bug_report_end(out); @@ -137,7 +137,8 @@ RUBY_EXTERN const int ruby_level; /** * This is what `ruby -v` prints to the standard error. Something like: - * `"ruby 2.5.9p229 (2021-04-05 revision 67829) [x86_64-linux]"` */ RUBY_EXTERN const char ruby_description[]; @@ -1826,10 +1826,11 @@ process_options(int argc, char **argv, ruby_cmdline_options_t *opt) rb_yjit_init(); #endif } - if (opt->dump & (DUMP_BIT(version) | DUMP_BIT(version_v))) { #if USE_MJIT - mjit_opts.on = opt->mjit.on; /* used by ruby_show_version(). mjit_init() still can't be called here. */ #endif ruby_show_version(); if (opt->dump & DUMP_BIT(version)) return Qtrue; } @@ -1888,7 +1889,6 @@ process_options(int argc, char **argv, ruby_cmdline_options_t *opt) mjit_init(&opt->mjit); #endif - Init_ruby_description(); Init_enc(); lenc = rb_locale_encoding(); rb_enc_associate(rb_progname, lenc); @@ -7,8 +7,6 @@ class TestBugReporter < Test::Unit::TestCase omit if ENV['RUBY_ON_BUG'] description = RUBY_DESCRIPTION - description = description.sub(/\+MJIT /, '') if defined?(RubyVM::MJIT) && RubyVM::MJIT.enabled? - description = description.sub(/\+YJIT /, '') if defined?(RubyVM::YJIT.enabled?) && RubyVM::YJIT.enabled? expected_stderr = [ :*, /\[BUG\]\sSegmentation\sfault.*\n/, @@ -740,7 +740,7 @@ class TestRubyOptions < Test::Unit::TestCase -e:(?:1:)?\s\[BUG\]\sSegmentation\sfault.*\n )x, %r( - #{ Regexp.quote(NO_JIT_DESCRIPTION) }\n\n )x, %r( (?:--\s(?:.+\n)*\n)? @@ -47,6 +47,9 @@ static const char ruby_description_with_yjit[] = RUBY_DESCRIPTION_WITH(" +YJIT") const char ruby_copyright[] = RUBY_COPYRIGHT; const char ruby_engine[] = "ruby"; /*! Defines platform-depended Ruby-level constants */ void Init_version(void) @@ -104,9 +107,11 @@ Init_ruby_description(void) VALUE description; if (MJIT_OPTS_ON) { description = MKSTR(description_with_mjit); } else if (rb_yjit_enabled_p()) { description = MKSTR(description_with_yjit); } else { @@ -122,15 +127,7 @@ Init_ruby_description(void) void ruby_show_version(void) { - if (MJIT_OPTS_ON) { - PRINT(description_with_mjit); - } - else if (rb_yjit_enabled_p()) { - PRINT(description_with_yjit); - } - else { - PRINT(description); - } #ifdef RUBY_LAST_COMMIT_TITLE fputs("last_commit=" RUBY_LAST_COMMIT_TITLE, stdout); |