Merge pull request ruby#131 from Shopify/yjit-callfunc

Use `jit_func` as YJIT's entry point

Author: tenderworks

.gitignore

@@ -228,6 +228,3 @@ lcov*.info
 /rb_mjit_header.h
 /mjit_config.h
 /include/ruby-*/*/rb_mjit_min_header-*.h
-
-# YJIT
-/yjit_hooks.inc

bootstraptest/test_yjit.rb

@@ -1,3 +1,56 @@
+# Check that global tracepoints work
+assert_equal 'true', %q{
+  def foo
+    1
+  end
+
+  foo
+  foo
+  foo
+
+  called = false
+
+  tp = TracePoint.new(:return) { |event|
+    if event.method_id == :foo
+      called = true
+    end
+  }
+  tp.enable
+  foo
+  tp.disable
+  called
+}
+
+# Check that local tracepoints work
+assert_equal 'true', %q{
+  def foo
+    1
+  end
+
+  foo
+  foo
+  foo
+
+  called = false
+
+  tp = TracePoint.new(:return) { |_| called = true }
+  tp.enable(target: method(:foo))
+  foo
+  tp.disable
+  called
+}
+
+# Make sure that optional param methods return the correct value
+assert_equal '1', %q{
+  def m(ary = [])
+    yield(ary)
+  end
+
+  # Warm the JIT with a 0 param call
+  2.times { m { } }
+  m(1) { |v| v }
+}
+
 # Test for topn
 assert_equal 'array', %q{
   def threequals(a)

common.mk

@@ -1087,8 +1087,6 @@ incs: $(INSNS) {$(VPATH)}node_name.inc {$(VPATH)}known_errors.inc \
 
 insns: $(INSNS)
 
-yjit_hooks.inc: vm.$(OBJEXT)
-
 id.h: $(tooldir)/generic_erb.rb $(srcdir)/template/id.h.tmpl $(srcdir)/defs/id.def
 	$(ECHO) generating $@
 	$(Q) $(BASERUBY) $(tooldir)/generic_erb.rb --output=$@ \
@@ -16810,7 +16808,6 @@ yjit_compile.$(OBJEXT): {$(VPATH)}vm_sync.h
 yjit_compile.$(OBJEXT): {$(VPATH)}yjit.h
 yjit_compile.$(OBJEXT): {$(VPATH)}yjit_asm.h
 yjit_compile.$(OBJEXT): {$(VPATH)}yjit_compile.c
-yjit_compile.$(OBJEXT): {$(VPATH)}yjit_hooks.inc
 yjit_compile.$(OBJEXT): {$(VPATH)}yjit_utils.h
 yjit_core.$(OBJEXT): $(CCAN_DIR)/check_type/check_type.h
 yjit_core.$(OBJEXT): $(CCAN_DIR)/container_of/container_of.h
@@ -17206,7 +17203,6 @@ yjit_iface.$(OBJEXT): {$(VPATH)}yjit.rbinc
 yjit_iface.$(OBJEXT): {$(VPATH)}yjit_asm.h
 yjit_iface.$(OBJEXT): {$(VPATH)}yjit_codegen.h
 yjit_iface.$(OBJEXT): {$(VPATH)}yjit_core.h
-yjit_iface.$(OBJEXT): {$(VPATH)}yjit_hooks.inc
 yjit_iface.$(OBJEXT): {$(VPATH)}yjit_iface.c
 yjit_iface.$(OBJEXT): {$(VPATH)}yjit_iface.h
 yjit_utils.$(OBJEXT): {$(VPATH)}yjit_asm.h

iseq.c

@@ -3278,6 +3278,8 @@ rb_iseq_trace_flag_cleared(const rb_iseq_t *iseq, size_t pos)
     encoded_iseq_trace_instrument(&iseq_encoded[pos], 0, false);
 }
 
+typedef VALUE (*jit_func_t)(struct rb_execution_context_struct *, struct rb_control_frame_struct *);
+
 static int
 iseq_add_local_tracepoint(const rb_iseq_t *iseq, rb_event_flag_t turnon_events, VALUE tpval, unsigned int target_line)
 {
@@ -3288,6 +3290,11 @@ iseq_add_local_tracepoint(const rb_iseq_t *iseq, rb_event_flag_t turnon_events,
 
     VM_ASSERT(ISEQ_EXECUTABLE_P(iseq));
 
+#if USE_MJIT
+    // Force write the jit function to NULL
+    *((jit_func_t *)(&body->jit_func)) = 0;
+#endif
+
     for (pc=0; pc<body->iseq_size;) {
         const struct iseq_insn_info_entry *entry = get_insn_info(iseq, pc);
         rb_event_flag_t pc_events = entry->events;
@@ -3423,6 +3430,10 @@ rb_iseq_trace_set(const rb_iseq_t *iseq, rb_event_flag_t turnon_events)
             rb_event_flag_t pc_events = rb_iseq_event_flags(iseq, pc);
             pc += encoded_iseq_trace_instrument(&iseq_encoded[pc], pc_events & enabled_events, true);
 	}
+#if USE_MJIT
+        // Force write the jit function to NULL
+        *((jit_func_t *)(&body->jit_func)) = 0;
+#endif
     }
 }
 

mjit.h

@@ -149,17 +149,27 @@ mjit_exec(rb_execution_context_t *ec)
 
 #ifndef MJIT_HEADER
     if (rb_yjit_enabled_p() && !mjit_call_p && body->total_calls == rb_yjit_call_threshold())  {
-        rb_yjit_compile_iseq(iseq, ec);
-        return Qundef;
+        // If we couldn't generate any code for this iseq, then return
+        // Qundef so the interpreter will handle the call.
+        if (!rb_yjit_compile_iseq(iseq, ec)) {
+          return Qundef;
+        }
     }
 #endif
 
-    if (!mjit_call_p)
+    if (!(mjit_call_p || rb_yjit_enabled_p()))
         return Qundef;
 
     RB_DEBUG_COUNTER_INC(mjit_exec);
 
     mjit_func_t func = body->jit_func;
+
+    // YJIT tried compiling this function once before and couldn't do
+    // it, so return Qundef so the interpreter handles it.
+    if (rb_yjit_enabled_p() && func == 0) {
+      return Qundef;
+    }
+
     if (UNLIKELY((uintptr_t)func <= LAST_JIT_ISEQ_FUNC)) {
 #  ifdef MJIT_HEADER
         RB_DEBUG_COUNTER_INC(mjit_frame_JT2VM);
@@ -175,6 +185,8 @@ mjit_exec(rb_execution_context_t *ec)
     RB_DEBUG_COUNTER_INC(mjit_frame_VM2JT);
 #  endif
     RB_DEBUG_COUNTER_INC(mjit_exec_call_func);
+    // ec -> RDI
+    // cfp -> RSI
     return func(ec, ec->cfp);
 }
 

template/Makefile.in

@@ -577,7 +577,7 @@ update-known-errors:
 	$(IFCHANGE) $(srcdir)/defs/known_errors.def -
 
 INSNS	= opt_sc.inc optinsn.inc optunifs.inc insns.inc insns_info.inc \
-	  vmtc.inc vm.inc mjit_compile.inc yjit_hooks.inc
+	  vmtc.inc vm.inc mjit_compile.inc
 
 $(INSNS): $(srcdir)/insns.def vm_opts.h \
 	  $(srcdir)/defs/opt_operand.def $(srcdir)/defs/opt_insn_unif.def \
@@ -597,8 +597,6 @@ $(INSNS): $(srcdir)/insns.def vm_opts.h \
 	  $(tooldir)/ruby_vm/models/instructions_unifications.rb \
 	  $(tooldir)/ruby_vm/models/operands_unifications.rb \
 	  $(tooldir)/ruby_vm/models/trace_instructions.rb \
-	  $(tooldir)/ruby_vm/models/yjit.rb \
-	  $(tooldir)/ruby_vm/models/yjit/example_instructions.rb \
 	  $(tooldir)/ruby_vm/models/typemap.rb \
 	  $(tooldir)/ruby_vm/scripts/converter.rb \
 	  $(tooldir)/ruby_vm/scripts/insns2vm.rb \

test/lib/jit_support.rb

@@ -39,6 +39,7 @@ def eval_with_jit_without_retry(env = nil, script, verbose: 0, min_calls: 5, sav
       '--disable-gems', "--jit-verbose=#{verbose}",
       "--jit-min-calls=#{min_calls}", "--jit-max-cache=#{max_cache}",
     ]
+    args << '--disable-yjit'
     args << '--jit-wait' if wait
     args << '--jit-save-temps' if save_temps
     args << '--jit-debug' if defined?(@jit_debug) && @jit_debug

tool/ruby_vm/models/instructions.rb

@@ -13,12 +13,10 @@
 require_relative 'bare_instructions'
 require_relative 'operands_unifications'
 require_relative 'instructions_unifications'
-require_relative 'yjit'
 
 RubyVM::Instructions = RubyVM::BareInstructions.to_a + \
                        RubyVM::OperandsUnifications.to_a + \
-                       RubyVM::InstructionsUnifications.to_a + \
-                       RubyVM::YJIT::ExampleInstructions.to_a
+                       RubyVM::InstructionsUnifications.to_a
 
 
 require_relative 'trace_instructions'