aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--ChangeLog4
-rw-r--r--include/ruby/ruby.h11
2 files changed, 15 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index dfaadc5843..d8e4ab7ac1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Fri Dec 20 16:01:35 2013 Koichi Sasada <ko1@atdot.net>
+
+ * include/ruby/ruby.h: add a comment for WB interfaces.
+
Fri Dec 20 16:00:52 2013 Nobuyoshi Nakada <nobu@ruby-lang.org>
* configure.in: DLDFLAGS is defined in --with-opt-dir handler, so
diff --git a/include/ruby/ruby.h b/include/ruby/ruby.h
index 03b9bd0d1a..366ce96983 100644
--- a/include/ruby/ruby.h
+++ b/include/ruby/ruby.h
@@ -1199,6 +1199,17 @@ void rb_gc_writebarrier_unprotect_promoted(VALUE obj);
#define OBJ_WB_UNPROTECT(x) rb_obj_wb_unprotect(x, __FILE__, __LINE__)
#endif
+/* Write barrier (WB) interfaces:
+ * - OBJ_WRITE(a, slot, b): WB for new reference from `a' to `b'.
+ * Write `b' into `*slot'. `slot' is a pointer in `a'.
+ * - OBJ_WRITTEN(a, oldv, b): WB for new reference from `a' to `b'.
+ * This doesn't write any values, but only a WB declaration.
+ * `oldv' is replaced value with `b' (not used in current Ruby).
+ *
+ * NOTE: The following core interfaces can be changed in the future.
+ * Please catch up if you want to insert WB into C-extensions
+ * correctly.
+ */
#define OBJ_WRITE(a, slot, b) rb_obj_write((VALUE)(a), (VALUE *)(slot), (VALUE)(b), __FILE__, __LINE__)
#define OBJ_WRITTEN(a, oldv, b) rb_obj_written((VALUE)(a), (VALUE)(oldv), (VALUE)(b), __FILE__, __LINE__)