rice 4.3.1 → 4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1c38f3ecf4a82df0f710ebcddb90f42152a4329e375ff8ea7afaf1eddade33
-  data.tar.gz: 3ae4a9a648313b45f2efe37fd370aa6442bd6e042b72384f980ac2ae8ada6ddc
+  metadata.gz: 4f1560a877de281b9d1fb0538591d606dc0fe312a6fbbaaf9d15448028836fad
+  data.tar.gz: 0af73222a775ef41799404a26c4cd69290330ce41184b512ecfb1a2d05925900
 SHA512:
-  metadata.gz: 32208880275388fa976f4a848d483daa2190425e0b7272d09557af7a5ee1b28ef95fa45f3b280b4c2aff35daf9e745b2069bfcf7aa2e7827f81d36f15d1aaead
-  data.tar.gz: 81351aa2c5d1fca2f51bbdb519375623983c23a5fd10162aa6bcfe3b653110a59edfa5e8d56c8172dd8ef542e9bb223d428ddbd66c6a1787fcc9bfd241c0740b
+  metadata.gz: 426d8192d42f45b177a4f8639dc7d329143c2a5874b3ead5ab71bdcf0299d46d0e0d707cb616e57c33f2c2896aba7497baaba3191d02ab846ac2b2b49abe3071
+  data.tar.gz: d3cab1776f0817e76ee2d0576c8addf3412bf16d0da5fbcb64232d5aa9887b7f9c3607878e201cc9677e387ec4253a61add0be845e46bfa6751d261b4d596815

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.3.2
+
+* Improve NativeRegistry to reduce possible hash collisions and weird "bad any cast" errors.
+
 ## 4.3.1
 
 * Update links and related references to the new repo and docs location: ruby-rice.github.io.

data/CONTRIBUTORS.md

@@ -16,7 +16,7 @@ I'd like to thank the following people for their help in making Rice what it is
 * [nobu](https://github.com/nobu) for [PR #122](https://github.com/jasonroelofs/rice/pull/122)
 * [Charlie Savage (cfis)](https://github.com/cfis) for multiple improvements and modernizations: [#130](https://github.com/jasonroelofs/rice/pull/130), [#131](https://github.com/jasonroelofs/rice/pull/131), [#133](https://github.com/jasonroelofs/rice/pull/133), [#134](https://github.com/jasonroelofs/rice/pull/134), [#136](https://github.com/jasonroelofs/rice/pull/136), [#137](https://github.com/jasonroelofs/rice/pull/137), [#140](https://github.com/jasonroelofs/rice/pull/140), [#141](https://github.com/jasonroelofs/rice/pull/141) and many others, including the work to make Rice header-only.
 * [Atsushi Tatsuma (yoshoku)](https://github.com/yoshoku) for [#135](https://github.com/jasonroelofs/rice/pull/135)
-* [Andrew Kane (ankane)](https://github.com/ankane) for helping [test Rice 4](https://github.com/jasonroelofs/rice/issues/149).
+* [Andrew Kane (ankane)](https://github.com/ankane) for helping [test Rice 4](https://github.com/jasonroelofs/rice/issues/149), [#208](https://github.com/ruby-rice/rice/pull/208), [#209](https://github.com/ruby-rice/rice/pull/208).
 * [Maxim Samsonov (maxirmx)](https://github.com/maxirmx) for [#193](https://github.com/jasonroelofs/rice/issues/193) and [#194](https://github.com/jasonroelofs/rice/pull/194)
 * [kvtb](https://github.com/kvtb) for [#191](https://github.com/jasonroelofs/rice/issues/191)
 * [thekendalmiller](https://github.com/thekendalmiller) for [#201](https://github.com/jasonroelofs/rice/pull/201)

data/include/rice/rice.hpp

@@ -1075,6 +1075,7 @@ namespace Rice::detail
 
 #include <unordered_map>
 #include <any>
+#include <tuple>
 
 
 namespace Rice::detail
@@ -1094,9 +1095,9 @@ namespace Rice::detail
 
   private:
     size_t key(VALUE klass, ID method_id);
-    std::unordered_map<size_t, std::any> natives_ = {};
+    std::unordered_multimap<size_t, std::tuple<VALUE, ID, std::any>> natives_ = {};
   };
-} 
+}
 
 // ---------   NativeRegistry.ipp   ---------
 
@@ -1114,19 +1115,30 @@ namespace Rice::detail
   // https://stackoverflow.com/a/2634715
   inline size_t NativeRegistry::key(VALUE klass, ID id)
   {
-    if (rb_type(klass) == T_ICLASS)
-    {
-      klass = detail::protect(rb_class_of, klass);
-    }
-
     uint32_t prime = 53;
     return (prime + klass) * prime + id;
   }
 
   inline void NativeRegistry::add(VALUE klass, ID method_id, std::any callable)
   {
-    // Now store data about it
-    this->natives_[key(klass, method_id)] = callable;
+    if (rb_type(klass) == T_ICLASS)
+    {
+      klass = detail::protect(rb_class_of, klass);
+    }
+
+    auto range = this->natives_.equal_range(key(klass, method_id));
+    for (auto it = range.first; it != range.second; ++it)
+    {
+      const auto [k, m, d] = it->second;
+
+      if (k == klass && m == method_id)
+      {
+        std::get<2>(it->second) = callable;
+        return;
+      }
+    }
+
+    this->natives_.emplace(std::make_pair(key(klass, method_id), std::make_tuple(klass, method_id, callable)));
   }
 
   template <typename Return_T>
@@ -1145,14 +1157,28 @@ namespace Rice::detail
   template <typename Return_T>
   inline Return_T NativeRegistry::lookup(VALUE klass, ID method_id)
   {
-    auto iter = this->natives_.find(key(klass, method_id));
-    if (iter == this->natives_.end())
+    if (rb_type(klass) == T_ICLASS)
+    {
+      klass = detail::protect(rb_class_of, klass);
+    }
+
+    auto range = this->natives_.equal_range(key(klass, method_id));
+    for (auto it = range.first; it != range.second; ++it)
     {
-      rb_raise(rb_eRuntimeError, "Could not find data for klass and method id");
+      const auto [k, m, d] = it->second;
+
+      if (k == klass && m == method_id)
+      {
+        auto* ptr = std::any_cast<Return_T>(&d);
+        if (!ptr)
+        {
+          rb_raise(rb_eRuntimeError, "Unexpected return type for %s#%s", rb_class2name(klass), rb_id2name(method_id));
+        }
+        return *ptr;
+      }
     }
 
-    std::any data = iter->second;
-    return std::any_cast<Return_T>(data);
+    rb_raise(rb_eRuntimeError, "Could not find data for klass and method id");
   }
 }
 
@@ -6242,6 +6268,9 @@ namespace Rice
     //! Construct a Symbol from an std::string.
     Symbol(std::string const& s);
 
+    //! Construct a Symbol from an std::string_view.
+    Symbol(std::string_view const& s);
+
     //! Return a string representation of the Symbol.
     char const* c_str() const;
 
@@ -6273,7 +6302,12 @@ namespace Rice
   }
 
   inline Symbol::Symbol(std::string const& s)
-    : Object(detail::protect(rb_id2sym, detail::protect(rb_intern2, s.c_str(), s.size())))
+    : Object(detail::protect(rb_id2sym, detail::protect(rb_intern2, s.c_str(), (long)s.length())))
+  {
+  }
+
+  inline Symbol::Symbol(std::string_view const& view)
+    : Object(detail::protect(rb_id2sym, detail::protect(rb_intern2, view.data(), (long)view.length())))
   {
   }
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Rice
-  VERSION = "4.3.1"
+  VERSION = "4.3.2"
 end

data/rice/detail/NativeRegistry.hpp

@@ -3,6 +3,7 @@
 
 #include <unordered_map>
 #include <any>
+#include <tuple>
 
 #include "ruby.hpp"
 
@@ -23,9 +24,9 @@ namespace Rice::detail
 
   private:
     size_t key(VALUE klass, ID method_id);
-    std::unordered_map<size_t, std::any> natives_ = {};
+    std::unordered_multimap<size_t, std::tuple<VALUE, ID, std::any>> natives_ = {};
   };
-} 
+}
 #include "NativeRegistry.ipp"
 
-#endif // Rice__detail__NativeRegistry__hpp
+#endif // Rice__detail__NativeRegistry__hpp

data/rice/detail/NativeRegistry.ipp

@@ -14,19 +14,30 @@ namespace Rice::detail
   // https://stackoverflow.com/a/2634715
   inline size_t NativeRegistry::key(VALUE klass, ID id)
   {
-    if (rb_type(klass) == T_ICLASS)
-    {
-      klass = detail::protect(rb_class_of, klass);
-    }
-
     uint32_t prime = 53;
     return (prime + klass) * prime + id;
   }
 
   inline void NativeRegistry::add(VALUE klass, ID method_id, std::any callable)
   {
-    // Now store data about it
-    this->natives_[key(klass, method_id)] = callable;
+    if (rb_type(klass) == T_ICLASS)
+    {
+      klass = detail::protect(rb_class_of, klass);
+    }
+
+    auto range = this->natives_.equal_range(key(klass, method_id));
+    for (auto it = range.first; it != range.second; ++it)
+    {
+      const auto [k, m, d] = it->second;
+
+      if (k == klass && m == method_id)
+      {
+        std::get<2>(it->second) = callable;
+        return;
+      }
+    }
+
+    this->natives_.emplace(std::make_pair(key(klass, method_id), std::make_tuple(klass, method_id, callable)));
   }
 
   template <typename Return_T>
@@ -45,13 +56,27 @@ namespace Rice::detail
   template <typename Return_T>
   inline Return_T NativeRegistry::lookup(VALUE klass, ID method_id)
   {
-    auto iter = this->natives_.find(key(klass, method_id));
-    if (iter == this->natives_.end())
+    if (rb_type(klass) == T_ICLASS)
     {
-      rb_raise(rb_eRuntimeError, "Could not find data for klass and method id");
+      klass = detail::protect(rb_class_of, klass);
+    }
+
+    auto range = this->natives_.equal_range(key(klass, method_id));
+    for (auto it = range.first; it != range.second; ++it)
+    {
+      const auto [k, m, d] = it->second;
+
+      if (k == klass && m == method_id)
+      {
+        auto* ptr = std::any_cast<Return_T>(&d);
+        if (!ptr)
+        {
+          rb_raise(rb_eRuntimeError, "Unexpected return type for %s#%s", rb_class2name(klass), rb_id2name(method_id));
+        }
+        return *ptr;
+      }
     }
 
-    std::any data = iter->second;
-    return std::any_cast<Return_T>(data);
+    rb_raise(rb_eRuntimeError, "Could not find data for klass and method id");
   }
 }

data/test/test_Native_Registry.cpp

@@ -0,0 +1,50 @@
+#include "unittest.hpp"
+#include "embed_ruby.hpp"
+
+#include <rice/rice.hpp>
+#include <rice/stl.hpp>
+
+using namespace Rice;
+
+TESTSUITE(NativeRegistry);
+
+SETUP(NativeRegistry)
+{
+  embed_ruby();
+}
+
+TESTCASE(collisions)
+{
+  std::array<Class, 100> classes;
+  int scale = 1000;
+
+  for (int i = 0; i < std::size(classes); i++)
+  {
+    Class cls(anonymous_class());
+
+    for (int j = 0; j < scale; j++)
+    {
+      cls.define_function("int" + std::to_string(j), []() { return 1; });
+      cls.define_function("long" + std::to_string(j), []() { return 1L; });
+      cls.define_function("double" + std::to_string(j), []() { return 1.0; });
+      cls.define_function("float" + std::to_string(j), []() { return 1.0f; });
+      cls.define_function("bool" + std::to_string(j), []() { return true; });
+    }
+
+    classes[i] = cls;
+  }
+
+  for (auto& cls : classes)
+  {
+    auto obj = cls.call("new");
+
+    for (int j = 0; j < scale; j++)
+    {
+      obj.call("int" + std::to_string(j));
+      obj.call("long" + std::to_string(j));
+      obj.call("double" + std::to_string(j));
+      obj.call("float" + std::to_string(j));
+      obj.call("bool" + std::to_string(j));
+    }
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rice
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.3.2
 platform: ruby
 authors:
 - Paul Brannan
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-16 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -188,6 +188,7 @@ files:
 - test/test_Keep_Alive_No_Wrapper.cpp
 - test/test_Memory_Management.cpp
 - test/test_Module.cpp
+- test/test_Native_Registry.cpp
 - test/test_Object.cpp
 - test/test_Ownership.cpp
 - test/test_Self.cpp
@@ -232,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby Interface for C++ Extensions