File: C:/Ruby27-x64/share/doc/ruby/html/ObjectSpace.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module ObjectSpace - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "./";
var index_rel_prefix = "./";
</script>
<script src="./js/navigation.js" defer></script>
<script src="./js/search.js" defer></script>
<script src="./js/search_index.js" defer></script>
<script src="./js/searcher.js" defer></script>
<script src="./js/darkfish.js" defer></script>
<link href="./css/fonts.css" rel="stylesheet">
<link href="./css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="./index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-_id2ref">::_id2ref</a>
<li ><a href="#method-c-allocation_class_path">::allocation_class_path</a>
<li ><a href="#method-c-allocation_generation">::allocation_generation</a>
<li ><a href="#method-c-allocation_method_id">::allocation_method_id</a>
<li ><a href="#method-c-allocation_sourcefile">::allocation_sourcefile</a>
<li ><a href="#method-c-allocation_sourceline">::allocation_sourceline</a>
<li ><a href="#method-c-count_imemo_objects">::count_imemo_objects</a>
<li ><a href="#method-c-count_nodes">::count_nodes</a>
<li ><a href="#method-c-count_objects">::count_objects</a>
<li ><a href="#method-c-count_objects_size">::count_objects_size</a>
<li ><a href="#method-c-count_symbols">::count_symbols</a>
<li ><a href="#method-c-count_tdata_objects">::count_tdata_objects</a>
<li ><a href="#method-c-define_finalizer">::define_finalizer</a>
<li ><a href="#method-c-dump">::dump</a>
<li ><a href="#method-c-dump_all">::dump_all</a>
<li ><a href="#method-c-each_object">::each_object</a>
<li ><a href="#method-c-garbage_collect">::garbage_collect</a>
<li ><a href="#method-c-internal_class_of">::internal_class_of</a>
<li ><a href="#method-c-internal_super_of">::internal_super_of</a>
<li ><a href="#method-c-memsize_of">::memsize_of</a>
<li ><a href="#method-c-memsize_of_all">::memsize_of_all</a>
<li ><a href="#method-c-reachable_objects_from">::reachable_objects_from</a>
<li ><a href="#method-c-reachable_objects_from_root">::reachable_objects_from_root</a>
<li ><a href="#method-c-trace_object_allocations">::trace_object_allocations</a>
<li ><a href="#method-c-trace_object_allocations_clear">::trace_object_allocations_clear</a>
<li ><a href="#method-c-trace_object_allocations_debug_start">::trace_object_allocations_debug_start</a>
<li ><a href="#method-c-trace_object_allocations_start">::trace_object_allocations_start</a>
<li ><a href="#method-c-trace_object_allocations_stop">::trace_object_allocations_stop</a>
<li ><a href="#method-c-undefine_finalizer">::undefine_finalizer</a>
<li ><a href="#method-i-garbage_collect">#garbage_collect</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-ObjectSpace">
<h1 id="module-ObjectSpace" class="module">
module ObjectSpace
</h1>
<section class="description">
<p>The objspace library extends the <a href="ObjectSpace.html"><code>ObjectSpace</code></a> module and adds several methods to get internal statistic information about object/memory management.</p>
<p>You need to <code>require 'objspace'</code> to use this extension module.</p>
<p>Generally, you *SHOULD NOT* use this library if you do not know about the MRI implementation. Mainly, this library is for (memory) profiler developers and MRI developers who need to know about MRI memory usage.</p>
<p>The <a href="ObjectSpace.html"><code>ObjectSpace</code></a> module contains a number of routines that interact with the garbage collection facility and allow you to traverse all living objects with an iterator.</p>
<p><a href="ObjectSpace.html"><code>ObjectSpace</code></a> also provides support for object finalizers, procs that will be called when a specific object is about to be destroyed by garbage collection.</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'objspace'</span>
<span class="ruby-identifier">a</span> = <span class="ruby-string">"A"</span>
<span class="ruby-identifier">b</span> = <span class="ruby-string">"B"</span>
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">define_finalizer</span>(<span class="ruby-identifier">a</span>, <span class="ruby-identifier">proc</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">id</span><span class="ruby-operator">|</span> <span class="ruby-identifier">puts</span> <span class="ruby-node">"Finalizer one on #{id}"</span> })
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">define_finalizer</span>(<span class="ruby-identifier">b</span>, <span class="ruby-identifier">proc</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">id</span><span class="ruby-operator">|</span> <span class="ruby-identifier">puts</span> <span class="ruby-node">"Finalizer two on #{id}"</span> })
</pre>
<p><em>produces:</em></p>
<pre class="ruby"><span class="ruby-constant">Finalizer</span> <span class="ruby-identifier">two</span> <span class="ruby-identifier">on</span> <span class="ruby-value">537763470</span>
<span class="ruby-constant">Finalizer</span> <span class="ruby-identifier">one</span> <span class="ruby-identifier">on</span> <span class="ruby-value">537763480</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-_id2ref" class="method-detail ">
<div class="method-heading">
<span class="method-name">_id2ref</span><span
class="method-args">(p1)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="_id2ref-source">
<pre>static VALUE
os_id2ref(VALUE os, VALUE objid)
{
return id2ref(objid);
}</pre>
</div>
</div>
</div>
<div id="method-c-allocation_class_path" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
allocation_class_path(object) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the class for the given <code>object</code>.</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">A</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span>
<span class="ruby-constant">ObjectSpace</span><span class="ruby-operator">::</span><span class="ruby-identifier">trace_object_allocations</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">p</span> <span class="ruby-node">"#{ObjectSpace::allocation_class_path(obj)}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">A</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">foo</span> <span class="ruby-comment">#=> "Class"</span>
</pre>
<p>See <a href="ObjectSpace.html#method-c-trace_object_allocations"><code>::trace_object_allocations</code></a> for more information and examples.</p>
<div class="method-source-code" id="allocation_class_path-source">
<pre>static VALUE
allocation_class_path(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info && info->class_path) {
return rb_str_new2(info->class_path);
}
else {
return Qnil;
}
}</pre>
</div>
</div>
</div>
<div id="method-c-allocation_generation" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
allocation_generation(object) → integer or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns garbage collector generation for the given <code>object</code>.</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">B</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">ObjectSpace</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span>
<span class="ruby-identifier">trace_object_allocations</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">p</span> <span class="ruby-node">"Generation is #{allocation_generation(obj)}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">B</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">foo</span> <span class="ruby-comment">#=> "Generation is 3"</span>
</pre>
<p>See <a href="ObjectSpace.html#method-c-trace_object_allocations"><code>::trace_object_allocations</code></a> for more information and examples.</p>
<div class="method-source-code" id="allocation_generation-source">
<pre>static VALUE
allocation_generation(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info) {
return SIZET2NUM(info->generation);
}
else {
return Qnil;
}
}</pre>
</div>
</div>
</div>
<div id="method-c-allocation_method_id" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
allocation_method_id(object) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the method identifier for the given <code>object</code>.</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">A</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">ObjectSpace</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span>
<span class="ruby-identifier">trace_object_allocations</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">p</span> <span class="ruby-node">"#{allocation_class_path(obj)}##{allocation_method_id(obj)}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">A</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">foo</span> <span class="ruby-comment">#=> "Class#new"</span>
</pre>
<p>See <a href="ObjectSpace.html#method-c-trace_object_allocations"><code>::trace_object_allocations</code></a> for more information and examples.</p>
<div class="method-source-code" id="allocation_method_id-source">
<pre>static VALUE
allocation_method_id(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info) {
return info->mid;
}
else {
return Qnil;
}
}</pre>
</div>
</div>
</div>
<div id="method-c-allocation_sourcefile" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
allocation_sourcefile(object) → string
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the source file origin from the given <code>object</code>.</p>
<p>See <a href="ObjectSpace.html#method-c-trace_object_allocations"><code>::trace_object_allocations</code></a> for more information and examples.</p>
<div class="method-source-code" id="allocation_sourcefile-source">
<pre>static VALUE
allocation_sourcefile(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info && info->path) {
return rb_str_new2(info->path);
}
else {
return Qnil;
}
}</pre>
</div>
</div>
</div>
<div id="method-c-allocation_sourceline" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
allocation_sourceline(object) → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns the original line from source for from the given <code>object</code>.</p>
<p>See <a href="ObjectSpace.html#method-c-trace_object_allocations"><code>::trace_object_allocations</code></a> for more information and examples.</p>
<div class="method-source-code" id="allocation_sourceline-source">
<pre>static VALUE
allocation_sourceline(VALUE self, VALUE obj)
{
struct allocation_info *info = lookup_allocation_info(obj);
if (info) {
return INT2FIX(info->line);
}
else {
return Qnil;
}
}</pre>
</div>
</div>
</div>
<div id="method-c-count_imemo_objects" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
count_imemo_objects([result_hash]) → hash
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Counts objects for each <code>T_IMEMO</code> type.</p>
<p>This method is only for MRI developers interested in performance and memory usage of Ruby programs.</p>
<p>It returns a hash as:</p>
<pre class="ruby">{<span class="ruby-value">:imemo_ifunc</span><span class="ruby-operator">=></span><span class="ruby-value">8</span>,
<span class="ruby-value">:imemo_svar</span><span class="ruby-operator">=></span><span class="ruby-value">7</span>,
<span class="ruby-value">:imemo_cref</span><span class="ruby-operator">=></span><span class="ruby-value">509</span>,
<span class="ruby-value">:imemo_memo</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>,
<span class="ruby-value">:imemo_throw_data</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>}
</pre>
<p>If the optional argument, result_hash, is given, it is overwritten and returned. This is intended to avoid probe effect.</p>
<p>The contents of the returned hash is implementation specific and may change in the future.</p>
<p>In this version, keys are symbol objects.</p>
<p>This method is only expected to work with C Ruby.</p>
<div class="method-source-code" id="count_imemo_objects-source">
<pre>static VALUE
count_imemo_objects(int argc, VALUE *argv, VALUE self)
{
VALUE hash = setup_hash(argc, argv);
if (imemo_type_ids[0] == 0) {
imemo_type_ids[0] = rb_intern("imemo_env");
imemo_type_ids[1] = rb_intern("imemo_cref");
imemo_type_ids[2] = rb_intern("imemo_svar");
imemo_type_ids[3] = rb_intern("imemo_throw_data");
imemo_type_ids[4] = rb_intern("imemo_ifunc");
imemo_type_ids[5] = rb_intern("imemo_memo");
imemo_type_ids[6] = rb_intern("imemo_ment");
imemo_type_ids[7] = rb_intern("imemo_iseq");
imemo_type_ids[8] = rb_intern("imemo_tmpbuf");
imemo_type_ids[9] = rb_intern("imemo_ast");
imemo_type_ids[10] = rb_intern("imemo_parser_strterm");
}
rb_objspace_each_objects(count_imemo_objects_i, (void *)hash);
return hash;
}</pre>
</div>
</div>
</div>
<div id="method-c-count_nodes" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
count_nodes([result_hash]) → hash
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Counts nodes for each node type.</p>
<p>This method is only for MRI developers interested in performance and memory usage of Ruby programs.</p>
<p>It returns a hash as:</p>
<pre>{:NODE_METHOD=>2027, :NODE_FBODY=>1927, :NODE_CFUNC=>1798, ...}</pre>
<p>If the optional argument, result_hash, is given, it is overwritten and returned. This is intended to avoid probe effect.</p>
<p>Note: The contents of the returned hash is implementation defined. It may be changed in future.</p>
<p>This method is only expected to work with C Ruby.</p>
<div class="method-source-code" id="count_nodes-source">
<pre>static VALUE
count_nodes(int argc, VALUE *argv, VALUE os)
{
size_t nodes[NODE_LAST+1];
enum node_type i;
VALUE hash = setup_hash(argc, argv);
for (i = 0; i <= NODE_LAST; i++) {
nodes[i] = 0;
}
rb_objspace_each_objects(cn_i, &nodes[0]);
for (i=0; i<NODE_LAST; i++) {
if (nodes[i] != 0) {
VALUE node;
switch (i) {
#define COUNT_NODE(n) case n: node = ID2SYM(rb_intern(#n)); goto set
COUNT_NODE(NODE_SCOPE);
COUNT_NODE(NODE_BLOCK);
COUNT_NODE(NODE_IF);
COUNT_NODE(NODE_UNLESS);
COUNT_NODE(NODE_CASE);
COUNT_NODE(NODE_CASE2);
COUNT_NODE(NODE_CASE3);
COUNT_NODE(NODE_WHEN);
COUNT_NODE(NODE_IN);
COUNT_NODE(NODE_WHILE);
COUNT_NODE(NODE_UNTIL);
COUNT_NODE(NODE_ITER);
COUNT_NODE(NODE_FOR);
COUNT_NODE(NODE_FOR_MASGN);
COUNT_NODE(NODE_BREAK);
COUNT_NODE(NODE_NEXT);
COUNT_NODE(NODE_REDO);
COUNT_NODE(NODE_RETRY);
COUNT_NODE(NODE_BEGIN);
COUNT_NODE(NODE_RESCUE);
COUNT_NODE(NODE_RESBODY);
COUNT_NODE(NODE_ENSURE);
COUNT_NODE(NODE_AND);
COUNT_NODE(NODE_OR);
COUNT_NODE(NODE_MASGN);
COUNT_NODE(NODE_LASGN);
COUNT_NODE(NODE_DASGN);
COUNT_NODE(NODE_DASGN_CURR);
COUNT_NODE(NODE_GASGN);
COUNT_NODE(NODE_IASGN);
COUNT_NODE(NODE_CDECL);
COUNT_NODE(NODE_CVASGN);
COUNT_NODE(NODE_OP_ASGN1);
COUNT_NODE(NODE_OP_ASGN2);
COUNT_NODE(NODE_OP_ASGN_AND);
COUNT_NODE(NODE_OP_ASGN_OR);
COUNT_NODE(NODE_OP_CDECL);
COUNT_NODE(NODE_CALL);
COUNT_NODE(NODE_OPCALL);
COUNT_NODE(NODE_FCALL);
COUNT_NODE(NODE_VCALL);
COUNT_NODE(NODE_QCALL);
COUNT_NODE(NODE_SUPER);
COUNT_NODE(NODE_ZSUPER);
COUNT_NODE(NODE_LIST);
COUNT_NODE(NODE_ZLIST);
COUNT_NODE(NODE_VALUES);
COUNT_NODE(NODE_HASH);
COUNT_NODE(NODE_RETURN);
COUNT_NODE(NODE_YIELD);
COUNT_NODE(NODE_LVAR);
COUNT_NODE(NODE_DVAR);
COUNT_NODE(NODE_GVAR);
COUNT_NODE(NODE_IVAR);
COUNT_NODE(NODE_CONST);
COUNT_NODE(NODE_CVAR);
COUNT_NODE(NODE_NTH_REF);
COUNT_NODE(NODE_BACK_REF);
COUNT_NODE(NODE_MATCH);
COUNT_NODE(NODE_MATCH2);
COUNT_NODE(NODE_MATCH3);
COUNT_NODE(NODE_LIT);
COUNT_NODE(NODE_STR);
COUNT_NODE(NODE_DSTR);
COUNT_NODE(NODE_XSTR);
COUNT_NODE(NODE_DXSTR);
COUNT_NODE(NODE_EVSTR);
COUNT_NODE(NODE_DREGX);
COUNT_NODE(NODE_ONCE);
COUNT_NODE(NODE_ARGS);
COUNT_NODE(NODE_ARGS_AUX);
COUNT_NODE(NODE_OPT_ARG);
COUNT_NODE(NODE_KW_ARG);
COUNT_NODE(NODE_POSTARG);
COUNT_NODE(NODE_ARGSCAT);
COUNT_NODE(NODE_ARGSPUSH);
COUNT_NODE(NODE_SPLAT);
COUNT_NODE(NODE_BLOCK_PASS);
COUNT_NODE(NODE_DEFN);
COUNT_NODE(NODE_DEFS);
COUNT_NODE(NODE_ALIAS);
COUNT_NODE(NODE_VALIAS);
COUNT_NODE(NODE_UNDEF);
COUNT_NODE(NODE_CLASS);
COUNT_NODE(NODE_MODULE);
COUNT_NODE(NODE_SCLASS);
COUNT_NODE(NODE_COLON2);
COUNT_NODE(NODE_COLON3);
COUNT_NODE(NODE_DOT2);
COUNT_NODE(NODE_DOT3);
COUNT_NODE(NODE_FLIP2);
COUNT_NODE(NODE_FLIP3);
COUNT_NODE(NODE_SELF);
COUNT_NODE(NODE_NIL);
COUNT_NODE(NODE_TRUE);
COUNT_NODE(NODE_FALSE);
COUNT_NODE(NODE_ERRINFO);
COUNT_NODE(NODE_DEFINED);
COUNT_NODE(NODE_POSTEXE);
COUNT_NODE(NODE_DSYM);
COUNT_NODE(NODE_ATTRASGN);
COUNT_NODE(NODE_LAMBDA);
COUNT_NODE(NODE_ARYPTN);
COUNT_NODE(NODE_HSHPTN);
#undef COUNT_NODE
case NODE_LAST: break;
}
UNREACHABLE;
set:
rb_hash_aset(hash, node, SIZET2NUM(nodes[i]));
}
}
return hash;
}</pre>
</div>
</div>
</div>
<div id="method-c-count_objects" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
count_objects([result_hash]) → hash
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Counts all objects grouped by type.</p>
<p>It returns a hash, such as:</p>
<pre class="ruby">{
<span class="ruby-value">:TOTAL</span><span class="ruby-operator">=></span><span class="ruby-value">10000</span>,
<span class="ruby-value">:FREE</span><span class="ruby-operator">=></span><span class="ruby-value">3011</span>,
<span class="ruby-value">:T_OBJECT</span><span class="ruby-operator">=></span><span class="ruby-value">6</span>,
<span class="ruby-value">:T_CLASS</span><span class="ruby-operator">=></span><span class="ruby-value">404</span>,
<span class="ruby-comment"># ...</span>
}
</pre>
<p>The contents of the returned hash are implementation specific. It may be changed in future.</p>
<p>The keys starting with <code>:T_</code> means live objects. For example, <code>:T_ARRAY</code> is the number of arrays. <code>:FREE</code> means object slots which is not used now. <code>:TOTAL</code> means sum of above.</p>
<p>If the optional argument <code>result_hash</code> is given, it is overwritten and returned. This is intended to avoid probe effect.</p>
<pre class="ruby"><span class="ruby-identifier">h</span> = {}
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">count_objects</span>(<span class="ruby-identifier">h</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">h</span>
<span class="ruby-comment"># => { :TOTAL=>10000, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249 }</span>
</pre>
<p>This method is only expected to work on C Ruby.</p>
<div class="method-source-code" id="count_objects-source">
<pre>static VALUE
count_objects(int argc, VALUE *argv, VALUE os)
{
rb_objspace_t *objspace = &rb_objspace;
size_t counts[T_MASK+1];
size_t freed = 0;
size_t total = 0;
size_t i;
VALUE hash = Qnil;
if (rb_check_arity(argc, 0, 1) == 1) {
hash = argv[0];
if (!RB_TYPE_P(hash, T_HASH))
rb_raise(rb_eTypeError, "non-hash given");
}
for (i = 0; i <= T_MASK; i++) {
counts[i] = 0;
}
for (i = 0; i < heap_allocated_pages; i++) {
struct heap_page *page = heap_pages_sorted[i];
RVALUE *p, *pend;
p = page->start; pend = p + page->total_slots;
for (;p < pend; p++) {
void *poisoned = asan_poisoned_object_p((VALUE)p);
asan_unpoison_object((VALUE)p, false);
if (p->as.basic.flags) {
counts[BUILTIN_TYPE(p)]++;
}
else {
freed++;
}
if (poisoned) {
GC_ASSERT(BUILTIN_TYPE((VALUE)p) == T_NONE);
asan_poison_object((VALUE)p);
}
}
total += page->total_slots;
}
if (hash == Qnil) {
hash = rb_hash_new();
}
else if (!RHASH_EMPTY_P(hash)) {
rb_hash_stlike_foreach(hash, set_zero, hash);
}
rb_hash_aset(hash, ID2SYM(rb_intern("TOTAL")), SIZET2NUM(total));
rb_hash_aset(hash, ID2SYM(rb_intern("FREE")), SIZET2NUM(freed));
for (i = 0; i <= T_MASK; i++) {
VALUE type = type_sym(i);
if (counts[i])
rb_hash_aset(hash, type, SIZET2NUM(counts[i]));
}
return hash;
}</pre>
</div>
</div>
</div>
<div id="method-c-count_objects_size" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
count_objects_size([result_hash]) → hash
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Counts objects size (in bytes) for each type.</p>
<p>Note that this information is incomplete. You need to deal with this information as only a <strong>HINT</strong>. Especially, total size of T_DATA may be wrong.</p>
<p>It returns a hash as:</p>
<pre>{:TOTAL=>1461154, :T_CLASS=>158280, :T_MODULE=>20672, :T_STRING=>527249, ...}</pre>
<p>If the optional argument, result_hash, is given, it is overwritten and returned. This is intended to avoid probe effect.</p>
<p>The contents of the returned hash is implementation defined. It may be changed in future.</p>
<p>This method is only expected to work with C Ruby.</p>
<div class="method-source-code" id="count_objects_size-source">
<pre>static VALUE
count_objects_size(int argc, VALUE *argv, VALUE os)
{
size_t counts[T_MASK+1];
size_t total = 0;
enum ruby_value_type i;
VALUE hash = setup_hash(argc, argv);
for (i = 0; i <= T_MASK; i++) {
counts[i] = 0;
}
rb_objspace_each_objects(cos_i, &counts[0]);
for (i = 0; i <= T_MASK; i++) {
if (counts[i]) {
VALUE type = type2sym(i);
total += counts[i];
rb_hash_aset(hash, type, SIZET2NUM(counts[i]));
}
}
rb_hash_aset(hash, ID2SYM(rb_intern("TOTAL")), SIZET2NUM(total));
return hash;
}</pre>
</div>
</div>
</div>
<div id="method-c-count_symbols" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
count_symbols([result_hash]) → hash
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Counts symbols for each <a href="Symbol.html"><code>Symbol</code></a> type.</p>
<p>This method is only for MRI developers interested in performance and memory usage of Ruby programs.</p>
<p>If the optional argument, result_hash, is given, it is overwritten and returned. This is intended to avoid probe effect.</p>
<p>Note: The contents of the returned hash is implementation defined. It may be changed in future.</p>
<p>This method is only expected to work with C Ruby.</p>
<p>On this version of MRI, they have 3 types of Symbols (and 1 total counts).</p>
<pre>* mortal_dynamic_symbol: GC target symbols (collected by GC)
* immortal_dynamic_symbol: Immortal symbols promoted from dynamic symbols (do not collected by GC)
* immortal_static_symbol: Immortal symbols (do not collected by GC)
* immortal_symbol: total immortal symbols (immortal_dynamic_symbol+immortal_static_symbol)</pre>
<div class="method-source-code" id="count_symbols-source">
<pre>static VALUE
count_symbols(int argc, VALUE *argv, VALUE os)
{
struct dynamic_symbol_counts dynamic_counts = {0, 0};
VALUE hash = setup_hash(argc, argv);
size_t immortal_symbols = rb_sym_immortal_count();
rb_objspace_each_objects(cs_i, &dynamic_counts);
rb_hash_aset(hash, ID2SYM(rb_intern("mortal_dynamic_symbol")), SIZET2NUM(dynamic_counts.mortal));
rb_hash_aset(hash, ID2SYM(rb_intern("immortal_dynamic_symbol")), SIZET2NUM(dynamic_counts.immortal));
rb_hash_aset(hash, ID2SYM(rb_intern("immortal_static_symbol")), SIZET2NUM(immortal_symbols - dynamic_counts.immortal));
rb_hash_aset(hash, ID2SYM(rb_intern("immortal_symbol")), SIZET2NUM(immortal_symbols));
return hash;
}</pre>
</div>
</div>
</div>
<div id="method-c-count_tdata_objects" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
count_tdata_objects([result_hash]) → hash
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Counts objects for each <code>T_DATA</code> type.</p>
<p>This method is only for MRI developers interested in performance and memory usage of Ruby programs.</p>
<p>It returns a hash as:</p>
<pre class="ruby">{<span class="ruby-constant">RubyVM</span><span class="ruby-operator">::</span><span class="ruby-constant">InstructionSequence</span><span class="ruby-operator">=></span><span class="ruby-value">504</span>, <span class="ruby-value">:parser</span><span class="ruby-operator">=></span><span class="ruby-value">5</span>, <span class="ruby-value">:barrier</span><span class="ruby-operator">=></span><span class="ruby-value">6</span>,
<span class="ruby-value">:mutex</span><span class="ruby-operator">=></span><span class="ruby-value">6</span>, <span class="ruby-constant">Proc</span><span class="ruby-operator">=></span><span class="ruby-value">60</span>, <span class="ruby-constant">RubyVM</span><span class="ruby-operator">::</span><span class="ruby-constant">Env</span><span class="ruby-operator">=></span><span class="ruby-value">57</span>, <span class="ruby-constant">Mutex</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-constant">Encoding</span><span class="ruby-operator">=></span><span class="ruby-value">99</span>,
<span class="ruby-constant">ThreadGroup</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-constant">Binding</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-constant">Thread</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-constant">RubyVM</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-value">:iseq</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>,
<span class="ruby-constant">Random</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-constant">ARGF</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-constant">Data</span><span class="ruby-operator">=></span><span class="ruby-value">1</span>, <span class="ruby-value">:autoload</span><span class="ruby-operator">=></span><span class="ruby-value">3</span>, <span class="ruby-constant">Time</span><span class="ruby-operator">=></span><span class="ruby-value">2</span>}
<span class="ruby-comment"># T_DATA objects existing at startup on r32276.</span>
</pre>
<p>If the optional argument, result_hash, is given, it is overwritten and returned. This is intended to avoid probe effect.</p>
<p>The contents of the returned hash is implementation specific and may change in the future.</p>
<p>In this version, keys are <a href="Class.html"><code>Class</code></a> object or <a href="Symbol.html"><code>Symbol</code></a> object.</p>
<p>If object is kind of normal (accessible) object, the key is <a href="Class.html"><code>Class</code></a> object. If object is not a kind of normal (internal) object, the key is symbol name, registered by rb_data_type_struct.</p>
<p>This method is only expected to work with C Ruby.</p>
<div class="method-source-code" id="count_tdata_objects-source">
<pre>static VALUE
count_tdata_objects(int argc, VALUE *argv, VALUE self)
{
VALUE hash = setup_hash(argc, argv);
rb_objspace_each_objects(cto_i, (void *)hash);
return hash;
}</pre>
</div>
</div>
</div>
<div id="method-c-define_finalizer" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
define_finalizer(obj, aProc=proc())
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <em>aProc</em> as a finalizer, to be called after <em>obj</em> was destroyed. The object ID of the <em>obj</em> will be passed as an argument to <em>aProc</em>. If <em>aProc</em> is a lambda or method, make sure it can be called with a single argument.</p>
<div class="method-source-code" id="define_finalizer-source">
<pre>static VALUE
define_final(int argc, VALUE *argv, VALUE os)
{
VALUE obj, block;
rb_scan_args(argc, argv, "11", &obj, &block);
should_be_finalizable(obj);
if (argc == 1) {
block = rb_block_proc();
}
else {
should_be_callable(block);
}
return define_final0(obj, block);
}</pre>
</div>
</div>
</div>
<div id="method-c-dump" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
dump(obj[, output: :string]) # → "{ ... }"
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
dump(obj, output: :file) # → #<File:/tmp/rubyobj20131125-88733-1xkfmpv.json>
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
dump(obj, output: :stdout) # → nil
</span>
</div>
<div class="method-description">
<p>Dump the contents of a ruby object as <a href="JSON.html"><code>JSON</code></a>.</p>
<p>This method is only expected to work with C Ruby. This is an experimental method and is subject to change. In particular, the function signature and output format are not guaranteed to be compatible in future versions of ruby.</p>
<div class="method-source-code" id="dump-source">
<pre>static VALUE
objspace_dump(int argc, VALUE *argv, VALUE os)
{
static const char filename[] = "rubyobj";
VALUE obj = Qnil, opts = Qnil, output;
struct dump_config dc = {0,};
rb_scan_args(argc, argv, "1:", &obj, &opts);
output = dump_output(&dc, opts, sym_string, filename);
dump_object(obj, &dc);
return dump_result(&dc, output);
}</pre>
</div>
</div>
</div>
<div id="method-c-dump_all" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
dump_all([output: :file]) # → #<File:/tmp/rubyheap20131125-88469-laoj3v.json>
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
dump_all(output: :stdout) # → nil
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
dump_all(output: :string) # → "{...}\n{...}\n..."
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
dump_all(output:
</span>
</div>
<div class="method-heading">
<span class="method-callseq">
open('heap.json','w')) # → #<File:heap.json>
</span>
</div>
<div class="method-description">
<p>Dump the contents of the ruby heap as <a href="JSON.html"><code>JSON</code></a>.</p>
<p>This method is only expected to work with C Ruby. This is an experimental method and is subject to change. In particular, the function signature and output format are not guaranteed to be compatible in future versions of ruby.</p>
<div class="method-source-code" id="dump_all-source">
<pre>static VALUE
objspace_dump_all(int argc, VALUE *argv, VALUE os)
{
static const char filename[] = "rubyheap";
VALUE opts = Qnil, output;
struct dump_config dc = {0,};
rb_scan_args(argc, argv, "0:", &opts);
output = dump_output(&dc, opts, sym_file, filename);
/* dump roots */
rb_objspace_reachable_objects_from_root(root_obj_i, &dc);
if (dc.roots) dump_append(&dc, "]}\n");
/* dump all objects */
rb_objspace_each_objects(heap_i, &dc);
return dump_result(&dc, output);
}</pre>
</div>
</div>
</div>
<div id="method-c-each_object" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
each_object([module]) {|obj| ... } → integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-heading">
<span class="method-callseq">
each_object([module]) → an_enumerator
</span>
</div>
<div class="method-description">
<p>Calls the block once for each living, nonimmediate object in this Ruby process. If <em>module</em> is specified, calls the block for only those classes or modules that match (or are a subclass of) <em>module</em>. Returns the number of objects found. Immediate objects (<code>Fixnum</code>s, <code>Symbol</code>s <code>true</code>, <code>false</code>, and <code>nil</code>) are never returned. In the example below, each_object returns both the numbers we defined and several constants defined in the <a href="Math.html"><code>Math</code></a> module.</p>
<p>If no block is given, an enumerator is returned instead.</p>
<pre class="ruby"><span class="ruby-identifier">a</span> = <span class="ruby-value">102.7</span>
<span class="ruby-identifier">b</span> = <span class="ruby-value">95</span> <span class="ruby-comment"># Won't be returned</span>
<span class="ruby-identifier">c</span> = <span class="ruby-value">12345678987654321</span>
<span class="ruby-identifier">count</span> = <span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">each_object</span>(<span class="ruby-constant">Numeric</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">p</span> <span class="ruby-identifier">x</span> }
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Total count: #{count}"</span>
</pre>
<p><em>produces:</em></p>
<pre class="ruby"><span class="ruby-value">12345678987654321</span>
<span class="ruby-value">102.7</span>
<span class="ruby-value">2.71828182845905</span>
<span class="ruby-value">3.14159265358979</span>
<span class="ruby-value">2.22044604925031e-16</span>
<span class="ruby-value">1.7976931348623157e+308</span>
<span class="ruby-value">2.2250738585072e-308</span>
<span class="ruby-constant">Total</span> <span class="ruby-value">count:</span> <span class="ruby-value">7</span>
</pre>
<div class="method-source-code" id="each_object-source">
<pre>static VALUE
os_each_obj(int argc, VALUE *argv, VALUE os)
{
VALUE of;
of = (!rb_check_arity(argc, 0, 1) ? 0 : argv[0]);
RETURN_ENUMERATOR(os, 1, &of);
return os_obj_of(of);
}</pre>
</div>
</div>
</div>
<div id="method-c-garbage_collect" class="method-detail ">
<div class="method-heading">
<span class="method-name">garbage_collect</span><span
class="method-args">(full_mark: true, immediate_mark: true, immediate_sweep: true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="garbage_collect-source">
<pre><span class="ruby-comment"># File gc.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">garbage_collect</span> <span class="ruby-value">full_mark:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">immediate_mark:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">immediate_sweep:</span> <span class="ruby-keyword">true</span>
<span class="ruby-identifier">__builtin_gc_start_internal</span> <span class="ruby-identifier">full_mark</span>, <span class="ruby-identifier">immediate_mark</span>, <span class="ruby-identifier">immediate_sweep</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-internal_class_of" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
internal_class_of(obj) → Class or Module
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<dl class="rdoc-list label-list"><dt>MRI specific feature
<dd>
<p>Return internal class of obj.</p>
</dd></dl>
<p>obj can be an instance of <a href="ObjectSpace/InternalObjectWrapper.html"><code>InternalObjectWrapper</code></a>.</p>
<p>Note that you should not use this method in your application.</p>
<div class="method-source-code" id="internal_class_of-source">
<pre>static VALUE
objspace_internal_class_of(VALUE self, VALUE obj)
{
VALUE klass;
if (rb_typeddata_is_kind_of(obj, &iow_data_type)) {
obj = (VALUE)DATA_PTR(obj);
}
klass = CLASS_OF(obj);
return wrap_klass_iow(klass);
}</pre>
</div>
</div>
</div>
<div id="method-c-internal_super_of" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
internal_super_of(cls) → Class or Module
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<dl class="rdoc-list label-list"><dt>MRI specific feature
<dd>
<p>Return internal super class of cls (<a href="Class.html"><code>Class</code></a> or <a href="Module.html"><code>Module</code></a>).</p>
</dd></dl>
<p>obj can be an instance of <a href="ObjectSpace/InternalObjectWrapper.html"><code>InternalObjectWrapper</code></a>.</p>
<p>Note that you should not use this method in your application.</p>
<div class="method-source-code" id="internal_super_of-source">
<pre>static VALUE
objspace_internal_super_of(VALUE self, VALUE obj)
{
VALUE super;
if (rb_typeddata_is_kind_of(obj, &iow_data_type)) {
obj = (VALUE)DATA_PTR(obj);
}
switch (OBJ_BUILTIN_TYPE(obj)) {
case T_MODULE:
case T_CLASS:
case T_ICLASS:
super = RCLASS_SUPER(obj);
break;
default:
rb_raise(rb_eArgError, "class or module is expected");
}
return wrap_klass_iow(super);
}</pre>
</div>
</div>
</div>
<div id="method-c-memsize_of" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
memsize_of(obj) → Integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return consuming memory size of obj.</p>
<p>Note that the return size is incomplete. You need to deal with this information as only a <strong>HINT</strong>. Especially, the size of <code>T_DATA</code> may not be correct.</p>
<p>This method is only expected to work with C Ruby.</p>
<p>From Ruby 2.2, <a href="ObjectSpace.html#method-c-memsize_of"><code>memsize_of</code></a>(obj) returns a memory size includes sizeof(RVALUE).</p>
<div class="method-source-code" id="memsize_of-source">
<pre>static VALUE
memsize_of_m(VALUE self, VALUE obj)
{
return SIZET2NUM(rb_obj_memsize_of(obj));
}</pre>
</div>
</div>
</div>
<div id="method-c-memsize_of_all" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
memsize_of_all([klass]) → Integer
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return consuming memory size of all living objects.</p>
<p>If <code>klass</code> (should be <a href="Class.html"><code>Class</code></a> object) is given, return the total memory size of instances of the given class.</p>
<p>Note that the returned size is incomplete. You need to deal with this information as only a <strong>HINT</strong>. Especially, the size of <code>T_DATA</code> may not be correct.</p>
<p>Note that this method does <strong>NOT</strong> return total malloc'ed memory size.</p>
<p>This method can be defined by the following Ruby code:</p>
<pre class="ruby"><span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">memsize_of_all</span> <span class="ruby-identifier">klass</span> = <span class="ruby-keyword">false</span>
<span class="ruby-identifier">total</span> = <span class="ruby-value">0</span>
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">each_object</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">total</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">memsize_of</span>(<span class="ruby-identifier">e</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">klass</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-identifier">klass</span>)
}
<span class="ruby-identifier">total</span>
<span class="ruby-keyword">end</span>
</pre>
<p>This method is only expected to work with C Ruby.</p>
<div class="method-source-code" id="memsize_of_all-source">
<pre>static VALUE
memsize_of_all_m(int argc, VALUE *argv, VALUE self)
{
struct total_data data = {0, 0};
if (argc > 0) {
rb_scan_args(argc, argv, "01", &data.klass);
}
rb_objspace_each_objects(total_i, &data);
return SIZET2NUM(data.total);
}</pre>
</div>
</div>
</div>
<div id="method-c-reachable_objects_from" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
reachable_objects_from(obj) → array or nil
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<dl class="rdoc-list label-list"><dt>MRI specific feature
<dd>
<p>Return all reachable objects from `obj'.</p>
</dd></dl>
<p>This method returns all reachable objects from `obj'.</p>
<p>If `obj' has two or more references to the same object `x', then returned array only includes one `x' object.</p>
<p>If `obj' is a non-markable (non-heap management) object such as true, false, nil, symbols and Fixnums (and Flonum) then it simply returns nil.</p>
<p>If `obj' has references to an internal object, then it returns instances of <a href="ObjectSpace/InternalObjectWrapper.html"><code>ObjectSpace::InternalObjectWrapper</code></a> class. This object contains a reference to an internal object and you can check the type of internal object with `type' method.</p>
<p>If `obj' is instance of <a href="ObjectSpace/InternalObjectWrapper.html"><code>ObjectSpace::InternalObjectWrapper</code></a> class, then this method returns all reachable object from an internal object, which is pointed by `obj'.</p>
<p>With this method, you can find memory leaks.</p>
<p>This method is only expected to work except with C Ruby.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">reachable_objects_from</span>([<span class="ruby-string">'a'</span>, <span class="ruby-string">'b'</span>, <span class="ruby-string">'c'</span>])
<span class="ruby-comment">#=> [Array, 'a', 'b', 'c']</span>
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">reachable_objects_from</span>([<span class="ruby-string">'a'</span>, <span class="ruby-string">'a'</span>, <span class="ruby-string">'a'</span>])
<span class="ruby-comment">#=> [Array, 'a', 'a', 'a'] # all 'a' strings have different object id</span>
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">reachable_objects_from</span>([<span class="ruby-identifier">v</span> = <span class="ruby-string">'a'</span>, <span class="ruby-identifier">v</span>, <span class="ruby-identifier">v</span>])
<span class="ruby-comment">#=> [Array, 'a']</span>
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">reachable_objects_from</span>(<span class="ruby-value">1</span>)
<span class="ruby-comment">#=> nil # 1 is not markable (heap managed) object</span>
</pre>
<div class="method-source-code" id="reachable_objects_from-source">
<pre>static VALUE
reachable_objects_from(VALUE self, VALUE obj)
{
if (rb_objspace_markable_object_p(obj)) {
VALUE ret = rb_ary_new();
struct rof_data data;
if (rb_typeddata_is_kind_of(obj, &iow_data_type)) {
obj = (VALUE)DATA_PTR(obj);
}
data.refs = st_init_numtable();
data.internals = rb_ary_new();
rb_objspace_reachable_objects_from(obj, reachable_object_from_i, &data);
st_foreach(data.refs, collect_values, (st_data_t)ret);
return ret;
}
else {
return Qnil;
}
}</pre>
</div>
</div>
</div>
<div id="method-c-reachable_objects_from_root" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
reachable_objects_from_root → hash
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<dl class="rdoc-list label-list"><dt>MRI specific feature
<dd>
<p>Return all reachable objects from root.</p>
</dd></dl>
<div class="method-source-code" id="reachable_objects_from_root-source">
<pre>static VALUE
reachable_objects_from_root(VALUE self)
{
struct rofr_data data;
VALUE hash = data.categories = rb_ident_hash_new();
data.last_category = 0;
rb_objspace_reachable_objects_from_root(reachable_object_from_root_i, &data);
rb_hash_foreach(hash, collect_values_of_values, hash);
return hash;
}</pre>
</div>
</div>
</div>
<div id="method-c-trace_object_allocations" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
trace_object_allocations { block }
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Starts tracing object allocations from the <a href="ObjectSpace.html"><code>ObjectSpace</code></a> extension module.</p>
<p>For example:</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'objspace'</span>
<span class="ruby-keyword">class</span> <span class="ruby-constant">C</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">ObjectSpace</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">foo</span>
<span class="ruby-identifier">trace_object_allocations</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">obj</span> = <span class="ruby-constant">Object</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">p</span> <span class="ruby-node">"#{allocation_sourcefile(obj)}:#{allocation_sourceline(obj)}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">C</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">foo</span> <span class="ruby-comment">#=> "objtrace.rb:8"</span>
</pre>
<p>This example has included the <a href="ObjectSpace.html"><code>ObjectSpace</code></a> module to make it easier to read, but you can also use the <a href="ObjectSpace.html#method-c-trace_object_allocations"><code>::trace_object_allocations</code></a> notation (recommended).</p>
<p>Note that this feature introduces a huge performance decrease and huge memory consumption.</p>
<div class="method-source-code" id="trace_object_allocations-source">
<pre>static VALUE
trace_object_allocations(VALUE self)
{
trace_object_allocations_start(self);
return rb_ensure(rb_yield, Qnil, trace_object_allocations_stop, self);
}</pre>
</div>
</div>
</div>
<div id="method-c-trace_object_allocations_clear" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
trace_object_allocations_clear
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Clear recorded tracing information.</p>
<div class="method-source-code" id="trace_object_allocations_clear-source">
<pre>static VALUE
trace_object_allocations_clear(VALUE self)
{
struct traceobj_arg *arg = get_traceobj_arg();
/* clear tables */
st_foreach(arg->object_table, free_values_i, 0);
st_clear(arg->object_table);
st_foreach(arg->str_table, free_keys_i, 0);
st_clear(arg->str_table);
/* do not touch TracePoints */
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-trace_object_allocations_debug_start" class="method-detail ">
<div class="method-heading">
<span class="method-name">trace_object_allocations_debug_start</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="trace_object_allocations_debug_start-source">
<pre>static VALUE
trace_object_allocations_debug_start(VALUE self)
{
tmp_keep_remains = 1;
if (object_allocations_reporter_registered == 0) {
object_allocations_reporter_registered = 1;
rb_bug_reporter_add(object_allocations_reporter, 0);
}
return trace_object_allocations_start(self);
}</pre>
</div>
</div>
</div>
<div id="method-c-trace_object_allocations_start" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
trace_object_allocations_start
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Starts tracing object allocations.</p>
<div class="method-source-code" id="trace_object_allocations_start-source">
<pre>static VALUE
trace_object_allocations_start(VALUE self)
{
struct traceobj_arg *arg = get_traceobj_arg();
if (arg->running++ > 0) {
/* do nothing */
}
else {
if (arg->newobj_trace == 0) {
arg->newobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_NEWOBJ, newobj_i, arg);
rb_gc_register_mark_object(arg->newobj_trace);
arg->freeobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_FREEOBJ, freeobj_i, arg);
rb_gc_register_mark_object(arg->freeobj_trace);
}
rb_tracepoint_enable(arg->newobj_trace);
rb_tracepoint_enable(arg->freeobj_trace);
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-trace_object_allocations_stop" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
trace_object_allocations_stop
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Stop tracing object allocations.</p>
<p>Note that if <a href="ObjectSpace.html#method-c-trace_object_allocations_start"><code>::trace_object_allocations_start</code></a> is called n-times, then tracing will stop after calling <a href="ObjectSpace.html#method-c-trace_object_allocations_stop"><code>::trace_object_allocations_stop</code></a> n-times.</p>
<div class="method-source-code" id="trace_object_allocations_stop-source">
<pre>static VALUE
trace_object_allocations_stop(VALUE self)
{
struct traceobj_arg *arg = get_traceobj_arg();
if (arg->running > 0) {
arg->running--;
}
if (arg->running == 0) {
rb_tracepoint_disable(arg->newobj_trace);
rb_tracepoint_disable(arg->freeobj_trace);
}
return Qnil;
}</pre>
</div>
</div>
</div>
<div id="method-c-undefine_finalizer" class="method-detail ">
<div class="method-heading">
<span class="method-callseq">
undefine_finalizer(obj)
</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Removes all finalizers for <em>obj</em>.</p>
<div class="method-source-code" id="undefine_finalizer-source">
<pre>static VALUE
undefine_final(VALUE os, VALUE obj)
{
return rb_undefine_finalizer(obj);
}</pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-garbage_collect" class="method-detail ">
<div class="method-heading">
<span class="method-name">garbage_collect</span><span
class="method-args">(full_mark: true, immediate_mark: true, immediate_sweep: true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="garbage_collect-source">
<pre><span class="ruby-comment"># File gc.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">garbage_collect</span> <span class="ruby-value">full_mark:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">immediate_mark:</span> <span class="ruby-keyword">true</span>, <span class="ruby-value">immediate_sweep:</span> <span class="ruby-keyword">true</span>
<span class="ruby-identifier">__builtin_gc_start_internal</span> <span class="ruby-identifier">full_mark</span>, <span class="ruby-identifier">immediate_mark</span>, <span class="ruby-identifier">immediate_sweep</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>