Move gc_fastpath.rs to codegen/gc_fastpath.rs

Author: peterzhu2118

zjit/src/codegen.rs

@@ -2,6 +2,8 @@
 
 #![allow(clippy::let_and_return)]
 
+mod gc_fastpath;
+
 use std::cell::{Cell, RefCell};
 use std::rc::Rc;
 use std::ffi::{c_int, c_long, c_void};
@@ -48,7 +50,7 @@ const PC_POISON: Option<*const VALUE> = if cfg!(feature = "runtime_checks") {
 };
 
 /// Ephemeral code generation state
-pub(crate) struct JITState {
+struct JITState {
     /// ISEQ version that is being compiled, which will be used by PatchPoint
     version: IseqVersionRef,
 
@@ -93,7 +95,7 @@ impl JITState {
     }
 
     /// Find or create a label for a given BlockId
-    pub(crate) fn get_label(&mut self, asm: &mut Assembler, lir_block_id: lir::BlockId, hir_block_id: BlockId) -> Target {
+    fn get_label(&mut self, asm: &mut Assembler, lir_block_id: lir::BlockId, hir_block_id: BlockId) -> Target {
         // Extend labels vector if the requested index is out of bounds
         if lir_block_id.0 >= self.labels.len() {
             self.labels.resize(lir_block_id.0 + 1, None);
@@ -137,7 +139,7 @@ macro_rules! define_split_jumps {
     ($($name:ident => $insn:ident),+ $(,)?) => {
         impl Assembler {
             $(
-                pub(crate) fn $name(&mut self, jit: &mut JITState, target: Target) {
+                fn $name(&mut self, jit: &mut JITState, target: Target) {
                     self.split_block_jump(jit, |asm, target| asm.push_insn(lir::Insn::$insn(target)), target);
                 }
             )+
@@ -1862,7 +1864,7 @@ fn gen_new_array(
     let flags = (RUBY_T_ARRAY as u64) | (RARRAY_EMBED_FLAG as u64);
     let klass = unsafe { rb_cArray };
 
-    crate::gc_fastpath::gc_fast_path_new_obj(jit, asm, alloc_size, flags, klass, |asm| {
+    gc_fastpath::gc_fast_path_new_obj(jit, asm, alloc_size, flags, klass, |asm| {
         asm_ccall!(asm, rb_ec_ary_new_from_values, EC, 0i64.into(), Opnd::UImm(0))
     })
 }

zjit/src/gc_fastpath.rs zjit/src/codegen/gc_fastpath.rszjit/src/gc_fastpath.rs renamed to zjit/src/codegen/gc_fastpath.rs

@@ -1,16 +1,16 @@
 use std::ffi::c_void;
 
 use crate::backend::lir::{self, Assembler, EC, Opnd, Target, asm_comment};
-use crate::codegen::JITState;
 use crate::cruby::{
     RB_GC_ZJIT_FASTPATH_DEFAULT, RB_GC_ZJIT_FASTPATH_MMTK,
     RUBY_OFFSET_EC_THREAD_PTR, RUBY_OFFSET_RBASIC_FLAGS, RUBY_OFFSET_RBASIC_KLASS,
     RUBY_OFFSET_THREAD_RACTOR, VALUE, VALUE_BITS, rb_zjit_offset_ractor_newobj_cache,
 };
+use super::JITState;
 
 #[repr(C)]
 #[derive(Clone, Copy)]
-pub(crate) struct RbGcZjitDefaultNewObjFastpath {
+struct RbGcZjitDefaultNewObjFastpath {
     cursor_offset: usize,
     jit_cursor_end_offset: usize,
     slot_size: usize,
@@ -20,7 +20,7 @@ pub(crate) struct RbGcZjitDefaultNewObjFastpath {
 
 #[repr(C)]
 #[derive(Clone, Copy)]
-pub(crate) struct RbGcZjitMmtkNewObjFastpath {
+struct RbGcZjitMmtkNewObjFastpath {
     objspace: *const c_void,
     objspace_total_allocated_objects_offset: usize,
     ractor_cache_mutator_offset: usize,
@@ -63,12 +63,12 @@ unsafe extern "C" {
     ) -> bool;
 }
 
-pub(crate) enum PreparedNewObjFastpath {
+enum PreparedNewObjFastpath {
     Default(RbGcZjitDefaultNewObjFastpath),
     Mmtk(RbGcZjitMmtkNewObjFastpath),
 }
 
-pub(crate) fn gc_fast_path_new_obj(
+pub(super) fn gc_fast_path_new_obj(
     jit: &mut JITState,
     asm: &mut Assembler,
     alloc_size: usize,
@@ -141,7 +141,7 @@ fn prepare_new_obj_fastpath(alloc_size: usize, flags: u64, klass: VALUE) -> Opti
     }
 }
 
-pub(crate) fn emit_new_obj_fastpath(
+fn emit_new_obj_fastpath(
     jit: &mut JITState,
     asm: &mut Assembler,
     prepared: &PreparedNewObjFastpath,
@@ -162,6 +162,10 @@ pub(crate) fn emit_new_obj_fastpath(
     }
 }
 
+/* This function implements the GC fast path for the default GC. It implements
+ * the fast path defined in function ractor_cache_allocate_slot (but not the
+ * medium path in ractor_cache_advance_region). It also implements newobj_init
+ * to write the flags and klass in the object.  */
 fn emit_default_new_obj_fastpath(
     jit: &mut JITState,
     asm: &mut Assembler,
@@ -199,6 +203,9 @@ fn emit_default_new_obj_fastpath(
     Some(cursor)
 }
 
+/* This function implements the GC fast path for MMTk. It implements the fast
+ * path defined in function rb_mmtk_alloc_fast_path, as well as writing the
+ * flags and klass into the object. */
 fn emit_mmtk_new_obj_fastpath(
     jit: &mut JITState,
     asm: &mut Assembler,

zjit/src/lib.rs

@@ -16,7 +16,6 @@ mod cruby_methods;
 mod hir;
 mod hir_type;
 mod hir_effect;
-mod gc_fastpath;
 mod codegen;
 mod stats;
 mod cast;