mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
9ddfd2ca00
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>
61 lines
1.8 KiB
Ruby
61 lines
1.8 KiB
Ruby
require_relative '../../spec_helper'
|
|
require 'objspace'
|
|
|
|
describe "ObjectSpace.reachable_objects_from" do
|
|
it "returns nil for true and false" do
|
|
ObjectSpace.reachable_objects_from(true).should == nil
|
|
ObjectSpace.reachable_objects_from(false).should == nil
|
|
end
|
|
|
|
it "returns nil for nil" do
|
|
ObjectSpace.reachable_objects_from(nil).should == nil
|
|
end
|
|
|
|
it "returns nil for small Integers" do
|
|
ObjectSpace.reachable_objects_from(42).should == nil
|
|
end
|
|
|
|
it "enumerates objects directly reachable from a given object" do
|
|
ObjectSpace.reachable_objects_from(['a', 'b', 'c']).should include(Array, 'a', 'b', 'c')
|
|
ObjectSpace.reachable_objects_from(Object.new).should include(Object)
|
|
end
|
|
|
|
it "finds an object stored in an Array" do
|
|
obj = Object.new
|
|
ary = [obj]
|
|
reachable = ObjectSpace.reachable_objects_from(ary)
|
|
reachable.should include(obj)
|
|
end
|
|
|
|
it "finds an object stored in a copy-on-write Array" do
|
|
removed = Object.new
|
|
obj = Object.new
|
|
ary = [removed, obj]
|
|
ary.shift
|
|
reachable = ObjectSpace.reachable_objects_from(ary)
|
|
reachable.should include(obj)
|
|
reachable.should_not include(removed)
|
|
end
|
|
|
|
it "finds an object stored in a Queue" do
|
|
require 'thread'
|
|
o = Object.new
|
|
q = Queue.new
|
|
q << o
|
|
|
|
reachable = ObjectSpace.reachable_objects_from(q)
|
|
reachable = reachable + reachable.flat_map { |r| ObjectSpace.reachable_objects_from(r) }
|
|
reachable.should include(o)
|
|
end
|
|
|
|
it "finds an object stored in a SizedQueue" do
|
|
require 'thread'
|
|
o = Object.new
|
|
q = SizedQueue.new(3)
|
|
q << o
|
|
|
|
reachable = ObjectSpace.reachable_objects_from(q)
|
|
reachable = reachable + reachable.flat_map { |r| ObjectSpace.reachable_objects_from(r) }
|
|
reachable.should include(o)
|
|
end
|
|
end
|