1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
ruby--ruby/version.c
Chris Seaton 31b2cd38c5 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 <nobu@ruby-lang.org>
Co-authored-by: Alan Wu <alanwu@ruby-lang.org>
2022-06-20 17:18:29 -04:00

146 lines
3.9 KiB
C

/**********************************************************************
version.c -
$Author$
created at: Thu Sep 30 20:08:01 JST 1993
Copyright (C) 1993-2007 Yukihiro Matsumoto
**********************************************************************/
#include "ruby/ruby.h"
#include "version.h"
#include "vm_core.h"
#include "mjit.h"
#include "yjit.h"
#include <stdio.h>
#ifndef EXIT_SUCCESS
#define EXIT_SUCCESS 0
#endif
#define PRINT(type) puts(ruby_##type)
#define MKSTR(type) rb_obj_freeze(rb_usascii_str_new_static(ruby_##type, sizeof(ruby_##type)-1))
#define MKINT(name) INT2FIX(ruby_##name)
const int ruby_api_version[] = {
RUBY_API_VERSION_MAJOR,
RUBY_API_VERSION_MINOR,
RUBY_API_VERSION_TEENY,
};
#define RUBY_VERSION \
STRINGIZE(RUBY_VERSION_MAJOR) "." \
STRINGIZE(RUBY_VERSION_MINOR) "." \
STRINGIZE(RUBY_VERSION_TEENY) ""
#ifndef RUBY_FULL_REVISION
# define RUBY_FULL_REVISION RUBY_REVISION
#endif
const char ruby_version[] = RUBY_VERSION;
const char ruby_revision[] = RUBY_FULL_REVISION;
const char ruby_release_date[] = RUBY_RELEASE_DATE;
const char ruby_platform[] = RUBY_PLATFORM;
const int ruby_patchlevel = RUBY_PATCHLEVEL;
const char ruby_description[] = RUBY_DESCRIPTION_WITH("");
static const char ruby_description_with_mjit[] = RUBY_DESCRIPTION_WITH(" +MJIT");
static const char ruby_description_with_yjit[] = RUBY_DESCRIPTION_WITH(" +YJIT");
const char ruby_copyright[] = RUBY_COPYRIGHT;
const char ruby_engine[] = "ruby";
// Might change after initialization
const char *rb_dynamic_description = ruby_description;
/*! Defines platform-depended Ruby-level constants */
void
Init_version(void)
{
enum {ruby_patchlevel = RUBY_PATCHLEVEL};
VALUE version;
VALUE ruby_engine_name;
/*
* The running version of ruby
*/
rb_define_global_const("RUBY_VERSION", (version = MKSTR(version)));
/*
* The date this ruby was released
*/
rb_define_global_const("RUBY_RELEASE_DATE", MKSTR(release_date));
/*
* The platform for this ruby
*/
rb_define_global_const("RUBY_PLATFORM", MKSTR(platform));
/*
* The patchlevel for this ruby. If this is a development build of ruby
* the patchlevel will be -1
*/
rb_define_global_const("RUBY_PATCHLEVEL", MKINT(patchlevel));
/*
* The GIT commit hash for this ruby.
*/
rb_define_global_const("RUBY_REVISION", MKSTR(revision));
/*
* The copyright string for ruby
*/
rb_define_global_const("RUBY_COPYRIGHT", MKSTR(copyright));
/*
* The engine or interpreter this ruby uses.
*/
rb_define_global_const("RUBY_ENGINE", ruby_engine_name = MKSTR(engine));
ruby_set_script_name(ruby_engine_name);
/*
* The version of the engine or interpreter this ruby uses.
*/
rb_define_global_const("RUBY_ENGINE_VERSION", (1 ? version : MKSTR(version)));
rb_provide("ruby2_keywords.rb");
}
#if USE_MJIT
#define MJIT_OPTS_ON mjit_opts.on
#else
#define MJIT_OPTS_ON 0
#endif
void
Init_ruby_description(void)
{
VALUE description;
if (MJIT_OPTS_ON) {
rb_dynamic_description = ruby_description_with_mjit;
description = MKSTR(description_with_mjit);
}
else if (rb_yjit_enabled_p()) {
rb_dynamic_description = ruby_description_with_yjit;
description = MKSTR(description_with_yjit);
}
else {
description = MKSTR(description);
}
/*
* The full ruby version string, like <tt>ruby -v</tt> prints
*/
rb_define_global_const("RUBY_DESCRIPTION", /* MKSTR(description) */ description);
}
void
ruby_show_version(void)
{
puts(rb_dynamic_description);
#ifdef RUBY_LAST_COMMIT_TITLE
fputs("last_commit=" RUBY_LAST_COMMIT_TITLE, stdout);
#endif
#ifdef HAVE_MALLOC_CONF
if (malloc_conf) printf("malloc_conf=%s\n", malloc_conf);
#endif
fflush(stdout);
}
void
ruby_show_copyright(void)
{
PRINT(copyright);
fflush(stdout);
}