Ruby 2.2.0 リファレンスマニュアル > ライブラリ一覧 > 組み込みライブラリ > ObjectSpaceモジュール

module ObjectSpace

クラスの継承リスト: ObjectSpace

要約

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

モジュール関数

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

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

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

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

count_objects(result_hash = {}) -> Hash[permalink][rdoc]

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

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

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

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

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

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

obj が解放されるときに実行されるファイナライザ proc を登録します。同じオブジェクトについて複数回呼ばれたときは置き換えではなく追加登録されます。現在のセーフレベルと 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]

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]

どこからも参照されなくなったオブジェクトを回収します。 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]

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

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

module ObjectSpace

要約

目次

モジュール関数

使い方の注意