summaryrefslogtreecommitdiff
path: root/ext/objspace
diff options
context:
space:
mode:
authorko1 <ko1@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-05-27 18:14:28 +0000
committerko1 <ko1@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-05-27 18:14:28 +0000
commit30dbed383786362eaf70ad584a8b382a12b68fef (patch)
treebc0325c9f735daec0d64d6f3f8ffcb27380352ee /ext/objspace
parentb01c4ddfce5faa7e0bb982a41319c7e44141c5e3 (diff)
* ext/objspace/gc_hook.c, ext/objspace/objspace.c: add new methods to
hook GC invocation. * ObjectSpace.after_gc_start_hook=(proc) * ObjectSpace.after_gc_end_hook=(proc) Note that hooks are not kicked immediately. Procs are kicked at postponed_job. This feature is a sample of new internal event and rb_postponed_job API. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40970 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/objspace')
-rw-r--r--ext/objspace/gc_hook.c80
-rw-r--r--ext/objspace/objspace.c2
2 files changed, 82 insertions, 0 deletions
diff --git a/ext/objspace/gc_hook.c b/ext/objspace/gc_hook.c
new file mode 100644
index 0000000..1613227
--- /dev/null
+++ b/ext/objspace/gc_hook.c
@@ -0,0 +1,80 @@
+/**********************************************************************
+
+ gc_hook.c - GC hook mechanism/ObjectSpace extender for MRI.
+
+ $Author: sorah $
+ created at: Tue May 28 01:34:25 2013
+
+ NOTE: This extension library is not expected to exist except C Ruby.
+ NOTE: This feature is an example usage of internal event tracing APIs.
+
+ All the files in this distribution are covered under the Ruby's
+ license (see the file COPYING).
+
+**********************************************************************/
+
+#include "ruby/ruby.h"
+#include "ruby/debug.h"
+
+static void
+invoke_proc(void *data)
+{
+ VALUE proc = (VALUE)data;
+ rb_proc_call(proc, rb_ary_new());
+}
+
+static void
+gc_start_end_i(VALUE tpval, void *data)
+{
+ rb_trace_arg_t *tparg = rb_tracearg_from_tracepoint(tpval);
+ if (0) fprintf(stderr, "trace: %s\n", rb_tracearg_event_flag(tparg) == RUBY_INTERNAL_EVENT_GC_START ? "gc_start" : "gc_end");
+ rb_postponed_job_register(0, invoke_proc, data);
+}
+
+static VALUE
+set_gc_hook(VALUE rb_mObjSpace, VALUE proc, rb_event_flag_t event, const char *tp_str, const char *proc_str)
+{
+ VALUE tpval;
+ ID tp_key = rb_intern(tp_str);
+ ID proc_key = rb_intern(proc_str);
+
+ if (RTEST(tpval = rb_ivar_get(rb_mObjSpace, tp_key))) {
+ rb_tracepoint_disable(tpval);
+ rb_ivar_set(rb_mObjSpace, tp_key, Qnil);
+ rb_ivar_set(rb_mObjSpace, proc_key, Qnil);
+ }
+
+ if (RTEST(proc)) {
+ if (!rb_obj_is_proc(proc)) {
+ rb_raise(rb_eTypeError, "trace_func needs to be Proc");
+ }
+
+ tpval = rb_tracepoint_new(0, event, gc_start_end_i, (void *)proc);
+ rb_ivar_set(rb_mObjSpace, tp_key, tpval);
+ rb_ivar_set(rb_mObjSpace, proc_key, proc); /* GC guard */
+ rb_tracepoint_enable(tpval);
+ }
+
+ return proc;
+}
+
+static VALUE
+set_after_gc_start(VALUE rb_mObjSpace, VALUE proc)
+{
+ return set_gc_hook(rb_mObjSpace, proc, RUBY_INTERNAL_EVENT_GC_START,
+ "__set_after_gc_start_tpval__", "__set_after_gc_start_proc__");
+}
+
+static VALUE
+set_after_gc_end(VALUE rb_mObjSpace, VALUE proc)
+{
+ return set_gc_hook(rb_mObjSpace, proc, RUBY_INTERNAL_EVENT_GC_END,
+ "__set_after_gc_end_tpval__", "__set_after_gc_end_proc__");
+}
+
+void
+Init_gc_hook(VALUE rb_mObjSpace)
+{
+ rb_define_module_function(rb_mObjSpace, "after_gc_start_hook=", set_after_gc_start, 1);
+ rb_define_module_function(rb_mObjSpace, "after_gc_end_hook=", set_after_gc_end, 1);
+}
diff --git a/ext/objspace/objspace.c b/ext/objspace/objspace.c
index a077a1e..ae298fc 100644
--- a/ext/objspace/objspace.c
+++ b/ext/objspace/objspace.c
@@ -780,6 +780,7 @@ reachable_objects_from(VALUE self, VALUE obj)
}
void Init_object_tracing(VALUE rb_mObjSpace);
+void Init_gc_hook(VALUE rb_mObjSpace);
/* objspace library extends ObjectSpace module and add several
* methods to get internal statistic information about
@@ -811,4 +812,5 @@ Init_objspace(void)
rb_define_method(rb_mInternalObjectWrapper, "internal_object_id", iow_internal_object_id, 0);
Init_object_tracing(rb_mObjSpace);
+ Init_gc_hook(rb_mObjSpace);
}