From d21a30ac4fa68e809229de136b37c5ad954eeaa9 Mon Sep 17 00:00:00 2001
From: Kunshan Wang <wks1986@gmail.com>
Date: Fri, 24 Nov 2023 20:18:40 +0800
Subject: [PATCH] Pin dynamic symbol in rb_sym2id

A dynamic symbol with an associated ID is implicitly pinned in Ruby.  We
also pin it with MMTk's API when using MMTk.
---
 internal/mmtk.h |  6 ++++++
 symbol.c        | 14 ++++++++++++++
 2 files changed, 20 insertions(+)

diff --git a/internal/mmtk.h b/internal/mmtk.h
index 3777f9474ec592..43fe3f77cd1fc0 100644
--- a/internal/mmtk.h
+++ b/internal/mmtk.h
@@ -197,4 +197,10 @@ void mmtk_gc_poll(MMTk_VMMutatorThread tls);
 
 size_t mmtk_get_immix_bump_ptr_offset(void);
 
+bool mmtk_pin_object(MMTk_ObjectReference object);
+
+bool mmtk_unpin_object(MMTk_ObjectReference object);
+
+bool mmtk_is_pinned(MMTk_ObjectReference object);
+
 #endif /* MMTK_H */
diff --git a/symbol.c b/symbol.c
index 771b56fa1d2ebc..305f415f2d4ddc 100644
--- a/symbol.c
+++ b/symbol.c
@@ -910,11 +910,25 @@ rb_sym2id(VALUE sym)
                 RSYMBOL(sym)->id = id |= num;
                 /* make it permanent object */
 
+#if USE_MMTK
+                if (rb_mmtk_enabled_p()) {
+                    // Symbols with associated ID are implicitly pinned (see gc_is_moveable_obj).
+                    // When using MMTk, we need to inform MMTk not to move the object.
+                    mmtk_pin_object((MMTk_ObjectReference)sym);
+                }
+#endif
+
                 set_id_entry(symbols, rb_id_to_serial(num), fstr, sym);
                 rb_hash_delete_entry(symbols->dsymbol_fstr_hash, fstr);
             }
         }
         GLOBAL_SYMBOLS_LEAVE();
+#if USE_MMTK && RUBY_DEBUG
+        if (rb_mmtk_enabled_p()) {
+            // Assert that all dynamic symbols returned from this function are pinned.
+            RUBY_ASSERT(mmtk_is_pinned((MMTk_ObjectReference)sym));
+        }
+#endif
     }
     else {
         rb_raise(rb_eTypeError, "wrong argument type %s (expected Symbol)",