[GR-19220] Implement rb_hash_start (#1841).

PullRequest: truffleruby/1173

Author: aardvark179

CHANGELOG.md

@@ -46,6 +46,7 @@ Compatibility:
 * Implemented `MatchData#dup` (#1792, @XrXr).
 * Implemented a native storage strategy for arrays to allow better C extension compatibility.
 * Implemented `rb_check_symbol_cstr` (#1814).
+* Implemented `rb_hash_start` (#1841, @XrXr).
 
 Performance:
 

lib/truffle/truffle/cext.rb

@@ -565,6 +565,10 @@ def RFLOAT_VALUE(value)
     value
   end
 
+  def rb_hash_start(h)
+    TrufflePrimitive.vm_hash_start(h)
+  end
+
   def rb_obj_classname(object)
     object.class.name
   end

spec/ruby/optional/capi/ext/hash_spec.c

@@ -113,6 +113,15 @@ VALUE hash_spec_rb_hash_set_ifnone(VALUE self, VALUE hash, VALUE def) {
   return rb_hash_set_ifnone(hash, def);
 }
 
+VALUE hash_spec_compute_a_hash_code(VALUE self, VALUE seed) {
+  int int_seed = FIX2INT(seed);
+  st_index_t h = rb_hash_start(int_seed);
+  h = rb_hash_uint32(h, 540u);
+  h = rb_hash_uint32(h, 340u);
+  h = rb_hash_end(h);
+  return ULONG2NUM(h);
+}
+
 void Init_hash_spec(void) {
   VALUE cls = rb_define_class("CApiHashSpecs", rb_cObject);
   rb_define_method(cls, "rb_hash", hash_spec_rb_hash, 1);
@@ -136,6 +145,7 @@ void Init_hash_spec(void) {
   rb_define_method(cls, "rb_hash_new", hash_spec_rb_hash_new, 0);
   rb_define_method(cls, "rb_hash_size", hash_spec_rb_hash_size, 1);
   rb_define_method(cls, "rb_hash_set_ifnone", hash_spec_rb_hash_set_ifnone, 2);
+  rb_define_method(cls, "compute_a_hash_code", hash_spec_compute_a_hash_code, 1);
 }
 
 #ifdef __cplusplus

spec/ruby/optional/capi/hash_spec.rb

@@ -254,4 +254,13 @@ def h.to_hash; 42; end
       -> { @s.rb_Hash(h) }.should raise_error(TypeError)
     end
   end
+
+  describe "hash code functions" do
+    it "computes a deterministic number" do
+      hash_code = @s.compute_a_hash_code(53)
+      hash_code.should be_an_instance_of(Integer)
+      hash_code.should == @s.compute_a_hash_code(53)
+      @s.compute_a_hash_code(90) == @s.compute_a_hash_code(90)
+    end
+  end
 end

src/main/c/cext/ruby.c

@@ -4350,7 +4350,7 @@ VALUE rb_str_cat_cstr(VALUE str, const char *ptr) {
 }
 
 st_index_t rb_hash_start(st_index_t h) {
-  rb_tr_error("rb_hash_start not implemented");
+  return (st_index_t) polyglot_as_i64(polyglot_invoke(RUBY_CEXT, "rb_hash_start", h));
 }
 
 int rb_str_hash_cmp(VALUE str1, VALUE str2) {

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

@@ -9,13 +9,10 @@
  */
 package org.truffleruby.cext;
 
-import org.truffleruby.RubyContext;
-import org.truffleruby.RubyLanguage;
 import org.truffleruby.cext.ValueWrapperManager.AllocateHandleNode;
 import org.truffleruby.core.MarkingServiceNodes.KeepAliveNode;
 
 import com.oracle.truffle.api.dsl.Cached;
-import com.oracle.truffle.api.dsl.CachedContext;
 import com.oracle.truffle.api.interop.InteropLibrary;
 import org.truffleruby.cext.ValueWrapperManager.HandleBlock;
 
@@ -72,7 +69,7 @@ public boolean equals(Object other) {
 
     @Override
     public int hashCode() {
-        return this.object.hashCode();
+        return object.hashCode();
     }
 
     @ExportMessage
@@ -87,21 +84,22 @@ public void toNative() {
     @ExportMessage
     public static long asPointer(
             ValueWrapper wrapper,
-            @CachedContext(RubyLanguage.class) RubyContext context,
             @Cached KeepAliveNode keepAliveNode,
             @Cached AllocateHandleNode createNativeHandleNode,
             @Cached BranchProfile createHandleProfile,
             @Cached BranchProfile taggedObjBranchProfile) {
-
         long handle = wrapper.getHandle();
+
         if (handle == ValueWrapperManager.UNSET_HANDLE) {
             createHandleProfile.enter();
             handle = createNativeHandleNode.execute(wrapper);
         }
+
         if (ValueWrapperManager.isTaggedObject(handle)) {
             taggedObjBranchProfile.enter();
             keepAliveNode.execute(wrapper);
         }
+
         return handle;
     }
 }

src/main/java/org/truffleruby/core/VMPrimitiveNodes.java

@@ -55,7 +55,7 @@
 import org.truffleruby.core.kernel.KernelNodesFactory;
 import org.truffleruby.core.proc.ProcOperations;
 import org.truffleruby.core.rope.CodeRange;
-import org.truffleruby.core.string.StringNodes;
+import org.truffleruby.core.string.StringNodes.MakeStringNode;
 import org.truffleruby.core.string.StringOperations;
 import org.truffleruby.language.backtrace.Backtrace;
 import org.truffleruby.language.control.ExitException;
@@ -84,13 +84,12 @@ public abstract class VMPrimitiveNodes {
     @Primitive(name = "vm_catch", needsSelf = false)
     public abstract static class CatchNode extends PrimitiveArrayArgumentsNode {
 
-        @Child private YieldNode dispatchNode = YieldNode.create();
-
         @Specialization
-        protected Object doCatch(VirtualFrame frame, Object tag, DynamicObject block,
+        protected Object doCatch(Object tag, DynamicObject block,
                 @Cached BranchProfile catchProfile,
                 @Cached("createBinaryProfile()") ConditionProfile matchProfile,
-                @Cached ReferenceEqualNode referenceEqualNode) {
+                @Cached ReferenceEqualNode referenceEqualNode,
+                @Cached YieldNode dispatchNode) {
             try {
                 return dispatchNode.executeDispatch(block, tag);
             } catch (ThrowException e) {
@@ -106,7 +105,7 @@ protected Object doCatch(VirtualFrame frame, Object tag, DynamicObject block,
 
     // The hard #exit!
     @Primitive(name = "vm_exit", needsSelf = false, lowerFixnum = 1)
-    public static abstract class VMExitPrimitiveNode extends PrimitiveArrayArgumentsNode {
+    public static abstract class VMExitNode extends PrimitiveArrayArgumentsNode {
 
         @Specialization
         protected Object vmExit(int status) {
@@ -149,16 +148,10 @@ protected boolean vmMethodIsBasic(VirtualFrame frame, DynamicObject method) {
     @Primitive(name = "vm_method_lookup", needsSelf = false)
     public static abstract class VMMethodLookupNode extends PrimitiveArrayArgumentsNode {
 
-        @Child private NameToJavaStringNode nameToJavaStringNode;
-        @Child private LookupMethodNode lookupMethodNode;
-
-        public VMMethodLookupNode() {
-            nameToJavaStringNode = NameToJavaStringNode.create();
-            lookupMethodNode = LookupMethodNode.create();
-        }
-
         @Specialization
-        protected DynamicObject vmMethodLookup(VirtualFrame frame, Object receiver, Object name) {
+        protected DynamicObject vmMethodLookup(VirtualFrame frame, Object receiver, Object name,
+                @Cached NameToJavaStringNode nameToJavaStringNode,
+                @Cached LookupMethodNode lookupMethodNode) {
             // TODO BJF Sep 14, 2016 Handle private
             final String normalizedName = nameToJavaStringNode.executeToJavaString(name);
             InternalMethod method = lookupMethodNode.lookupIgnoringVisibility(frame, receiver, normalizedName);
@@ -171,7 +164,7 @@ protected DynamicObject vmMethodLookup(VirtualFrame frame, Object receiver, Obje
     }
 
     @Primitive(name = "vm_object_respond_to", needsSelf = false)
-    public static abstract class VMObjectRespondToPrimitiveNode extends PrimitiveArrayArgumentsNode {
+    public static abstract class VMObjectRespondToNode extends PrimitiveArrayArgumentsNode {
 
         @Child private KernelNodes.RespondToNode respondToNode = KernelNodesFactory.RespondToNodeFactory
                 .create(null, null, null);
@@ -185,7 +178,7 @@ protected boolean vmObjectRespondTo(VirtualFrame frame, Object object, Object na
 
 
     @Primitive(name = "vm_object_singleton_class", needsSelf = false)
-    public static abstract class VMObjectSingletonClassPrimitiveNode extends PrimitiveArrayArgumentsNode {
+    public static abstract class VMObjectSingletonClassNode extends PrimitiveArrayArgumentsNode {
 
         @Child private KernelNodes.SingletonClassMethodNode singletonClassNode = KernelNodesFactory.SingletonClassMethodNodeFactory
                 .create(null);
@@ -228,7 +221,7 @@ public static void reRaiseException(RubyContext context, DynamicObject exception
     }
 
     @Primitive(name = "vm_set_module_name", needsSelf = false)
-    public static abstract class VMSetModuleNamePrimitiveNode extends PrimitiveArrayArgumentsNode {
+    public static abstract class VMSetModuleNameNode extends PrimitiveArrayArgumentsNode {
 
         @Specialization
         protected Object vmSetModuleName(Object object) {
@@ -248,7 +241,7 @@ protected Object doThrow(Object tag, Object value) {
     }
 
     @Primitive(name = "vm_watch_signal", needsSelf = false)
-    public static abstract class VMWatchSignalPrimitiveNode extends PrimitiveArrayArgumentsNode {
+    public static abstract class VMWatchSignalNode extends PrimitiveArrayArgumentsNode {
 
         @TruffleBoundary
         @Specialization(guards = { "isRubyString(signalName)", "isRubyString(action)" })
@@ -386,7 +379,7 @@ private boolean registerHandler(String signalName, Runnable newHandler) {
     }
 
     @Primitive(name = "vm_get_config_item", needsSelf = false)
-    public abstract static class VMGetConfigItemPrimitiveNode extends PrimitiveArrayArgumentsNode {
+    public abstract static class VMGetConfigItemNode extends PrimitiveArrayArgumentsNode {
 
         @TruffleBoundary
         @Specialization(guards = "isRubyString(key)")
@@ -403,14 +396,13 @@ protected Object get(DynamicObject key) {
     }
 
     @Primitive(name = "vm_get_config_section", needsSelf = false)
-    public abstract static class VMGetConfigSectionPrimitiveNode extends PrimitiveArrayArgumentsNode {
-
-        @Child private StringNodes.MakeStringNode makeStringNode = StringNodes.MakeStringNode.create();
-        @Child private YieldNode yieldNode = YieldNode.create();
+    public abstract static class VMGetConfigSectionNode extends PrimitiveArrayArgumentsNode {
 
         @TruffleBoundary
         @Specialization(guards = { "isRubyString(section)", "isRubyProc(block)" })
-        protected DynamicObject getSection(DynamicObject section, DynamicObject block) {
+        protected DynamicObject getSection(DynamicObject section, DynamicObject block,
+                @Cached MakeStringNode makeStringNode,
+                @Cached YieldNode yieldNode) {
             for (Entry<String, Object> entry : getContext()
                     .getNativeConfiguration()
                     .getSection(StringOperations.getString(section))) {
@@ -425,7 +417,7 @@ protected DynamicObject getSection(DynamicObject section, DynamicObject block) {
     }
 
     @Primitive(name = "vm_set_class", needsSelf = false)
-    public abstract static class VMSetClassPrimitiveNode extends PrimitiveArrayArgumentsNode {
+    public abstract static class VMSetClassNode extends PrimitiveArrayArgumentsNode {
 
         @Specialization(guards = "isRubyClass(newClass)")
         protected DynamicObject setClass(DynamicObject object, DynamicObject newClass) {
@@ -444,7 +436,7 @@ public abstract static class VMDevUrandomBytes extends PrimitiveArrayArgumentsNo
 
         @Specialization(guards = "count >= 0")
         protected DynamicObject readRandomBytes(int count,
-                @Cached StringNodes.MakeStringNode makeStringNode) {
+                @Cached MakeStringNode makeStringNode) {
             final byte[] bytes = getContext().getRandomSeedBytes(count);
 
             return makeStringNode.executeMake(bytes, ASCIIEncoding.INSTANCE, CodeRange.CR_UNKNOWN);
@@ -462,7 +454,7 @@ protected DynamicObject negativeCount(int count) {
     }
 
     @Primitive(name = "vm_hash_start", needsSelf = false)
-    public abstract static class VMHashStart extends PrimitiveArrayArgumentsNode {
+    public abstract static class VMHashStartNode extends PrimitiveArrayArgumentsNode {
 
         @Specialization
         protected long startHash(long salt) {
@@ -495,7 +487,7 @@ protected Object startHashNotNumber(Object salt,
     }
 
     @Primitive(name = "vm_hash_update", needsSelf = false)
-    public abstract static class VMHashUpdate extends PrimitiveArrayArgumentsNode {
+    public abstract static class VMHashUpdateNode extends PrimitiveArrayArgumentsNode {
 
         @Specialization
         protected long updateHash(long hash, long value) {
@@ -507,7 +499,6 @@ protected long updateHash(long hash, DynamicObject value) {
             return Hashing.update(hash, Layouts.BIGNUM.getValue(value).hashCode());
         }
 
-
         @Specialization(guards = "!isRubyNumber(value)")
         protected Object updateHash(long hash, Object value,
                 @Cached("createPrivate()") CallDispatchHeadNode coerceToIntNode,
@@ -529,11 +520,13 @@ protected Object updateHash(long hash, Object value,
     }
 
     @Primitive(name = "vm_hash_end", needsSelf = false)
-    public abstract static class VMHashEnd extends PrimitiveArrayArgumentsNode {
+    public abstract static class VMHashEndNode extends PrimitiveArrayArgumentsNode {
 
         @Specialization
         protected long endHash(long hash) {
             return Hashing.end(hash);
         }
+
     }
+
 }