ruby/misc
Jemma Issroff d594a5a8bd
This commit implements the Object Shapes technique in CRuby.
Object Shapes is used for accessing instance variables and representing the
"frozenness" of objects.  Object instances have a "shape" and the shape
represents some attributes of the object (currently which instance variables are
set and the "frozenness").  Shapes form a tree data structure, and when a new
instance variable is set on an object, that object "transitions" to a new shape
in the shape tree.  Each shape has an ID that is used for caching. The shape
structure is independent of class, so objects of different types can have the
same shape.

For example:

```ruby
class Foo
  def initialize
    # Starts with shape id 0
    @a = 1 # transitions to shape id 1
    @b = 1 # transitions to shape id 2
  end
end

class Bar
  def initialize
    # Starts with shape id 0
    @a = 1 # transitions to shape id 1
    @b = 1 # transitions to shape id 2
  end
end

foo = Foo.new # `foo` has shape id 2
bar = Bar.new # `bar` has shape id 2
```

Both `foo` and `bar` instances have the same shape because they both set
instance variables of the same name in the same order.

This technique can help to improve inline cache hits as well as generate more
efficient machine code in JIT compilers.

This commit also adds some methods for debugging shapes on objects.  See
`RubyVM::Shape` for more details.

For more context on Object Shapes, see [Feature: #18776]

Co-Authored-By: Aaron Patterson <tenderlove@ruby-lang.org>
Co-Authored-By: Eileen M. Uchitelle <eileencodes@gmail.com>
Co-Authored-By: John Hawthorn <john@hawthorn.email>
2022-09-28 08:26:21 -07:00
..
lldb_rb Write interface instead of interfact 2022-08-19 22:18:36 +09:00
README Partly reverted for ruby-style.el. 2018-09-14 13:19:45 +00:00
expand_tabs.rb Promote net-smtp to the bundled gems 2021-05-27 14:42:11 +09:00
lldb_cruby.py This commit implements the Object Shapes technique in CRuby. 2022-09-28 08:26:21 -07:00
lldb_disasm.py Get the insns_address_table from the vm_exec_core module table... 2022-07-14 08:25:37 -07:00
lldb_yjit.py Add an lldb script to print YJIT comments 2021-10-20 18:19:37 -04:00
rb_optparse.bash [ruby/optparse] Add EditorConfig file 2021-04-28 11:56:15 +09:00
rb_optparse.zsh [ruby/optparse] Add EditorConfig file 2021-04-28 11:56:15 +09:00
ruby-style.el ruby-style.el: ruby-style-c-mode by VCS [ci skip] 2018-11-27 13:47:49 +00:00
test_lldb_cruby.rb Fix typo in lldb script 2019-04-02 21:13:22 +00:00

README

README             this file
rb_optparse.bash   bash completion script
rb_optparse.zsh    zsh completion script
ruby-style.el      Ruby's C/C++ mode style for emacs
lldb_cruby.py      LLDB port of debug utility
test_lldb_cruby.rb test file for LLDB port