[GR-22583] C handle specs

PullRequest: truffleruby/3359

Author: aardvark179

spec/mspec/lib/mspec/runner/context.rb

@@ -210,6 +210,7 @@ def process
               MSpec.clear_expectations
               if example
                 passed = protect nil, example
+                passed = protect nil, -> { MSpec.actions :passed, state, example } if passed
                 MSpec.actions :example, state, example
                 protect nil, EXPECTATION_MISSING if !MSpec.expectation? and passed
               end

spec/mspec/lib/mspec/runner/mspec.rb

@@ -26,6 +26,7 @@ module MSpec
   @unload  = nil
   @tagged  = nil
   @current = nil
+  @passed = nil
   @example = nil
   @modes   = []
   @shared  = {}
@@ -243,6 +244,7 @@ def self.store(symbol, value)
   #   :before       before a single spec is run
   #   :add          while a describe block is adding examples to run later
   #   :expectation  before a 'should', 'should_receive', etc.
+  #   :passed       after an example block is run and passes, passed the block, run before :example action
   #   :example      after an example block is run, passed the block
   #   :exception    after an exception is rescued
   #   :after        after a single spec is run

spec/nativeconversion.mspec

@@ -0,0 +1,68 @@
+
+class NativeHandleChecker
+  EXPECTED_FAILURES = {
+    "C-API Debug function rb_debug_inspector_open creates a debug context and calls the given callback" => 2,
+    "C-API Debug function rb_debug_inspector_frame_self_get returns self" => 2,
+    "C-API Debug function rb_debug_inspector_frame_class_get returns the frame class" => 2,
+    "C-API Debug function rb_debug_inspector_frame_binding_get returns the current binding" => 2,
+    "C-API Debug function rb_debug_inspector_frame_binding_get matches the locations in rb_debug_inspector_backtrace_locations" => 2,
+    "C-API Debug function rb_debug_inspector_frame_iseq_get returns an InstructionSequence" => 2,
+    "C-API Debug function rb_debug_inspector_backtrace_locations returns an array of Thread::Backtrace::Location" => 2,
+    "C-API IO function rb_io_printf calls #to_str to convert the format object to a String" => 2,
+    "C-API IO function rb_io_printf calls #to_s to convert the object to a String" => 2,
+    "C-API IO function rb_io_printf writes the Strings to the IO" => 4,
+    "C-API IO function rb_io_print calls #to_s to convert the object to a String" => 1,
+    "C-API IO function rb_io_print writes the Strings to the IO with no separator" => 3,
+    "C-API IO function rb_io_puts calls #to_s to convert the object to a String" => 1,
+    "C-API IO function rb_io_puts writes the Strings to the IO separated by newlines" => 3,
+    "C-API Kernel function rb_rescue executes the passed 'rescue function' if a StandardError exception is raised" => 3,
+    "C-API Kernel function rb_rescue passes the user supplied argument to the 'rescue function' if a StandardError exception is raised" => 4,
+    "C-API Kernel function rb_rescue passes the raised exception to the 'rescue function' if a StandardError exception is raised" => 2,
+    "C-API Kernel function rb_rescue raises an exception if any exception is raised inside the 'rescue function'" => 1,
+    "C-API Kernel function rb_rescue makes $! available only during the 'rescue function' execution" => 1,
+    "CApiObject rb_obj_call_init sends #initialize" => 2,
+    "C-API String function rb_sprintf formats a string VALUE using to_s if sign not specified in format" => 1,
+    "C-API String function rb_sprintf formats a string VALUE using inspect if sign specified in format" => 1,
+    "C-API String function rb_sprintf formats a TrueClass VALUE as `TrueClass` if sign not specified in format" => 1,
+    "C-API String function rb_sprintf truncates a VALUE string to a supplied precision if that is shorter than the VALUE string" => 1,
+    "C-API String function rb_sprintf does not truncates a VALUE string to a supplied precision if that is longer than the VALUE string" => 1,
+    "C-API String function rb_sprintf pads a VALUE string to a supplied width if that is longer than the VALUE string" => 1,
+    "C-API String function rb_sprintf can format a string VALUE as a pointer and gives the same output as sprintf in C" => 1,
+    "C-API String function rb_string_value_cstr returns a non-null pointer for a simple string" => 1,
+    "C-API String function rb_string_value_cstr returns a non-null pointer for a UTF-16 string" => 1,
+    "C-API String function rb_string_value_cstr raises an error if a string contains a null" => 1,
+    "C-API String function rb_string_value_cstr raises an error if a UTF-16 string contains a null" => 1,
+    "CApiWrappedTypedStruct throws an exception for a wrong type" => 1,
+    "C-API Util function rb_scan_args assigns Hash arguments" => 1,
+    "C-API Util function rb_scan_args assigns required and Hash arguments" => 1,
+    "C-API Util function rb_scan_args assigns required, optional, splat, post-splat, Hash and block arguments" => 1,
+    "C-API Util function rb_get_kwargs extracts required arguments in the order requested" => 2,
+    "C-API Util function rb_get_kwargs extracts required and optional arguments in the order requested" => 1,
+    "C-API Util function rb_get_kwargs raises an error if a required argument is not in the hash" => 1,
+    "Native handle conversion converts all elements to native handles when memcpying an RARRAY_PTR" => 1000,
+  }
+
+  def register
+    MSpec.register :before, self
+    MSpec.register :passed, self
+  end
+
+  def unregister
+    MSpec.unregister :before, self
+    MSpec.unregister :passed, self
+  end
+
+  def before(state)
+    @start_count = Truffle::Debug.cexts_to_native_count
+  end
+
+  def passed(state, example)
+    (Truffle::Debug.cexts_to_native_count - @start_count).should == (EXPECTED_FAILURES[state.description] || 0)
+  end
+end
+
+begin
+  checker = NativeHandleChecker.new
+  checker.register
+  load File.expand_path('../truffleruby.mspec', __FILE__)
+end

spec/truffle/capi/ext/handle_conversion_spec.c

@@ -0,0 +1,54 @@
+/*
+ * Copyright (c) 2021 Oracle and/or its affiliates. All rights reserved. This
+ * code is released under a tri EPL/GPL/LGPL license. You can use it,
+ * redistribute it and/or modify it under the terms of the:
+ *
+ * Eclipse Public License version 2.0, or
+ * GNU General Public License version 2, or
+ * GNU Lesser General Public License version 2.1.
+ */
+#include "ruby.h"
+#include "rubyspec.h"
+#include <stdio.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+static VALUE value_comparison_with_nil(VALUE self, VALUE val) {
+  return val == Qnil ? Qtrue : Qfalse;
+}
+
+static VALUE value_array_ptr_access(VALUE self, VALUE ary) {
+  VALUE *ptr = RARRAY_PTR(ary);
+  return ptr[0];
+}
+
+static VALUE value_array_ptr_memcpy(VALUE self, VALUE ary) {
+  VALUE *ptr = RARRAY_PTR(ary);
+  VALUE *cpy = malloc(RARRAY_LEN(ary) * sizeof(VALUE));
+  VALUE res;
+  memcpy(cpy, ptr, RARRAY_LEN(ary) * sizeof(VALUE));
+  res = cpy[1];
+  free(cpy);
+  return res;
+}
+
+static VALUE our_static_value;
+
+static VALUE value_store_in_static(VALUE self, VALUE val) {
+  our_static_value = val;
+  return val;
+}
+
+void Init_handle_conversion_spec(void) {
+  VALUE cls = rb_define_class("CAPIHandleConversionTest", rb_cObject);
+  rb_define_method(cls, "value_comparison_with_nil", value_comparison_with_nil, 1);
+  rb_define_method(cls, "value_array_ptr_access", value_array_ptr_access, 1);
+  rb_define_method(cls, "value_array_ptr_memcpy", value_array_ptr_memcpy, 1);
+  rb_define_method(cls, "value_store_in_static", value_store_in_static, 1);
+}
+
+#ifdef __cplusplus
+}
+#endif

spec/truffle/capi/handle_conversion_spec.rb

@@ -0,0 +1,33 @@
+# Copyright (c) 2017, 2021 Oracle and/or its affiliates. All rights reserved. This
+# code is released under a tri EPL/GPL/LGPL license. You can use it,
+# redistribute it and/or modify it under the terms of the:
+#
+# Eclipse Public License version 2.0, or
+# GNU General Public License version 2, or
+# GNU Lesser General Public License version 2.1.
+
+require_relative '../../ruby/optional/capi/spec_helper'
+
+load_extension('handle_conversion')
+
+guard -> { Truffle::Boot.get_option('cexts-to-native-count') == true } do
+  describe "Native handle conversion" do
+    it "converts no handles when comparing a VALUE with a constant" do
+      CAPIHandleConversionTest.new.value_comparison_with_nil(Object.new)
+    end
+
+    it "converts no handles when accessing array elements via an RARRAY_PTR" do
+      ary = Array.new(1000) { Object.new }
+      CAPIHandleConversionTest.new.value_array_ptr_access([ary])
+    end
+
+    it "converts all elements to native handles when memcpying an RARRAY_PTR" do
+      ary = Array.new(1000) { Object.new }
+      CAPIHandleConversionTest.new.value_array_ptr_memcpy(ary)
+    end
+
+    it "converts no handles when storing a VALUE in a static variable" do
+      CAPIHandleConversionTest.new.value_store_in_static(Object.new)
+    end
+  end
+end

src/main/java/org/truffleruby/cext/ValueWrapperManager.java

@@ -324,7 +324,7 @@ protected static long allocateHandle(ValueWrapper wrapper, RubyContext context,
                 block = holder.handleBlock;
             }
 
-            if (context.getOptions().CEXTS_TO_NATIVE_STATS) {
+            if (context.getOptions().CEXTS_TO_NATIVE_COUNT) {
                 context.getValueWrapperManager().recordHandleAllocation();
             }
 

src/main/java/org/truffleruby/debug/TruffleDebugNodes.java

@@ -1275,4 +1275,13 @@ protected RubyArray primitiveNames() {
         }
     }
 
+    @CoreMethod(names = "cexts_to_native_count", onSingleton = true)
+    public abstract static class HandleCreationCountNode extends CoreMethodArrayArgumentsNode {
+
+        @Specialization
+        protected long handleCount() {
+            return getContext().getValueWrapperManager().totalHandleAllocations();
+        }
+    }
+
 }

src/main/java/org/truffleruby/options/Options.java

@@ -164,6 +164,8 @@ public class Options {
     public final boolean ROPE_PRINT_INTERN_STATS;
     /** --cexts-to-native-stats=false */
     public final boolean CEXTS_TO_NATIVE_STATS;
+    /** --cexts-to-native-count=CEXTS_TO_NATIVE_STATS */
+    public final boolean CEXTS_TO_NATIVE_COUNT;
     /** --basic-ops-log-rewrite=false */
     public final boolean BASICOPS_LOG_REWRITE;
     /** --array-small=3 */
@@ -278,6 +280,7 @@ public Options(Env env, OptionValues options, LanguageOptions languageOptions) {
         LOG_PENDING_INTERRUPTS = options.get(OptionsCatalog.LOG_PENDING_INTERRUPTS_KEY);
         ROPE_PRINT_INTERN_STATS = options.get(OptionsCatalog.ROPE_PRINT_INTERN_STATS_KEY);
         CEXTS_TO_NATIVE_STATS = options.get(OptionsCatalog.CEXTS_TO_NATIVE_STATS_KEY);
+        CEXTS_TO_NATIVE_COUNT = options.hasBeenSet(OptionsCatalog.CEXTS_TO_NATIVE_COUNT_KEY) ? options.get(OptionsCatalog.CEXTS_TO_NATIVE_COUNT_KEY) : CEXTS_TO_NATIVE_STATS;
         BASICOPS_LOG_REWRITE = options.get(OptionsCatalog.BASICOPS_LOG_REWRITE_KEY);
         ARRAY_SMALL = options.get(OptionsCatalog.ARRAY_SMALL_KEY);
         CEXTS_MARKING_CACHE = options.get(OptionsCatalog.CEXTS_MARKING_CACHE_KEY);
@@ -443,6 +446,8 @@ public Object fromDescriptor(OptionDescriptor descriptor) {
                 return ROPE_PRINT_INTERN_STATS;
             case "ruby.cexts-to-native-stats":
                 return CEXTS_TO_NATIVE_STATS;
+            case "ruby.cexts-to-native-count":
+                return CEXTS_TO_NATIVE_COUNT;
             case "ruby.basic-ops-log-rewrite":
                 return BASICOPS_LOG_REWRITE;
             case "ruby.array-small":

src/options.yml

@@ -172,6 +172,7 @@ INTERNAL: # Options for debugging the TruffleRuby implementation
     LOG_PENDING_INTERRUPTS: [log-pending-interrupts, boolean, false, Log when executing pending interrupts]
     ROPE_PRINT_INTERN_STATS: [rope-print-intern-stats, boolean, false, Print interned rope stats at application exit]
     CEXTS_TO_NATIVE_STATS: [cexts-to-native-stats, boolean, false, Track the number of conversions of VALUEs to native and print the stats at application exit]
+    CEXTS_TO_NATIVE_COUNT: [cexts-to-native-count, boolean, CEXTS_TO_NATIVE_STATS, Track the number of conversions of VALUEs to native]
 
     # Options to debug the implementation
     LAZY_BUILTINS: [lazy-builtins, boolean, LAZY_CALLTARGETS, Load builtin classes (core methods & primitives) lazily on first use]

src/shared/java/org/truffleruby/shared/options/OptionsCatalog.java

@@ -102,6 +102,7 @@ public class OptionsCatalog {
     public static final OptionKey<Boolean> LOG_PENDING_INTERRUPTS_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> ROPE_PRINT_INTERN_STATS_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> CEXTS_TO_NATIVE_STATS_KEY = new OptionKey<>(false);
+    public static final OptionKey<Boolean> CEXTS_TO_NATIVE_COUNT_KEY = new OptionKey<>(CEXTS_TO_NATIVE_STATS_KEY.getDefaultValue());
     public static final OptionKey<Boolean> LAZY_BUILTINS_KEY = new OptionKey<>(LAZY_CALLTARGETS_KEY.getDefaultValue());
     public static final OptionKey<Boolean> LAZY_TRANSLATION_CORE_KEY = new OptionKey<>(LAZY_CALLTARGETS_KEY.getDefaultValue());
     public static final OptionKey<Boolean> CHAOS_DATA_KEY = new OptionKey<>(false);
@@ -819,6 +820,14 @@ public class OptionsCatalog {
             .usageSyntax("")
             .build();
 
+    public static final OptionDescriptor CEXTS_TO_NATIVE_COUNT = OptionDescriptor
+            .newBuilder(CEXTS_TO_NATIVE_COUNT_KEY, "ruby.cexts-to-native-count")
+            .help("Track the number of conversions of VALUEs to native")
+            .category(OptionCategory.INTERNAL)
+            .stability(OptionStability.EXPERIMENTAL)
+            .usageSyntax("")
+            .build();
+
     public static final OptionDescriptor LAZY_BUILTINS = OptionDescriptor
             .newBuilder(LAZY_BUILTINS_KEY, "ruby.lazy-builtins")
             .help("Load builtin classes (core methods & primitives) lazily on first use")
@@ -1465,6 +1474,8 @@ public static OptionDescriptor fromName(String name) {
                 return ROPE_PRINT_INTERN_STATS;
             case "ruby.cexts-to-native-stats":
                 return CEXTS_TO_NATIVE_STATS;
+            case "ruby.cexts-to-native-count":
+                return CEXTS_TO_NATIVE_COUNT;
             case "ruby.lazy-builtins":
                 return LAZY_BUILTINS;
             case "ruby.lazy-translation-core":
@@ -1674,6 +1685,7 @@ public static OptionDescriptor[] allDescriptors() {
             LOG_PENDING_INTERRUPTS,
             ROPE_PRINT_INTERN_STATS,
             CEXTS_TO_NATIVE_STATS,
+            CEXTS_TO_NATIVE_COUNT,
             LAZY_BUILTINS,
             LAZY_TRANSLATION_CORE,
             CHAOS_DATA,