module ObjectSpace (Ruby 4.1 リファレンスマニュアル)

要約

全てのオブジェクトを操作するためのモジュールです。

モジュール関数

_id2ref(id) -> object[permalink][rdoc][edit]

オブジェクト ID(BasicObject#__id__)からオブジェクトを得ます。

このメソッドは Ruby 4.0 から deprecated です。Warning[:deprecated] が真のとき「ObjectSpace._id2ref is deprecated」という警告を出力します。将来のバージョンでは削除される予定です。

オブジェクト ID からオブジェクトを引く必要がある場合は、Object#object_id をキーとして ObjectSpace::WeakMap にオブジェクトを保持しておく方法があります。

map = ObjectSpace::WeakMap.new
a = "hoge"
map[a.object_id] = a
p map[a.object_id] # => "hoge"

[PARAM] id:: 取得したいオブジェクトの ID を整数で指定します。
[EXCEPTION] RangeError:: 対応するオブジェクトが存在しなければ発生します。

例

a = "hoge"
p ObjectSpace._id2ref(a.__id__) #=> "hoge"

count_objects(result_hash = {}) -> HashRuby 1.9.3 から[permalink][rdoc][edit]

オブジェクトを種類ごとにカウントした結果を Hash として返します。

このメソッドは C Ruby 以外の Ruby では動かないでしょう。

[PARAM] result_hash:: ハッシュを指定します。与えられたハッシュは上書きして返されます。これを利用すると測定による影響を避けることができます。
[EXCEPTION] TypeError:: 引数に Hash 以外を与えた場合、発生します。

例

p ObjectSpace.count_objects # => {:TOTAL=>10000, :FREE=>3011, :T_OBJECT=>6, :T_CLASS=>404, ...}

define_finalizer(obj, proc) -> Array[permalink][rdoc][edit]

define_finalizer(obj) {|id| ...} -> Array

obj が解放されるときに実行されるファイナライザ proc を登録します。同じオブジェクトについて複数回呼ばれたときは置き換えではなく追加登録されます。固定値 0 と proc を配列にして返します。

ブロックを指定した場合は、そのブロックがファイナライザになります。 obj の回収時にブロックは obj の ID (BasicObject#__id__)を引数として実行されます。しかし、後述の問題があるのでブロックでファイナライザを登録するのは難しいでしょう。

[PARAM] obj:: ファイナライザを登録したいオブジェクトを指定します。
[PARAM] proc:: ファイナライザとして Proc オブジェクトを指定します。proc は obj の回収時に obj の ID を引数として実行されます。

使い方の注意

以下は、define_finalizer の使い方の悪い例です。

悪い例

class Foo
  def initialize
    ObjectSpace.define_finalizer(self) {
      puts "foo"
    }
  end
end
Foo.new
GC.start

これは、渡された proc の self が obj を参照しつづけるため。そのオブジェクトが GC の対象になりません。

tempfile は、ファイナライザの使い方の良い例になっています。これは、クラスのコンテキストで Proc を生成することで上記の問題を回避しています。

例

class Bar
  def Bar.callback
    proc {
      puts "bar"
    }
  end
  def initialize
    ObjectSpace.define_finalizer(self, Bar.callback)
  end
end
Bar.new
GC.start

proc の呼び出しで発生した大域脱出(exitや例外)は無視されます。これは、スクリプトのメイン処理が GC の発生によって非同期に中断されるのを防ぐためです。不安なうちは -d オプションで事前に例外の発生の有無を確認しておいた方が良いでしょう。

例

class Baz
  def initialize
    ObjectSpace.define_finalizer self, eval(%q{
      proc {
        raise "baz" rescue puts $!
        raise "baz2"
        puts "baz3"
      }
    }, TOPLEVEL_BINDING)
  end
end
Baz.new
GC.start

# => baz

[SEE_ALSO] Rubyの起動

each_object {|object| ...} -> Integer[permalink][rdoc][edit]

each_object(klass) {|object| ...} -> Integer

each_object -> Enumerator

each_object(klass) -> Enumerator

指定された klass と Object#kind_of? の関係にある全てのオブジェクトに対して繰り返します。引数が省略された時には全てのオブジェクトに対して繰り返します。繰り返した数を返します。

ブロックが与えられなかった場合は、 Enumerator オブジェクトを返します。

次のクラスのオブジェクトについては繰り返しません

とくに、klass に Fixnum や Symbol などのクラスを指定した場合は、何も繰り返さないことになります。なお、Symbol については、かわりに Symbol.all_symbols が使用できます。

[PARAM] klass:: クラスかモジュールを指定します。

例: ブロックなし

p ObjectSpace.each_object
# => #<Enumerator: ObjectSpace:each_object(false)>

例: 全てのオブジェクトを扱う

ObjectSpace.each_object.take(5).each { |x| p x }
count = ObjectSpace.each_object { |x| x }
puts "Total count: #{count}"

# => "scope"
# => "scopes"
# => "sym"
# => "class_names"
# => "@corrections"
# => Total count: 9938

例: 任意のクラスを扱う

Person = Struct.new(:name)
s1 = Person.new("tanaka")
s2 = Person.new("sato")

count = ObjectSpace.each_object(Person) { |x| p x }
puts "Total count: #{count}"

# => #<struct Person name="sato">
# => #<struct Person name="tanaka">
# => Total count: 2

garbage_collect(full_mark: true, immediate_sweep: true) -> nil[permalink][rdoc][edit]

どこからも参照されなくなったオブジェクトを回収します。 GC.start と同じです。

[PARAM] full_mark:: マイナー GC を動作させる場合は false を、そうでない場合は true を指定します。
[PARAM] immediate_sweep:: sweep を遅らせる(Lazy Sweep を行う)場合は false を、そうでない場合は true を指定します。

注意: これらのキーワード引数は Ruby の実装やバージョンによって異なります。将来のバージョンとの互換性も保証されません。また、Ruby の実装がサポートしていない場合はキーワード引数を指定しても無視される可能性があります。

[SEE_ALSO] GC.start

undefine_finalizer(obj) -> object[permalink][rdoc][edit]

obj に対するファイナライザをすべて解除します。 obj を返します。

[PARAM] obj:: ファイナライザを解除したいオブジェクトを指定します。

例

class Sample
  def Sample.callback
    proc {
      puts "finalize"
    }
  end

  def initialize
    ObjectSpace.define_finalizer(self, Sample.callback)
  end

  def undef
    ObjectSpace.undefine_finalizer(self)
  end
end

Sample.new
p GC.start
# => finalize

Sample.new
sample.undef
GC.start
# ※何も出力されない

[SEE_ALSO] ObjectSpace?.define_finalizer

追加されるメソッド

allocation_sourcefile(object) -> StringRuby 2.1.0 から[permalink][rdoc][edit] [added by objspace]

objectの元となったソースファイル名を返します。

[PARAM] object:: 元となるソースファイル名を取得したいobjectを指定します。
[RETURN]: objectの元となるソースファイル名を返します。存在しない場合はnilを返します。

例:test.rbというファイルで下記のスクリプトを実行した場合

require 'objspace'

ObjectSpace.trace_object_allocations_start
obj = Object.new
puts "file:#{ObjectSpace.allocation_sourcefile(obj)}"   # => file:test.rb
ObjectSpace.trace_object_allocations_stop

[SEE_ALSO] ObjectSpace?.trace_object_allocations_start, ObjectSpace?.trace_object_allocations_stop

allocation_sourceline(object) -> IntegerRuby 2.1.0 から[permalink][rdoc][edit] [added by objspace]

objectの元となったソースファイルの行番号を返します。

[PARAM] object:: 元となるソースファイルの行番号を取得したいobjectを指定します。
[RETURN]: objectの元となるソースファイルの行番号を返します。存在しない場合はnilを返します。

例

require 'objspace'

ObjectSpace.trace_object_allocations_start
obj = Object.new
puts "line:#{ObjectSpace.allocation_sourceline(obj)}"  # => line:4
ObjectSpace.trace_object_allocations_stop

[SEE_ALSO] ObjectSpace?.trace_object_allocations_start, ObjectSpace?.trace_object_allocations_stop

count_nodes(result_hash = nil) -> HashRuby 1.9.3 から[permalink][rdoc][edit] [added by objspace]

ノードの種類ごとの数を格納したハッシュを返します。

[PARAM] result_hash:: 戻り値のためのハッシュを指定します。省略した場合は新しくハッシュを作成します。result_hash の内容は上書きされます。プローブ効果を避けるために使用します。
[EXCEPTION] TypeError:: result_hash にハッシュ以外を指定した時に発生します。

本メソッドは普通の Ruby プログラマ向けのメソッドではありません。パフォーマンスやメモリ管理に興味のある C Ruby の開発者向けのものです。

例

p ObjectSpace.count_nodes
# => {:NODE_METHOD=>2027, :NODE_FBODY=>1927, :NODE_CFUNC=>1798, ...}

戻り値のハッシュは処理系に依存します。これは将来変更になるかもしれません。

本メソッドは C Ruby 以外では動作しません。

count_objects_size(result_hash = nil) -> HashRuby 1.9.3 から[permalink][rdoc][edit] [added by objspace]

型ごとのオブジェクトサイズをバイト単位で格納したハッシュを返します。

[PARAM] result_hash:: 戻り値のためのハッシュを指定します。省略した場合は新しくハッシュを作成します。result_hash の内容は上書きされます。プローブ効果を避けるために使用します。

戻り値の内容は完全ではない事に注意してください。この内容はあくまでもヒントとして扱う必要があります。特に T_DATA の合計値は正しくないでしょう。

例

p ObjectSpace.count_objects_size
# => {:TOTAL=>1461154, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249, ...}

[EXCEPTION] TypeError:: result_hash にハッシュ以外を指定した時に発生します。

戻り値のハッシュは処理系に依存します。これは将来変更になるかもしれません。

本メソッドは C Ruby 以外では動作しません。

count_tdata_objects(result_hash = nil) -> HashRuby 1.9.3 から[permalink][rdoc][edit] [added by objspace]

T_DATA の種類ごとにオブジェクトの数を格納したハッシュを返します。

[PARAM] result_hash:: 戻り値のためのハッシュを指定します。省略した場合は新しくハッシュを作成します。result_hash の内容は上書きされます。プローブ効果を避けるために使用します。
[EXCEPTION] TypeError:: result_hash にハッシュ以外を指定した時に発生します。

本メソッドは普通の Ruby プログラマ向けのメソッドではありません。パフォーマンスに興味のある C Ruby の開発者向けのものです。

例

p ObjectSpace.count_tdata_objects
# => {RubyVM::InstructionSequence=>504, :parser=>5, :barrier=>6,
#     :mutex=>6, Proc=>60, RubyVM::Env=>57, Mutex=>1, Encoding=>99,
#     ThreadGroup=>1, Binding=>1, Thread=>1, RubyVM=>1, :iseq=>1,
#     Random=>1, ARGF.class=>1, Data=>1, :autoload=>3, Time=>2}

現在のバージョンでは、戻り値のキーはクラスオブジェクトかシンボルのオブジェクトです。

普通の参照可能なオブジェクトの場合、キーはクラスオブジェクトです。それ以外の内部的なオブジェクトの場合、キーはシンボルです。シンボルの値は rb_data_type_struct に格納された名前が使用されます。

戻り値のハッシュは処理系に依存します。これは将来変更になるかもしれません。

本メソッドは C Ruby 以外では動作しません。

memsize_of(obj) -> IntegerRuby 1.9.3 から[permalink][rdoc][edit] [added by objspace]

obj が消費するメモリ使用量をバイト単位で返します。

[PARAM] obj:: 任意のオブジェクトを指定します。

戻り値の内容は完全ではない事に注意してください。この内容はあくまでもヒントとして扱う必要があります。特に T_DATA の値は正しくないでしょう。 2.2 以降では RVALUE のサイズを含んだ結果を返します。

本メソッドは C Ruby 以外では動作しません。

例

require 'objspace'

p ObjectSpace.memsize_of(10)          # => 0
p ObjectSpace.memsize_of("12345" * 10)  # => 91

memsize_of_all(klass = nil) -> IntegerRuby 1.9.3 から[permalink][rdoc][edit] [added by objspace]

すべての生存しているオブジェクトが消費しているメモリ使用量をバイト単位で返します。

[PARAM] klass:: 指定したクラスのインスタンスのメモリ使用量を返します。省略した場合はすべてのクラスのインスタンスのメモリ使用量を返します。

本メソッドは以下のような Ruby のコードで定義できます。

例

def memsize_of_all klass = false
  total = 0
  ObjectSpace.each_object{|e|
    total += ObjectSpace.memsize_of(e) if klass == false || e.kind_of?(klass)
  }
  total
end

戻り値の内容は完全ではない事に注意してください。この内容はあくまでもヒントとして扱う必要があります。特に T_DATA の値は正しくないでしょう。

また、同様に戻り値の内容は malloc されたメモリの合計でもない事に注意してください。

本メソッドは C Ruby 以外では動作しません。

reachable_objects_from(obj) -> Array | nilRuby 2.0.0 から[permalink][rdoc][edit] [added by objspace]

obj から到達可能なすべてのオブジェクトを返します。マーク不能なオブジェクトを指定した場合は nil を返します。本メソッドを使う事でメモリリークの調査が行えます。

例

# 配列クラス(Array)と 'a'、'b'、'c' に到達可能。
p ObjectSpace.reachable_objects_from(['a', 'b', 'c'])
# => [Array, 'a', 'b', 'c']

obj が 2 つ以上の同じオブジェクト x への参照を持つ場合、戻り値に含まれるオブジェクト x は 1 つだけです。

例

# 配列クラス(Array)と v に到達可能。
p ObjectSpace.reachable_objects_from([v = 'a', v, v])
# => [Array, 'a']

# 配列クラス(Array)と 3 つの異なる 'a' オブジェクトに到達可能。
p ObjectSpace.reachable_objects_from(['a', 'a', 'a'])
# => [Array, 'a', 'a', 'a']

obj にマーク不能なオブジェクト(true、false、nil、Symbol、 Fixnum、Flonum(即値の Float オブジェクト))を指定した場合は nil を返します。

例

# 1 はマーク不能
p ObjectSpace.reachable_objects_from(1)
# => nil

obj が内部でオブジェクトへの参照を持つ場合、 ObjectSpace::InternalObjectWrapper オブジェクトが戻り値に含まれます。このオブジェクトは obj が内部で持っているオブジェクトを持ちます。内部のオブジェクトの型を確認する場合は ObjectSpace::InternalObjectWrapper#type を参照してください。:T_CLASS のような Symbol を返します。

obj が ObjectSpace::InternalObjectWrapper オブジェクトであった場合、そのオブジェクトから参照される全てのオブジェクトを返します。

本メソッドは C Ruby 以外では動作しません。

[SEE_ALSO] https://www.atdot.net/~ko1/diary/201212.html#d8, https://www.atdot.net/~ko1/diary/201212.html#d9

trace_object_allocations { ... }Ruby 2.1.0 から[permalink][rdoc][edit] [added by objspace]

与えられたブロック内でオブジェクトのトレースを行います。　

例

require 'objspace'

class C
  include ObjectSpace

  def foo
    trace_object_allocations do
      obj = Object.new
      p "#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"
    end
  end
end

p C.new.foo #=> "objtrace.rb:8"

trace_object_allocations_start -> nilRuby 2.1.0 から[permalink][rdoc][edit] [added by objspace]

オブジェクト割り当てのトレースを開始します。

[SEE_ALSO] ObjectSpace?.trace_object_allocations_stop

trace_object_allocations_stop -> nilRuby 2.1.0 から[permalink][rdoc][edit] [added by objspace]

オブジェクト割り当てのトレースを終了します。

トレースを終了する為には、ObjectSpace?.trace_object_allocations_startを呼んだ回数分だけこのメソッドを呼ぶ必要があります。

[SEE_ALSO] ObjectSpace?.trace_object_allocations_start

要約

目次

モジュール関数

使い方の注意

追加されるメソッド