* include/ruby/ruby.h, gc.c: add new internal events

  RUBY_INTERNAL_EVENT_GC_ENTER and
  RUBY_INTERNAL_EVENT_GC_EXIT.
  When invoking GC process, GC_ENTER event is called.
  When exiting from GC process, GC_EXIT event is called.
  Incremental GC (incremental marking and lazy sweep) can call
  these events many times.
  For example (minor marking):
  (1) GC_ENTER
  - (2) GC_START (minor GC)
    (minor marking)
  - (3) GC_END_MARK
    (start lazy sweep)
  (4) GC_EXIT
    (ruby process)
  (5) GC_ENTER
    (lazy sweep)
  (6) GC_EXIT
    (ruby process)
    (... repeat (5), (6))
  (7) GC_ENTER
      (finish lazy sweep)
    - (8) GC_END_SWEEP
  (9) GC_EXIT
  2nd example (incremental major marking):
  (1) GC_ENTER
  - (2) GC_START (minor GC)
    (start incremental marking)
  (3) GC_EXIT
    (ruby process)
  (4) GC_ENTER
    (incremental marking)
  (5) GC_EXIT
     (ruby process)
     (... repeat (4), (5))
  (6) GC_ENTER
    (finish incremental marking)
  - (7) GC_END_MARK
    (start lazy sweep)
  (8) GC_EXIT
    (ruby process)
  (9) GC_ENTER
    (lazy sweep)
  (10) GC_EXIT
    (ruby process)
    (... repeat (9), (10))
  (11) GC_ENTER
    (finish lazy marking)
  - (12) GC_STOP_SWEEP
  (13) GC_EXIT
  Thease internal events enable to measure GC pause time completely.



git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@47528 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

3 files changed, 64 insertions, 1 deletions

diff --git a/ChangeLog b/ChangeLog
index a96e9c6385..d706acdb71 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,62 @@
+Thu Sep 11 17:25:31 2014  Koichi Sasada  <[email protected]>
+
+	* include/ruby/ruby.h, gc.c: add new internal events
+	  RUBY_INTERNAL_EVENT_GC_ENTER and
+	  RUBY_INTERNAL_EVENT_GC_EXIT.
+
+	  When invoking GC process, GC_ENTER event is called.
+	  When exiting from GC process, GC_EXIT event is called.
+
+	  Incremental GC (incremental marking and lazy sweep) can call
+	  these events many times.
+
+	  For example (minor marking):
+	  (1) GC_ENTER
+	  - (2) GC_START (minor GC)
+	    (minor marking)
+	  - (3) GC_END_MARK
+	    (start lazy sweep)
+	  (4) GC_EXIT
+	    (ruby process)
+	  (5) GC_ENTER
+	    (lazy sweep)
+	  (6) GC_EXIT
+	    (ruby process)
+	    (... repeat (5), (6))
+	  (7) GC_ENTER
+	      (finish lazy sweep)
+	    - (8) GC_END_SWEEP
+	  (9) GC_EXIT
+
+	  2nd example (incremental major marking):
+	  (1) GC_ENTER
+	  - (2) GC_START (minor GC)
+	    (start incremental marking)
+	  (3) GC_EXIT
+	    (ruby process)
+	  (4) GC_ENTER
+	    (incremental marking)
+	  (5) GC_EXIT
+	     (ruby process)
+	     (... repeat (4), (5))
+	  (6) GC_ENTER
+	    (finish incremental marking)
+	  - (7) GC_END_MARK
+	    (start lazy sweep)
+	  (8) GC_EXIT
+	    (ruby process)
+	  (9) GC_ENTER
+	    (lazy sweep)
+	  (10) GC_EXIT
+	    (ruby process)
+	    (... repeat (9), (10))
+	  (11) GC_ENTER
+	    (finish lazy marking)
+	  - (12) GC_STOP_SWEEP
+	  (13) GC_EXIT
+
+	  Thease internal events enable to measure GC pause time completely.
+
 Thu Sep 11 17:04:54 2014  Eric Wong  <[email protected]>
 
 	* lib/benchmark.rb: remove CLOCK_MONOTONIC_RAW support
diff --git a/gc.c b/gc.c
index cd9ffe4513..0f74f80d5d 100644
--- a/gc.c
+++ b/gc.c
@@ -5966,6 +5966,7 @@ gc_enter(rb_objspace_t *objspace, const char *event)
     during_gc = TRUE;
     gc_report(1, objspace, "gc_entr: %s [%s]\n", event, gc_current_status(objspace));
     gc_record(objspace, 0, event);
+    gc_event_hook(objspace, RUBY_INTERNAL_EVENT_GC_ENTER, 0); /* TODO: which parameter should be passed? */
 }
 
 static inline void
@@ -5973,6 +5974,7 @@ gc_exit(rb_objspace_t *objspace, const char *event)
 {
     if (RGENGC_CHECK_MODE) assert(during_gc != 0);
 
+    gc_event_hook(objspace, RUBY_INTERNAL_EVENT_GC_EXIT, 0); /* TODO: which parameter should be passsed? */
     gc_record(objspace, 1, event);
     gc_report(1, objspace, "gc_exit: %s [%s]\n", event, gc_current_status(objspace));
     during_gc = FALSE;
diff --git a/include/ruby/ruby.h b/include/ruby/ruby.h
index 01e9be386b..b98c7e4eca 100644
--- a/include/ruby/ruby.h
+++ b/include/ruby/ruby.h
@@ -1683,7 +1683,9 @@ int ruby_native_thread_p(void);
 #define RUBY_INTERNAL_EVENT_GC_START        0x400000
 #define RUBY_INTERNAL_EVENT_GC_END_MARK     0x800000
 #define RUBY_INTERNAL_EVENT_GC_END_SWEEP   0x1000000
-#define RUBY_INTERNAL_EVENT_OBJSPACE_MASK  0x1f00000
+#define RUBY_INTERNAL_EVENT_GC_ENTER       0x2000000
+#define RUBY_INTERNAL_EVENT_GC_EXIT        0x4000000
+#define RUBY_INTERNAL_EVENT_OBJSPACE_MASK  0x7f00000
 #define RUBY_INTERNAL_EVENT_MASK          0xfffe0000
 
 typedef unsigned long rb_event_flag_t;