[Feature #20249] Add crash report configuration

Extend `RUBY_CRASH_REPORT` syntax as comma/space sparated `key=value`
pairs.

Supported keys:
+ dump       set/reset the following boolean values all
+ bt         if true, show Ruby-level backtrace
+ vmbt       if true, show Ruby-level backtrace with VM information
+ cbt        if true, show C-level backtrace
+ box        if true, show Box information
+ thread     if true, show Thread information
+ regs       if true, show Register information
+ lf         if true, show loaded features
+ mm         if true, show memory maps
+ additional if true, show additional bug reporters
+ path       output file path to store the report
+ pipe       command and arguments to receive the report

Boolean values are:
`true`: "t", "y", "1", "true", "yes"
`false`: "f", "n", "0", "false", "no"

Author: nobu

depend

@@ -5107,6 +5107,7 @@ error.$(OBJEXT): $(top_srcdir)/internal/string.h
 error.$(OBJEXT): $(top_srcdir)/internal/struct.h
 error.$(OBJEXT): $(top_srcdir)/internal/symbol.h
 error.$(OBJEXT): $(top_srcdir)/internal/thread.h
+error.$(OBJEXT): $(top_srcdir)/internal/util.h
 error.$(OBJEXT): $(top_srcdir)/internal/variable.h
 error.$(OBJEXT): $(top_srcdir)/internal/vm.h
 error.$(OBJEXT): $(top_srcdir)/internal/warnings.h
@@ -19135,12 +19136,14 @@ vm_dump.$(OBJEXT): $(top_srcdir)/internal/array.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/basic_operators.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/box.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/compilers.h
+vm_dump.$(OBJEXT): $(top_srcdir)/internal/error.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/gc.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/imemo.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/sanitizers.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/serial.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/set_table.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/static_assert.h
+vm_dump.$(OBJEXT): $(top_srcdir)/internal/string.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/struct.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/variable.h
 vm_dump.$(OBJEXT): $(top_srcdir)/internal/vm.h

error.c

@@ -44,6 +44,7 @@
 #include "internal/symbol.h"
 #include "internal/thread.h"
 #include "internal/variable.h"
+#include "internal/util.h"
 #include "ruby/encoding.h"
 #include "ruby/st.h"
 #include "ruby/util.h"
@@ -866,45 +867,124 @@ expand_report_argument(const char **input_template, struct report_expansion *val
 
 FILE *ruby_popen_writer(char *const *argv, rb_pid_t *pid);
 
+struct crash_report_config {
+    struct vm_dump_conf dump;
+    const char *begin;
+    int len;
+    bool pipe;                  // write to pipe
+};
+
+static bool
+boolconv(const char *word, int len, bool *ret)
+{
+#define boolword(n, v) \
+    if (len == rb_strlen_lit(#n) && strncmp(word, #n, len) == 0) {*ret = v; return true;}
+    boolword(false, false);
+    boolword(true, true);
+    boolword(yes, true);
+    boolword(no, false);
+#undef boolword
+    if (len == 1) {
+        switch (*word) {
+          case 't': case 'y': case '1': *ret = true; return true;
+          case 'f': case 'n': case '0': *ret = false; return true;
+        }
+    }
+    return false;
+}
+
+static int
+handle_crash_report_word(const char *word, int len, void *arg)
+{
+    struct crash_report_config *cf = arg;
+#define isconfname(conf) \
+    (len > (int)sizeof(#conf) && strncmp(word, #conf "=", sizeof(#conf)) == 0 ? \
+     (word += sizeof(#conf), len -= sizeof(#conf), 1) : 0)
+#define boolconf(conf) \
+    if (isconfname(conf)) { \
+        bool v = cf->dump.conf; \
+        if (boolconv(word, len, &v)) cf->dump.conf = v; \
+        return 0; \
+    }
+    if (isconfname(dump)) {
+        bool v;
+        if (boolconv(word, len, &v)) {
+            cf->dump.bt = v;
+            cf->dump.vmbt = v;
+            cf->dump.cbt = v;
+            cf->dump.box = v;
+            cf->dump.thread = v;
+            cf->dump.regs = v;
+            cf->dump.lf = v;
+            cf->dump.mm = v;
+            cf->dump.additional = v;
+        }
+        return 0;
+    }
+    boolconf(bt);
+    boolconf(vmbt);
+    boolconf(cbt);
+    boolconf(box);
+    boolconf(thread);
+    boolconf(regs);
+    boolconf(lf);
+    boolconf(mm);
+    if (!cf->begin) {
+        if (word[0] == '|' || isconfname(pipe)) {
+            if (*++word) cf->begin = word;
+            cf->pipe = true;
+            return 1;
+        }
+        else {
+            isconfname(path); // skip "path="
+            cf->begin = word;
+            cf->len = len;
+            return 0;
+        }
+    }
+    return 0;
+}
+
 static FILE *
-open_report_path(const char *template, char *buf, size_t size, rb_pid_t *pid)
+open_report_path(struct crash_report_config *conf, char *buf, size_t size, rb_pid_t *pid)
 {
     struct report_expansion values = {{0}};
-
-    if (!template) return NULL;
-    if (0) fprintf(stderr, "RUBY_CRASH_REPORT=%s\n", buf);
-    if (*template == '|') {
+    const char *str = conf->begin;
+    if (!str) return NULL;
+    if (conf->pipe) {
         char *argv[16], *bufend = buf + size, *p;
         int argc;
-        template++;
         for (argc = 0; argc < numberof(argv) - 1; ++argc) {
-            while (*template && ISSPACE(*template)) template++;
-            p = expand_report_argument(&template, &values, buf, bufend-buf, true);
+            while (*str && ISSPACE(*str)) str++;
+            p = expand_report_argument(&str, &values, buf, bufend-buf, true);
             if (!p) break;
             argv[argc] = buf;
             buf = p;
         }
         argv[argc] = NULL;
         if (!p) return ruby_popen_writer(argv, pid);
     }
-    else if (*template) {
-        expand_report_argument(&template, &values, buf, size, false);
+    else if (*str) {
+        expand_report_argument(&str, &values, buf, size, false);
         return fopen(buf, "w");
     }
     return NULL;
 }
 
-static const char *crash_report;
+static struct crash_report_config crash_report = {VM_DUMP_CONF_DEFAULT};
 
 /* SIGSEGV handler might have a very small stack. Thus we need to use it carefully. */
 #define REPORT_BUG_BUFSIZ 256
 static FILE *
 bug_report_file(const char *file, int line, rb_pid_t *pid)
 {
     char buf[REPORT_BUG_BUFSIZ];
-    const char *report = crash_report;
-    if (!report) report = getenv("RUBY_CRASH_REPORT");
-    FILE *out = open_report_path(report, buf, sizeof(buf), pid);
+    if (!crash_report.begin) {
+        const char *report = getenv("RUBY_CRASH_REPORT");
+        if (0) fprintf(stderr, "RUBY_CRASH_REPORT=%s\n", report);
+        if (report) ruby_set_crash_report(report);
+    }
+    FILE *out = open_report_path(&crash_report, buf, sizeof(buf), pid);
     int len = err_position_0(buf, sizeof(buf), file, line);
 
     if (out) {
@@ -1011,7 +1091,7 @@ bug_report_begin_valist(FILE *out, const char *fmt, va_list args)
     fputs(buf, out);
     snprintf(buf, sizeof(buf), "\n%s\n\n", rb_dynamic_description);
     fputs(buf, out);
-    preface_dump(out);
+    if (vm_dump_conf_enabled_any(&crash_report.dump)) preface_dump(out);
 }
 
 #define bug_report_begin(out, fmt) do { \
@@ -1025,14 +1105,14 @@ static void
 bug_report_end(FILE *out, rb_pid_t pid)
 {
     /* call additional bug reporters */
-    {
+    if (crash_report.dump.additional) {
         int i;
         for (i=0; i<bug_reporters_size; i++) {
             struct bug_reporters *reporter = &bug_reporters[i];
             (*reporter->func)(out, reporter->data);
         }
     }
-    postscript_dump(out);
+    if (vm_dump_conf_enabled_any(&crash_report.dump)) postscript_dump(out);
     finish_report(out, pid);
 }
 
@@ -1041,7 +1121,7 @@ bug_report_end(FILE *out, rb_pid_t pid)
     FILE *out = bug_report_file(file, line, &pid); \
     if (out) { \
         bug_report_begin(out, fmt); \
-        rb_vm_bugreport(ctx, out); \
+        rb_vm_bugreport(&crash_report.dump, ctx, out); \
         bug_report_end(out, pid); \
     } \
 } while (0) \
@@ -1051,25 +1131,15 @@ bug_report_end(FILE *out, rb_pid_t pid)
     FILE *out = bug_report_file(file, line, &pid); \
     if (out) { \
         bug_report_begin_valist(out, fmt, args); \
-        rb_vm_bugreport(ctx, out); \
+        rb_vm_bugreport(&crash_report.dump, ctx, out); \
         bug_report_end(out, pid); \
     } \
 } while (0) \
 
 void
 ruby_set_crash_report(const char *template)
 {
-    crash_report = template;
-#if RUBY_DEBUG
-    rb_pid_t pid = -1;
-    char buf[REPORT_BUG_BUFSIZ];
-    FILE *out = open_report_path(template, buf, sizeof(buf), &pid);
-    if (out) {
-        time_t t = time(NULL);
-        fprintf(out, "ruby_test_bug_report: %s", ctime(&t));
-        finish_report(out, pid);
-    }
-#endif
+    ruby_each_words_until(template, handle_crash_report_word, "|", &crash_report);
 }
 
 NORETURN(static void die(void));
@@ -1212,9 +1282,10 @@ rb_assert_failure_detail(const char *file, int line, const char *name, const cha
         }
         fprintf(out, "\n%s\n\n", rb_dynamic_description);
 
-        preface_dump(out);
-        rb_vm_bugreport(NULL, out);
-        bug_report_end(out, pid);
+        bool dump_any = vm_dump_conf_enabled_any(&crash_report.dump);
+        if (dump_any) preface_dump(out);
+        rb_vm_bugreport(&crash_report.dump, NULL, out);
+        if (dump_any) bug_report_end(out, pid);
     }
 
     die();

internal/error.h

@@ -249,4 +249,34 @@ typedef enum {
 } ruby_stack_overflow_critical_level;
 NORETURN(void rb_ec_stack_overflow(struct rb_execution_context_struct *ec, ruby_stack_overflow_critical_level crit));
 
+struct vm_dump_conf {
+    unsigned int bt: 1;         // Ruby-level backtrace
+    unsigned int vmbt: 1;       // Ruby-level backtrace with VM information
+    unsigned int cbt: 1;        // C-level backtrace
+    unsigned int box: 1;        // Box information
+    unsigned int thread: 1;     // Threading information
+    unsigned int regs: 1;       // Register information
+    unsigned int lf: 1;         // loaded features
+    unsigned int mm: 1;         // memory maps
+    unsigned int additional: 1; // additional bug reporters
+};
+
+#define VM_DUMP_CONF_DEFAULT \
+    { \
+        .bt = 1, .vmbt = 1, .cbt = 1, .box = 1, \
+        .thread = 1, .regs = 1, .lf = 1, .mm = 1, \
+        .additional = 1, \
+    }
+
+static inline bool
+vm_dump_conf_enabled_any(const struct vm_dump_conf *dump)
+{
+    return dump->bt || dump->vmbt || dump->cbt || dump->box ||
+        dump->thread || dump->regs || dump->lf || dump->mm ||
+        dump->additional;
+}
+
+bool rb_vm_bugreport(const struct vm_dump_conf *cf, const void *ctx, FILE *errout);
+void ruby_set_crash_report(const char *template);
+
 #endif /* INTERNAL_ERROR_H */

internal/util.h

@@ -19,6 +19,7 @@
 /* util.c */
 char *ruby_dtoa(double d_, int mode, int ndigits, int *decpt, int *sign, char **rve);
 char *ruby_hdtoa(double d, const char *xdigs, int ndigits, int *decpt, int *sign, char **rve);
+void ruby_each_words_until(const char *str, int (*func)(const char*, int, void*), const char *sep, void *arg);
 
 RUBY_SYMBOL_EXPORT_BEGIN
 /* util.c (export) */