backtracie 0.3.0 → 1.1.0

data/ext/backtracie_native_extension/ruby_shards.c

@@ -1,533 +0,0 @@
-// backtracie: Ruby gem for beautiful backtraces
-// Copyright (C) 2021 Ivo Anjo <ivo@ivoanjo.me>
-//
-// This file is part of backtracie.
-//
-// backtracie is free software: you can redistribute it and/or modify
-// it under the terms of the GNU Lesser General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-//
-// backtracie is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU Lesser General Public License for more details.
-//
-// You should have received a copy of the GNU Lesser General Public License
-// along with backtracie.  If not, see <http://www.gnu.org/licenses/>.
-
-// -----------------------------------------------------------------------------
-// The file below has modified versions of code extracted from the Ruby project.
-// The Ruby project copyright and license follow:
-// -----------------------------------------------------------------------------
-
-// Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
-// You can redistribute it and/or modify it under either the terms of the
-// 2-clause BSDL (see the file BSDL), or the conditions below:
-
-// 1. You may make and give away verbatim copies of the source form of the
-//    software without restriction, provided that you duplicate all of the
-//    original copyright notices and associated disclaimers.
-
-// 2. You may modify your copy of the software in any way, provided that
-//    you do at least ONE of the following:
-
-//    a. place your modifications in the Public Domain or otherwise
-//       make them Freely Available, such as by posting said
-//       modifications to Usenet or an equivalent medium, or by allowing
-//       the author to include your modifications in the software.
-
-//    b. use the modified software only within your corporation or
-//       organization.
-
-//    c. give non-standard binaries non-standard names, with
-//       instructions on where to get the original software distribution.
-
-//    d. make other distribution arrangements with the author.
-
-// 3. You may distribute the software in object code or binary form,
-//    provided that you do at least ONE of the following:
-
-//    a. distribute the binaries and library files of the software,
-//       together with instructions (in the manual page or equivalent)
-//       on where to get the original distribution.
-
-//    b. accompany the distribution with the machine-readable source of
-//       the software.
-
-//    c. give non-standard binaries non-standard names, with
-//       instructions on where to get the original software distribution.
-
-//    d. make other distribution arrangements with the author.
-
-// 4. You may modify and include the part of the software into any other
-//    software (possibly commercial).  But some files in the distribution
-//    are not written by the author, so that they are not under these terms.
-
-//    For the list of those files and their copying conditions, see the
-//    file LEGAL.
-
-// 5. The scripts and library files supplied as input to or produced as
-//    output from the software do not automatically fall under the
-//    copyright of the software, but belong to whomever generated them,
-//    and may be sold commercially, and may be aggregated with this
-//    software.
-
-// 6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-//    IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-//    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-//    PURPOSE.
-
-// -----------------------------------------------------------------------------
-
-// ruby_shards.c contains a number of borrowed functions from the MRI Ruby (usually 3.0.0) source tree:
-// * A few were copy-pasted verbatim, and are dependencies for other functions
-// * A few were copy-pasted and then changed so we can add features and fixes
-// * A few were copy-pasted verbatim, with the objective of backporting their 3.0.0 behavior to earlier Ruby versions
-// `git blame` usually documents which functions were added for what reason.
-
-// Note that since the RUBY_MJIT_HEADER is a very special header, meant for internal use only, it has a number of quirks:
-//
-// 1. I've seen a few segfaults when trying to call back into original Ruby functions. E.g. even if the API is used
-//    correctly, just the mere inclusion of RUBY_MJIT_HEADER causes usage to crash. Thus, as much as possible, it's
-//    better to define functions OUTSIDE this file.
-//
-// 2. On Windows, I've observed "multiple definition of `something...'" (such as `rb_vm_ep_local_ep') whenever there
-//    are multiple files in the codebase that include the RUBY_MJIT_HEADER.
-//    It looks like (some?) Windows versions of Ruby define a bunch of functions in the RUBY_MJIT_HEADER itself
-//    without marking them as "static" (e.g. not visible to the outside of the file), and thus the linker then complains
-//    when linking together several files which all have these non-private symbols.
-//    One possible hacky solution suggested by the internets is to use the "-Wl,-allow-multiple-definition" linker
-//    flags to ignore this problem; instead I've chosen to implement all usage of the RUBY_MJIT_HEADER on this file --
-//    no other file in backtracie shall include RUBY_MJIT_HEADER.
-//    It's a simpler approach, and hopefully avoids any problems.
-
-#include "extconf.h"
-
-#ifndef PRE_MJIT_RUBY
-#ifndef RUBY_MJIT_HEADER_INCLUDED
-#define RUBY_MJIT_HEADER_INCLUDED
-#include RUBY_MJIT_HEADER
-#endif
-#endif
-
-#include "ruby_shards.h"
-
-#ifdef PRE_MJIT_RUBY
-#include <iseq.h>
-#include <regenc.h>
-#endif
-
-#ifdef PRE_EXECUTION_CONTEXT
-// The thread and its execution context were separated on Ruby 2.5; prior to that, everything was part of the thread
-#define rb_execution_context_t rb_thread_t
-#endif
-
-#ifdef PRE_VM_ENV_RENAMES
-#define VM_ENV_LOCAL_P VM_EP_LEP_P
-#define VM_ENV_PREV_EP VM_EP_PREV_EP
-#define VM_ENV_DATA_INDEX_ME_CREF -1
-#define VM_FRAME_RUBYFRAME_P(cfp) RUBY_VM_NORMAL_ISEQ_P(cfp->iseq)
-#endif
-
-/**********************************************************************
-  vm_backtrace.c -
-  $Author: ko1 $
-  created at: Sun Jun 03 00:14:20 2012
-  Copyright (C) 1993-2012 Yukihiro Matsumoto
-**********************************************************************/
-
-inline static int
-calc_lineno(const rb_iseq_t *iseq, const VALUE *pc)
-{
-    VM_ASSERT(iseq);
-    VM_ASSERT(iseq->body);
-    VM_ASSERT(iseq->body->iseq_encoded);
-    VM_ASSERT(iseq->body->iseq_size);
-    if (! pc) {
-        /* This can happen during VM bootup. */
-        VM_ASSERT(iseq->body->type == ISEQ_TYPE_TOP);
-        VM_ASSERT(! iseq->body->local_table);
-        VM_ASSERT(! iseq->body->local_table_size);
-        return 0;
-    }
-    else {
-        ptrdiff_t n = pc - iseq->body->iseq_encoded;
-        VM_ASSERT(n <= iseq->body->iseq_size);
-        VM_ASSERT(n >= 0);
-        ASSUME(n >= 0);
-        size_t pos = n; /* no overflow */
-        if (LIKELY(pos)) {
-            /* use pos-1 because PC points next instruction at the beginning of instruction */
-            pos--;
-        }
-        return rb_iseq_line_no(iseq, pos);
-    }
-}
-
-static VALUE
-id2str(ID id)
-{
-    VALUE str = rb_id2str(id);
-    if (!str) return Qnil;
-    return str;
-}
-#define rb_id2str(id) id2str(id)
-
-// Hacked version of Ruby's rb_profile_frames from Ruby 3.0.0 with the following changes:
-// 1. Instead of just using the rb_execution_context_t for the current thread, the context is received as an argument,
-//    thus allowing the sampling of any thread in the VM, not just the current one.
-// 2. It gathers a lot more data: originally you'd get only a VALUE (either iseq or the cme, depending on the case),
-//    and the line number. The hacked version returns a whole raw_location with a lot more info.
-// 3. It correctly ignores the dummy frame at the bottom of the main Ruby thread stack, thus mimicking the behavior of
-//    Ruby's backtrace_each (which is the function that is used to implement Thread#backtrace and friends)
-// 4. Removed the start argument (upstream was broken anyway -- https://github.com/ruby/ruby/pull/2713 -- so we can
-//    re-add later if needed)
-static int backtracie_rb_profile_frames_for_execution_context(
-  rb_execution_context_t *ec,
-  int limit,
-  raw_location *raw_locations
-) {
-  int i = 0;
-  const rb_control_frame_t *cfp = ec->cfp;
-  const rb_control_frame_t *end_cfp = RUBY_VM_END_CONTROL_FRAME(ec);
-  const rb_callable_method_entry_t *cme = 0;
-
-  // Hack #3 above: Here we go back one frame in addition to what the original Ruby rb_profile_frames method did.
-  // Why? According to backtrace_each() in vm_backtrace.c there's two "dummy frames" (what MRI calls them) at the
-  // bottom of the stack, and we need to skip them both.
-  // I have no idea why the original rb_profile_frames omits this. Without this, sampling `Thread.main` always
-  // returned one more frame than the regular MRI APIs (which use the aforementioned backtrace_each internally).
-  end_cfp = RUBY_VM_NEXT_CONTROL_FRAME(end_cfp);
-
-  for (i = 0; i < limit && cfp != end_cfp;) {
-    // Initialize the raw_location, to avoid issues
-    raw_locations[i].is_ruby_frame = false;
-    raw_locations[i].should_use_iseq = false;
-    raw_locations[i].vm_method_type = 0;
-    raw_locations[i].line_number = 0;
-    raw_locations[i].iseq = Qnil;
-    raw_locations[i].callable_method_entry = Qnil;
-    raw_locations[i].original_id = Qnil;
-
-    // The current object this is getting called on!
-    raw_locations[i].self = cfp->self;
-
-    cme = rb_vm_frame_method_entry(cfp);
-
-    if (cfp->iseq && !cfp->pc) {
-      // Do nothing -- this frame should not be used
-      // Bugfix: rb_profile_frames did not do this (skip a frame when there's no pc), but backtrace_each did, and that
-      // caused the "Backtracie.backtrace_locations when sampling a map from an enumerable returns the same number of items as the Ruby API"
-      // test to fail -- Backtracie returned one more frame than Ruby. I suspect that, as usual, this is yet another case where
-      // rb_profile_frames fails us.
-    } else if (VM_FRAME_RUBYFRAME_P(cfp)) {
-      raw_locations[i].is_ruby_frame = true;
-      raw_locations[i].iseq = (VALUE) cfp->iseq;
-
-      if (cme) {
-        raw_locations[i].callable_method_entry = (VALUE) cme;
-        raw_locations[i].vm_method_type = cme->def->type;
-      }
-
-      if (!(cme && cme->def->type == VM_METHOD_TYPE_ISEQ)) {
-        // This comes from the original rb_profile_frames logic, which would only return the iseq when the cme
-        // type is not VM_METHOD_TYPE_ISEQ
-        raw_locations[i].should_use_iseq = true;
-      }
-
-      raw_locations[i].line_number = calc_lineno(cfp->iseq, cfp->pc);
-
-      i++;
-    } else {
-      if (cme && cme->def->type == VM_METHOD_TYPE_CFUNC) {
-        raw_locations[i].is_ruby_frame = false;
-        raw_locations[i].callable_method_entry = (VALUE) cme;
-        raw_locations[i].vm_method_type = cme->def->type;
-        raw_locations[i].line_number = 0;
-        raw_locations[i].original_id = ID2SYM(cme->def->original_id);
-
-        i++;
-      }
-    }
-
-    cfp = RUBY_VM_PREVIOUS_CONTROL_FRAME(cfp);
-  }
-
-  return i;
-}
-
-int backtracie_rb_profile_frames(int limit, raw_location *raw_locations) {
-  #ifndef PRE_EXECUTION_CONTEXT
-    return backtracie_rb_profile_frames_for_execution_context(GET_EC(), limit, raw_locations);
-  #else
-    // FIXME: Figure out how to make GET_EC (GET_THREAD) work for Ruby <= 2.4
-    return 0;
-  #endif
-}
-
-bool backtracie_is_thread_alive(VALUE thread) {
-  // In here we're assuming that what we got is really a Thread or its subclass. This assumption NEEDS to be verified by
-  // the caller, otherwise I see a segfault in your future.
-  rb_thread_t *thread_pointer = (rb_thread_t*) DATA_PTR(thread);
-
-  return !(thread_pointer->to_kill || thread_pointer->status == THREAD_KILLED);
-}
-
-int backtracie_rb_profile_frames_for_thread(VALUE thread, int limit, raw_location *raw_locations) {
-  if (!backtracie_is_thread_alive(thread)) return 0;
-
-  // In here we're assuming that what we got is really a Thread or its subclass. This assumption NEEDS to be verified by
-  // the caller, otherwise I see a segfault in your future.
-  rb_thread_t *thread_pointer = (rb_thread_t*) DATA_PTR(thread);
-
-  #ifndef PRE_EXECUTION_CONTEXT
-    return backtracie_rb_profile_frames_for_execution_context(thread_pointer->ec, limit, raw_locations);
-  #else
-    return backtracie_rb_profile_frames_for_execution_context(thread_pointer, limit, raw_locations);
-  #endif
-}
-
-VALUE backtracie_called_id(raw_location *the_location) {
-  if (the_location->callable_method_entry == Qnil) return Qnil;
-
-  return ID2SYM(
-    ((rb_callable_method_entry_t *) the_location->callable_method_entry)
-      ->called_id
-  );
-}
-
-VALUE backtracie_defined_class(raw_location *the_location) {
-  if (the_location->callable_method_entry == Qnil) return Qnil;
-
-  return \
-    ((rb_callable_method_entry_t *) the_location->callable_method_entry)
-      ->defined_class;
-}
-
-bool backtracie_iseq_is_block(raw_location *the_location) {
-  if (the_location->iseq == Qnil) return false;
-
-  return ((rb_iseq_t *) the_location->iseq)->body->type == ISEQ_TYPE_BLOCK;
-}
-
-bool backtracie_iseq_is_eval(raw_location *the_location) {
-  if (the_location->iseq == Qnil) return false;
-
-  return ((rb_iseq_t *) the_location->iseq)->body->type == ISEQ_TYPE_EVAL;
-}
-
-VALUE backtracie_refinement_name(raw_location *the_location) {
-  VALUE defined_class = backtracie_defined_class(the_location);
-  if (defined_class == Qnil) return Qnil;
-
-  VALUE refinement_module = rb_class_of(defined_class);
-  if (!FL_TEST(refinement_module, RMODULE_IS_REFINEMENT)) return Qnil;
-
-  // The below bits are inspired by Ruby's rb_mod_to_s(VALUE)
-  ID id_refined_class;
-  CONST_ID(id_refined_class, "__refined_class__");
-  VALUE refined_class = rb_attr_get(refinement_module, id_refined_class);
-  if (refined_class == Qnil) return Qnil;
-
-  VALUE result = rb_inspect(refined_class);
-  rb_str_concat(result, rb_str_new2("$refinement@"));
-  ID id_defined_at;
-  CONST_ID(id_defined_at, "__defined_at__");
-  rb_str_concat(result, rb_inspect(rb_attr_get(refinement_module, id_defined_at)));
-
-  return result;
-}
-
-// For more details on the objective of this backport, see the comments on ruby_shards.h
-// This is used for Ruby < 3.0.0
-#ifdef CFUNC_FRAMES_BACKPORT_NEEDED
-
-static const rb_callable_method_entry_t *
-cframe(VALUE frame)
-{
-    if (frame == Qnil) return NULL;
-
-    if (RB_TYPE_P(frame, T_IMEMO)) {
-        switch (imemo_type(frame)) {
-          case imemo_ment:
-            {
-                const rb_callable_method_entry_t *cme = (rb_callable_method_entry_t *)frame;
-                switch (cme->def->type) {
-                  case VM_METHOD_TYPE_CFUNC:
-                    return cme;
-                  default:
-                    return NULL;
-                }
-            }
-          default:
-            return NULL;
-        }
-    }
-
-    return NULL;
-}
-
-static const rb_iseq_t *
-frame2iseq(VALUE frame)
-{
-    if (frame == Qnil) return NULL;
-
-    if (RB_TYPE_P(frame, T_IMEMO)) {
-        switch (imemo_type(frame)) {
-          case imemo_iseq:
-            return (const rb_iseq_t *)frame;
-          case imemo_ment:
-            {
-                const rb_callable_method_entry_t *cme = (rb_callable_method_entry_t *)frame;
-                switch (cme->def->type) {
-                  case VM_METHOD_TYPE_ISEQ:
-                    return cme->def->body.iseq.iseqptr;
-                  default:
-                    return NULL;
-                }
-            }
-          default:
-            break;
-        }
-    }
-    rb_bug("frame2iseq: unreachable");
-}
-
-VALUE
-backported_rb_profile_frame_method_name(VALUE frame)
-{
-    const rb_callable_method_entry_t *cme = cframe(frame);
-    if (cme) {
-        ID mid = cme->def->original_id;
-        return id2str(mid);
-    }
-    const rb_iseq_t *iseq = frame2iseq(frame);
-    return iseq ? rb_iseq_method_name(iseq) : Qnil;
-}
-
-#endif // CFUNC_FRAMES_BACKPORT_NEEDED
-
-#ifdef CLASSPATH_BACKPORT_NEEDED
-static VALUE
-frame2klass(VALUE frame)
-{
-    if (frame == Qnil) return Qnil;
-
-    if (RB_TYPE_P(frame, T_IMEMO)) {
-        const rb_callable_method_entry_t *cme = (rb_callable_method_entry_t *)frame;
-
-        if (imemo_type(frame) == imemo_ment) {
-            return cme->defined_class;
-        }
-    }
-    return Qnil;
-}
-
-VALUE
-backported_rb_profile_frame_classpath(VALUE frame)
-{
-    VALUE klass = frame2klass(frame);
-
-    if (klass && !NIL_P(klass)) {
-        if (RB_TYPE_P(klass, T_ICLASS)) {
-            klass = RBASIC(klass)->klass;
-        }
-        else if (FL_TEST(klass, FL_SINGLETON)) {
-            klass = rb_ivar_get(klass, id__attached__);
-            if (!RB_TYPE_P(klass, T_CLASS) && !RB_TYPE_P(klass, T_MODULE))
-                return rb_sprintf("#<%s:%p>", rb_class2name(rb_obj_class(klass)), (void*)klass);
-        }
-        return rb_class_path(klass);
-    }
-    else {
-        return Qnil;
-    }
-}
-
-// Oddly enough, this method is on debug.h BUT NOT on the MJIT header. Since I've had
-// crashes when trying to combine the MJIT header with the regular Ruby headers, let's
-// just supply the declaration for this function, as otherwise the build seems to fail
-// on macOS in CI.
-VALUE rb_profile_frame_singleton_method_p(VALUE frame);
-
-static VALUE
-qualified_method_name(VALUE frame, VALUE method_name)
-{
-    if (method_name != Qnil) {
-        VALUE classpath = backported_rb_profile_frame_classpath(frame);
-        VALUE singleton_p = rb_profile_frame_singleton_method_p(frame);
-
-        if (classpath != Qnil) {
-            return rb_sprintf("%"PRIsVALUE"%s%"PRIsVALUE,
-                              classpath, singleton_p == Qtrue ? "." : "#", method_name);
-        }
-        else {
-            return method_name;
-        }
-    }
-    else {
-        return Qnil;
-    }
-}
-
-VALUE
-backported_rb_profile_frame_qualified_method_name(VALUE frame)
-{
-    VALUE method_name = backported_rb_profile_frame_method_name(frame);
-
-    return qualified_method_name(frame, method_name);
-}
-#endif // CLASSPATH_BACKPORT_NEEDED
-
-#ifdef PRE_MJIT_RUBY
-
-// A few extra functions copied from the Ruby sources, needed to support Ruby < 2.6
-
-/**********************************************************************
-  vm_insnhelper.c - instruction helper functions.
-  $Author$
-  Copyright (C) 2007 Koichi Sasada
-**********************************************************************/
-
-static rb_callable_method_entry_t *
-check_method_entry(VALUE obj, int can_be_svar)
-{
-    if (obj == Qfalse) return NULL;
-
-#if VM_CHECK_MODE > 0
-    if (!RB_TYPE_P(obj, T_IMEMO)) rb_bug("check_method_entry: unknown type: %s", rb_obj_info(obj));
-#endif
-
-    switch (imemo_type(obj)) {
-      case imemo_ment:
-  return (rb_callable_method_entry_t *)obj;
-      case imemo_cref:
-  return NULL;
-      case imemo_svar:
-  if (can_be_svar) {
-      return check_method_entry(((struct vm_svar *)obj)->cref_or_me, FALSE);
-  }
-      default:
-#if VM_CHECK_MODE > 0
-  rb_bug("check_method_entry: svar should not be there:");
-#endif
-  return NULL;
-    }
-}
-
-const rb_callable_method_entry_t *
-rb_vm_frame_method_entry(const rb_control_frame_t *cfp)
-{
-    const VALUE *ep = cfp->ep;
-    rb_callable_method_entry_t *me;
-
-    while (!VM_ENV_LOCAL_P(ep)) {
-        if ((me = check_method_entry(ep[VM_ENV_DATA_INDEX_ME_CREF], FALSE)) != NULL) return me;
-        ep = VM_ENV_PREV_EP(ep);
-    }
-
-    return check_method_entry(ep[VM_ENV_DATA_INDEX_ME_CREF], TRUE);
-}
-
-#endif